No edit summary |
No edit summary |
||
Line 3: | Line 3: | ||
== Message Types == | == Message Types == | ||
{| class="wikitable" | {| class="wikitable" | ||
!Publisher use | |||
!Message Type | |||
!Message Name | |||
! rowspan="11" | | |||
!Publisher use | !Publisher use | ||
!Message Type | !Message Type | ||
Line 10: | Line 14: | ||
|ADT^A01 | |ADT^A01 | ||
|Admit / visit notification | |Admit / visit notification | ||
|Barts Health | |||
|ADT^A13 | |||
|Cancel discharge/end visit | |||
|- | |- | ||
|Barts Health | |Barts Health | ||
|ADT^A02 | |ADT^A02 | ||
|Transfer a patient | |Transfer a patient | ||
| | |||
|ADT^A14 | |||
|Pending admit | |||
|- | |- | ||
|Barts Health | |Barts Health | ||
|ADT^A03 | |ADT^A03 | ||
|Discharge/end visit | |Discharge/end visit | ||
| | |||
|ADT^A17 | |||
|Swap patients | |||
|- | |- | ||
|Barts Health | |Barts Health | ||
|ADT^A04 | |ADT^A04 | ||
|Register a patient | |Register a patient | ||
|Barts Health | |||
|ADT^A23 | |||
|Delete a patient record | |||
|- | |- | ||
| | | | ||
|ADT^A05 | |ADT^A05 | ||
|Pre-admit a patient | |Pre-admit a patient | ||
| | |||
|ADT^A27 | |||
|Cancel pending admit | |||
|- | |- | ||
| | | | ||
|ADT^A06 | |ADT^A06 | ||
|Change an outpatient to an inpatient | |Change an outpatient to an inpatient | ||
|Barts Health | |||
|ADT^A28 | |||
|Add person information | |||
|- | |- | ||
| | | | ||
|ADT^A07 | |ADT^A07 | ||
|Change an inpatient to an outpatient | |Change an inpatient to an outpatient | ||
|Barts Health | |||
|ADT^A31 | |||
|Update person information | |||
|- | |- | ||
|Barts Health | |Barts Health | ||
|ADT^A08 | |ADT^A08 | ||
|Update patient information | |Update patient information | ||
|Barts Health | |||
|ADT^A34 | |||
|Merge patient information - patient ID only | |||
|- | |- | ||
|Barts Health | |Barts Health | ||
|ADT^A11 | |ADT^A11 | ||
|Cancel admit/visit notification | |Cancel admit/visit notification | ||
|Barts Health | |||
|ADT^A35 | |||
|Merge patient information - account number only | |||
|- | |- | ||
|Barts Health | |Barts Health | ||
|ADT^A12 | |ADT^A12 | ||
|Cancel transfer | |Cancel transfer | ||
|Barts Health | |Barts Health | ||
|ADT^A44 | |ADT^A44 |
Revision as of 11:49, 10 May 2021
The Discovery Data Service (DDS) takes HL7 ADT messages from a number of suppliers, transforms the data into FHIR, and makes this available for subscriber use. This page explains the HL7 ADT message types, structure, transform process, and the ADT -> FHIR -> Compass2 mappings.
Message Types
Publisher use | Message Type | Message Name | Publisher use | Message Type | Message Name | |
---|---|---|---|---|---|---|
Barts Health | ADT^A01 | Admit / visit notification | Barts Health | ADT^A13 | Cancel discharge/end visit | |
Barts Health | ADT^A02 | Transfer a patient | ADT^A14 | Pending admit | ||
Barts Health | ADT^A03 | Discharge/end visit | ADT^A17 | Swap patients | ||
Barts Health | ADT^A04 | Register a patient | Barts Health | ADT^A23 | Delete a patient record | |
ADT^A05 | Pre-admit a patient | ADT^A27 | Cancel pending admit | |||
ADT^A06 | Change an outpatient to an inpatient | Barts Health | ADT^A28 | Add person information | ||
ADT^A07 | Change an inpatient to an outpatient | Barts Health | ADT^A31 | Update person information | ||
Barts Health | ADT^A08 | Update patient information | Barts Health | ADT^A34 | Merge patient information - patient ID only | |
Barts Health | ADT^A11 | Cancel admit/visit notification | Barts Health | ADT^A35 | Merge patient information - account number only | |
Barts Health | ADT^A12 | Cancel transfer | Barts Health | ADT^A44 | Move account information - patient account number |
Message Structures
The messages types are grouped by their structure for transformation to FHIR, since this avoids a large amount of code repetition.
When saving FHIR to the Discovery store there are variations in handling of message types within the message structure groups.
The structures are as follows:
Structure A – Patient level messages
Applies to:
|
Segments used:
|
Structure B – Person level messages (without encounter information)
Applies to:
|
Standard segments:
|
Structure C – Merge patient information
Applies to:
|
Standard segments:
|
Structure D – Merge account number
Applies to:
|
Standard segments:
|
Transformation
The diagram below shows a simplified view of the HL7 to FHIR transform with the source HL7 segments on the left and target FHIR resources on the right.
The following sections show each transformation in detail, including field mappings.
MSH - Message Header Segment
Publisher use | Field# | FieldName | FHIR Mapping | Extension | Compass Schema Table | Field |
---|---|---|---|---|---|---|
Barts Health | MSH.3 | Sending application | MessageHeader.source.software | |||
Barts Health | MSH.4 | Sending facility | MessageHeader.source.name | |||
Barts Health | MSH.5 | Receiving application | MessageHeader.destination.extension | message-header-destination-software-extension | ||
Barts Health | MSH.6 | Receiving facility | MessageHeader.destination.name & MessageHeader.responsible | |||
Barts Health | MSH.7 | Message date/time | MessageHeader.timestamp | |||
Barts Health | MSH.9 | Message type | MessageHeader.event.code | |||
Barts Health | MSH.10 | Message control id | MessageHeader.extension | message-header-message-control-id-extension | ||
Barts Health | MSH.12 | Version ID | MessageHeader.event.version | |||
MSH.13 | Sequence number | MessageHeader.extension | message-header-sequence-number-extension |
Patient Identification (PID) & Patient Additional Demographic (PD1) Segments
Publisher use | Field# | FieldName | FHIR Mapping | Extension | Compass Schema Table | Field |
---|---|---|---|---|---|---|
Barts Health | PID.2 | Patient ID | Patient.identifier | |||
Barts Health | PID.3 | Patient Identifier List | Patient.identifier | |||
Barts Health | - PID.3.1 | ID | Patient.identifier.value | |||
Barts Health | - PID.3.4 | Assigning authority | Patient.identifier.system | |||
PID.4 | Alternate PatientIidentifier | Patient.identifier | ||||
Barts Health | PID.5 | Patient Name | Patient.name | |||
Barts Health | - PID.5.1 | Family Name | Patient.name.family | |||
Barts Health | - PID.5.2 | Given Name | Patient.name.given | |||
Barts Health | - PID.5.3 | Middle Name | Patient.name.given | |||
Barts Health | - PID.5.5 | Prefix | Patient.name.prefix | |||
Barts Health | - PID.5.7 | Name Type Code | Patient.name.use | |||
Barts Health | PID.7 | Date/Time Of Birth | Patient.birthDate & Patient.extension | primarycare-contact-birth-time-extension | ||
Barts Health | PID.8 | Sex | Patient.gender | |||
Barts Health | PID.9 | Patient Alias | Patient.name | |||
Barts Health | PID.11 | Patient Address | Patient.address | |||
Barts Health | - PID.11.1 | Street Address | Patient.address.line | |||
Barts Health | - PID.11.2 | Other Designation | Patient.address.line | |||
Barts Health | - PID.11.3 | City | Patient.address.city | |||
Barts Health | - PID.11.5 | Zip Or Postal Code | Patient.address.postalCode | |||
Barts Health | - PID.11.7 | Address Type | Patient.address.use | |||
Barts Health | - PID.11.8 | Other Geographic Designation | Patient.address.line | |||
Barts Health | - PID.11.9 | County/Parish Code | Patient.address.district | |||
Barts Health | PID.13 | Phone Number - Home | Patient.telecom | |||
Barts Health | - PID.13.1 | Patient Number | Patient.telecom.value | |||
Barts Health | - PID.13.2 | Telecommunication Use Code | Patient.telecom.use | |||
Barts Health | PID.14 | Phone Number - Business | Patient.telecom | |||
Barts Health | - PID.14.1 | Patient Number | Patient.telecom.value | |||
Barts Health | - PID.14.2 | Telecommunication Use Code | Patient.telecom.use | |||
Barts Health | PID.15 | Primary Language | Patient.communication.language | |||
Barts Health | PID.16 | Marital Status | Patient.maritalStatus | |||
Barts Health | PID.17 | Religion | Patient.extension | primarycare-religion-category-extension | ||
Barts Health | PID.18 | Patient Account Number | Patient.identifier | |||
Barts Health | PID.22 | Ethnic Group | Patient.extension | primarycare-ethnic-category-extension | ||
Barts Health | PID.29 | Patient Death Date and Time | Patient.deceased | |||
Barts Health | PID.30 | Patient Death Indicator | Patient.deceased |
Publisher use | Field# | FieldName | FHIR Mapping | Extension | Compass Schema Table | Field |
---|---|---|---|---|---|---|
Barts Health | PD1.3 | Patient primary facility | Patient.careProvider& Organization | |||
Barts Health | - PD1.3.3 | ID number | Organization.identifier.value | |||
Barts Health | PD1.4 | Patient primary care provider | Patient.careProvider& Practitioner | |||
Barts Health | - PD1.4.1 | ID number | Practitioner.identifier.value | |||
Barts Health | - PD1.4.2 | Family name | Practitioner.name.family | |||
Barts Health | - PD1.4.3 | Given name | Practitioner.name.given | |||
Barts Health | - PD1.4.9 | Assigning authority | Practitioner.identifier.system |
Segment - NK1 - Next of Kin / Associated Parties
Field# | FieldName | FHIR Mapping | Extension |
---|---|---|---|
NK1.2 | Name | Patient.contact.name | |
NK1.3 | Relationship | Patient.contact.relationship | |
NK1.4 | Address | Patient.contact.address | |
NK1.5 | Phone number | Patient.contact.telecom.value | |
NK1.6 | Business phone number | Patient.contact.telecom.value | |
NK1.7 | Contact role | Patient.contact.extension | primarycare-contact-role-category-extension |
NK1.20 | Primary language | Patient.contact.extension | primarycare-contact-main-language-category-extension |
Segment - PV1 - Patient Visit
Field# | FieldName | FHIR Mapping | Extension |
---|---|---|---|
PV1.2 | Patient class | Encounter.class | |
PV1.4 | Admission type | Encounter.extension | encounter-admission-type |
PV1.6 | Prior patient location | Encounter.location& Location | |
PV1.7 | Attending doctor | Encounter.participant & Practitioner | |
PV1.8 | Referring doctor | Encounter.participant & Practitioner | |
PV1.9 | Consulting doctor | Encounter.participant& Practitioner | |
PV1.10 | Hospital service | Encounter.serviceProvider& Organization | |
PV1.14 | Admit source | Encounter.hospitalization.origin | |
PV1.17 | Admitting doctor | Encounter.participant & Practitioner | |
PV1.18 | Patient type | Encounter.type | |
PV1.19 | Visit number | EpisodeOfCare.identifier | |
PV1.36 | Discharge disposition | Encounter.hospitalization.dischargeDisposition | |
PV1.37 | Discharged to location | Encounter.hospitalization.destination | |
PV1.39 | Servicing facility | Encounter.managingOrganization | |
PV1.41 | Account status | Encounter.status | |
PV1.44 | Admit date/time | Encounter.statusHistory.start | |
PV1.45 | Discharge date/time | Encounter.statusHistory.end | |
PV1.50 | Alternate visit ID | Encounter.identifier | |
PV1.52 | Other healthcare provider | Encounter.participant& Practitioner |
Segment - PV2 - Patient Visit - Additional Information
Field# | FieldName | FHIR Mapping | Extension |
---|---|---|---|
PV2.3 | Admit reason | Encounter.reason | |
PV2.4 | Transfer reason | Encounter.reason | |
PV2.8 | Expected admit date/time | Encounter.statusHistory.start |
Segment - EVN - Event Type
Field# | FieldName | FHIR Mapping | Extension |
---|---|---|---|
EVN.2 | Recorded date/time | Encounter.extension | primarycare-recorded-date-extension |
EVN.5 | Operator ID | MessageHeader.enterer & Practitioner.identifier & Practitioner.name |