Encounter REST Endpoints

Sort by

Task Path Method

Description

Encounter

This topic describes information for the Encounter resource.

Overview

The Encounter resource provides admissions or visits during which healthcare services were provided to a patient. An encounter has a class to distinguish between different healthcare settings such as inpatient, outpatient, emergency, and so on. A patient may have one medical record number with multiple encounter numbers per facility or organization. Substantial variance exists between organizations in the definition of an encounter and what events are aggregated together to constitute an encounter.

This resource supports the US Core Encounter Profile from HL7 FHIR US Core Implementation Guide STU 6.1.0.

Note:

The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site. The meta.security field is present only when a problem or diagnosis is marked as confidential.

Fields

• Encounter ID
• Encounter identifier
• Status
• Class
• Type
• Service Type
• Priority

• Subject

  • Reference (Patient)

• Participant:

  • Type

  • Name

    • Reference (Practitioner)
• Appointment
• Start/end time of the Encounter
• Reason for visit
• Incident
• Admitting diagnoses
• Administrative problem

• Hospitalization:

  • Admit source
  • Diet preference
  • Special courtesy
  • Special arrangement

  • Discharge destination

    • Reference (Location)
  • Discharge disposition

• Location:

  • Name
  • Location status
• Service provider
• Extensions (for more information, see the Extensions section of this topic)

Contained Location bindings

• Location.type

  Description: Indicates the type of function performed at the location.

  Details: v3 Code System RoleCode

  System: http://terminology.hl7.org/CodeSystem/v3-RoleCode

Terminology Bindings

• Encounter.identifier.type

  Description: The type used to determine which identifier to use for a specific purpose.

  • Details: Identifier Type Codes

    System: http://hl7.org/fhir/identifier-type

  • Details: v2 Identifier Type

    System: http://terminology.hl7.org/CodeSystem/v2-0203

  • Details: For more information, see Code Set 319 Encounter Alias Type under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR source id>/codeSet/319

• Encounter.type

  Description: The type of encounter.

  • Details: For more information, see Code Set 71 Visit Type under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR source id>/codeSet/71

  • Details: v2 Patient Class

    System: http://terminology.hl7.org/CodeSystem/v2-0004

  • Details: SNOMED CT

    System: http://snomed.info/sct

• Encounter.serviceType

  Description: Broad categorization of the service that is to be provided.

  • Details: SNOMED CT

    System: http://snomed.info/sct

  • Details: For more information, see Code Set 34 Hospital Service under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR source id>/codeSet/34

• Encounter.priority

  Description: Indicates the urgency of the encounter.

  • Details: Encounter Priority

    System: http://hl7.org/fhir/encounter-priority

  • Details: For more information, see Code Set 3 Encounter Admission Type under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR source id>/codeSet/3

• Encounter.participant.type

  Description: Role of participant in encounter.

  • Details: ParticipantType

    System: http://terminology.hl7.org/CodeSystem/v3-ParticipationType

  • Details: For more information, see Code Set 333 Encounter/Personnel Relationship under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR source id>/codeSet/333

• Encounter.hospitalization.admitSource

  Description: From where patient was admitted.

  • Details: AdmitSource

    System: http://hl7.org/fhir/admit-source

  • Details: For more information, see Code Set 2 Admission Source under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR source id>/codeSet/2

• Encounter.hospitalization.dietPreference

  Description: Medical, cultural or ethical food preferences to help with catering requirements.

  • Details: Diet

    System: http://terminology.hl7.org/CodeSystem/diet

  • Details: For more information, see Code Set 18 Diet under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR source id>/codeSet/18

• Encounter.hospitalization.specialCourtesy

  Description: Special courtesies.

  • Details: v3 Code System EncounterSpecialCourtesy

    System: http://terminology.hl7.org/CodeSystem/v3-EncounterSpecialCourtesy

  • Details: For more information, see Code Set 67 VIP under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR source id>/codeSet/67

  • Details: For more information, see Code Set 16 Courtesy under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR source id>/codeSet/16

• Encounter.hospitalization.specialArrangement

  Description: Special arrangements.

  Details: SpecialArrangements

  System: http://hl7.org/fhir/encounter-special-arrangements

• Encounter.hospitalization.dischargeDisposition

  Description: Discharge Disposition.

  • Details: DischargeDisposition

    System: http://hl7.org/fhir/discharge-disposition

  • Details: For more information, see Code Set 19 Discharge Disposition under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR source id>/codeSet/19

• Encounter.meta.security

  Description: Security labels applied to this resource.

  Note:

  Encounters created with meta.security set with code 'UNCERTREL' will be returned with an external encounter type.

  Details: Observation Values

  System: http://terminology.hl7.org/CodeSystem/v3-ObservationValue

• Encounter.extension[x].extension[x].valueCodeableConcept

  Description: The value of the client defined custom attribute. This binding is used for the custom-attribute-value extension nested under custom-attribute extensions.

  Note:

  • The terminology binding only applies when the custom-attribute-value extension is of type CodeableConcept.
  • The value of the custom attribute is not limited to a single Code Set or nomenclature.

  • Details: For more information, see the Proprietary Codes section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR source id>/codeSet/<code set>

  • Details: For more information, see Nomenclature under the List of Systems section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/<EHR source id>/nomenclature

• Encounter.extension[x].valueMoney.currency (for more information, see the Extensions section of this topic)

  Description: Currency codes from ISO 4217. This binding is used in estimated-financial-responsibility-amount extensions.

  Details: Currencies

  System: urn:iso:std:iso:4217

• Encounter.extension[x].valueCodeableConcept (for more information, see the Extensions section of this topic)

  Description: The reason no estimated amount is collected for the encounter. This binding is used in estimated-financial-responsibility-not-collected-reason extensions.

  Details: For more information, see the List of Code Sets section in Proprietary Codes and Systems.

  System: https://fhir.cerner.com/<EHR source id>/codeSet/4660008

• Encounter.extension[x].valueCodeableConcept (for more information, see the Extensions section of this topic)

  Description: Identifies whether an encounter is connected to military service. This binding is used in military-service-connected-indicator extensions.

  Details: For more information, see the List of Code Sets section in Proprietary Codes and Systems.

  System: https://fhir.cerner.com/<EHR source id>/codeSet/4003348

• Encounter.extension[x].valueCodeableConcept (for more information, see the Extensions section of this topic)

  Description: The payment collection status. This binding is used in payment-collection-status extensions.

  Details: For more information, see the List of Code Sets section in Proprietary Codes and Systems.

  System: https://fhir.cerner.com/<EHR source id>/codeSet/4003489

Extensions

All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}

Table - Extensions

ID	Value[x} Type	Description
client-organization	Reference	The financially responsible organization.
custom-attribute	None (contains nested extensions)	A client defined custom attribute for the resource. Attribute values can be of type integer, string, CodeableConcept, or dateTime.
estimated-financial-responsibility-amount	Money	The estimated amount to be collected for the encounter.
estimated-financial-responsibility-not-collected-reason	CodeableConcept	The reason no estimated amount is collected for the encounter.
military-service-connected-indicator	CodeableConcept	Identifies whether an encounter is connected to military service.
payment-collection-status	CodeableConcept	The status of the payment collection for the encounter.

Encounter

The operations from the Encounter category.

Create an encounter

Method: post

Path: /Encounter

Get a list of encounters

Method: get

Path: /Encounter

Get an encounter by ID

Method: get

Path: /Encounter/{ID}

Patch an encounter by ID

Method: patch

Path: /Encounter/{ID}