HL7 ADT: Difference between revisions

From Discovery Data Service
Jump to navigation Jump to search
No edit summary
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
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.
To see the latest Compass V2 schema, please see [[Discovery Remote Subscriber Database Familiarisation#Data_Mapping]]
 
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 provides an overview the HL7 ADT message types, structure, transform process, and the ADT -> FHIR -> Compass2 mappings.
 
Further segment level details are described in the article  [[Publisher API HL7 Messages]] where details of cardinality are also  given


== Message Types ==
== Message Types ==
Line 232: Line 236:
{|
{|
|'''Barts Health'''
|'''Barts Health'''
|
|'''Homerton'''
|'''Homerton'''
|-
|-
|[[File:HL7_ADT_Transformation_Overview.jpg|frameless|500x500px]]
|[[File:HL7_ADT_Transformation_Overview.jpg|frameless|500x500px]]
|
||[[File:Transformation Overview Homerton V2.jpg|frameless|500x500px]]
||[[File:Transformation Overview Homerton V2.jpg|frameless|500x500px]]
|-
|-
|
|<div style="width: 100px"></div>
|
|<div style="text-align:center">''As Barts Health plus NK1 and ZVI''</div>
|''As Barts Health plus NK1 and ZVI''
|}
|}


Line 260: Line 261:
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:95%;"
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:95%;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="7.5%" |Publisher
! scope="col" width="20%" |Publisher
! scope="col" width="7.5%" |Field#
! scope="col" width="15%" |Field#
! scope="col" width="15%" |FieldName
! scope="col" width="20%" |FieldName
! scope="col" width="20%" |FHIR Mapping
! scope="col" width="25%" |FHIR Mapping
! scope="col" width="15%" |Extension
! scope="col" width="20%" |Extension
! scope="col" width="15%" |Compass Schema Table
! scope="col" width="20%" |Field
|-
|-
|Barts Health
|Barts Health
Line 273: Line 272:
|Sending application
|Sending application
|MessageHeader.source.software
|MessageHeader.source.software
|
|
|
|
|-
|-
Line 282: Line 279:
|Sending facility
|Sending facility
|MessageHeader.source.name
|MessageHeader.source.name
|
|
|
|
|-
|-
Line 292: Line 287:
|MessageHeader.destination.extension
|MessageHeader.destination.extension
|message-header-destination-software-extension
|message-header-destination-software-extension
|
|
|-
|-
|Barts Health
|Barts Health
Line 300: Line 293:
|Receiving facility
|Receiving facility
|MessageHeader.destination.name  & MessageHeader.responsible
|MessageHeader.destination.name  & MessageHeader.responsible
|
|
|
|
|-
|-
Line 309: Line 300:
|Message date/time
|Message date/time
|MessageHeader.timestamp
|MessageHeader.timestamp
|
|
|
|
|-
|-
Line 318: Line 307:
|Message type
|Message type
|MessageHeader.event.code
|MessageHeader.event.code
|
|
|
|
|-
|-
Line 328: Line 315:
|MessageHeader.extension
|MessageHeader.extension
|message-header-message-control-id-extension
|message-header-message-control-id-extension
|
|
|-
|-
|Barts Health
|Barts Health
Line 336: Line 321:
|Version ID
|Version ID
|MessageHeader.event.version
|MessageHeader.event.version
|
|
|
|
|-
|-
Line 345: Line 328:
|MessageHeader.extension
|MessageHeader.extension
|message-header-sequence-number-extension
|message-header-sequence-number-extension
|
|
|}
|}


Line 352: Line 333:
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:95%;"
{| class="mw-collapsible" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top; width:95%;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
! scope="col" width="7.5%" |Publisher
! scope="col" width="20% |Publisher
! scope="col" width="7.5%" |Field#
! scope="col" width="15%" |Field#
! scope="col" width="15%" |FieldName
! scope="col" width="20%" |FieldName
! scope="col" width="20%" |FHIR Mapping
! scope="col" width="45%" |FHIR Mapping
! scope="col" width="30%" |Compass Schema Table
! scope="col" width="20%" |Field
|-
|-
|Homerton
|Homerton
Line 363: Line 342:
|Operator ID
|Operator ID
|MessageHeader.enterer  & Practitioner.identifier & Practitioner.name
|MessageHeader.enterer  & Practitioner.identifier & Practitioner.name
|
|
|}
|}


Line 402: Line 379:
|Patient.identifier
|Patient.identifier
|
|
|
|patient
|
|nhs_number
or null
|-
|-
|Barts Health
|Barts Health
Line 411: Line 389:
|Patient.identifier
|Patient.identifier
|
|
|
|patient
|
|nhs_number
 
or null
|-
|-
|Barts Health
|Barts Health
Line 419: Line 399:
|Patient.identifier.value
|Patient.identifier.value
|
|
|
|patient
|
|nhs_number
 
or null
|-
|-
|Barts Health
|Barts Health
|  - PID.3.4
|  - PID.3.4
|Assigning authority
|Assigning authority
|Patient.identifier.system
|Patient.identifier.system
|
|
|Patient
| style="color:grey;" |'''&#8211;'''
|organization_id
| style="color:grey;" |'''&#8211;'''
|-
|-
|Homerton
|Homerton
Line 435: Line 417:
|Patient.identifier
|Patient.identifier
|
|
|
|patient
|
|nhs_number
 
or null
|-
|-
|Barts Health
|Barts Health
Line 444: Line 428:
|Patient.name
|Patient.name
|
|
|Patient
|patient
|first_names
|first_names
last_name
last_name
Line 453: Line 437:
|Patient.name.family
|Patient.name.family
|
|
|Patient
|patient
|last_name
|last_name
|-
|-
|Barts Health
|Barts Health
|  - PID.5.2
|  - PID.5.2
|Given Name
|Given Name
|Patient.name.given
|Patient.name.given
|
|
|Patient
|patient
|first_names
|first_names
|-
|-
|Barts Health
|Barts Health
|  - PID.5.3
|  - PID.5.3
|Middle Name
|Middle Name
|Patient.name.given
|Patient.name.given
|
|
|Patient
|patient
|first_names
|first_names
|-
|-
Line 477: Line 461:
|Patient.name.prefix
|Patient.name.prefix
|
|
|Patient
|patient
|title
|title
|-
|-
|Barts Health
|Barts Health
|  - PID.5.7
|  - PID.5.7
|Name Type Code
|Name Type Code
|Patient.name.use
|Patient.name.use
|
|
|
| style="color:grey;" |'''&#8211;'''
|
| style="color:grey;" |'''&#8211;'''
|-
|-
|Barts Health
|Barts Health
Line 494: Line 478:
|Patient.birthDate & Patient.extension
|Patient.birthDate & Patient.extension
|primarycare-contact-birth-time-extension
|primarycare-contact-birth-time-extension
|Patient
|patient
|date_of_birth
|date_of_birth
|-
|-
Line 503: Line 487:
|Patient.gender
|Patient.gender
|
|
|Patient
|patient
|gender_concept_id
|gender_concept_id
|-
|-
Line 512: Line 496:
|Patient.name
|Patient.name
|
|
|
| style="color:grey;" |'''&#8211;'''
|
| style="color:grey;" |'''&#8211;'''
|-
|-
|Barts Health
|Barts Health
Line 534: Line 518:
|Barts Health
|Barts Health
|<nowiki>- PID.11.2</nowiki>
|<nowiki>- PID.11.2</nowiki>
|Other Designation
|Other Designation
|Patient.address.line
|Patient.address.line
|
|
Line 550: Line 534:
|Barts Health
|Barts Health
|<nowiki>- PID.11.5</nowiki>
|<nowiki>- PID.11.5</nowiki>
|Zip Or Postal Code
|Zip Or Postal Code
|Patient.address.postalCode
|Patient.address.postalCode
|
|
Line 558: Line 542:
|Barts Health
|Barts Health
|<nowiki>- PID.11.7</nowiki>
|<nowiki>- PID.11.7</nowiki>
|Address Type
|Address Type
|Patient.address.use
|Patient.address.use
|
|
Line 566: Line 550:
|Barts Health
|Barts Health
|<nowiki>- PID.11.8</nowiki>
|<nowiki>- PID.11.8</nowiki>
|Other Geographic Designation
|Other Geographic Designation
|Patient.address.line
|Patient.address.line
|
|
Line 574: Line 558:
|Barts Health
|Barts Health
|<nowiki>- PID.11.9</nowiki>
|<nowiki>- PID.11.9</nowiki>
|County/Parish Code
|County/Parish Code
|Patient.address.district
|Patient.address.district
|
|
Line 600: Line 584:
|Barts Health
|Barts Health
|<nowiki>- PID.13.2</nowiki>
|<nowiki>- PID.13.2</nowiki>
|Telecommunication Use Code
|Telecommunication Use Code
|Patient.telecom.use
|Patient.telecom.use
|
|
Line 625: Line 609:
|Barts Health
|Barts Health
|<nowiki>- PID.14.2</nowiki>
|<nowiki>- PID.14.2</nowiki>
|Telecommunication Use Code
|Telecommunication Use Code
|Patient.telecom.use
|Patient.telecom.use
|
|
|patint_concept
|patient_contact
|use_concept_id
|use_concept_id
|-
|-
Line 637: Line 621:
|Patient.communication.language
|Patient.communication.language
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Barts Health
|Barts Health
Line 646: Line 630:
|Patient.maritalStatus
|Patient.maritalStatus
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Barts Health
|Barts Health
Line 655: Line 639:
|Patient.extension
|Patient.extension
|primarycare-religion-category-extension
|primarycare-religion-category-extension
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Barts Health
|Barts Health
Line 664: Line 648:
|Patient.identifier
|Patient.identifier
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Barts Health
|Barts Health
Line 673: Line 657:
|Patient.extension
|Patient.extension
|primarycare-ethnic-category-extension
|primarycare-ethnic-category-extension
|Patient
|patient
|ethnic_code_concept_id
|ethnic_code_concept_id
|-
|-
Line 682: Line 666:
|Patient.deceased
|Patient.deceased
|
|
|Patient
|patient
|date_of_death
|date_of_death
|-
|-
Line 691: Line 675:
|Patient.deceased
|Patient.deceased
|
|
|
| style="color:grey;" |'''&#8211;'''
|
| style="color:grey;" |'''&#8211;'''
|}
|}
<span style="color: red;">'''&#x2717;'''</span> = Data available but not published to Compass schema <br /><span style="color:grey;">'''&#8211;'''</span> = Not applicable


===== PD1 field mapping =====
===== PD1 field mapping =====
Line 708: Line 693:
Homerton
Homerton
|PD1.3
|PD1.3
|Patient primary facility
|Patient primary facility
|Patient.careProvider& Organization
|Patient.careProvider& Organization
|
|patient
|
|organization_id
|-
|-
|Barts Health
|Barts Health
Line 717: Line 702:
|ID number
|ID number
|Organization.identifier.value
|Organization.identifier.value
|
|organization
|
|ods_code
|-
|-
|Barts Health
|Barts Health
Homerton
Homerton
|PD1.4
|PD1.4
|Patient primary care provider
|Patient primary care provider
|Patient.careProvider& Practitioner
|Patient.careProvider& Practitioner
|
|patient
|
|registered_practice_organization_id
|-
|-
|Barts Health
|Barts Health
Line 732: Line 717:
|ID number
|ID number
|Practitioner.identifier.value
|Practitioner.identifier.value
|
|practitioner
|
|gmc_code
|-
|-
|Barts Health
|Barts Health
Line 739: Line 724:
|Family name
|Family name
|Practitioner.name.family
|Practitioner.name.family
|
|practitioner
|
|name
|-
|-
|Barts Health
|Barts Health
Line 746: Line 731:
|Given name
|Given name
|Practitioner.name.given
|Practitioner.name.given
|
|practitioner
|
|name
|-
|-
|Barts Health
|Barts Health
Line 753: Line 738:
|Assigning authority
|Assigning authority
|Practitioner.identifier.system
|Practitioner.identifier.system
|
|practitioner
|
|organization_id
|}
|}


Line 773: Line 758:
|Patient.contact.name
|Patient.contact.name
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|Homerton
Line 781: Line 766:
|Patient.contact.relationship
|Patient.contact.relationship
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|Homerton
Line 789: Line 774:
|Patient.contact.address
|Patient.contact.address
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|Homerton
|NK1.5
|NK1.5
|Phone number
|Phone number
|Patient.contact.telecom.value
|Patient.contact.telecom.value
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|Homerton
|NK1.6
|NK1.6
|Business phone number
|Business phone number
|Patient.contact.telecom.value
|Patient.contact.telecom.value
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|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
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|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
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|}
|}
 
<span style="color: red;">'''&#x2717;'''</span> = Data available but not published to Compass schema <br />Encounter
=== Encounter ===
{| class="wikitable"
{| class="wikitable"
|Barts Health
|Barts Health
Line 867: Line 851:
|Encounter.class
|Encounter.class
|
|
|
|encounter
|
|core_concept_id
 
non_core_concept_id
 
admission_method
|-
|-
|Barts Health
|Barts Health
Line 877: Line 865:
&  Location
&  Location
|
|
|
|encounter
|
location
|institution_location_id
 
id
|-
|-
|Barts Health
|Barts Health
Line 885: Line 876:
|Encounter.location
|Encounter.location
|
|
|
|encounter
|
|institution_location_id
|-
|-
|Barts Health
|Barts Health
Line 893: Line 884:
|Encounter.location
|Encounter.location
|
|
|
|encounter
|
|institution_location_id
|-
|-
|Barts Health
|Barts Health
Line 901: Line 892:
|Encounter.location
|Encounter.location
|
|
|
|encounter
|
|institution_location_id
|-
|-
|Barts Health
|Barts Health
Line 911: Line 902:
Encounter.location
Encounter.location
|
|
|
|encounter
|
|institution_location_id
|-
|-
|Barts Health
|Barts Health
Line 919: Line 910:
|Encounter.location
|Encounter.location
|
|
|
|encounter
|
|institution_location_id
|-
|-
|Homerton
|Homerton
Line 927: Line 918:
|Encounter.extension
|Encounter.extension
|encounter-admission-type
|encounter-admission-type
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|Homerton
Line 935: Line 926:
|Encounter.location&  Location
|Encounter.location&  Location
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Barts Health
|Barts Health
Line 944: Line 935:
|Encounter.participant  & Practitioner
|Encounter.participant  & Practitioner
|
|
|
|encounter
|
practitioner
|practitioner_id
 
id
|-
|-
|Barts Health
|Barts Health
Line 953: Line 947:
|
|
|practitioner
|practitioner
|id
|gmc_code
|-
|-
|Barts Health
|Barts Health
Line 960: Line 954:
|Practitioner.name.family
|Practitioner.name.family
|
|
|practicioner
|practitioner
|name
|name
|-
|-
Line 968: Line 962:
|Practitioner.name.given
|Practitioner.name.given
|
|
|practicioner
|practitioner
|name
|name
|-
|-
Line 976: Line 970:
|Practitioner.identifier.system
|Practitioner.identifier.system
|
|
|practicioner
|practitioner
|organization_id
|organization_id
|-
|-
Line 985: Line 979:
|Encounter.participant  & Practitioner
|Encounter.participant  & Practitioner
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Barts Health
|Barts Health
Line 993: Line 987:
|Practitioner.identifier.value
|Practitioner.identifier.value
|
|
|practicioner
| style="color: red;" |'''&#x2717;'''
|id
| style="color: red;" |'''&#x2717;'''
|-
|-
|Barts Health
|Barts Health
Line 1,001: Line 995:
|Practitioner.name.family
|Practitioner.name.family
|
|
|practicioner
| style="color: red;" |'''&#x2717;'''
|name
| style="color: red;" |'''&#x2717;'''
|-
|-
|Barts Health
|Barts Health
Line 1,009: Line 1,003:
|Practitioner.name.given
|Practitioner.name.given
|
|
|practicioner
| style="color: red;" |'''&#x2717;'''
|name
| style="color: red;" |'''&#x2717;'''
|-
|-
|Barts Health
|Barts Health
Line 1,017: Line 1,011:
|Practitioner.identifier.system
|Practitioner.identifier.system
|
|
|practicioner
| style="color: red;" |'''&#x2717;'''
|organization_id
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|Homerton
Line 1,025: Line 1,019:
|Encounter.participant&  Practitioner
|Encounter.participant&  Practitioner
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Barts Health
|Barts Health
Line 1,034: Line 1,028:
|Encounter.serviceProvider&  Organization
|Encounter.serviceProvider&  Organization
|
|
|
|encounter
|
organization
|organization_id
 
service_provider_organization_id
 
id
|-
|-
|Homerton
|Homerton
Line 1,042: Line 1,041:
|Encounter.hospitalization.origin
|Encounter.hospitalization.origin
|
|
|encounter_additional
| style="color: red;" |'''&#x2717;'''
|value_id
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|Homerton
Line 1,050: Line 1,049:
|Encounter.participant  & Practitioner
|Encounter.participant  & Practitioner
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Barts Health
|Barts Health
Line 1,059: Line 1,058:
|Encounter.type
|Encounter.type
|
|
|
|encounter
|
|core_concept_id
 
non_core_concept_id
|-
|-
|Barts Health
|Barts Health
Line 1,077: Line 1,078:
|Encounter.hospitalization.dischargeDisposition
|Encounter.hospitalization.dischargeDisposition
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Barts Health
|Barts Health
Line 1,086: Line 1,087:
|Encounter.hospitalization.destination
|Encounter.hospitalization.destination
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|Homerton
|PV1.39
|PV1.39
|Servicing facility
|Servicing facility
|Encounter.managingOrganization
|Encounter.managingOrganization
|
|
|encounter
| style="color:grey;" |'''&#8211;'''
|service_provider_organization_id
| style="color:grey;" |'''&#8211;'''
|-
|-
|Barts Health
|Barts Health
Line 1,103: Line 1,104:
|Encounter.status
|Encounter.status
|
|
|
|episode_of_care
|
|registration_status_concept_id
|-
|-
|Barts Health
|Barts Health
Line 1,115: Line 1,116:
encounter_event
encounter_event
|clinical_effective_date
|clinical_effective_date
clinical_effective_date
<br />
|-
|-
|Barts Health
|Barts Health
Line 1,123: Line 1,124:
|Encounter.statusHistory.end
|Encounter.statusHistory.end
|
|
|
|encounter
|
encounter_event
|end_date
clinical_effective_date
|-
|-
|Homerton
|Homerton
Line 1,131: Line 1,134:
|Encounter.identifier
|Encounter.identifier
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|Homerton
Line 1,139: Line 1,142:
|Encounter.participant&  Practitioner
|Encounter.participant&  Practitioner
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|}
|}


Line 1,158: Line 1,161:
|Admit reason
|Admit reason
|Encounter.reason
|Encounter.reason
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|Homerton
Line 1,165: Line 1,168:
|Transfer reason
|Transfer reason
|Encounter.reason
|Encounter.reason
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Barts Health
|Barts Health
Line 1,173: Line 1,176:
|Expected admit date/time
|Expected admit date/time
|Encounter.statusHistory.start
|Encounter.statusHistory.start
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|Homerton
Line 1,180: Line 1,183:
|Expected discharge date/time
|Expected discharge date/time
|Encounter.statusHistory.end
|Encounter.statusHistory.end
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|}
|}


Line 1,203: Line 1,206:
|date_recorded
|date_recorded
|-
|-
|
|Homerton
|EVN.5
|EVN.5
|Operator ID
|Operator ID
|MessageHeader.enterer  & Practitioner.identifier & Practitioner.name
|MessageHeader.enterer  & Practitioner.identifier & Practitioner.name
|
|
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|}
|}


Line 1,226: Line 1,229:
|Admit mode
|Admit mode
|Encounter.hospitalization.admitSource
|Encounter.hospitalization.admitSource
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|-
|-
|Homerton
|Homerton
Line 1,233: Line 1,236:
|Assign to location date/time
|Assign to location date/time
|Encounter.location.period
|Encounter.location.period
|
| style="color: red;" |'''&#x2717;'''
|
| style="color: red;" |'''&#x2717;'''
|}
|}
<span style="color: red;">'''&#x2717;'''</span> = Data available but not published to Compass schema <br/><span style="color:grey;">'''&#8211;'''</span> = Not applicable

Latest revision as of 10:59, 3 August 2023

To see the latest Compass V2 schema, please see Discovery Remote Subscriber Database Familiarisation#Data_Mapping

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 provides an overview the HL7 ADT message types, structure, transform process, and the ADT -> FHIR -> Compass2 mappings.

Further segment level details are described in the article Publisher API HL7 Messages where details of cardinality are also given

Message Types

Publisher Message Type CollapseMessage Name
Barts Health

Homerton

ADT^A01 Admit / visit notification
Barts Health

Homerton

ADT^A02 Transfer a patient
Barts Health

Homerton

ADT^A03 Discharge/end visit
Barts Health

Homerton

ADT^A04 Register a patient
Homerton ADT^A05 Pre-admit a patient
Homerton ADT^A06 Change an outpatient to an inpatient
Homerton ADT^A07 Change an inpatient to an outpatient
Barts Health

Homerton

ADT^A08 Update patient information
Barts Health ADT^A11 Cancel admit/visit notification
Barts Health

Homerton

ADT^A12 Cancel transfer
Barts Health

Homerton

ADT^A13 Cancel discharge/end visit
Homerton ADT^A14 Pending admit
Homerton ADT^A17 Swap patients
Barts Health

Homerton

ADT^A23 Delete a patient record
Homerton ADT^A27 Cancel pending admit
Barts Health

Homerton

ADT^A28 Add person information
Barts Health

Homerton

ADT^A31 Update person information
Barts Health

Homerton

ADT^A34 Merge patient information - patient ID only
Barts Health

Homerton

ADT^A35 Merge patient information - account number only
Barts Health

Homerton

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 Standard segments Cerner custom segments
  • ADT^A01 (Admit/visit notification)
  • ADT^A02 (Transfer a patient)
  • ADT^A03 (Discharge/end visit)
  • 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^A11 (Cancel admit/visit notification)
  • ADT^A12 (Cancel transfer)
  • ADT^A13 (Cancel discharge/end visit)
  • ADT^A14 (Pending admit)
  • ADT^A23 (Delete a patient record)
  • MSH [1..1] Message header
  • EVN [1..1]  Event information
  • PID [1..1] Patient information
  • PD1 [0..1] Additional demographics
  • NK1 [0..*] Next of kin / associated parties
  • PV1 [1..1] Patient visit information
  • 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
  • ZAL [0..*] Additional allergy information
  • ZQA [0..1] Questionnaire information
  • ZPI [0..1] Additional person information
  • ZVI [0..1] Additional visit information

Structure B – Person level messages (without encounter information)

Applies to Standard segments Cerner custom segments
  • ADT^A28 (Add person information)
  • ADT^A31 (Update person information)
  • MSH [1..1] Message header
  • EVN [1..1] Event information
  • PID [1..1] Patient information
  • 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
  • ZAL [0..*] Additional allergy information
  • ZPI [0..1] Additional person information

Structure C – Swap patients

Applies to Standard segments Cerner custom segments
  • ADT^A17 (Swap patients)
  • 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)
  • ZPI [0..1] Additional person information
  • ZVI [0..1] Additional visit information

Structure D – Merge patient information

Applies to Standard segments
  • A34 (Merge patient information)
  • A44 (Move account information)
  • MSH [1..1] Message header
  • EVN [1..1] Event information
  • PID [1..1] Patient information
  • PD1 [0..1] Additional demographics
  • MRG [1..1] Merge information

Structure E – Merge account number

Applies to Standard segments
  • A35 (Merge account number)
  • MSH [1..1] Message header
  • EVN [1..1] Event information
  • PID [1..1] Patient information
  • PD1 [0..1] Additional demographics
  • PV1 [1..1] Patient visit information
  • MRG [1..1] Merge information

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 Homerton
HL7 ADT Transformation Overview.jpg Transformation Overview Homerton V2.jpg
As Barts Health plus NK1 and ZVI

The following sections show each transformation in detail, including field mappings.

Message Header

Barts Health Homerton
MSH Overview.jpg MSH EVN Overview.jpg
Message Header (MSH) Message Header (MSH) & Even Type (EVN)
MSH field mapping
Publisher Field# FieldName FHIR Mapping CollapseExtension
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
EVN field mapping
Publisher Field# FieldName CollapseFHIR Mapping
Homerton EVN.5 Operator ID MessageHeader.enterer & Practitioner.identifier & Practitioner.name

Patient

Barts Health

Patient Identification (PID), & Patient Additional Demographic (PD1)



OR

Homerton

PID PD1 NK1 segments.jpg

Patient Identification (PID), Patient Additional Demographic (PD1), & Next of Kin (NK1) segments

PID field mapping
Publisher Field# FieldName FHIR Mapping Extension Compass Schema Table CollapseField
Barts Health

Homerton

PID.2 Patient ID Patient.identifier patient nhs_number

or null

Barts Health

Homerton

PID.3 Patient Identifier List Patient.identifier patient nhs_number

or null

Barts Health - PID.3.1 ID Patient.identifier.value patient nhs_number

or null

Barts Health - PID.3.4 Assigning authority Patient.identifier.system – –
Homerton PID.4 Alternate PatientIidentifier Patient.identifier patient nhs_number

or null

Barts Health

Homerton

PID.5 Patient Name Patient.name patient first_names

last_name

Barts Health - PID.5.1 Family Name Patient.name.family patient last_name
Barts Health - PID.5.2 Given Name Patient.name.given patient first_names
Barts Health - PID.5.3 Middle Name Patient.name.given patient first_names
Barts Health - PID.5.5 Prefix Patient.name.prefix patient title
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 patient date_of_birth
Barts Health

Homerton

PID.8 Sex Patient.gender patient gender_concept_id
Barts Health

Homerton

PID.9 Patient Alias Patient.name – –
Barts Health

Homerton

PID.11 Patient Address Patient.address patient current_address_id
Barts Health - PID.11.1 Street Address Patient.address.line patient_address address_line_1
Barts Health - PID.11.2 Other Designation Patient.address.line patient_address address_line_2
Barts Health - PID.11.3 City Patient.address.city patient_address city
Barts Health - PID.11.5 Zip Or Postal Code Patient.address.postalCode patient_address postcode
Barts Health - PID.11.7 Address Type Patient.address.use patient_address use_concept_id
Barts Health - PID.11.8 Other Geographic Designation Patient.address.line patient_address address_line_3
Barts Health - PID.11.9 County/Parish Code Patient.address.district patient_address ward_code

local_authority_code

Barts Health

Homerton

PID.13 Phone Number - Home Patient.telecom patient_contact type_concept_id
Barts Health - PID.13.1 Patient Number Patient.telecom.value patient_contact value
Barts Health - PID.13.2 Telecommunication Use Code Patient.telecom.use patient_contact use_concept_id
Barts Health

Homerton

PID.14 Phone Number - Business Patient.telecom patient_contact type_concept_id
Barts Health - PID.14.1 Patient Number Patient.telecom.value patient_contact value
Barts Health - PID.14.2 Telecommunication Use Code Patient.telecom.use patient_contact use_concept_id
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 patient ethnic_code_concept_id
Barts Health

Homerton

PID.29 Patient Death Date and Time Patient.deceased patient date_of_death
Barts Health

Homerton

PID.30 Patient Death Indicator Patient.deceased – –

✗ = Data available but not published to Compass schema
– = Not applicable

PD1 field mapping
Publisher Field# FieldName FHIR Mapping Compass Schema Table CollapseField
Barts Health

Homerton

PD1.3 Patient primary facility Patient.careProvider& Organization patient organization_id
Barts Health - PD1.3.3 ID number Organization.identifier.value organization ods_code
Barts Health

Homerton

PD1.4 Patient primary care provider Patient.careProvider& Practitioner patient registered_practice_organization_id
Barts Health - PD1.4.1 ID number Practitioner.identifier.value practitioner gmc_code
Barts Health - PD1.4.2 Family name Practitioner.name.family practitioner name
Barts Health - PD1.4.3 Given name Practitioner.name.given practitioner name
Barts Health - PD1.4.9 Assigning authority Practitioner.identifier.system practitioner organization_id
NK1 field mapping
Publisher Field# FieldName FHIR Mapping Extension Compass Schema Table CollapseField
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 ✗ ✗

✗ = Data available but not published to Compass schema
Encounter

Barts Health

PV1 PV2 EVN Segments.jpg

Patient Visit (PV1), Patient Visit - additional (PV2), & Event Type (EVN)



OR

Homerton

PV1 PV2 ZVI segments.jpg

Patient Visit (PV1), Patient Visit - additional (PV2), & Additional Visit Information (ZVI) segments

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.

PV1 field mapping
Publisher Field# FieldName FHIR Mapping Extension Compass Schema Table CollapseField
Barts Health

Homerton

PV1.2 Patient class Encounter.class encounter core_concept_id

non_core_concept_id

admission_method

Barts Health PV1.3 Assigned patient location Encounter.location

& Location

encounter

location

institution_location_id

id

Barts Health - PV1.3.1 Point of Care Encounter.location encounter institution_location_id
Barts Health - PV1.3.2 Room Encounter.location encounter institution_location_id
Barts Health - PV1.3.3 Bed Encounter.location encounter institution_location_id
Barts Health - PV1.3.4 Facility Encounter.location

Encounter.location

encounter institution_location_id
Barts Health - PV1.3.7 Building Encounter.location encounter institution_location_id
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 encounter

practitioner

practitioner_id

id

Barts Health - PV1.7.1 ID number Practitioner.identifier.value practitioner gmc_code
Barts Health - PV1.7.2 Family name Practitioner.name.family practitioner name
Barts Health - PV1.7.3 Given name Practitioner.name.given practitioner name
Barts Health - PV1.7.9 Assigning authority Practitioner.identifier.system practitioner organization_id
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 encounter

organization

organization_id

service_provider_organization_id

id

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 encounter core_concept_id

non_core_concept_id

Barts Health

Homerton

PV1.19 Visit number EpisodeOfCare.identifier episode_of_care id
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 episode_of_care registration_status_concept_id
Barts Health

Homerton

PV1.44 Admit date/time Encounter.statusHistory.start encounter

encounter_event

clinical_effective_date


Barts Health

Homerton

PV1.45 Discharge date/time Encounter.statusHistory.end encounter

encounter_event

end_date

clinical_effective_date

Homerton PV1.50 Alternate visit ID Encounter.identifier ✗ ✗
Homerton PV1.52 Other healthcare provider Encounter.participant& Practitioner ✗ ✗
PV2 field mapping
Publisher Field# FieldName FHIR Mapping Compass Schema Table CollapseField
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 ✗ ✗
EVN field mapping
Publisher Field# FieldName FHIR Mapping Extension Compass Schema Table CollapseField
Barts Health EVN.2 Recorded date/time Encounter.extension primarycare-recorded-date-extension encounter date_recorded
Homerton EVN.5 Operator ID MessageHeader.enterer & Practitioner.identifier & Practitioner.name ✗ ✗
ZVI field mapping
Publisher Field# FieldName FHIR Mapping Compass Schema Table CollapseField
Homerton ZVI.9 Admit mode Encounter.hospitalization.admitSource ✗ ✗
Homerton ZVI.15 Assign to location date/time Encounter.location.period ✗ ✗

✗ = Data available but not published to Compass schema
– = Not applicable

Retrieved from ‘https://wiki.discoverydataservice.org/index.php?title=HL7_ADT&oldid=6553’