Jump to

• Request
• Response

Get a list of encounters

get

/Encounter

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves a list of encounters that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.
• _revinclude: string
  The related Provenance resources to include in the search bundle.

  Allowed Values: [ "Provenance:target" ]
• date: string
  A date within the encounter's time period.
• patient: string
  The patient present at the encounter.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/Encounter"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/Encounter"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object Encounter
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/Encounter"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : Encounter

Type: object

Show Source

• class(required): class
  (USCDI) The classification of the patient encounter.
• hospitalization: hospitalization
  (USCDI) The details about the admission to a healthcare service.
• id(required): string
• identifier: array identifier
  (USCDI) The identifiers by which this encounter is known.
• location: array location
  (USCDI) The list of locations where the patient has been.
• participant: array participant
  (USCDI) The list of participants involved in the encounter.
• period: period
  (USCDI) The start and end time of the encounter.
• reasonCode: array reasonCode
  (USCDI) The coded reason the encounter takes place.
• reasonReference: array reasonReference
  (USCDI) The reason the encounter takes place (reference).
• resourceType(required): string
  Allowed Values: [ "Encounter" ]
• serviceProvider: serviceProvider
  (USCDI) The organization (facility) responsible for this encounter.
• status(required): string
  (USCDI) The following values are supported:

  • planned
  • arrived
  • triaged
  • in-progress
  • onleave
  • finished
  • cancelled
• subject(required): subject
  (USCDI) The patient or group present at the encounter.
• type(required): array type
  (USCDI) The specific type of encounter.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "status",
        "class",
        "type",
        "subject"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Encounter"
            ]
        },
        "id":{
            "type":"string"
        },
        "identifier":{
            "type":"array",
            "description":"(USCDI) The identifiers by which this encounter is known.",
            "items":{
                "$ref":"#/components/schemas/Identifier"
            }
        },
        "status":{
            "type":"string",
            "description":"(USCDI) The following values are supported:\n  <ul>\n    <li><code>planned</code></li>\n    <li><code>arrived</code></li>\n    <li><code>triaged</code></li>\n    <li><code>in-progress</code></li>\n    <li><code>onleave</code></li>\n    <li><code>finished</code></li>\n    <li><code>cancelled</code></li>\n  </ul>\n"
        },
        "class":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Coding"
                }
            ],
            "description":"(USCDI) The classification of the patient encounter."
        },
        "type":{
            "type":"array",
            "description":"(USCDI) The specific type of encounter.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "subject":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The patient or group present at the encounter."
        },
        "participant":{
            "type":"array",
            "description":"(USCDI) The list of participants involved in the encounter.",
            "items":{
                "$ref":"#/components/schemas/EncounterParticipant"
            }
        },
        "period":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Period"
                }
            ],
            "description":"(USCDI) The start and end time of the encounter."
        },
        "reasonCode":{
            "type":"array",
            "description":"(USCDI) The coded reason the encounter takes place.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "reasonReference":{
            "type":"array",
            "description":"(USCDI) The reason the encounter takes place (reference).",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        },
        "hospitalization":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/EncounterHospitalization"
                }
            ],
            "description":"(USCDI) The details about the admission to a healthcare service."
        },
        "location":{
            "type":"array",
            "description":"(USCDI) The list of locations where the patient has been.",
            "items":{
                "$ref":"#/components/schemas/EncounterLocation"
            }
        },
        "serviceProvider":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The organization (facility) responsible for this encounter."
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : class

(USCDI) The classification of the patient encounter.

Match All

(USCDI) The classification of the patient encounter.

Show Source

• object Coding

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Coding"
        }
    ],
    "description":"(USCDI) The classification of the patient encounter."
}

Nested Schema : hospitalization

(USCDI) The details about the admission to a healthcare service.

Match All

(USCDI) The details about the admission to a healthcare service.

Show Source

• object EncounterHospitalization

{
    "allOf":[
        {
            "$ref":"#/components/schemas/EncounterHospitalization"
        }
    ],
    "description":"(USCDI) The details about the admission to a healthcare service."
}

Nested Schema : identifier

Type: array

(USCDI) The identifiers by which this encounter is known.

Show Source

• Array of: object Identifier

{
    "type":"array",
    "description":"(USCDI) The identifiers by which this encounter is known.",
    "items":{
        "$ref":"#/components/schemas/Identifier"
    }
}

Nested Schema : location

Type: array

(USCDI) The list of locations where the patient has been.

Show Source

• Array of: object EncounterLocation

{
    "type":"array",
    "description":"(USCDI) The list of locations where the patient has been.",
    "items":{
        "$ref":"#/components/schemas/EncounterLocation"
    }
}

Nested Schema : participant

Type: array

(USCDI) The list of participants involved in the encounter.

Show Source

• Array of: object EncounterParticipant

{
    "type":"array",
    "description":"(USCDI) The list of participants involved in the encounter.",
    "items":{
        "$ref":"#/components/schemas/EncounterParticipant"
    }
}

Nested Schema : period

(USCDI) The start and end time of the encounter.

Match All

(USCDI) The start and end time of the encounter.

Show Source

• object Period

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Period"
        }
    ],
    "description":"(USCDI) The start and end time of the encounter."
}

Nested Schema : reasonCode

Type: array

(USCDI) The coded reason the encounter takes place.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"(USCDI) The coded reason the encounter takes place.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : reasonReference

Type: array

(USCDI) The reason the encounter takes place (reference).

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"(USCDI) The reason the encounter takes place (reference).",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : serviceProvider

(USCDI) The organization (facility) responsible for this encounter.

Match All

(USCDI) The organization (facility) responsible for this encounter.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The organization (facility) responsible for this encounter."
}

Nested Schema : subject

(USCDI) The patient or group present at the encounter.

Match All

(USCDI) The patient or group present at the encounter.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The patient or group present at the encounter."
}

Nested Schema : type

Type: array

(USCDI) The specific type of encounter.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"(USCDI) The specific type of encounter.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : EncounterHospitalization

Type: object

Show Source

• dischargeDisposition: dischargeDisposition
  (USCDI) The category or type of location after discharge.

{
    "type":"object",
    "properties":{
        "dischargeDisposition":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The category or type of location after discharge."
        }
    }
}

Nested Schema : dischargeDisposition

(USCDI) The category or type of location after discharge.

Match All

(USCDI) The category or type of location after discharge.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The category or type of location after discharge."
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Identifier

Type: object

Show Source

• system(required): string (uri)
• value(required): string

{
    "type":"object",
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : EncounterLocation

Type: object

Show Source

• location(required): location
  (USCDI) The location where the encounter takes place.

{
    "type":"object",
    "required":[
        "location"
    ],
    "properties":{
        "location":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The location where the encounter takes place."
        }
    }
}

Nested Schema : location

(USCDI) The location where the encounter takes place.

Match All

(USCDI) The location where the encounter takes place.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The location where the encounter takes place."
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : EncounterParticipant

Type: object

Show Source

• individual: individual
  (USCDI) The people involved in the encounter other than the patient.
• period: period
  (USCDI) The period of time during the encounter when the participant participated.
• type: array type
  (USCDI) The role of the participant in the encounter.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"array",
            "description":"(USCDI) The role of the participant in the encounter.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "period":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Period"
                }
            ],
            "description":"(USCDI) The period of time during the encounter when the participant participated."
        },
        "individual":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The people involved in the encounter other than the patient."
        }
    }
}

Nested Schema : individual

(USCDI) The people involved in the encounter other than the patient.

Match All

(USCDI) The people involved in the encounter other than the patient.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The people involved in the encounter other than the patient."
}

Nested Schema : period

(USCDI) The period of time during the encounter when the participant participated.

Match All

(USCDI) The period of time during the encounter when the participant participated.

Show Source

• object Period

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Period"
        }
    ],
    "description":"(USCDI) The period of time during the encounter when the participant participated."
}

Nested Schema : type

Type: array

(USCDI) The role of the participant in the encounter.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"(USCDI) The role of the participant in the encounter.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string (date-time)
• start: string (date-time)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top