Jump to

• Request
• Response

Get an encounter by ID

get

/Encounter/{id}

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 an individual encounter by the associated ID.

Request

Path Parameters

• id(required): string
  The logical resource ID.

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 retrieve response.

Body ()

Root 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 : 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."
}

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