View source for FHIR Store Mappings

=== Introduction ===
This page describes the mapping between the [[Publisher API HL7 Segments|HL7v2 segments]] that DDS can ingest and the FHIR Resources (TODO link to profiles) that DDS uses to represent them internally.

There are two kinds ways that values are written into the internal FHIR store when mapping from an inbound HL7v2 message - 

# Dynamic values - here the raw value from the inbound HL7v2 message is copied into a property on a FHIR resource
# Fixed values - here the value that is inserted into a FHIR resource is fixed and is not copied from the source message. Instead the value that is inserted is likely to be contingent on the presence and/or value of a field from the source message

The relationship between HL7v2 segments and the FHIR resources that they populate is also diagrammed in the Entity Relationship section.

=== Dynamic Values ===
==== [[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]] ====
{| class="wikitable"
!Field
!Component
!Resource
!Property
!References
!Condition
|-
|PID:3
|PID:3.1
|Encounter
|patient
|Patient
|
|-
|PID:3
|PID:3.1
|EpisodeOfCare
|patient
|Patient
|
|-
|PID:3
|PID:3.1
|Patient
|identifier.value
|
|if PID:3.4 == "MRN" then set to PID:3.1
|-
|PID:3
|PID:3.4
|Patient
|identifier.system
|
|
|-
|PID:3
|PID:3.1
|Patient
|identifier.value
|
|if PID:3.4 == "NHS" then set to PID.3.1
|-
|PID:5
|PID:5.1
|Patient
|name.family
|
|
|-
|PID:5
|PID:5.2
|Patient
|name.given
|
|
|-
|PID:5
|PID:5.3
|Patient
|name.middle
|
|
|-
|PID:5
|PID:5.5
|Patient
|name.prefix
|
|
|-
|PID:7
|PID:7.1
|Patient
|birthDate
|
|
|-
|PID:8
|PID:8.1
|Patient
|gender
|
|
|-
|PID:11
|PID:11.1
|Patient
|address.line
|
|
|-
|PID:11
|PID:11.2
|Patient
|address.line
|
|
|-
|PID:11
|PID:11.3
|Patient
|address.city
|
|
|-
|PID:11
|PID:11.5
|Patient
|address.postalCode
|
|
|-style='background-color: #ddd;'
|PID:11
|PID:11.6
|Patient
|address.country
|
|
|-
|PID:11
|PID:11.9
|Patient
|address.district
|
|
|-
|PID:13
|PID:13.1
|Patient
|telecom.value
|
|
|-
|PID:13
|PID:13.2
|Patient
|telecom.use
|
|if PID:13.2 == 'PRS' then set to "mobile"
if PID:13.2 == 'PRN' then set to "home"
|-style='background-color: #ddd;'
|PID:13
|PID:13.4
|Patient
|telecom.value
|
|if PID:13.2 == 'NET' then set to PID:13.4
|-style='background-color: #ddd;'
|PID:14
|PID:14.1
|Patient
|telecom.value
|
|
|-style='background-color: #ddd;'
|PID:14
|PID:14.4
|Patient
|telecom.value
|
|if PID:14.2 == 'NET' then set to PID:14.4
|-
|PID:15
|PID:15.1
|Patient
|communication.language
|
|
|-style='background-color: #ddd;'
|PID:15
|PID:15.4
|Patient
|communication.language
|
|
|-
|PID:18
|PID:18.1
|Encounter
|contained.Parameters.parameter.valueCodeableConcept.coding.code
|Patient
|
|-
|PID:22
|PID:22.1
|Patient
|http://endeavourhealth.org/fhir/StructureDefinition/primarycare-ethnic-category-extension
|
|
|-
|PID:29
|PID:29.1
|Patient
|deceased
|
|
|}
==== [[Publisher API HL7 Segments#PD1 - Patient Additional Demographic|PD1 - Patient Additional Demographic]] ====
{| class="wikitable"
!Field
!Component
!Resource
!Property
!References
!Condition
|-
|PD1:3
|PD1:3.1
|Organization
|identifier.name
|
|
|-
|PD1:3
|PD1:3.3
|Organization
|identifier.value
|
|
|-
|PD1:3
|PD1:3.3
|Patient
|careProvider
|Organization
|
|-
|PD1:4
|PD1:4.1
|Patient
|careProvider
|Practitioner
|
|}
==== [[Publisher API HL7 Segments#PV1 - Patient Visit|PV1 - Patient Visit]] ====
{| class="wikitable"
!Field
!Component
!Resource
!Property
!References
!Condition
|-
|PV1:2
|PV1:2.1
|Encounter
|class
|
|
|-
|PV1:3
|PV1:3.9
|Encounter
|location (current)
|Location
|
|-
|PV1:3
|PV1:3.9
|Location
|identifier
|
|
|-
|PV1:3
|PV1:3.9
|Location
|name
|
|
|-
|PV1:3
|PV1:3.9
|Location
|description
|
|
|-
|PV1:4
|PV1:4.1
|Encounter
|contained.Parameters.parameter.name
|
|if PV1:4 is not empty then set to "DM_methodOfAdmssion"
|-
|PV1:4
|PV1:4.1
|Encounter
|contained.Parameters.parameter.valueCodeableConcept.coding.code
|
|
|-style='background-color: #ddd;'
|PV1:6
|PV1:6.9
|Encounter
|location (prior)
|Location
|
|-style='background-color: #ddd;'
|PV1:6
|PV1:6.9
|Location
|identifier
|
|
|-style='background-color: #ddd;'
|PV1:7
|PV1:7.1
|Encounter
|participant (attending clinician)
|Practitioner
|
|-style='background-color: #ddd;'
|PV1:7
|PV1:7.1
|Practitioner
|identifier.value
|
|
|-style='background-color: #ddd;'
|PV1:7
|
|Practitioner
|identifier.system
|
|if PV1:7 is not empty then set to ? (need to find a type system)
|-style='background-color: #ddd;'
|PV1:7
|PV1:7.2
|Practitioner
|name.family
|
|
|-style='background-color: #ddd;'
|PV1:7
|PV1:7.3
|Practitioner
|name.given
|
|
|-style='background-color: #ddd;'
|PV1:7
|PV1:7.4
|Practitioner
|name.given
|
|
|-style='background-color: #ddd;'
|PV1:7
|PV1:7.6
|Practitioner
|name.prefix
|
|
|-
|PV1:8
|PV1:8.1
|Encounter
|participant (consulting clinician)
|Practitioner
|
|-
|PV1:8
|PV1:8.1
|Practitioner
|identifier.value
|
|
|-
|PV1:8
|PV1:8.2
|Practitioner
|name.family
|
|
|-
|PV1:8
|PV1:8.3
|Practitioner
|name.given
|
|
|-style='background-color: #ddd;'
|PV1:8
|PV1:8.4
|Practitioner
|name.given
|
|
|-style='background-color: #ddd;'
|PV1:8
|PV1:8.6
|Practitioner
|name.prefix
|
|
|-
|PV1:9
|PV1:9.1
|EpisodeOfCare
|careManager
|
|
|-
|PV1:9
|PV1:9.1
|Encounter
|participant (referring clinician)
|Practitioner
|
|-
|PV1:9
|PV1:9.1
|Practitioner
|identifier.value
|
|
|-
|PV1:9
|PV1:9.2
|Practitioner
|name.family
|
|
|-
|PV1:9
|PV1:9.3
|Practitioner
|name.given
|
|
|-style='background-color: #ddd;'
|PV1:9
|PV1:9.4
|Practitioner
|name.given
|
|
|-style='background-color: #ddd;'
|PV1:9
|PV1:9.6
|Practitioner
|name.prefix
|
|
|-
|PV1:14
|PV1:14.1
|Encounter
|contained.Parameters.parameter.valueCodeableConcept.coding.code
|
|
|-
|PV1:18
|PV1:18.1
|Encounter
|type
|
|
|-
|PV1:19
|PV1:19.1
|Encounter
|episodeOfCare
|EpisodeOfCare
|
|-
|PV1:36
|PV1:36.1
|Encounter
|contained.Parameters.parameter.valueCodeableConcept.coding.code
|
|
|-
|PV1:37
|PV1:37.1
|Encounter
|contained.Parameters.parameter.valueCodeableConcept.coding.code
|
|
|-
|PV1:44
|PV1:44.1
|Encounter
|period.start
|
|
|-
|PV1:44
|PV1:44.1
|EpisodeOfCare
|startDt
|
|
|-
|PV1:45
|PV1:45.1
|Encounter
|period.end
|
|
|-
|PV1:45
|PV1:45.1
|EpisodeOfCare
|endDt
|
|
|}
==== [[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]] ====
{| class="wikitable"
!Field
!Component
!Resource
!Property
!References
!Condition
|-
|MSH:3
|MSH:3.1
|EpisodeOfCare
|managingOrganization
|Organization
|
|-
|MSH:3
|MSH:3.1
|Organization
|identifier.name
|
|
|-
|MSH:3
|MSH:3.3
|Organization
|identifier.value
|
|
|}

==== [[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient Allergy Information]] ====
{| class="wikitable"
!Field
!Component
!Resource
!Property
!References
!Condition
|-style='background-color: #ddd;'
|AL1:2
|AL1:2.1
|AllergyIntolerance
|category
|
|
|-style='background-color: #ddd;'
|AL1:3
|AL1:3.1
|AllergyIntolerance
|substance.coding.code
|
|
|-style='background-color: #ddd;'
|AL1:3
|AL1:3.2
|AllergyIntolerance
|substance.coding.display
|
|
|-style='background-color: #ddd;'
|AL1:3
|AL1:3.3
|AllergyIntolerance
|substance.coding.system
|
|
|-style='background-color: #ddd;'
|AL1:4
|AL1:4.1
|AllergyIntolerance
|reaction[].severity.code
|
|
|-style='background-color: #ddd;'
|AL1:5
|AL1:5.1
|AllergyIntolerance
|reaction[].manifestation.coding.code
|
|
|-style='background-color: #ddd;'
|AL1:5
|AL1:5.2
|AllergyIntolerance
|reaction[].manifestation.coding.display
|
|
|-style='background-color: #ddd;'
|AL1:5
|AL1:5.3
|AllergyIntolerance
|reaction[].manifestation.coding.system
|
|
|-style='background-color: #ddd;'
|AL1:6
|AL1:6.1
|AllergyIntolerance
|reaction[].onset
|
|
|}

==== [[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]] ====
{| class="wikitable"
!Field
!Component
!Resource
!Property
!References
!Condition
|- style="background-color: #ddd;"
|DG1:3
|DG1:3.1
|Condition
|substance.coding.code
|
|
|- style="background-color: #ddd;"
|DG1:3
|DG1:3.2
|Condition
|substance.coding.display
|
|
|- style="background-color: #ddd;"
|DG1:3
|DG1:3.3
|Condition
|substance.coding.system
|
|
|- style="background-color: #ddd;"
|DG1:4
|DG1:4.1
|Condition
|reaction[].severity.code
|
|
|- style="background-color: #ddd;"
|DG1:5
|DG1:5.1
|Condition
|reaction[].manifestation.coding.code
|
|
|-style="background-color: #ddd;"
|DG1:16
|DG1:16.1
|Condition
|asserter
|Practitioner
|
|-style="background-color: #ddd;"
|DG1:16
|DG1:16.1
|Practitioner
|identifier.value
|
|
|- style="background-color: #ddd;"
|DG1:16
|DG1:16.2
|Practitioner
|name.family
|
|
|- style="background-color: #ddd;"
|DG1:16
|DG1:16.3
|Practitioner
|name.given
|
|
|- style="background-color: #ddd;"
|DG1:16
|DG1:16.4
|Practitioner
|name.given
|
|
|-style="background-color: #ddd;"
|DG1:16
|DG1:16.6
|Practitioner
|name.prefix
|
|
|-style="background-color: #ddd;"
|DG1:17
|DG1:17.1
|Condition
|requires a new extension
|
|
|}
==== [[Publisher API HL7 Segments#PR1 - Procedures|PR1 - Procedures]] ====
{| class="wikitable"
!Field
!Component
!Resource
!Property
!References
!Condition
|- style="background-color: #ddd;"
|PR1:3
|PR1:3.1
|Procedure
|code.coding.code
|
|
|- style="background-color: #ddd;"
|PR1:3
|PR1:3.2
|Procedure
|code.coding.display
|
|
|- style="background-color: #ddd;"
|PR1:3
|PR1:3.3
|Procedure
|code.coding.system
|
|
|- style="background-color: #ddd;"
|PR1:4
|PR1:4.1
|Procedure
|code.text
|
|
|- style="background-color: #ddd;"
|PR1:5
|PR1:5.1
|Procedure
|performedDateTime
|
|
|-style="background-color: #ddd;"
|PR1:6
|PR1:6.1
|Procedure
|category
|
|
|}

==== [[Publisher API HL7 Segments#OBR_-_Observation_Request|OBR - Observation Request]] ====
{| class="wikitable"
!Field
!Component
!Resource
!Property
!References
!Condition
|- style="background-color: #ddd;"
|OBR:3
|OBR:3.1
|DiagnosticReport
|identifier.value
|
|
|- style="background-color: #ddd;"
|OBR:24
|OBR:24.1
|DiagnosticReport
|category.coding.system
|
|if MSH:3.1 != "RADIOLOGY"
|- style="background-color: #ddd;"
|OBR:4
|OBR:4.1
|DiagnosticReport
|code.coding.code
|
|
|- style="background-color: #ddd;"
|OBR:4
|OBR:4.2
|DiagnosticReport
|code.text
|
|
|- style="background-color: #ddd;"
|OBR:4
|OBR:4.2
|DiagnosticReport
|code.coding.display
|
|
|-style="background-color: #ddd;"
|OBR:7
|OBR:7.1
|DiagnosticReport
|subject
|Patient
|
|}

=== Fixed Values ===
==== [[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]] ====
{| class="wikitable"
!Resource
!Property
!Value
|-
|Patient
|identifier.system
|if PID:3.4 == "NHS" then set to "https://fhir.hl7.org.uk/Id/nhs-number"
|-
|Patient
|address.use
|if PID:11.7 == 'TEMPORARY' then set to 'temp' else set to 'home'
|-style='background-color: #ddd;'
|Patient
|telecom.use
|set to "work"
|-style='background-color: #ddd;'
|Patient
|communication.preferred
|if PID:15.1 is not empty then set to "true"
|-style='background-color: #ddd;'
|Patient
|communication.preferred
|if PID:15.4 is not empty then set to "false"
|-
|Encounter
|contained.Parameters.parameter.name
|if PID:18 is not empty then set to "CM_PatientFIN"
|-
|Encounter
|contained.Parameters.parameter.valueCodeableConcept.coding.system
|if PID:18 is not empty then set to ? (need a code system here)
|}
==== [[Publisher API HL7 Segments#PD1 - Patient Additional Demographic|PD1 - Patient Additional Demographic]] ====
{| class="wikitable"
!Resource
!Property
!Value
|-
|Organization
|identifier.system
|if PD1:3.3 is not empty then set to "http://fhir.nhs.net/Id/ods-organization-code"
|-
|Organization
|identifier.type
|if PD1:3.3 is not empty then set to "official"
|-
|Organization
|type.system
|if PD1:3.3 is not empty then set to "http://endeavourhealth.org/fhir/ValueSet/primarycare-organization-type"
|-
|Organization
|type.code
|if PD1:3.3 is not empty then set to "PR"
|-
|Organization
|type.display
|if PD1:3.3 is not empty then set to "GP Practices in England and Wales"
|}
==== [[Publisher API HL7 Segments#PV1 - Patient Visit|PV1 - Patient Visit]] ====
{| class="wikitable"
!Resource
!Property
!Value
|-
|Location
|status
|if PV1:3.9 is not empty then set to "ACTIVE"
|-
|Encounter
|contained.Parameters.parameter.valueCodeableConcept.coding.system
|if PV1:4 is not empty then set to ? (need a code system here)
|-style='background-color: #ddd;'
|Location
|status
|if PV1:6.9 is not empty then set to "ACTIVE"
|-
|Practitioner
|identifier.system
|if PV1:8 is not empty then set to "http://endeavourhealth.org/fhir/Identifier/gmp-ppd-code"
|-
|Practitioner
|identifier.system
|if PV1:9 is not empty then set to "http://endeavourhealth.org/fhir/Identifier/gmp-ppd-code"
|-
|Encounter
|contained.Parameters.parameter.name
|if PV1:14 is not empty then set to "DM_sourceOfAdmission"
|-
|Encounter
|contained.Parameters.parameter.valueCodeableConcept.coding.system
|if PV1:14 is not empty then set to ? (need a code system here)
|-
|Encounter
|contained.Parameters.parameter.name
|if PV1:36 is not empty then set to "DM_dischargeMethod"
|-
|Encounter
|contained.Parameters.parameter.valueCodeableConcept.coding.system
|if PV1:36 is not empty then set to ? (need a code system here)
|-
|Encounter
|contained.Parameters.parameter.name
|if PV1:37 is not empty then set to "DM_destination"
|-
|Encounter
|contained.Parameters.parameter.valueCodeableConcept.coding.system
|if PV1:37 is not empty then set to ? (need a code system here)
|}
==== [[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]] ====
{| class="wikitable"
!Resource
!Property
!Value
|-
|Organization
|identifier.system
|if MSH:3.3 is not empty then set to "http://fhir.nhs.net/Id/ods-organization-code"
|-
|Organization
|identifier.system
|if MSH:3.3 is not empty then set to "official"
|}
==== [[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]] ====
{| class="wikitable"
!Resource
!Property
!Value
|-
|Practitioner
|identifier.system
|if DG1:16.1 is not empty then set to TODO
|}

=== Entity Relationship ===
The section describes how the references between FHIR resources are created. It shows where the references are sourced from in the original HL7v2 messages. This section is presented as a series of diagrams each centered around a main FHIR resource. On the left are the source segments mapping into the main FHRI resource in the middle. On the right are the FHIR resources that those mappings then reference. Note that the origin on the data held within each FHIR resource is detailed in the tables above - this section is purely concerned with references between resources.

==== Encounter ====
[[File:Hl7 to fhir encounter3.png]]

==== Patient ====
[[File:Hl7 to fhir patient.png]]

==== AllergyIntolerance, Condition and Procedure ====
All three of AllergyIntolerance, Condition and Procedure reference the same resources and use the same HL7 fields to create the relationship

[[File:Hl7 to fhir allergy-condition-procedure2.png]]

==== EpisodeOfCare ====
[[File:Hl7 to fhir episodeofcare.png]]