xCaliber healthCare Data Mesh

Encounter

Overview

The Encounter API empowers healthcare developers to seamlessly manage and retrieve patient encounter information, providing a standardized interface for efficient integration of visit details, diagnoses, and treatments into clinical workflows. By leveraging this API, developers can optimize encounter documentation, streamline care coordination, and ensure accurate tracking of patient interactions, enhancing the overall efficiency of healthcare delivery.

Use Cases

  • Patient Timelines - Record encounter details to construct longitudinal patient interaction histories.
  • Clinical Notes - Associate physician notes, findings with encounter records for documentation.
  • Orders & Plans - Place orders for medications, procedures related to reason for a particular encounter.
  • Billing & Claims - Capture diagnosis details, practitioner info to streamline billing for encounters.
  • Reporting & Analytics - Assess utilization metrics by analyzing encounter types distribution.
  • Workflow Integration - Trigger actions based on state changes such as admission, discharge.
  • Care Coordination - Share encounter details across providers to enable transitions of care.
  • Patient Portals - Display key encounter data to allow access to health information.
  • Population Health - Stratify patient populations by attributed facility encounters.
  • Interoperability - Exchange and consolidate encounter data from disparate systems.

EHR Data Model

EHRSupported?Mapped Source Object
AthenaEncounter, Encounter Reasons, Encounter Patient Goal Discussion Notes, Encounter Physical Exam, Encounter HPI, Encounter Review Of Systems, Order Group
ElationN/A
EpicInteraction, Encounter, Encounter Facility, Encounter Provider

Object Definition

{
  "resourceType": "Encounter",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Encounter with patient @example</div>"
  },
  "status": "in-progress",
  "class": {
    "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
    "code": "IMP",
    "display": "inpatient encounter"
  },
  "subject": {
    "reference": "Patient/example"
  },
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data FieldTypeDescription
resourceTypeEncounterThis is a Encounter resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedBackboneElementThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierIdentifier(s) by which this encounter is known.
statuscodeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +.
statusHistoryBackboneElementThe status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
statusHistory.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
statusHistory.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
statusHistory.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
statusHistory.statuscodeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +.
statusHistory.periodPeriodThe time that the episode was in the specified status.
classCodingConcepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
classHistoryBackboneElementThe class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.
classHistory.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
classHistory.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
classHistory.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
classHistory.classCodinginpatient | outpatient | ambulatory | emergency +.
classHistory.periodPeriodThe time that the episode was in the specified class.
typeCodeableConceptSpecific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
serviceTypeCodeableConceptBroad categorization of the service that is to be provided (e.g. cardiology).
priorityCodeableConceptIndicates the urgency of the encounter.
subjectReferenceThe patient or group present at the encounter.
episodeOfCareReferenceWhere a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
basedOnReferenceThe request this encounter satisfies (e.g. incoming referral or procedure request).
participantBackboneElementThe list of people responsible for providing the service.
participant.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
participant.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
participant.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
participant.typeCodeableConceptRole of participant in encounter.
participant.periodPeriodThe period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.
participant.individualReferencePersons involved in the encounter other than the patient.
appointmentReferenceThe appointment that scheduled this encounter.
periodPeriodThe start and end time of the encounter.
lengthDurationQuantity of time the encounter lasted. This excludes the time during leaves of absence.
reasonCodeCodeableConceptReason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
reasonReferenceReferenceReason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
diagnosisBackboneElementThe list of diagnosis relevant to this encounter.
diagnosis.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
diagnosis.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
diagnosis.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
diagnosis.conditionReferenceReason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
diagnosis.useCodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …).
diagnosis.rankpositiveIntRanking of the diagnosis (for each role type).
accountReferenceThe set of accounts that may be used for billing for this Encounter.
hospitalizationBackboneElementDetails about the admission to a healthcare service.
hospitalization.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
hospitalization.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
hospitalization.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
hospitalization.preAdmissionIdentifierIdentifierPre-admission identifier.
hospitalization.originReferenceThe location/organization from which the patient came before admission.
hospitalization.admitSourceCodeableConceptFrom where patient was admitted (physician referral, transfer).
hospitalization.reAdmissionCodeableConceptWhether this hospitalization is a readmission and why if known.
hospitalization.dietPreferenceCodeableConceptDiet preferences reported by the patient.
hospitalization.specialCourtesyCodeableConceptSpecial courtesies (VIP, board member).
hospitalization.specialArrangementCodeableConceptAny special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.
hospitalization.destinationReferenceLocation/organization to which the patient is discharged.
hospitalization.dischargeDispositionCodeableConceptCategory or kind of location after discharge.
locationBackboneElementList of locations where the patient has been during this encounter.
location.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
location.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
location.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
location.statuscodeThe status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.
location.physicalTypeCodeableConceptThis will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.
location.periodPeriodTime period during which the patient was present at the location.
serviceProviderReferenceThe organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.
partOfReferenceAnother Encounter of which this encounter is a part of (administratively or in time).

Extensions

NameURL
STAGEhttp://xcaliber-fhir/structureDefinition/stage
CLOSEDDATEhttp://xcaliber-fhir/structureDefinition/closed-date
CLOSEDUSERhttp://xcaliber-fhir/structureDefinition/closed-user
PATIENTLOCATIONhttp://xcaliber-fhir/structureDefinition/patient-location
PATIENTLOCATIONIDhttp://xcaliber-fhir/structureDefinition/patient-location-id
PATIENTSTATUShttp://xcaliber-fhir/structureDefinition/patient-status
PROVIDERFIRSTNAMEhttp://xcaliber-fhir/structureDefinition/provider-first-name
PROVIDERLASTNAMEhttp://xcaliber-fhir/structureDefinition/provider-last-name
PROVIDERPHONEhttp://xcaliber-fhir/structureDefinition/provider-phone
ENCOUNTERVISITNAMEhttp://xcaliber-fhir/structureDefinition/encounter-visit-name
STATUShttp://xcaliber-fhir/structureDefinition/status
XCALIBER_ATHENA_EXTENSIONhttp://xcaliber-fhir/structureDefinition
PATIENTSTATUSIDhttp://xcaliber-fhir/structureDefinition/patient-status-id
LASTREOPENEDhttp://xcaliber-fhir/structureDefinition/last-reopened
LASTUPDATEDhttp://xcaliber-fhir/structureDefinition/last-updated
DESCRIPTIONhttp://xcaliber-fhir/structureDefinition/diagnosis-description
DIAGNOSISIDhttp://xcaliber-fhir/structureDefinition/diagnosis-id
NOTEhttp://xcaliber-fhir/structureDefinition/diagnosis-note
SNOMEDCODEhttp://xcaliber-fhir/structureDefinition/snomed-code
REVIEWEDANDSIGNEDBYhttp://xcaliber-fhir/structureDefinition/reviewed-and-signed-by
REVIEWEDANDSIGNEDDATEhttp://xcaliber-fhir/structureDefinition/reviewed-and-signed-date
ASSESSMENTTEXThttp://xcaliber-fhir/structureDefinition/assessment-text
ASSESSMENTLASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/assessment-last-modified-by
ASSESSMENTLASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/assessment-last-modified-date-time
ENCOUNTERREASONNOTEhttp://xcaliber-fhir/structureDefinition/encounter-reason-note
ENCOUNTERREASONLASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/encounter-reason-last-modified-date-time
ENCOUNTERREASONNOTELASTMODIFIEDUSERhttp://xcaliber-fhir/structureDefinition/encounter-reason-note-last-modified-user
ENCOUNTERREASONNOTELASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/encounter-reason-note-last-modified-date-time
ENCOUNTERREASONLASTMODIFIEDUSERhttp://xcaliber-fhir/structureDefinition/encounter-reason-last-modified-user
PHYSICALEXAMTEMPLATEDATAhttp://xcaliber-fhir/structureDefinition/physical-exam-template-data
PHYSICALEXAMhttp://xcaliber-fhir/structureDefinition/physical-exam
PHYSICALEXAMLASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/physical-exam-last-modified-by
PHYSICALEXAMLASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/physical-exam-last-modified-datetime
PHYSICALEXAMSECTIONNOTELASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/physical-exam-section-note-last-modified-by
PHYSICALEXAMSECTIONNOTELASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/physical-exam-section-note-last-modified-datetime
PHYSICALEXAMSUMMARYTEXThttp://xcaliber-fhir/structureDefinition/physical-exam-summary-text
PHYSICALEXAMTEMPLATEShttp://xcaliber-fhir/structureDefinition/physical-exam-templates
PHYSICALEXAMSECTIONNOTEhttp://xcaliber-fhir/structureDefinition/physical-exam-section-note
HPITEMPLATEDATAhttp://xcaliber-fhir/structureDefinition/hpi-template-data
HPIhttp://xcaliber-fhir/structureDefinition/hpi
HPILASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/hpi-last-modified-by
HPILASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/hpi-last-modified-datetime
HPISECTIONNOTELASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/hpi-section-note-last-modified-by
HPISECTIONNOTELASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/hpi-section-note-last-modified-datetime
HPISUMMARYTEXThttp://xcaliber-fhir/structureDefinition/hpi-summary-text
HPITEMPLATEShttp://xcaliber-fhir/structureDefinition/hpi-templates
HPISECTIONNOTEhttp://xcaliber-fhir/structureDefinition/hpi-section-note
HPITOROShttp://xcaliber-fhir/structureDefinition/hpi-to-ros
HPITOROSLASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/hpi-to-ros-last-modified-by
HPITOROSLASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/hpi-to-ros-last-modified-datetime
ROSTEMPLATEDATAhttp://xcaliber-fhir/structureDefinition/ros-template-data
ROShttp://xcaliber-fhir/structureDefinition/review-of-systems
ROSLASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/ros-last-modified-by
ROSLASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/ros-last-modified-datetime
ROSSECTIONNOTELASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/ros-section-note-last-modified-by
ROSSECTIONNOTELASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/ros-section-note-last-modified-datetime
ROSSUMMARYTEXThttp://xcaliber-fhir/structureDefinition/ros-summary-text
ROSTEMPLATEShttp://xcaliber-fhir/structureDefinition/ros-templates
ROSSECTIONNOTEhttp://xcaliber-fhir/structureDefinition/ros-section-note
WELLCHILDTEMPLATEDATAhttp://xcaliber-fhir/structureDefinition/well-child-template-data
WELLCHILDROShttp://xcaliber-fhir/structureDefinition/well-child-ros
WELLCHILDLASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/well-child-last-modified-by
WELLCHILDLASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/well-child-last-modified-datetime
WELLCHILDSECTIONNOTELASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/well-child-section-note-last-modified-by
WELLCHILDSECTIONNOTELASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/well-child-section-note-last-modified-datetime
WELLCHILDSUMMARYTEXThttp://xcaliber-fhir/structureDefinition/well-child-summary-text
WELLCHILDTEMPLATEShttp://xcaliber-fhir/structureDefinition/well-child-templates
WELLCHILDSECTIONNOTEhttp://xcaliber-fhir/structureDefinition/well-child-section-note
ROSREPORTEDBYhttp://xcaliber-fhir/structureDefinition/ros-reported-by
WELLCHILDREPORTEDBYhttp://xcaliber-fhir/structureDefinition/well-child-reported-by
PROCEDUREDOCUMENTATIONLASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/procedure-documentation-last-modified-datetime
PROCEDUREDOCUMENTATIONLASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/procedure-documentation-last-modified-by
PROCEDUREDOCUMENTATIONTEXThttp://xcaliber-fhir/structureDefinition/procedure-documentation-text
PROCEDUREDOCUMENTATIONTEMPLATENAMEhttp://xcaliber-fhir/structureDefinition/procedure-documentation-template-name
PROCEDUREDOCUMENTATIONOUTCOMELASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/procedure-documentation-outcome-last-modified-by
PROCEDUREDOCUMENTATIONOUTCOMELASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/procedure-documentation-outcome-last-modified-datetime
PROCEDUREDOCUMENTATIONOUTCOMENOTEhttp://xcaliber-fhir/structureDefinition/procedure-documentation-outcome-note
PROCEDUREDOCUMENTATIONOUTCOMERESULThttp://xcaliber-fhir/structureDefinition/procedure-documentation-outcome-result
PROCEDUREDOCUMENTATIONCOMPLICATIONShttp://xcaliber-fhir/structureDefinition/procedure-documentation-complications
PROCEDUREDOCUMENTATIONCOMPLICATIONhttp://xcaliber-fhir/structureDefinition/procedure-documentation-complication
PROCEDUREDOCUMENTATIONCOMPLICATIONGRADEhttp://xcaliber-fhir/structureDefinition/procedure-documentation-complication-grade
PROCEDUREDOCUMENTATIONCOMPLICATIONLASTMODIFIEDBYhttp://xcaliber-fhir/structureDefinition/procedure-documentation-complication-last-modified-by
PROCEDUREDOCUMENTATIONCOMPLICATIONLASTMODIFIEDDATETIMEhttp://xcaliber-fhir/structureDefinition/procedure-documentation-complication-last-modified-datetime
PROCEDUREDOCUMENTATIONhttp://xcaliber-fhir/structureDefinition/procedure-documentation

Operations & APIs

Encounter-GET

Encounter-POST

Encounter ID-GET

Encounter ID-PUT

Encounter ID-DELETE

Encounter Export-POST