Jump to

• Request
• Response

Get a list of encounters

get

/Encounter

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

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

• Provide _id or patient, not both.
• Use status only with patient.

Request

Query Parameters

• _count: integer
  Minimum Value: 1

  The maximum number of results per page.

  Default Value: 50
• _id: string
  The logical resource ID.
• _lastUpdated: array[string]
  The last updated date or range.
• _revinclude: string
  The inclusion of related Provenance resources targeting returned encounters.

  Allowed Values: [ "Provenance:target" ]
• date: array[string]
  The encounter date or range.
• identifier: string
  The identifier value or system|value token.
• patient: string
  The patient reference or ID.
• status: string
  The encounter status.
• subject: string
  The patient subject ID or reference.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The 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":{
                "$ref":"#/components/schemas/BundleEntryForEncounter"
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object BundleEntryForEncounter

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

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

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

Nested Schema : BundleEntryForEncounter

Type: object

Show Source

• fullUrl: string (uri)
• resource: resource
• search: object BundleEntrySearch

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/Encounter"
                },
                {
                    "$ref":"#/components/schemas/ProvenanceForEncounter"
                },
                {
                    "$ref":"#/components/schemas/OperationOutcome"
                }
            ]
        },
        "search":{
            "$ref":"#/components/schemas/BundleEntrySearch"
        }
    }
}

Nested Schema : resource

Match One Schema

Show Source

• object Encounter
  The FHIR R4 Encounter resource.
• object ProvenanceForEncounter
  Additional Properties Allowed: true
• object OperationOutcome
  The FHIR OperationOutcome.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/Encounter"
        },
        {
            "$ref":"#/components/schemas/ProvenanceForEncounter"
        },
        {
            "$ref":"#/components/schemas/OperationOutcome"
        }
    ]
}

Nested Schema : BundleEntrySearch

Type: object

Show Source

• mode: string

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

Nested Schema : Encounter

Type: object

The FHIR R4 Encounter resource.

Show Source

• appointment: array appointment
• class(required): object Coding
• extension: array extension
• hospitalization: object HospitalizationForEncounter
• id(required): string
• identifier: array identifier
• location: array location
• meta: object meta
• participant: array participant
• period: object PeriodForEncounter
• priority: object Coding
• reasonCode: array reasonCode
• resourceType(required): string
  Allowed Values: [ "Encounter" ]
• serviceProvider: object ReferenceForEncounter
• serviceType: object CodeableConcept
• status(required): string
• subject(required): object ReferenceForEncounter
• text: object Narrative
• type: array type

{
    "type":"object",
    "description":"The FHIR R4 Encounter resource.",
    "required":[
        "resourceType",
        "id",
        "status",
        "class",
        "subject"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Encounter"
            ]
        },
        "id":{
            "type":"string"
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForEncounter"
            }
        },
        "identifier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IdentifierForEncounter"
            }
        },
        "status":{
            "type":"string"
        },
        "class":{
            "$ref":"#/components/schemas/Coding"
        },
        "type":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "serviceType":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "priority":{
            "$ref":"#/components/schemas/Coding"
        },
        "subject":{
            "$ref":"#/components/schemas/ReferenceForEncounter"
        },
        "participant":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ParticipantForEncounter"
            }
        },
        "appointment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForEncounter"
            }
        },
        "period":{
            "$ref":"#/components/schemas/PeriodForEncounter"
        },
        "reasonCode":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "hospitalization":{
            "$ref":"#/components/schemas/HospitalizationForEncounter"
        },
        "location":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LocationForEncounter"
            }
        },
        "serviceProvider":{
            "$ref":"#/components/schemas/ReferenceForEncounter"
        }
    }
}

Nested Schema : ProvenanceForEncounter

Type: object

Additional Properties Allowed: true

Show Source

• resourceType: string
  Allowed Values: [ "Provenance" ]

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Provenance"
            ]
        }
    },
    "additionalProperties":true
}

Nested Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : appointment

Type: array

Show Source

• Array of: object ReferenceForEncounter

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

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForEncounter

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

Nested Schema : HospitalizationForEncounter

Type: object

Show Source

• admitSource: object CodeableConcept
• destination: object ReferenceForEncounter
• dischargeDisposition: object CodeableConcept

{
    "type":"object",
    "properties":{
        "admitSource":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "dischargeDisposition":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "destination":{
            "$ref":"#/components/schemas/ReferenceForEncounter"
        }
    }
}

Nested Schema : identifier

Type: array

Show Source

• Array of: object IdentifierForEncounter

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

Nested Schema : location

Type: array

Show Source

• Array of: object LocationForEncounter

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

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
• security: array security
• versionId: string

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : participant

Type: array

Show Source

• Array of: object ParticipantForEncounter

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

Nested Schema : PeriodForEncounter

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForEncounter"
            }
        }
    }
}

Nested Schema : reasonCode

Type: array

Show Source

• Array of: object CodeableConcept

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

Nested Schema : ReferenceForEncounter

Type: object

Show Source

• display: string
• reference: string

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

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : Narrative

Type: object

Show Source

• div: string
  The XHTML narrative content.
• status: string
  The narrative generation status.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The narrative generation status."
        },
        "div":{
            "type":"string",
            "description":"The XHTML narrative content."
        }
    }
}

Nested Schema : type

Type: array

Show Source

• Array of: object CodeableConcept

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

Nested Schema : ExtensionForEncounter

Type: object

Show Source

• url: string (uri)
• valueCode: string
• valueMoney: object MoneyForEncounter
• valueReference: object ReferenceForEncounter

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueCode":{
            "type":"string"
        },
        "valueMoney":{
            "$ref":"#/components/schemas/MoneyForEncounter"
        },
        "valueReference":{
            "$ref":"#/components/schemas/ReferenceForEncounter"
        }
    }
}

Nested Schema : MoneyForEncounter

Type: object

Show Source

• currency: string
• value: number

{
    "type":"object",
    "properties":{
        "value":{
            "type":"number"
        },
        "currency":{
            "type":"string"
        }
    }
}

Nested Schema : IdentifierForEncounter

Type: object

Show Source

• _system: object PrimitiveElementForEncounter
• period: object PeriodForEncounter
• system: string (uri)
• type: object CodeableConcept
• use: string
• value: string

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "_system":{
            "$ref":"#/components/schemas/PrimitiveElementForEncounter"
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "use":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "period":{
            "$ref":"#/components/schemas/PeriodForEncounter"
        }
    }
}

Nested Schema : PrimitiveElementForEncounter

Type: object

Show Source

• extension: array extension

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForEncounter"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForEncounter

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

Nested Schema : LocationForEncounter

Type: object

Show Source

• location: object ReferenceForEncounter
• period: object PeriodForEncounter
• status: string

{
    "type":"object",
    "properties":{
        "location":{
            "$ref":"#/components/schemas/ReferenceForEncounter"
        },
        "period":{
            "$ref":"#/components/schemas/PeriodForEncounter"
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

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

Nested Schema : ParticipantForEncounter

Type: object

Show Source

• individual: object ReferenceForEncounter
• period: object PeriodForEncounter
• type: array type

{
    "type":"object",
    "properties":{
        "type":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "period":{
            "$ref":"#/components/schemas/PeriodForEncounter"
        },
        "individual":{
            "$ref":"#/components/schemas/ReferenceForEncounter"
        }
    }
}

Nested Schema : type

Type: array

Show Source

• Array of: object CodeableConcept

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

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForEncounter

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

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]

  The link relation.
• url: string
  The link URL.

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ],
            "description":"The link relation."
        },
        "url":{
            "type":"string",
            "description":"The link URL."
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top