xCaliber healthCare Data Mesh

Encounter

Source Object: Encounter

Overview and Usage: The "Encounter" source object in athena EHR is a pivotal component for recording detailed information related to patient encounters. It encapsulates various aspects of encounters, including encounter details, diagnosis information, provider information, and status updates. Here's an overview of key fields and their usage:

  • Appointment ID: "appointmentid" indicates the ID of the associated appointment, if applicable, connecting the encounter to the scheduled appointment.
  • Department ID: "departmentid" specifies the department or clinic where the encounter took place, providing context for the encounter's location.
  • Encounter Date: "encounterdate" records the date when the encounter occurred, offering a chronological reference.
  • Encounter ID: "encounterid" is a unique identifier for the encounter, ensuring individual encounter records can be distinguished.
  • Encounter Type: "encountertype" describes the type of encounter, which can vary based on the purpose or nature of the visit (e.g., routine checkup, urgent care, specialist consultation).
  • Encounter Visit Name: "encountervisitname" may provide a descriptive name or title for the encounter, enhancing recognition and categorization.
  • Patient Location ID: "patientlocationid" designates the location within the healthcare facility where the patient was seen during the encounter, aiding in tracking patient movement.
  • Patient Status ID: "patientstatusid" represents the patient's status during the encounter (e.g., inpatient, outpatient, emergency), enabling the differentiation of encounter types.
  • Provider ID: "providerid" identifies the healthcare provider or clinician responsible for the encounter, connecting the encounter to the provider's profile.
  • Stage: "stage" and "status" fields can be used to record the stage and status of the encounter, providing insights into the progress and completion of the encounter.
  • Closed Date: "closeddate" records the date when the encounter was closed or marked as completed.
  • Closed User: "closeduser" specifies the user or entity responsible for closing the encounter, allowing tracking of closure actions.
  • Last Reopened: "lastreopened" documents the date when the encounter was last reopened or modified after closure.
  • Last Updated: "lastupdated" records the date and time of the last update to the encounter record.
  • Provider First Name: "providerfirstname," "providerlastname," and "providerphone" contain information about the provider's first name, last name, and contact phone number.
  • Diagnoses: The "diagnoses" section includes multiple sub-fields for recording diagnosis-related information, such as description, diagnosis ID, ICD codes, SNOMED code, and additional notes.
  • Reviewed and Signed By: "reviewedandsignedby" indicates the user or entity who reviewed and signed the encounter record.
  • Reviewed and Signed Date: "reviewedandsigneddate" records the date when the encounter record was reviewed and signed off.

The "Encounter" source object serves as a comprehensive repository for encounter-related information, facilitating accurate patient tracking, documentation of healthcare services, and communication among healthcare providers. Developers can leverage this source object to enhance encounter management within athena EHR, streamline workflows, and support clinical decision-making.

Mapping Table

Data FieldExample ValueSource Data Field DescriptionSource Field Data TypeSource Data Field CardinalityMapped FHIR++ ResourceMapped FHIR Data FieldAugmented MappingAssociated Coding SystemAssociated FHIR Data Field ExtensionMapping Context
appointmentid-athena appointment ID resulting in this encounter.Integer0..1Encounterappointment.reference---Top Level
departmentid-The athena department ID of this encounter.Integer1..1Encounterlocation[*].location.reference---Top Level
encounterdate-Date when this encounter occured.String0..1Encounterperiod.start---Top Level
encounterid-athena ID for this encounter.Integer0..1Encounterid---Top Level
encountertype-Type of encounter (FLOWSHEET, ORDERSONLY, VISIT, etc.). By default only VISIT and ORDERSONLY are shown, use INCLUDEALLtypeS flag to see others.String0..1Encountertype.coding[1].code---Top Level
encountervisitname-The visit name for this encounter.String0..1Encounterextension[*].valueString--encounter-visit-nameTop Level
patientlocationid-athena ID for the patient location.Integer0..1Encounterextension[*].valueString--patient-location-idTop Level
patientstatusid-athena ID for the patient status.Integer0..1Encounterextension[*].valueId--patient-status-idTop Level
providerid-The ID of the provider for this encounter.Integer0..1Encounterparticipant[1].individual.reference---Top Level
stage-Last stage of the encounter.String0..1Encounterextension[*].valueString--stageTop Level
status-Status of this encounter (CLOSED, OPEN, PEND). By default only OPEN, CLOSED, and REVIEW statuses are shown, use INCLUDEALLSTATUSES flag to see others.String0..1Encounterstatus---Top Level
closeddate-date when this encounter was closed.String0..1Encounterperiod.end---Top Level
closeduser-Username of the provider who closed this encounter.String0..1Encounterextension[*].valueString--closed-userTop Level
lastreopened-The date the encounter was last reopened. The field will not be present if the encounter has not be closed.String0..1Encounterextension[*].valueString--last-reopenedTop Level
lastupdated-The date the encounter was last updated.String0..1Encounterextension[*].valueString--last-updatedTop Level
patientlocation-Patient location.String0..1Encounterlocation[*].location.display---Top Level
patientstatus-Patient status.String0..1Encounterextension[*].valueString--patient-statusTop Level
providerfirstname-First name of the provider for this encounter.String0..1Practitionername[*].given[1]use=official--Contained
providerlastname-Last name of the provider for this encounter.String0..1Practitionername[*].family---Contained
providerphone-Phone number of the provider for this encounter.String0..1Practitionertelecom[*].valuesystem=phone, use=work--Contained
diagnoses-List of diagnoses for this encounter.Object0..*Encounterdiagnosis---Top Level
diagnoses.description-Brief description for this SNOMED Code.String0..1Encounterdiagnosis.extension[*].valueString--diagnosis-descriptionTop Level
diagnoses.diagnosisid-athena ID for this diagnosis.Integer0..1Encounterdiagnosis.extension[*].valueInteger--diagnosis-idTop Level
diagnoses.icdcodes-List of relevant ICD codes for this diagnosis.Object0..*Encounter----Top Level
diagnoses.icdcodes.code-Actual ICD code for this diagnosis.String0..1Encounterdiagnosis.use.code.coding[1].code-ICD10,ICD9-Top Level
diagnoses.icdcodes.codeset-Codeset for this code (ICD9 or ICD10).String0..1Encounterdiagnosis.use.code.coding[1].system---Top Level
diagnoses.icdcodes.description-Brief description for this code.String0..1Encounterdiagnosis.use.code.coding[1].display---Top Level
diagnoses.note-The note entered for this diagnosis.String0..1Encounterdiagnosis.extension[*].valueString--diagnosis-noteTop Level
diagnoses.snomedcode-SNOMED Code for this diagnosis.Integer0..1Encounterdiagnosis.extension[*].valueInteger-Snomedsnomed-codeTop Level
reviewedandsignedby-Username of provider who reviewed amd signed the encounter.String0..1Encounterextension[*].valueInteger--reviewed-signed-byTop Level
reviewedandsigneddate-Date and time of when encounter was reviewed and signed off.String0..1Encounterextension[*].valueInteger--reviewd-signed-dateTop Level
appointmentid-athena appointment ID resulting in this encounter.Integer0..1DocumentReferencecontext.related.referenceAppointment--Top Level
closeddate-date when this encounter was closed.String0..1DocumentReferencecontext.period.end---Top Level
closeduser-Username of the provider who closed this encounter.String0..1DocumentReferenceauthor[0].display---Top Level
departmentid-The athena department ID of this encounter.Integer0..1DocumentReferenceextension[*].valueInteger--department-idTop Level
diagnoses-List of diagnoses for this encounter.Object0..*Conditioncontained[*]---Contained
diagnoses.description-Brief description for this SNOMED Code.String0..1Conditioncontained[*].code.text---Contained
diagnoses.diagnosisid-athena ID for this diagnosis.Integer0..1Conditioncontained[*].id---Contained
diagnoses.icdcodes-List of relevant ICD codes for this diagnosis.Object0..*Conditioncontained[*].code.coding---Contained
diagnoses.icdcodes.code-Actual ICD code for this diagnosis.String0..1Conditioncontained[*].code.coding[1].code-ICD10,ICD9-Contained
diagnoses.icdcodes.codeset-Codeset for this code (ICD9 or ICD10).String0..1Conditioncontained[*].code.coding[1].system---Contained
diagnoses.icdcodes.description-Brief description for this code.String0..1Conditioncontained[*].code.coding[1].display---Contained
diagnoses.note-The note entered for this diagnosis.String0..1Conditioncontained[*].note---Contained
diagnoses.snomedcode-SNOMED Code for this diagnosis.Integer0..1Conditioncontained[*].code.coding[2].code-Snomed-Contained
encounterdate-Date when this encounter occured.String0..1DocumentReferencecontext.period.start---Top Level
encounterid-athena ID for this encounter.Integer0..1DocumentReferenceid---Top Level
encountertype-Type of encounter (FLOWSHEET, ORDERSONLY, VISIT, etc.). By default only VISIT and ORDERSONLY are shown, use INCLUDEALLtypeS flag to see others.String0..1DocumentReferenceextensions[*].valueString--encounter-typeTop Level
encountervisitname-The visit name for this encounter.String0..1DocumentReferenceextensions[*].valueString--encounter-visit-nameTop Level
lastreopened-The date the encounter was last reopened. The field will not be present if the encounter has not be closed.String0..1DocumentReferenceextensions[*].valueString--last-reopenedTop Level
lastupdated-The date the encounter was last updated.String0..1DocumentReferenceextensions[*].valueString--last-modified-dateTop Level
patientlocation-Patient location.String0..1DocumentReferencecontext[*].related.displayLocation--Top Level
patientlocationid-athena ID for the patient location.Integer0..1DocumentReferencecontext.related.referenceLocation--Top Level
patientstatus-Patient status.String0..1DocumentReferencecontext.sourcePatientInfo.extensions[*].valueString--patient-statusTop Level
patientstatusid-athena ID for the patient status.Integer0..1DocumentReferencecontext.sourcePatientInfo.extensions[*].valueInteger--patient-status-idTop Level
providerfirstname-First name of the provider for this encounter.String0..1DocumentReferenceauthor[0].extensions[*].valueString--provider-first-nameTop Level
providerid-The ID of the provider for this encounter.Integer0..1DocumentReferenceauthor.[0].reference---Top Level
providerlastname-Last name of the provider for this encounter.String0..1DocumentReferenceauthor[0].extensions[*].valueString--provider-last-nameTop Level
providerphone-Phone number of the provider for this encounter.String0..1DocumentReferenceauthor[0].extensions[*].valueString--provider-phoneTop Level
stage-Last stage of the encounter.String0..1DocumentReferenceauthor[0].extensions[*].valueString--stageTop Level
status-Status of this encounter (CLOSED, OPEN, PEND). By default only OPEN, CLOSED, and REVIEW statuses are shown, use INCLUDEALLSTATUSES flag to see others.String0..1DocumentReferencedocStatus (actualEncounterResponse?.status?.toLowerCase() === "closed" ? "final" :"preliminary")---Top Level