WARNING
This guidance is under active development by NHS England and content may be added or updated on a regular basis. The implementation guide is currently in draft and SHOULD NOT be used for development or implementation without consulting the NHS England Pathology Standards and Implementation team.Data Mapping
Overview
This page provides a set of high-level data mappings between the FHIR profiles that are referenced by this implementation guide and the PMIP EDIFACT (NHS003) messaging specification. To aid traceability, the mappings are presented from two viewpoints: EDIFACT to FHIR and FHIR to EDIFACT.
Whilst every effort has been made to ensure that the mappings are correct, they are not a normative part of the implementation guide. They are intended to provide additional guidance to suppliers who are familiar with the existing PMIP EDIFACT (NHS003) specification.
EDIFACT to FHIR Mappings
The following diagram is based on the message structure/attribute cross-reference table that is included in Section 3 of ‘LSR_04_A_001.doc’, which forms part of the PMIP EDIFACT (NHS003) specification. The table has been updated to include the corresponding FHIR R4 element for each relevant EDIFACT attribute.
|
|
Information about the message: |
|||||||||||
|
|
|
|
|
|
|
|
UNH |
M |
1 |
Message reference number Message type |
|
|
|
|
|
|
|
|
|
|
BGM |
M |
1 |
Message name |
|
|
|
|
|
|
|
|
|
|
DTM |
A |
1 |
Date/time of message generation |
|
|
|
|
Healthcare party (including Healthcare professional and Healthcare organisation) Laboratory service requester / Message recipient / Laboratory service provider: |
|||||||||||
|
|
|
|
|
|
|
|
SG1 |
M |
6 |
|
|
|
|
|
|
|
|
|
|
|
+ S01 |
M |
1 |
|
|
|
|
|
|
|
|
|
|
|
NAD |
R |
1 |
Healthcare registration identification Name of healthcare organisation Person name details |
E084 - UKCore-Practitioner.identifier E080 - UKCore-Organization.name E092 - UKCore-Practitioner.name |
|
|
|
|
|
|
|
|
|
+ ADR |
N |
0 |
|
|
|
|
|
|
|
|
|
|
|
COM |
N |
0 |
|
|
|
|
|
|
|
|
|
|
|
RFF |
D |
1 |
Partner-agreed identification of healthcare party |
E083 - UKCore-Practitioner.identifier |
|
|
|
|
|
|
|
|
|
SEQ |
N |
0 |
|
|
|
|
|
|
|
|
|
|
|
+ SPR |
R |
1 |
Medical specialty of healthcare professional Position of healthcare professional |
E094 - UKCore-UKCore-PractitionerRole.specialty E095 - UKCore-UKCore-PractitionerRole.code |
|
|
|
Laboratory service report: |
|||||||||||
|
|
|
|
|
|
|
|
SG2 |
M |
1 |
|
|
|
|
|
|
|
|
|
|
|
+ S02 |
M |
1 |
|
|
|
|
|
|
|
|
|
|
|
GIS |
M |
1 |
Service type of laboratory service report |
E183 - N/A |
|
|
|
|
|
|
|
|
|
RFF |
M |
1 |
Identification of laboratory service report by laboratory service provider |
E184 - UKCore-DiagnosticReport-Lab.identifier |
|
|
|
|
|
|
|
|
|
STS |
R |
1 |
Status of laboratory service |
E186 - UKCore-DiagnosticReport-Lab.status |
|
|
|
|
|
|
|
|
|
DTM |
M |
1 |
Issue date and time of laboratory service report |
E185 - UKCore-DiagnosticReport-Lab.issued |
|
|
|
|
|
|
|
|
|
FTX |
N |
0 |
|
|
|
|
|
|
Laboratory service order: |
||||||||||
|
|
|
|
|
|
|
|
SG4 |
D |
1 |
|
|
|
|
|
|
|
|
|
|
|
+ S04 |
M |
1 |
|
|
|
|
|
|
|
|
|
|
|
FCA |
R |
1 |
Payment category |
E160 - N/A |
|
|
|
|
|
|
|
|
|
RFF |
M |
2 |
Identification of laboratory service order by laboratory service requester Identification of laboratory service order by laboratory service provider |
E152 - UKCore-ServiceRequest-Lab.identifier E153 - UKCore-ServiceRequest-Lab.identifier |
|
|
|
|
|
|
|
|
|
DTM |
O |
1 |
Issue date and time of laboratory service order |
E154 - UKCore-ServiceRequest-Lab.authoredOn |
|
|
|
|
|
|
|
|
|
FTX |
N |
0 |
|
|
|
|
|
|
Subject of investigation: |
||||||||||
|
|
|
|
|
|
|
|
SG6 |
R |
1 |
|
|
|
|
|
|
|
|
|
|
|
+ S06 |
M |
1 |
|
|
|
|
|
|
|
|
|
|
|
RFF |
D |
1 |
Identification of subject of investigation by laboratory service provider |
E294 - UKCore-Patient.identifier |
|
|
|
|
|
|
|
|
|
+ ADR |
O |
1 |
Unstructured address line Postal code |
E311 - UKCore-Patient.address E307 - UKCore-Patient.postalCode |
|
|
|
|
|
|
|
|
|
COM |
N |
0 |
|
|
|
|
|
|
|
Patient: |
|||||||||
|
|
|
|
|
|
|
|
SG7 |
R |
1 |
|
|
|
|
|
|
|
|
|
|
|
+ S07 |
M |
1 |
|
|
|
|
|
|
|
|
|
|
|
+ PNA |
R |
1 |
Official patient identification Family name First given name Middle name Title |
E202 - UKCore-Patient.identifier E313 - UKCore-Patient.name.family E314 - UKCore-Patient.name.given E315 - UKCore-Patient.name.given E316 - UKCore-Patient.name.prefix |
|
|
|
|
|
|
|
|
|
DTM |
A |
1 |
Date and time of birth |
E218 - UKCore-Patient.birthDate |
|
|
|
|
|
|
|
|
|
+ PDI |
A |
1 |
Patient administrative sex |
E217 - UKCore-Patient.gender |
|
|
|
|
|
Clinical information: |
|||||||||
|
|
|
|
|
|
|
|
SG10 |
O |
1 |
|
|
|
|
|
|
|
|
|
|
|
+ S10 |
M |
1 |
|
|
|
|
|
|
|
|
|
|
|
+ CIN |
R |
1 |
Type of clinical observation |
E045 - UKCore-ServiceRequest-Lab.reasonCode |
|
|
|
|
|
|
|
|
|
DTM |
N |
0 |
|
|
|
|
|
|
|
|
|
|
|
FTX |
R |
99 |
Clinical observation description |
E046 - UKCore-ServiceRequest-Lab.reasonCode |
|
|
|
|
|
|
|
||||||||
|
|
|
|
|
|
|
|
SG14 |
N |
0 |
|
|
|
|
|
|
|
|
|
|
|
+ CLI |
M |
1 |
|
|
|
|
|
|
|
|
|
|
|||||||
|
|
|
|
|
|
|
|
SG15 |
N |
0 |
|
|
|
|
|
|
|
|
|
|
|
IMD |
M |
1 |
|
|
|
|
|
|
|
|
|
|
|
+ DSG |
N |
0 |
|
|
|
|
|
|
|
|
|
|
|
FTX |
N |
0 |
|
|
|
|
|
|
|
Specimen: |
|||||||||
|
|
|
|
|
|
|
|
SG16 |
R |
99 |
|
|
|
|
|
|
|
|
|
|
|
+ S16 |
M |
1 |
|
|
|
|
|
|
|
|
|
|
|
SEQ |
R |
1 |
|
|
|
|
|
|
|
|
|
|
|
+ SPC |
M |
2 |
Pre-treatment description Type of sample |
E225 - UKCore-Specimen.collection.fastingStatus[x] E264 - UKCore-Specimen.type |
|
|
|
|
|
|
|
|
|
* PRC |
N |
0 |
|
|
|
|
|
|
|
|
|
|
|
RFF |
A |
2 |
Identification of sample by laboratory service requester Identification of sample by laboratory service provider |
E262 - UKCore-Specimen.identifier E263 - UKCore-Specimen.accessionIdentifier |
|
|
|
|
|
|
|
|
|
* QTY |
O |
1 |
Numerical value of amount of collected sample Unit of amount of collected sample |
E055 - UKCore-Specimen.collection.quantity.value E056 - UKCore-Specimen.collection.quantity.unit |
|
|
|
|
|
|
|
|
|
DTM |
A |
2 |
Date and time of sample collection Date and time of receipt of collected sample |
E050 - UKCore-Specimen.collection.collected[x] E061 - UKCore-Specimen.receivedTime |
|
|
|
|
|
|
|
|
|
FTX |
O |
9 |
Laboratory service provider's comments to sample |
E271 - UKCore-Specimen.note |
|
|
|
|
|
Laboratory investigation and result: |
|||||||||
|
|
|
|
|
|
|
|
SG18 |
M |
99 |
|
|
|
|
|
|
|
|
|
|
|
GIS |
M |
1 |
Service type of laboratory investigation result item |
E125 - N/A |
|
|
|
|
|
|
|
|
|
+ INV |
M |
1 |
Measurable quantity attribute |
E108 - UKCore-Observation-Lab.code |
|
|
|
|
|
|
|
|
|
|
|
|
E108 - UKCore-Observation-Group-Lab.code |
||
|
|
|
|
|
|
|
|
SEQ |
D |
1 |
|
|
|
|
|
|
|
|
|
|
|
+ RSL |
D |
1 |
Numerical value of a measurement result Arithmetic comparator Unit of measurement result Deviating result indicator |
E129 - UKCore-Observation-Lab.valueQuantity E128 - UKCore-Observation-Lab.valueQuantity.comparator E130 - UKCore-Observation-Lab.valueQuantity.unit E137 - UKCore-Observation-Lab.interpretation |
|
|
|
|
|
|
|
|
|
STS |
O |
1 |
Status of laboratory investigation (result item) |
E139 - UKCore-Observation-Lab.status |
|
|
|
|
|
|
|
|
|
|
|
|
E139 - UKCore-Observation-Group-Lab.status |
||
|
|
|
|
|
|
|
|
DTM |
N |
0 |
|
|
|
|
|
|
|
|
|
|
|
FTX |
D |
99 |
Text value of a laboratory investigation result item Comment to laboratory investigation result item
Complex reference range information |
E136 - UKCore-Observation-Lab.valueString E141 - UKCore-Observation-Lab.note E141 - UKCore-Observation-Group-Lab.note E330 - UKCore-Observation-Lab.referenceRange.text |
|
|
|
|
|
|
|
|
|
RFF |
R |
1 |
|
|
|
|
|
|
|
|
|
||||||||
|
|
|
|
|
|
|
|
SG19 |
N |
0 |
|
|
|
|
|
|
|
|
|
|
|
REL |
M |
1 |
|
|
|
|
|
|
|
|
|
|
|
RFF |
N |
0 |
|
|
|
|
|
|
|
|
Reference limit: |
||||||||
|
|
|
|
|
|
|
|
SG20 |
D |
9 |
|
|
|
|
|
|
|
|
|
|
|
+ S20 |
M |
1 |
|
|
|
|
|
|
|
|
|
|
|
+ RND |
R |
1 |
Numerical value of lower reference limit of quantity Numerical value of upper reference limit of quantity |
E144 - UKCore-Observation-Lab.referenceRange.low E145 - UKCore-Observation-Lab.referenceRange.high |
|
|
|
|
|
|
|
|
|
FTX |
O |
1 |
Reference population definition |
E148 - UKCore-Observation-Lab.referenceRange.type |
|
|
|
|
|
|
|
|
|
|
|
|
E148 - UKCore-Observation-Lab.referenceRange.appliesTo |
||
|
|
Message trailer: |
|||||||||||
|
|
|
|
|
|
|
|
UNT |
M |
1 |
Message reference number Segment count |
|
|
FHIR to EDIFACT Mappings
The following tables provide a mapping between the data elements in each FHIR profile and the corresponding EDIFACT attributes.
The constraints that need to be applied to each FHIR resource using the relevant UK Core profiles are described in the individual profile pages (refer to the Profiles section of this implementation guide). Only those FHIR data elements that are currently in scope (as defined in the Additional Guidance section of each profile page) are listed in the tables below.
| UKCore-DiagnosticReport-Lab | PMIP EDIFACT (NHS003) Mapping | |||
|---|---|---|---|---|
| FHIR Element Name | Attribute Id | Attribute Name | Message Mapping | Notes |
| identifier | E184 | identification of laboratory service report by laboratory service provider | SG2.RFF.C506.1154 | |
| basedOn | ||||
| status | E186 | status of laboratory service | SG2.STS.C555.9011 | 'STATUS EVENT' code is populated with a value of 'UN' (Unspecified). Refer to the definition of Segment Group 2 in LSR_04_A_001.doc for details. |
| category.text | E080 | name of healthcare organisation | SG1.NAD.C080.3036(1-2) | This mapping relates to the use of Segment Group 1 to carry the name of a pathology department (as text), indicated by a combination of 'PARTY QUALIFIER' = 'SLA' (Laboratory service provider) and 'SERVICE PROVIDER QUALIFIER' = 'DPT' (Department within an organisation). For example: S01+01Refer to LSR_04_A_001.doc for details. |
| code | ||||
| subject | ||||
| issued | E185 | issue date and time of laboratory service report | SG2.DTM.C507.2380 | |
| performer | ||||
| specimen | ||||
| result | ||||
| conclusion | ||||
| conclusionCode | ||||
| UKCore-Observation-Group-Lab | PMIP EDIFACT (NHS003) Mapping | |||
|---|---|---|---|---|
| FHIR Element Name | Attribute Id | Attribute Name | Message Mapping | Notes |
| identifier | ||||
| status | E139 | status of laboratory investigation (result item) | SG18.STS.C555.9011 | |
| category | ||||
| code.coding.code | E108 | measurable quantity attribute | SG18.INV.C847.9931 | |
| code.coding.system | E108 | code list specifying the measurable quantity attribute | SG18.INV.C847.1131 | |
| code.coding.display | E108 | textual representation of the code for measurable quantity attribute | SG18.INV.C847.9930 | |
| subject | ||||
| effective[x] | ||||
| issued | ||||
| performer | ||||
| note | E141 | comment to laboratory investigation result item | SG18.FTX.C108.4440(1-5) | 'TEXT SUBJECT QUALIFIER' is populated with a value of 'SPC' (Service provider's comment). Refer to the definition of Segment Group 18 in LSR_04_A_001.doc for details. |
| specimen | ||||
| hasMember | The mechanism for supporting test groups, component tests within test groups and standalone tests in PMIP EDIFACT (NHS003) is described in the definition of Segment Group 18 in LSR_04_A_001.doc. | |||
| UKCore-Observation-Lab | PMIP EDIFACT (NHS003) Mapping | |||
|---|---|---|---|---|
| FHIR Element Name | Attribute Id | Attribute Name | Message Mapping | Notes |
| identifier | ||||
| status | E139 | status of laboratory investigation (result item) | SG18.STS.C555.9011 | |
| category | ||||
| code.coding.code | E108 | measurable quantity attribute | SG18.INV.C847.9931 | |
| code.coding.system | E108 | code list specifying the measurable quantity attribute | SG18.INV.C847.1131 | |
| code.coding.display | E108 | textual representation of the code for measurable quantity attribute | SG18.INV.C847.9930 | |
| subject | ||||
| effective[x] | ||||
| issued | ||||
| performer | ||||
| valueQuantity | E129 | numerical value of a measurement result | SG18.RSL.C830(1).6314 | |
| valueQuantity.comparator | E128 | arithmetic comparator | SG18.RSL.C830(1).6321 | |
| valueQuantity.unit | E130 | unit of measurement result | SG18.RSL.C848.6410 | |
| valueString | E136 | text value of a laboratory investigation result item | SG18.FTX.C108.4440(1-5) | 'TEXT SUBJECT QUALIFIER' is populated with a value of 'RIT' (Text value of a result) for textual results. Refer to the definition of Segment Group 18 in LSR_04_A_001.doc for details. |
| dataAbsentReason | ||||
| interpretation | E137 | deviating result indicator | SG18.RSL.7857 | Partial mapping to 'RESULT NORMALCY INDICATOR, CODED' (also referred to as 'deviating result indicator'). Refer to the definition of Segment Group 18 in LSR_04_A_001.doc for details. |
| note | E141 | comment to laboratory investigation result item | SG18.FTX.C108.4440(1-5) | 'TEXT SUBJECT QUALIFIER' is populated with a value of 'SPC' (Service provider's comment). Refer to the definition of Segment Group 18 in LSR_04_A_001.doc for details. |
| bodySite | ||||
| method | ||||
| specimen | ||||
| referenceRange.low | E144 | numerical value of lower reference limit of quantity | SG20.RND.6162 | |
| referenceRange.high | E145 | numerical value of upper reference limit of quantity | SG20.RND.6152 | |
| referenceRange.type referenceRange.appliesTo |
E148 | reference population definition | SG20.FTX.C108.4440(1-5) | 'TEXT SUBJECT QUALIFIER' is populated with a value of 'RPD' (Reference population definition). Refer to the definition of Segment Group 18 in LSR_04_A_001.doc for details. |
| referenceRange.text | E330 | complex reference range information | SG18.FTX.C108.4440(1-5) | 'TEXT SUBJECT QUALIFIER' is populated with a value of 'CRR' (Complex reference range information). Refer to the definition of Segment Group 18 in LSR_04_A_001.doc for details. |
| component | ||||
| UKCore-Patient | PMIP EDIFACT (NHS003) Mapping | |||
|---|---|---|---|---|
| FHIR Element Name | Attribute Id | Attribute Name | Message Mapping | Notes |
| identifier.value | E202 | official patient identification | SG7.PNA.C206.7402 | |
| identifier.value | E294 | identification of subject of investigation by laboratory service provider | SG6.RFF.C506.1154 | |
| name.family | E313 | family name | SG7.PNA.C816(1).3836 | |
| name.given | E314 | first given name | SG7.PNA.C816(2).3836 | |
| name.given | E315 | middle name | SG7.PNA.C816(3).3836 | |
| name.prefix | E316 | title | SG7.PNA.C816(4).3836 | |
| gender | E217 | patient administrative sex | SG7.PDI.3917 | |
| birthDate | E218 | date and time of birth | SG7.DTM.C507.2380 | |
| address.line address.city |
E311 | unstructured address lines | SG6.ADR.C090.3794(1-5) | |
| address.postalCode | E307 | postal code | SG6.ADR.3251 | |
| UKCore-Organization (performing) | PMIP EDIFACT (NHS003) Mapping | |||
|---|---|---|---|---|
| FHIR Element Name | Attribute Id | Attribute Name | Message Mapping | Notes |
| identifier | ||||
| active | ||||
| name | E080 | name of healthcare organisation | SG1.NAD.C080.3036(1-2) | |
| telecom | ||||
| address | ||||
| UKCore-Practitioner (performer) | PMIP EDIFACT (NHS003) Mapping | |||
|---|---|---|---|---|
| FHIR Element Name | Attribute Id | Attribute Name | Message Mapping | Notes |
| identifier | E084 | healthcare registration identification | SG1.NAD.C082.3039 | |
| identifier | E083 | partner-agreed identification of healthcare part | SG1.RFF.C506.1154 | |
| name.family name.given name.prefix |
E092 | person name details | SG1.NAD.C080.3036(1-2) | |
| telecom | ||||
| UKCore-Practitioner (requester) | PMIP EDIFACT (NHS003) Mapping | |||
|---|---|---|---|---|
| FHIR Element Name | Attribute Id | Attribute Name | Message Mapping | Notes |
| identifier | E084 | healthcare registration identification | SG1.NAD.C082.3039 | |
| identifier | E083 | partner-agreed identification of healthcare part | SG1.RFF.C506.1154 | |
| name.family name.given name.prefix |
E092 | person name details | SG1.NAD.C080.3036(1-2) | |
| telecom | ||||
| UKCore-PractitionerRole | PMIP EDIFACT (NHS003) Mapping | |||
|---|---|---|---|---|
| FHIR Element Name | Attribute Id | Attribute Name | Message Mapping | Notes |
| identifier | ||||
| active | ||||
| period | ||||
| practitioner | ||||
| organization | ||||
| code | E095 | position of healthcare professional | SG1.SPR.C846.3812 | |
| specialty | E094 | medical specialty of healthcare professional | SG1.SPR.C845.3811 | |
| location | ||||
| telecom | ||||
| UKCore-ServiceRequest-Lab | PMIP EDIFACT (NHS003) Mapping | |||
|---|---|---|---|---|
| FHIR Element Name | Attribute Id | Attribute Name | Message Mapping | Notes |
| identifier | E152 | identification of laboratory service order by laboratory service requester | SG4.RFF.C506.1154 | 'Reference qualifier' is populated with a value of 'ROI' (Order ID by service requester). Refer to the definition of Segment Group 4 in LSR_04_A_001.doc for details. |
| identifier | E153 | identification of laboratory service order by laboratory service provider | SG4.RFF.C506.1154 | 'Reference qualifier' is populated with a value of 'SOI' (Order ID by service provider). Refer to the definition of Segment Group 4 in LSR_04_A_001.doc for details. |
| requisition | ||||
| status | ||||
| intent | ||||
| priority | ||||
| code | ||||
| subject | ||||
| authoredOn | E154 | issue date and time of laboratory service order | SG4.DTM.C507.2380 | |
| requester | ||||
| performer | ||||
| reasonCode | E045 | type of clinical observation | SG10.CIN.6810 | |
| E046 | clinical observation description | SG10.FTX.C108.4440(1-5) | ||
| reasonReference | ||||
| specimen | ||||
| note | ||||
| UKCore-Specimen | PMIP EDIFACT (NHS003) Mapping | |||
|---|---|---|---|---|
| FHIR Element Name | Attribute Id | Attribute Name | Message Mapping | Notes |
| identifier | E262 | identification of sample by laboratory service requester | SG16.RFF.C506.1154 | |
| accessionIdentifier | E263 | identification of sample by laboratory service provider | SG16.RFF.C506.1154 | |
| status | ||||
| type | E264 | type of sample | SG16.SPC.C832.7866 | |
| subject | ||||
| receivedTime | E061 | date and time of receipt of collected sample | SG16.DTM.C507.2380 | |
| request | ||||
| collection | ||||
| collection.collector | ||||
| collection.collected[x] | E050 | date and time of sample collection | SG16.DTM.C507.2380 | |
| collection.quantity.value | E055 | numerical value of amount of collected sample | SG16.QTY.C186.6060 | |
| collection.quantity.unit | E056 | unit of amount of collected sample | SG16.QTY.C848.6410 | |
| collection.bodySite | ||||
| collection.fastingStatus[x] | E225 | pre-treatment description | SG16.SPC.C832.7867 | |
| condition | ||||
| note | E271 | laboratory service provider's comments to sample | SG16.FTX.C108.4440(1-5) | |