HL7 ADT: Difference between revisions
No edit summary |
No edit summary |
||
Line 3: | Line 3: | ||
== Message Types == | == Message Types == | ||
{| class="wikitable" | {| class="wikitable" | ||
!Publisher | !Publisher | ||
!Message Type | !Message Type | ||
!Message Name | !Message Name | ||
! rowspan="11" | | ! rowspan="11" | | ||
|Barts Health | |||
Homerton | |||
|ADT^A13 | |||
|Cancel discharge/end visit | |||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|ADT^A01 | |ADT^A01 | ||
|Admit / visit notification | |Admit / visit notification | ||
| | |Homerton | ||
|ADT^ | |ADT^A14 | ||
| | |Pending admit | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|ADT^A02 | |ADT^A02 | ||
|Transfer a patient | |Transfer a patient | ||
| | |Homerton | ||
|ADT^ | |ADT^A17 | ||
| | |Swap patients | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|ADT^A03 | |ADT^A03 | ||
|Discharge/end visit | |Discharge/end visit | ||
| | |Barts Health | ||
|ADT^ | Homerton | ||
| | |ADT^A23 | ||
|Delete a patient record | |||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|ADT^A04 | |ADT^A04 | ||
|Register a patient | |Register a patient | ||
| | |Homerton | ||
|ADT^ | |ADT^A27 | ||
| | |Cancel pending admit | ||
|- | |- | ||
| | |Homerton | ||
|ADT^A05 | |ADT^A05 | ||
|Pre-admit a patient | |Pre-admit a patient | ||
| | |Barts Health | ||
|ADT^ | Homerton | ||
| | |ADT^A28 | ||
|Add person information | |||
|- | |- | ||
| | |Homerton | ||
|ADT^A06 | |ADT^A06 | ||
|Change an outpatient to an inpatient | |Change an outpatient to an inpatient | ||
|Barts Health | |Barts Health | ||
|ADT^ | Homerton | ||
| | |ADT^A31 | ||
|Update person information | |||
|- | |- | ||
| | |Homerton | ||
|ADT^A07 | |ADT^A07 | ||
|Change an inpatient to an outpatient | |Change an inpatient to an outpatient | ||
|Barts Health | |Barts Health | ||
|ADT^ | Homerton | ||
| | |ADT^A34 | ||
|Merge patient information - patient ID only | |||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|ADT^A08 | |ADT^A08 | ||
|Update patient information | |Update patient information | ||
|Barts Health | |Barts Health | ||
|ADT^ | Homerton | ||
|Merge patient information - | |ADT^A35 | ||
|Merge patient information - account number only | |||
|- | |- | ||
|Barts Health | |Barts Health | ||
Line 71: | Line 82: | ||
|Cancel admit/visit notification | |Cancel admit/visit notification | ||
|Barts Health | |Barts Health | ||
|ADT^ | Homerton | ||
| | |ADT^A44 | ||
|Move account information - patient account number | |||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|ADT^A12 | |ADT^A12 | ||
|Cancel transfer | |Cancel transfer | ||
| | | | ||
| | | | ||
| | | | ||
|} | |} | ||
Line 97: | Line 110: | ||
* ADT^A03 (Discharge/end visit) | * ADT^A03 (Discharge/end visit) | ||
* ADT^A04 (Register a patient) | * ADT^A04 (Register a patient) | ||
*ADT^A05 (Pre-admit a patient) | |||
*ADT^A06 (Change an outpatient to an inpatient) | |||
*ADT^A07 (Change an inpatient to an outpatient) | |||
* ADT^A08 (Update patient information) | * ADT^A08 (Update patient information) | ||
* ADT^A11 (Cancel admit/visit notification) | * ADT^A11 (Cancel admit/visit notification) | ||
* ADT^A12 (Cancel transfer) | * ADT^A12 (Cancel transfer) | ||
* ADT^A13 (Cancel discharge/end visit) | * ADT^A13 (Cancel discharge/end visit) | ||
*ADT^A14 (Pending admit) | |||
* ADT^A23 (Delete a patient record) | * ADT^A23 (Delete a patient record) | ||
| | |Standard segments | ||
* MSH [1..1] Message header | * MSH [1..1] Message header | ||
Line 108: | Line 125: | ||
* PID [1..1] Patient information | * PID [1..1] Patient information | ||
* PD1 [0..1] Additional demographics | * PD1 [0..1] Additional demographics | ||
*NK1 [0..*] Next of kin / associated parties | |||
* PV1 [1..1] Patient visit information | * PV1 [1..1] Patient visit information | ||
* PV2 [0..1] Patient visit additional | * PV2 [0..1] Patient visit additional | ||
*OBX [0..*] Obs (used by Homerton for misc. admin data) | |||
*AL1 [0..*] Allergies | |||
*ACC [0..*] Accident information | |||
*DG1 [0..*] Diagnosis information | |||
*NTE [0..*] Notes and comments | |||
|Cerner custom segments: | |||
* ZAL [0..*] Additional allergy information | |||
* ZQA [0..1] Questionnaire information | |||
* ZPI [0..1] Additional person information | |||
* ZVI [0..1] Additional visit information | |||
|} | |} | ||
Line 124: | Line 153: | ||
* PID [1..1] Patient information | * PID [1..1] Patient information | ||
* PD1 [0..1] Additional demographics | * PD1 [0..1] Additional demographics | ||
*NK1 [0..*] Next of kin / associated parties | |||
*OBX [0..*] Obs (used by Homerton for misc. admin data) | |||
*AL1 [0..*] Allergies | |||
*NTE [0..*] Notes and comments | |||
|Cerner custom segments: | |||
* ZAL [0..*] Additional allergy information | |||
* ZPI [0..1] Additional person information | |||
|} | |||
=== Structure C – Swap patients === | |||
Applicable to Homerton '''only''' | |||
{| class="wikitable" | |||
|Applies to: | |||
*ADT^A17 (Swap patients) | |||
|Standard segments: | |||
* MSH [1..1] Message header | |||
* EVN [1..1] Event information | |||
* PID [1..1] Patient information | |||
*PV1 [1..1] Patient visit information | |||
* PV2 [0..1] Patient visit additional | |||
*OBX [0..*] Obs (used by Homerton for misc. admin data) | |||
|Cerner custom segments: | |||
* ZPI [0..1] Additional person information | |||
* ZVI [0..1] Additional visit information | |||
|} | |} | ||
=== Structure | === Structure D – Merge patient information === | ||
{| class="wikitable" | {| class="wikitable" | ||
|Applies to: | |Applies to: | ||
Line 143: | Line 200: | ||
|} | |} | ||
=== Structure | === Structure E – Merge account number === | ||
{| class="wikitable" | {| class="wikitable" | ||
|Applies to: | |Applies to: | ||
Line 161: | Line 218: | ||
== Transformation == | == 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 diagram below shows a simplified view of the HL7 to FHIR transform for structure A with the source HL7 segments on the left and target FHIR resources on the right. | ||
{| class="wikitable" | |||
|Barts Health | |||
[[File:HL7_ADT_Transformation_Overview.jpg|alt=|frameless|500x500px]] | |||
| | |||
OR | |||
|Homerton | |||
[[File:Transformation Overview Homerton V2.jpg|frameless|500x500px]] | |||
|} | |||
The following sections show each transformation in detail, including field mappings. | The following sections show each transformation in detail, including field mappings. | ||
=== | === Message Header (MSH) & Even Type (EVN) segments === | ||
{| class="wikitable" | |||
|Barts Health | |||
[[File:MSH_Overview.jpg|alt=|frameless|500x500px]] | [[File:MSH_Overview.jpg|alt=|frameless|500x500px]] | ||
| | |||
OR | |||
|Homerton | |||
[[File:MSH EVN Overview.jpg|frameless|500x500px]] | |||
|} | |||
{| class="wikitable" | {| class="wikitable" | ||
|+MSH field mapping | |+MSH field mapping | ||
!Publisher | !Publisher | ||
!Field# | !Field# | ||
!FieldName | !FieldName | ||
Line 180: | Line 254: | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|MSH.3 | |MSH.3 | ||
|Sending application | |Sending application | ||
Line 188: | Line 263: | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|MSH.4 | |MSH.4 | ||
|Sending facility | |Sending facility | ||
Line 196: | Line 272: | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|MSH.5 | |MSH.5 | ||
|Receiving application | |Receiving application | ||
Line 204: | Line 281: | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|MSH.6 | |MSH.6 | ||
|Receiving facility | |Receiving facility | ||
Line 212: | Line 290: | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|MSH.7 | |MSH.7 | ||
|Message date/time | |Message date/time | ||
Line 220: | Line 299: | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|MSH.9 | |MSH.9 | ||
|Message type | |Message type | ||
Line 228: | Line 308: | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|MSH.10 | |MSH.10 | ||
|Message control id | |Message control id | ||
Line 236: | Line 317: | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|MSH.12 | |MSH.12 | ||
|Version ID | |Version ID | ||
Line 243: | Line 325: | ||
| | | | ||
|- | |- | ||
| | |Homerton | ||
|MSH.13 | |MSH.13 | ||
|Sequence number | |Sequence number | ||
Line 251: | Line 333: | ||
| | | | ||
|} | |} | ||
{| class="wikitable" | |||
|+EVN field mapping | |||
!Publisher | |||
!Field# | |||
!FieldName | |||
!FHIR Mapping | |||
!Compass Schema Table | |||
!Field | |||
|- | |||
|Homerton | |||
|EVN.5 | |||
|Operator ID | |||
|MessageHeader.enterer & Practitioner.identifier & Practitioner.name | |||
| | |||
| | |||
|}<br /> | |||
=== Patient Identification (PID), Patient Additional Demographic (PD1), & Next of Kin (NK1) segments === | |||
{| class="wikitable" | |||
|Barts Health | |||
[[File:PID_&_PD1_Segments.jpg|alt=|frameless|500x500px]] | |||
| | |||
[[File: | |||
OR | |||
|Homerton | |||
[[File:PID PD1 NK1 segments.jpg|frameless|500x500px]] | |||
|} | |||
<br /> | |||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
PID field mapping | PID field mapping | ||
!Publisher | !Publisher | ||
!Field# | !Field# | ||
!FieldName | !FieldName | ||
Line 266: | Line 375: | ||
!Field | !Field | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.2 | |PID.2 | ||
|Patient ID | |Patient ID | ||
Line 274: | Line 384: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.3 | |PID.3 | ||
|Patient Identifier List | |Patient Identifier List | ||
Line 282: | Line 393: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
| - PID.3.1 | | - PID.3.1 | ||
|ID | |ID | ||
|Patient.identifier.value | |Patient.identifier.value | ||
Line 290: | Line 401: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
| - PID.3.4 | | - PID.3.4 | ||
|Assigning authority | |Assigning authority | ||
|Patient.identifier.system | |Patient.identifier.system | ||
Line 298: | Line 409: | ||
| | | | ||
|- | |- | ||
| | |Homerton | ||
|PID.4 | |PID.4 | ||
|Alternate PatientIidentifier | |Alternate PatientIidentifier | ||
Line 306: | Line 417: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.5 | |PID.5 | ||
|Patient Name | |Patient Name | ||
Line 314: | Line 426: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
| - PID.5.1 | | - PID.5.1 | ||
|Family Name | |Family Name | ||
|Patient.name.family | |Patient.name.family | ||
Line 322: | Line 434: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
| - PID.5.2 | | - PID.5.2 | ||
|Given Name | |Given Name | ||
|Patient.name.given | |Patient.name.given | ||
Line 330: | Line 442: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
| - PID.5.3 | | - PID.5.3 | ||
|Middle Name | |Middle Name | ||
|Patient.name.given | |Patient.name.given | ||
Line 338: | Line 450: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
| - PID.5.5 | | - PID.5.5 | ||
|Prefix | |Prefix | ||
|Patient.name.prefix | |Patient.name.prefix | ||
Line 346: | Line 458: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
| - PID.5.7 | | - PID.5.7 | ||
|Name Type Code | |Name Type Code | ||
|Patient.name.use | |Patient.name.use | ||
Line 354: | Line 466: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.7 | |PID.7 | ||
|Date/Time Of Birth | |Date/Time Of Birth | ||
Line 362: | Line 475: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.8 | |PID.8 | ||
|Sex | |Sex | ||
Line 370: | Line 484: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.9 | |PID.9 | ||
|Patient Alias | |Patient Alias | ||
Line 378: | Line 493: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.11 | |PID.11 | ||
|Patient Address | |Patient Address | ||
Line 386: | Line 502: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
| - PID.11.1 | | - PID.11.1 | ||
|Street Address | |Street Address | ||
|Patient.address.line | |Patient.address.line | ||
Line 394: | Line 510: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
|<nowiki>- PID.11.2</nowiki> | |<nowiki>- PID.11.2</nowiki> | ||
|Other Designation | |Other Designation | ||
Line 402: | Line 518: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
|<nowiki>- PID.11.3</nowiki> | |<nowiki>- PID.11.3</nowiki> | ||
|City | |City | ||
Line 410: | Line 526: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
|<nowiki>- PID.11.5</nowiki> | |<nowiki>- PID.11.5</nowiki> | ||
|Zip Or Postal Code | |Zip Or Postal Code | ||
Line 418: | Line 534: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
|<nowiki>- PID.11.7</nowiki> | |<nowiki>- PID.11.7</nowiki> | ||
|Address Type | |Address Type | ||
Line 426: | Line 542: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
|<nowiki>- PID.11.8</nowiki> | |<nowiki>- PID.11.8</nowiki> | ||
|Other Geographic Designation | |Other Geographic Designation | ||
Line 434: | Line 550: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
|<nowiki>- PID.11.9</nowiki> | |<nowiki>- PID.11.9</nowiki> | ||
|County/Parish Code | |County/Parish Code | ||
Line 442: | Line 558: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.13 | |PID.13 | ||
|Phone Number - Home | |Phone Number - Home | ||
Line 450: | Line 567: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
|<nowiki>- PID.13.1</nowiki> | |<nowiki>- PID.13.1</nowiki> | ||
|Patient Number | |Patient Number | ||
Line 458: | Line 575: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
|<nowiki>- PID.13.2</nowiki> | |<nowiki>- PID.13.2</nowiki> | ||
|Telecommunication Use Code | |Telecommunication Use Code | ||
Line 466: | Line 583: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.14 | |PID.14 | ||
|Phone Number - Business | |Phone Number - Business | ||
Line 474: | Line 592: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
|<nowiki>- PID.14.1</nowiki> | |<nowiki>- PID.14.1</nowiki> | ||
|Patient Number | |Patient Number | ||
Line 482: | Line 600: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
|<nowiki>- PID.14.2</nowiki> | |<nowiki>- PID.14.2</nowiki> | ||
|Telecommunication Use Code | |Telecommunication Use Code | ||
Line 490: | Line 608: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.15 | |PID.15 | ||
|Primary Language | |Primary Language | ||
Line 498: | Line 617: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.16 | |PID.16 | ||
|Marital Status | |Marital Status | ||
Line 506: | Line 626: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.17 | |PID.17 | ||
|Religion | |Religion | ||
Line 514: | Line 635: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.18 | |PID.18 | ||
|Patient Account Number | |Patient Account Number | ||
Line 522: | Line 644: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.22 | |PID.22 | ||
|Ethnic Group | |Ethnic Group | ||
Line 530: | Line 653: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.29 | |PID.29 | ||
|Patient Death Date and Time | |Patient Death Date and Time | ||
Line 538: | Line 662: | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PID.30 | |PID.30 | ||
|Patient Death Indicator | |Patient Death Indicator | ||
Line 549: | Line 674: | ||
|+ | |+ | ||
PD1 field mapping | PD1 field mapping | ||
!Publisher | !Publisher | ||
!Field# | !Field# | ||
!FieldName | !FieldName | ||
!FHIR Mapping | !FHIR Mapping | ||
!Compass Schema Table | !Compass Schema Table | ||
!Field | !Field | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PD1.3 | |PD1.3 | ||
|Patient primary facility | |Patient primary facility | ||
|Patient.careProvider& Organization | |Patient.careProvider& Organization | ||
| | | | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
| - PD1.3.3 | | - PD1.3.3 | ||
|ID number | |ID number | ||
|Organization.identifier.value | |Organization.identifier.value | ||
| | | | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
Homerton | |||
|PD1.4 | |PD1.4 | ||
|Patient primary care provider | |Patient primary care provider | ||
|Patient.careProvider& Practitioner | |Patient.careProvider& Practitioner | ||
| | | | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
| - PD1.4.1 | | - PD1.4.1 | ||
|ID number | |ID number | ||
|Practitioner.identifier.value | |Practitioner.identifier.value | ||
| | | | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
| - PD1.4.2 | | - PD1.4.2 | ||
|Family name | |Family name | ||
|Practitioner.name.family | |Practitioner.name.family | ||
| | | | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
| - PD1.4.3 | | - PD1.4.3 | ||
|Given name | |Given name | ||
|Practitioner.name.given | |Practitioner.name.given | ||
| | | | ||
| | | | ||
|- | |- | ||
|Barts Health | |Barts Health | ||
| - PD1.4.9 | | - PD1.4.9 | ||
|Assigning authority | |Assigning authority | ||
|Practitioner.identifier.system | |Practitioner.identifier.system | ||
| | | | ||
| | | | ||
|} | |} | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+NK1 field mapping | ||
!Publisher | |||
!Field# | !Field# | ||
!FieldName | !FieldName | ||
!FHIR Mapping | !FHIR Mapping | ||
!Extension | !Extension | ||
!Compass Schema Table | |||
!Field | |||
|- | |- | ||
|Homerton | |||
|NK1.2 | |NK1.2 | ||
|Name | |Name | ||
|Patient.contact.name | |Patient.contact.name | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Homerton | |||
|NK1.3 | |NK1.3 | ||
|Relationship | |Relationship | ||
|Patient.contact.relationship | |Patient.contact.relationship | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Homerton | |||
|NK1.4 | |NK1.4 | ||
|Address | |Address | ||
|Patient.contact.address | |Patient.contact.address | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Homerton | |||
|NK1.5 | |NK1.5 | ||
|Phone number | |Phone number | ||
|Patient.contact.telecom.value | |Patient.contact.telecom.value | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Homerton | |||
|NK1.6 | |NK1.6 | ||
|Business phone number | |Business phone number | ||
|Patient.contact.telecom.value | |Patient.contact.telecom.value | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Homerton | |||
|NK1.7 | |NK1.7 | ||
|Contact role | |Contact role | ||
|Patient.contact.extension | |Patient.contact.extension | ||
|primarycare-contact-role-category-extension | |primarycare-contact-role-category-extension | ||
| | |||
| | |||
|- | |- | ||
|Homerton | |||
|NK1.20 | |NK1.20 | ||
|Primary language | |Primary language | ||
|Patient.contact.extension | |Patient.contact.extension | ||
|primarycare-contact-main-language-category-extension | |primarycare-contact-main-language-category-extension | ||
| | |||
| | |||
|} | |} | ||
== | === Patient Visit (PV1), Patient Visit - additional (PV2), & Event Type (EVN), or Additional Visit Information (ZVI) segments === | ||
{| class="wikitable" | |||
|Barts Health | |||
[[File:PV1 PV2 EVN Segments.jpg|frameless|540x540px]] | |||
| | |||
OR | |||
|Homerton | |||
[[File:PV1 PV2 ZVI segments.jpg|frameless|517x517px]] | |||
|} | |||
Note - Each ADT message containing a PV1 segment (i.e. Structure A messages) results in a new FHIR Encounter resource being created. | |||
The newly created FHIR Encounter is linked to an EpisodeOfCare resource based on the PV1’s Visit Number (this is carried in the Attendance Number field). | |||
If the PV1 Visit Number is new – i.e. has not previously been seen by Discovery – this causes a new EpisodeOfCare resource to be created. | |||
If the PV1 Attendance Number has previously been seen by Discovery, then the Encounter is linked to the existing EpisodeOfCare. | |||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+PV1 field mapping | ||
!Publisher use | |||
!Field# | !Field# | ||
!FieldName | !FieldName | ||
!FHIR Mapping | !FHIR Mapping | ||
!Extension | !Extension | ||
!Compass Schema Table | |||
!Field | |||
|- | |- | ||
|Barts Health | |||
Homerton | |||
|PV1.2 | |PV1.2 | ||
|Patient class | |Patient class | ||
|Encounter.class | |Encounter.class | ||
| | |||
| | |||
| | |||
|- | |||
|Barts Health | |||
|PV1.3 | |||
|Assigned patient location | |||
|Encounter.location | |||
& Location | |||
| | |||
| | |||
| | |||
|- | |||
|Barts Health | |||
| - PV1.3.1 | |||
|Point of Care | |||
|Encounter.location | |||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Barts Health | |||
| - PV1.3.2 | |||
|Room | |||
|Encounter.location | |||
| | |||
| | |||
| | |||
|- | |||
|Barts Health | |||
| - PV1.3.3 | |||
|Bed | |||
|Encounter.location | |||
| | |||
| | |||
| | |||
|- | |||
|Barts Health | |||
| - PV1.3.4 | |||
|Facility | |||
|Encounter.location | |||
Encounter.location | |||
| | |||
| | |||
| | |||
|- | |||
|Barts Health | |||
| - PV1.3.7 | |||
|Building | |||
|Encounter.location | |||
| | |||
| | |||
| | |||
|- | |||
|Homerton | |||
|PV1.4 | |PV1.4 | ||
|Admission type | |Admission type | ||
|Encounter.extension | |Encounter.extension | ||
|encounter-admission-type | |encounter-admission-type | ||
| | |||
| | |||
|- | |- | ||
|Homerton | |||
|PV1.6 | |PV1.6 | ||
|Prior patient location | |Prior patient location | ||
|Encounter.location& Location | |Encounter.location& Location | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Barts Health | |||
Homerton | |||
|PV1.7 | |PV1.7 | ||
|Attending doctor | |Attending doctor | ||
|Encounter.participant & Practitioner | |Encounter.participant & Practitioner | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Barts Health | |||
| - PV1.7.1 | |||
|ID number | |||
|Practitioner.identifier.value | |||
| | |||
| | |||
| | |||
|- | |||
|Barts Health | |||
| - PV1.7.2 | |||
|Family name | |||
|Practitioner.name.family | |||
| | |||
| | |||
| | |||
|- | |||
|Barts Health | |||
| - PV1.7.3 | |||
|Given name | |||
|Practitioner.name.given | |||
| | |||
| | |||
| | |||
|- | |||
|Barts Health | |||
| - PV1.7.9 | |||
|Assigning authority | |||
|Practitioner.identifier.system | |||
| | |||
| | |||
| | |||
|- | |||
|Barts Health | |||
Homerton | |||
|PV1.8 | |PV1.8 | ||
|Referring doctor | |Referring doctor | ||
|Encounter.participant & Practitioner | |Encounter.participant & Practitioner | ||
| | |||
| | |||
| | |||
|- | |||
|Barts Health | |||
| - PV1.8.1 | |||
|ID number | |||
|Practitioner.identifier.value | |||
| | |||
| | |||
| | |||
|- | |||
|Barts Health | |||
| - PV1.8.2 | |||
|Family name | |||
|Practitioner.name.family | |||
| | |||
| | |||
| | |||
|- | |||
|Barts Health | |||
| - PV1.8.3 | |||
|Given name | |||
|Practitioner.name.given | |||
| | |||
| | |||
| | |||
|- | |||
|Barts Health | |||
| - PV1.8.9 | |||
|Assigning authority | |||
|Practitioner.identifier.system | |||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Homerton | |||
|PV1.9 | |PV1.9 | ||
|Consulting doctor | |Consulting doctor | ||
|Encounter.participant& Practitioner | |Encounter.participant& Practitioner | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Barts Health | |||
Homerton | |||
|PV1.10 | |PV1.10 | ||
|Hospital service | |Hospital service | ||
|Encounter.serviceProvider& Organization | |Encounter.serviceProvider& Organization | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Homerton | |||
|PV1.14 | |PV1.14 | ||
|Admit source | |Admit source | ||
|Encounter.hospitalization.origin | |Encounter.hospitalization.origin | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Homerton | |||
|PV1.17 | |PV1.17 | ||
|Admitting doctor | |Admitting doctor | ||
|Encounter.participant & Practitioner | |Encounter.participant & Practitioner | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Barts Health | |||
Homerton | |||
|PV1.18 | |PV1.18 | ||
|Patient type | |Patient type | ||
|Encounter.type | |Encounter.type | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Barts Health | |||
Homerton | |||
|PV1.19 | |PV1.19 | ||
|Visit number | |Visit number | ||
|EpisodeOfCare.identifier | |EpisodeOfCare.identifier | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Barts Health | |||
Homerton | |||
|PV1.36 | |PV1.36 | ||
|Discharge disposition | |Discharge disposition | ||
|Encounter.hospitalization.dischargeDisposition | |Encounter.hospitalization.dischargeDisposition | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Barts Health | |||
Homerton | |||
|PV1.37 | |PV1.37 | ||
|Discharged to location | |Discharged to location | ||
|Encounter.hospitalization.destination | |Encounter.hospitalization.destination | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Homerton | |||
|PV1.39 | |PV1.39 | ||
|Servicing facility | |Servicing facility | ||
|Encounter.managingOrganization | |Encounter.managingOrganization | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Barts Health | |||
Homerton | |||
|PV1.41 | |PV1.41 | ||
|Account status | |Account status | ||
|Encounter.status | |Encounter.status | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Barts Health | |||
Homerton | |||
|PV1.44 | |PV1.44 | ||
|Admit date/time | |Admit date/time | ||
|Encounter.statusHistory.start | |Encounter.statusHistory.start | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Barts Health | |||
Homerton | |||
|PV1.45 | |PV1.45 | ||
|Discharge date/time | |Discharge date/time | ||
|Encounter.statusHistory.end | |Encounter.statusHistory.end | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Homerton | |||
|PV1.50 | |PV1.50 | ||
|Alternate visit ID | |Alternate visit ID | ||
|Encounter.identifier | |Encounter.identifier | ||
| | |||
| | |||
| | | | ||
|- | |- | ||
|Homerton | |||
|PV1.52 | |PV1.52 | ||
|Other healthcare provider | |Other healthcare provider | ||
|Encounter.participant& Practitioner | |Encounter.participant& Practitioner | ||
| | |||
| | |||
| | | | ||
|} | |} | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+PV2 field mapping | ||
!Publisher use | |||
!Field# | !Field# | ||
!FieldName | !FieldName | ||
!FHIR Mapping | !FHIR Mapping | ||
! | !Compass Schema Table | ||
!Field | |||
|- | |- | ||
|Barts Health | |||
Homerton | |||
|PV2.3 | |PV2.3 | ||
|Admit reason | |Admit reason | ||
|Encounter.reason | |Encounter.reason | ||
| | |||
| | | | ||
|- | |- | ||
|Homerton | |||
|PV2.4 | |PV2.4 | ||
|Transfer reason | |Transfer reason | ||
|Encounter.reason | |Encounter.reason | ||
| | |||
| | | | ||
|- | |- | ||
|Barts Health | |||
Homerton | |||
|PV2.8 | |PV2.8 | ||
|Expected admit date/time | |Expected admit date/time | ||
|Encounter.statusHistory.start | |Encounter.statusHistory.start | ||
| | |||
| | |||
|- | |||
|Homerton | |||
|PV2.9 | |||
|Expected discharge date/time | |||
|Encounter.statusHistory.end | |||
| | |||
| | | | ||
|} | |} | ||
{| class="wikitable" | {| class="wikitable" | ||
|+EVN field mapping | |||
!Publisher use | |||
!Field# | !Field# | ||
!FieldName | !FieldName | ||
!FHIR Mapping | !FHIR Mapping | ||
!Extension | !Extension | ||
!Compass Schema Table | |||
!Field | |||
|- | |- | ||
|Barts Health | |||
|EVN.2 | |EVN.2 | ||
|Recorded date/time | |Recorded date/time | ||
|Encounter.extension | |Encounter.extension | ||
|primarycare-recorded-date-extension | |primarycare-recorded-date-extension | ||
| | |||
| | |||
|- | |- | ||
| | |||
|EVN.5 | |EVN.5 | ||
|Operator ID | |Operator ID | ||
|MessageHeader.enterer & Practitioner.identifier & Practitioner.name | |MessageHeader.enterer & Practitioner.identifier & Practitioner.name | ||
| | | | ||
|} | | | ||
| | |||
|} | |||
{| class="wikitable" | |||
|+ZVI field mapping | |||
!Publisher use | |||
!Field# | |||
!FieldName | |||
!FHIR Mapping | |||
!Compass Schema Table | |||
!Field | |||
|- | |||
|Homerton | |||
|ZVI.9 | |||
|Admit mode | |||
|Encounter.hospitalization.admitSource | |||
| | |||
| | |||
|- | |||
|Homerton | |||
|ZVI.15 | |||
|Assign to location date/time | |||
|Encounter.location.period | |||
| | |||
| | |||
|} |
Revision as of 12:42, 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 | Message Type | Message Name | Barts Health
Homerton |
ADT^A13 | Cancel discharge/end visit | |
---|---|---|---|---|---|---|
Barts Health
Homerton |
ADT^A01 | Admit / visit notification | Homerton | ADT^A14 | Pending admit | |
Barts Health
Homerton |
ADT^A02 | Transfer a patient | Homerton | ADT^A17 | Swap patients | |
Barts Health
Homerton |
ADT^A03 | Discharge/end visit | Barts Health
Homerton |
ADT^A23 | Delete a patient record | |
Barts Health
Homerton |
ADT^A04 | Register a patient | Homerton | ADT^A27 | Cancel pending admit | |
Homerton | ADT^A05 | Pre-admit a patient | Barts Health
Homerton |
ADT^A28 | Add person information | |
Homerton | ADT^A06 | Change an outpatient to an inpatient | Barts Health
Homerton |
ADT^A31 | Update person information | |
Homerton | ADT^A07 | Change an inpatient to an outpatient | Barts Health
Homerton |
ADT^A34 | Merge patient information - patient ID only | |
Barts Health
Homerton |
ADT^A08 | Update patient information | Barts Health
Homerton |
ADT^A35 | Merge patient information - account number only | |
Barts Health | ADT^A11 | Cancel admit/visit notification | Barts Health
Homerton |
ADT^A44 | Move account information - patient account number | |
Barts Health
Homerton |
ADT^A12 | Cancel transfer |
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:
|
Standard segments
|
Cerner custom segments:
|
Structure B – Person level messages (without encounter information)
Applies to:
|
Standard segments:
|
Cerner custom segments:
|
Structure C – Swap patients
Applicable to Homerton only
Applies to:
|
Standard segments:
|
Cerner custom segments:
|
Structure D – Merge patient information
Applies to:
|
Standard segments:
|
Structure E – Merge account number
Applies to:
|
Standard segments:
|
Transformation
The diagram below shows a simplified view of the HL7 to FHIR transform for structure A with the source HL7 segments on the left and target FHIR resources on the right.
Barts Health |
OR |
Homerton |
The following sections show each transformation in detail, including field mappings.
Message Header (MSH) & Even Type (EVN) segments
Barts Health |
OR |
Homerton |
Publisher | Field# | FieldName | FHIR Mapping | Extension | Compass Schema Table | Field |
---|---|---|---|---|---|---|
Barts Health
Homerton |
MSH.3 | Sending application | MessageHeader.source.software | |||
Barts Health
Homerton |
MSH.4 | Sending facility | MessageHeader.source.name | |||
Barts Health
Homerton |
MSH.5 | Receiving application | MessageHeader.destination.extension | message-header-destination-software-extension | ||
Barts Health
Homerton |
MSH.6 | Receiving facility | MessageHeader.destination.name & MessageHeader.responsible | |||
Barts Health
Homerton |
MSH.7 | Message date/time | MessageHeader.timestamp | |||
Barts Health
Homerton |
MSH.9 | Message type | MessageHeader.event.code | |||
Barts Health
Homerton |
MSH.10 | Message control id | MessageHeader.extension | message-header-message-control-id-extension | ||
Barts Health
Homerton |
MSH.12 | Version ID | MessageHeader.event.version | |||
Homerton | MSH.13 | Sequence number | MessageHeader.extension | message-header-sequence-number-extension |
Publisher | Field# | FieldName | FHIR Mapping | Compass Schema Table | Field |
---|---|---|---|---|---|
Homerton | EVN.5 | Operator ID | MessageHeader.enterer & Practitioner.identifier & Practitioner.name |
Patient Identification (PID), Patient Additional Demographic (PD1), & Next of Kin (NK1) segments
Barts Health |
|
Homerton |
Publisher | Field# | FieldName | FHIR Mapping | Extension | Compass Schema Table | Field |
---|---|---|---|---|---|---|
Barts Health
Homerton |
PID.2 | Patient ID | Patient.identifier | |||
Barts Health
Homerton |
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 | |||
Homerton | PID.4 | Alternate PatientIidentifier | Patient.identifier | |||
Barts Health
Homerton |
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
Homerton |
PID.7 | Date/Time Of Birth | Patient.birthDate & Patient.extension | primarycare-contact-birth-time-extension | ||
Barts Health
Homerton |
PID.8 | Sex | Patient.gender | |||
Barts Health
Homerton |
PID.9 | Patient Alias | Patient.name | |||
Barts Health
Homerton |
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
Homerton |
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
Homerton |
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
Homerton |
PID.15 | Primary Language | Patient.communication.language | |||
Barts Health
Homerton |
PID.16 | Marital Status | Patient.maritalStatus | |||
Barts Health
Homerton |
PID.17 | Religion | Patient.extension | primarycare-religion-category-extension | ||
Barts Health
Homerton |
PID.18 | Patient Account Number | Patient.identifier | |||
Barts Health
Homerton |
PID.22 | Ethnic Group | Patient.extension | primarycare-ethnic-category-extension | ||
Barts Health
Homerton |
PID.29 | Patient Death Date and Time | Patient.deceased | |||
Barts Health
Homerton |
PID.30 | Patient Death Indicator | Patient.deceased |
Publisher | Field# | FieldName | FHIR Mapping | Compass Schema Table | Field |
---|---|---|---|---|---|
Barts Health
Homerton |
PD1.3 | Patient primary facility | Patient.careProvider& Organization | ||
Barts Health | - PD1.3.3 | ID number | Organization.identifier.value | ||
Barts Health
Homerton |
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 |
Publisher | Field# | FieldName | FHIR Mapping | Extension | Compass Schema Table | Field |
---|---|---|---|---|---|---|
Homerton | NK1.2 | Name | Patient.contact.name | |||
Homerton | NK1.3 | Relationship | Patient.contact.relationship | |||
Homerton | NK1.4 | Address | Patient.contact.address | |||
Homerton | NK1.5 | Phone number | Patient.contact.telecom.value | |||
Homerton | NK1.6 | Business phone number | Patient.contact.telecom.value | |||
Homerton | NK1.7 | Contact role | Patient.contact.extension | primarycare-contact-role-category-extension | ||
Homerton | NK1.20 | Primary language | Patient.contact.extension | primarycare-contact-main-language-category-extension |
Patient Visit (PV1), Patient Visit - additional (PV2), & Event Type (EVN), or Additional Visit Information (ZVI) segments
Barts Health |
|
Homerton |
Note - Each ADT message containing a PV1 segment (i.e. Structure A messages) results in a new FHIR Encounter resource being created.
The newly created FHIR Encounter is linked to an EpisodeOfCare resource based on the PV1’s Visit Number (this is carried in the Attendance Number field).
If the PV1 Visit Number is new – i.e. has not previously been seen by Discovery – this causes a new EpisodeOfCare resource to be created.
If the PV1 Attendance Number has previously been seen by Discovery, then the Encounter is linked to the existing EpisodeOfCare.
Publisher use | Field# | FieldName | FHIR Mapping | Extension | Compass Schema Table | Field |
---|---|---|---|---|---|---|
Barts Health
Homerton |
PV1.2 | Patient class | Encounter.class | |||
Barts Health | PV1.3 | Assigned patient location | Encounter.location
& Location |
|||
Barts Health | - PV1.3.1 | Point of Care | Encounter.location | |||
Barts Health | - PV1.3.2 | Room | Encounter.location | |||
Barts Health | - PV1.3.3 | Bed | Encounter.location | |||
Barts Health | - PV1.3.4 | Facility | Encounter.location
Encounter.location |
|||
Barts Health | - PV1.3.7 | Building | Encounter.location | |||
Homerton | PV1.4 | Admission type | Encounter.extension | encounter-admission-type | ||
Homerton | PV1.6 | Prior patient location | Encounter.location& Location | |||
Barts Health
Homerton |
PV1.7 | Attending doctor | Encounter.participant & Practitioner | |||
Barts Health | - PV1.7.1 | ID number | Practitioner.identifier.value | |||
Barts Health | - PV1.7.2 | Family name | Practitioner.name.family | |||
Barts Health | - PV1.7.3 | Given name | Practitioner.name.given | |||
Barts Health | - PV1.7.9 | Assigning authority | Practitioner.identifier.system | |||
Barts Health
Homerton |
PV1.8 | Referring doctor | Encounter.participant & Practitioner | |||
Barts Health | - PV1.8.1 | ID number | Practitioner.identifier.value | |||
Barts Health | - PV1.8.2 | Family name | Practitioner.name.family | |||
Barts Health | - PV1.8.3 | Given name | Practitioner.name.given | |||
Barts Health | - PV1.8.9 | Assigning authority | Practitioner.identifier.system | |||
Homerton | PV1.9 | Consulting doctor | Encounter.participant& Practitioner | |||
Barts Health
Homerton |
PV1.10 | Hospital service | Encounter.serviceProvider& Organization | |||
Homerton | PV1.14 | Admit source | Encounter.hospitalization.origin | |||
Homerton | PV1.17 | Admitting doctor | Encounter.participant & Practitioner | |||
Barts Health
Homerton |
PV1.18 | Patient type | Encounter.type | |||
Barts Health
Homerton |
PV1.19 | Visit number | EpisodeOfCare.identifier | |||
Barts Health
Homerton |
PV1.36 | Discharge disposition | Encounter.hospitalization.dischargeDisposition | |||
Barts Health
Homerton |
PV1.37 | Discharged to location | Encounter.hospitalization.destination | |||
Homerton | PV1.39 | Servicing facility | Encounter.managingOrganization | |||
Barts Health
Homerton |
PV1.41 | Account status | Encounter.status | |||
Barts Health
Homerton |
PV1.44 | Admit date/time | Encounter.statusHistory.start | |||
Barts Health
Homerton |
PV1.45 | Discharge date/time | Encounter.statusHistory.end | |||
Homerton | PV1.50 | Alternate visit ID | Encounter.identifier | |||
Homerton | PV1.52 | Other healthcare provider | Encounter.participant& Practitioner |
Publisher use | Field# | FieldName | FHIR Mapping | Compass Schema Table | Field |
---|---|---|---|---|---|
Barts Health
Homerton |
PV2.3 | Admit reason | Encounter.reason | ||
Homerton | PV2.4 | Transfer reason | Encounter.reason | ||
Barts Health
Homerton |
PV2.8 | Expected admit date/time | Encounter.statusHistory.start | ||
Homerton | PV2.9 | Expected discharge date/time | Encounter.statusHistory.end |
Publisher use | Field# | FieldName | FHIR Mapping | Extension | Compass Schema Table | Field |
---|---|---|---|---|---|---|
Barts Health | EVN.2 | Recorded date/time | Encounter.extension | primarycare-recorded-date-extension | ||
EVN.5 | Operator ID | MessageHeader.enterer & Practitioner.identifier & Practitioner.name |
Publisher use | Field# | FieldName | FHIR Mapping | Compass Schema Table | Field |
---|---|---|---|---|---|
Homerton | ZVI.9 | Admit mode | Encounter.hospitalization.admitSource | ||
Homerton | ZVI.15 | Assign to location date/time | Encounter.location.period |