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 Field | Example Value | Source Data Field Description | Source Field Data Type | Source Data Field Cardinality | Mapped FHIR++ Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapping Context |
---|---|---|---|---|---|---|---|---|---|---|
appointmentid | - | athena appointment ID resulting in this encounter. | Integer | 0..1 | Encounter | appointment.reference | - | - | - | Top Level |
departmentid | - | The athena department ID of this encounter. | Integer | 1..1 | Encounter | location[*].location.reference | - | - | - | Top Level |
encounterdate | - | Date when this encounter occured. | String | 0..1 | Encounter | period.start | - | - | - | Top Level |
encounterid | - | athena ID for this encounter. | Integer | 0..1 | Encounter | id | - | - | - | Top Level |
encountertype | - | Type of encounter (FLOWSHEET, ORDERSONLY, VISIT, etc.). By default only VISIT and ORDERSONLY are shown, use INCLUDEALLtypeS flag to see others. | String | 0..1 | Encounter | type.coding[1].code | - | - | - | Top Level |
encountervisitname | - | The visit name for this encounter. | String | 0..1 | Encounter | extension[*].valueString | - | - | encounter-visit-name | Top Level |
patientlocationid | - | athena ID for the patient location. | Integer | 0..1 | Encounter | extension[*].valueString | - | - | patient-location-id | Top Level |
patientstatusid | - | athena ID for the patient status. | Integer | 0..1 | Encounter | extension[*].valueId | - | - | patient-status-id | Top Level |
providerid | - | The ID of the provider for this encounter. | Integer | 0..1 | Encounter | participant[1].individual.reference | - | - | - | Top Level |
stage | - | Last stage of the encounter. | String | 0..1 | Encounter | extension[*].valueString | - | - | stage | Top 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. | String | 0..1 | Encounter | status | - | - | - | Top Level |
closeddate | - | date when this encounter was closed. | String | 0..1 | Encounter | period.end | - | - | - | Top Level |
closeduser | - | Username of the provider who closed this encounter. | String | 0..1 | Encounter | extension[*].valueString | - | - | closed-user | Top Level |
lastreopened | - | The date the encounter was last reopened. The field will not be present if the encounter has not be closed. | String | 0..1 | Encounter | extension[*].valueString | - | - | last-reopened | Top Level |
lastupdated | - | The date the encounter was last updated. | String | 0..1 | Encounter | extension[*].valueString | - | - | last-updated | Top Level |
patientlocation | - | Patient location. | String | 0..1 | Encounter | location[*].location.display | - | - | - | Top Level |
patientstatus | - | Patient status. | String | 0..1 | Encounter | extension[*].valueString | - | - | patient-status | Top Level |
providerfirstname | - | First name of the provider for this encounter. | String | 0..1 | Practitioner | name[*].given[1] | use=official | - | - | Contained |
providerlastname | - | Last name of the provider for this encounter. | String | 0..1 | Practitioner | name[*].family | - | - | - | Contained |
providerphone | - | Phone number of the provider for this encounter. | String | 0..1 | Practitioner | telecom[*].value | system=phone, use=work | - | - | Contained |
diagnoses | - | List of diagnoses for this encounter. | Object | 0..* | Encounter | diagnosis | - | - | - | Top Level |
diagnoses.description | - | Brief description for this SNOMED Code. | String | 0..1 | Encounter | diagnosis.extension[*].valueString | - | - | diagnosis-description | Top Level |
diagnoses.diagnosisid | - | athena ID for this diagnosis. | Integer | 0..1 | Encounter | diagnosis.extension[*].valueInteger | - | - | diagnosis-id | Top Level |
diagnoses.icdcodes | - | List of relevant ICD codes for this diagnosis. | Object | 0..* | Encounter | - | - | - | - | Top Level |
diagnoses.icdcodes.code | - | Actual ICD code for this diagnosis. | String | 0..1 | Encounter | diagnosis.use.code.coding[1].code | - | ICD10,ICD9 | - | Top Level |
diagnoses.icdcodes.codeset | - | Codeset for this code (ICD9 or ICD10). | String | 0..1 | Encounter | diagnosis.use.code.coding[1].system | - | - | - | Top Level |
diagnoses.icdcodes.description | - | Brief description for this code. | String | 0..1 | Encounter | diagnosis.use.code.coding[1].display | - | - | - | Top Level |
diagnoses.note | - | The note entered for this diagnosis. | String | 0..1 | Encounter | diagnosis.extension[*].valueString | - | - | diagnosis-note | Top Level |
diagnoses.snomedcode | - | SNOMED Code for this diagnosis. | Integer | 0..1 | Encounter | diagnosis.extension[*].valueInteger | - | Snomed | snomed-code | Top Level |
reviewedandsignedby | - | Username of provider who reviewed amd signed the encounter. | String | 0..1 | Encounter | extension[*].valueInteger | - | - | reviewed-signed-by | Top Level |
reviewedandsigneddate | - | Date and time of when encounter was reviewed and signed off. | String | 0..1 | Encounter | extension[*].valueInteger | - | - | reviewd-signed-date | Top Level |
appointmentid | - | athena appointment ID resulting in this encounter. | Integer | 0..1 | DocumentReference | context.related.reference | Appointment | - | - | Top Level |
closeddate | - | date when this encounter was closed. | String | 0..1 | DocumentReference | context.period.end | - | - | - | Top Level |
closeduser | - | Username of the provider who closed this encounter. | String | 0..1 | DocumentReference | author[0].display | - | - | - | Top Level |
departmentid | - | The athena department ID of this encounter. | Integer | 0..1 | DocumentReference | extension[*].valueInteger | - | - | department-id | Top Level |
diagnoses | - | List of diagnoses for this encounter. | Object | 0..* | Condition | contained[*] | - | - | - | Contained |
diagnoses.description | - | Brief description for this SNOMED Code. | String | 0..1 | Condition | contained[*].code.text | - | - | - | Contained |
diagnoses.diagnosisid | - | athena ID for this diagnosis. | Integer | 0..1 | Condition | contained[*].id | - | - | - | Contained |
diagnoses.icdcodes | - | List of relevant ICD codes for this diagnosis. | Object | 0..* | Condition | contained[*].code.coding | - | - | - | Contained |
diagnoses.icdcodes.code | - | Actual ICD code for this diagnosis. | String | 0..1 | Condition | contained[*].code.coding[1].code | - | ICD10,ICD9 | - | Contained |
diagnoses.icdcodes.codeset | - | Codeset for this code (ICD9 or ICD10). | String | 0..1 | Condition | contained[*].code.coding[1].system | - | - | - | Contained |
diagnoses.icdcodes.description | - | Brief description for this code. | String | 0..1 | Condition | contained[*].code.coding[1].display | - | - | - | Contained |
diagnoses.note | - | The note entered for this diagnosis. | String | 0..1 | Condition | contained[*].note | - | - | - | Contained |
diagnoses.snomedcode | - | SNOMED Code for this diagnosis. | Integer | 0..1 | Condition | contained[*].code.coding[2].code | - | Snomed | - | Contained |
encounterdate | - | Date when this encounter occured. | String | 0..1 | DocumentReference | context.period.start | - | - | - | Top Level |
encounterid | - | athena ID for this encounter. | Integer | 0..1 | DocumentReference | id | - | - | - | Top Level |
encountertype | - | Type of encounter (FLOWSHEET, ORDERSONLY, VISIT, etc.). By default only VISIT and ORDERSONLY are shown, use INCLUDEALLtypeS flag to see others. | String | 0..1 | DocumentReference | extensions[*].valueString | - | - | encounter-type | Top Level |
encountervisitname | - | The visit name for this encounter. | String | 0..1 | DocumentReference | extensions[*].valueString | - | - | encounter-visit-name | Top Level |
lastreopened | - | The date the encounter was last reopened. The field will not be present if the encounter has not be closed. | String | 0..1 | DocumentReference | extensions[*].valueString | - | - | last-reopened | Top Level |
lastupdated | - | The date the encounter was last updated. | String | 0..1 | DocumentReference | extensions[*].valueString | - | - | last-modified-date | Top Level |
patientlocation | - | Patient location. | String | 0..1 | DocumentReference | context[*].related.display | Location | - | - | Top Level |
patientlocationid | - | athena ID for the patient location. | Integer | 0..1 | DocumentReference | context.related.reference | Location | - | - | Top Level |
patientstatus | - | Patient status. | String | 0..1 | DocumentReference | context.sourcePatientInfo.extensions[*].valueString | - | - | patient-status | Top Level |
patientstatusid | - | athena ID for the patient status. | Integer | 0..1 | DocumentReference | context.sourcePatientInfo.extensions[*].valueInteger | - | - | patient-status-id | Top Level |
providerfirstname | - | First name of the provider for this encounter. | String | 0..1 | DocumentReference | author[0].extensions[*].valueString | - | - | provider-first-name | Top Level |
providerid | - | The ID of the provider for this encounter. | Integer | 0..1 | DocumentReference | author.[0].reference | - | - | - | Top Level |
providerlastname | - | Last name of the provider for this encounter. | String | 0..1 | DocumentReference | author[0].extensions[*].valueString | - | - | provider-last-name | Top Level |
providerphone | - | Phone number of the provider for this encounter. | String | 0..1 | DocumentReference | author[0].extensions[*].valueString | - | - | provider-phone | Top Level |
stage | - | Last stage of the encounter. | String | 0..1 | DocumentReference | author[0].extensions[*].valueString | - | - | stage | Top 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. | String | 0..1 | DocumentReference | docStatus (actualEncounterResponse?.status?.toLowerCase() === "closed" ? "final" :"preliminary") | - | - | - | Top Level |