HL7 UK - UK Core Access
0.1.0 - ci-build United Kingdom flag

HL7 UK - UK Core Access, published by HL7 UK. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-UK/UK-Core-Access/ and changes regularly. See the Directory of published versions

Resource Profile: UKCorePatient - Mappings

Active as of 2022-08-26

Mappings for the UKCore-Patient resource profile.

Mappings for RIM Mapping (http://hl7.org/v3)

UKCorePatient
PatientEntity. Role, or Act, Patient[classCode=PAT]
   textAct.text?
   containedN/A
   extension
   extension (birthPlace)
      idn/a
      urlN/A
      value[x]N/A
   extension (birthSex)
   extension (cadavericDonor)
      idn/a
      urlN/A
      value[x]N/A
   extension (contactPreference)
   extension (deathNotificationStatus)
   extension (ethnicCategory)
   extension (residentialStatus)
   extension (patientInterpreterRequired)
      idn/a
      urlN/A
      value[x]N/A
   modifierExtensionN/A
   identifierid
   identifier (nhsNumber)id
      idn/a
      useRole.code or implied by context
      typeRole.code or implied by context
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      periodRole.effectiveTime or implied by context
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   activestatusCode
   namename
   telecomtelecom
      idn/a
      extensionn/a
      system./scheme
      value./url
      useunique(./use)
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   genderplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
   birthDateplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
      extension
      extension (birthTime)
         idn/a
         urlN/A
         value[x]N/A
   deceased[x]player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
   addressaddr
      idn/a
      useunique(./use)
      typeunique(./use)
      text./formatted
      lineAD.part[parttype = AL]
      cityAD.part[parttype = CTY]
      districtAD.part[parttype = CNT | CPA]
      stateAD.part[parttype = STA]
      postalCodeAD.part[parttype = ZIP]
      countryAD.part[parttype = CNT]
      period./usablePeriod[type="IVL<TS>"]
   maritalStatusplayer[classCode=PSN]/maritalStatusCode
   multipleBirth[x]player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
   photoplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
   contactplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
      idn/a
      modifierExtensionN/A
      relationshipcode
      namename
      telecomtelecom
         idn/a
         extensionn/a
         system./scheme
         value./url
         useunique(./use)
         rankn/a
         period./usablePeriod[type="IVL<TS>"]
      addressaddr
      genderplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
      organizationscoper
         idn/a
         extensionn/a
         referenceN/A
         typeN/A
         identifier.identifier
            idn/a
            extensionn/a
            useRole.code or implied by context
            typeRole.code or implied by context
            systemII.root or Role.id.root
            valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
            periodRole.effectiveTime or implied by context
            assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
         displayN/A
      periodeffectiveTime
   communicationLanguageCommunication
      idn/a
      extension
      extension (proficiency)
         idn/a
         extension
         extension (level)
            idn/a
            urlN/A
            value[x]N/A
         extension (type)
            idn/a
            urlN/A
            value[x]N/A
         urlN/A
      modifierExtensionN/A
      languageplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
      preferredpreferenceInd
   generalPractitionersubjectOf.CareEvent.performer.AssignedEntity
      idn/a
      extensionn/a
      referenceN/A
      typeN/A
      identifier.identifier
         idn/a
         extensionn/a
         useRole.code or implied by context
         typeRole.code or implied by context
         systemII.root or Role.id.root
         valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
         periodRole.effectiveTime or implied by context
         assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
      displayN/A
   managingOrganizationscoper
      idn/a
      extensionn/a
      referenceN/A
      typeN/A
      identifier.identifier
         idn/a
         extensionn/a
         useRole.code or implied by context
         typeRole.code or implied by context
         systemII.root or Role.id.root
         valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
         periodRole.effectiveTime or implied by context
         assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
      displayN/A
   linkoutboundLink
      idn/a
      extensionn/a
      modifierExtensionN/A
      otherid
         idn/a
         extensionn/a
         referenceN/A
         typeN/A
         identifier.identifier
            idn/a
            extensionn/a
            useRole.code or implied by context
            typeRole.code or implied by context
            systemII.root or Role.id.root
            valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
            periodRole.effectiveTime or implied by context
            assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
         displayN/A
      typetypeCode

Mappings for CDA (R2) (http://hl7.org/v3/cda)

UKCorePatient
PatientClinicalDocument.recordTarget.patientRole
   identifier.id
   identifier (nhsNumber).id
   activen/a
   name.patient.name
   telecom.telecom
   gender.patient.administrativeGenderCode
   birthDate.patient.birthTime
   deceased[x]n/a
   address.addr
   maritalStatus.patient.maritalStatusCode
   multipleBirth[x]n/a
   photon/a
   contactn/a
      relationshipn/a
      namen/a
      telecomn/a
      addressn/a
      gendern/a
      organizationn/a
      periodn/a
   communicationpatient.languageCommunication
      language.languageCode
      preferred.preferenceInd
   generalPractitionern/a
   managingOrganization.providerOrganization
   linkn/a
      othern/a
      typen/a

Mappings for FiveWs Pattern Mapping (http://hl7.org/fhir/fivews)

UKCorePatient
Patient
   identifierFiveWs.identifier
   identifier (nhsNumber)FiveWs.identifier
   activeFiveWs.status

Mappings for HL7 v2 Mapping (http://hl7.org/v2)

UKCorePatient
Patient
   identifierPID-3
   identifier (nhsNumber)PID-3
      useN/A
      typeCX.5
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      periodCX.7 + CX.8
      assignerCX.4 / (CX.4,CX.9,CX.10)
   namePID-5, PID-9
   telecomPID-13, PID-14, PID-40
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   genderPID-8
   birthDatePID-7
   deceased[x]PID-30 (bool) and PID-29 (datetime)
   addressPID-11
      useXAD.7
      typeXAD.18
      textXAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
      lineXAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
      cityXAD.3
      districtXAD.9
      stateXAD.4
      postalCodeXAD.5
      countryXAD.6
      periodXAD.12 / XAD.13 + XAD.14
   maritalStatusPID-16
   multipleBirth[x]PID-24 (bool), PID-25 (integer)
   photoOBX-5 - needs a profile
   contact
      relationshipNK1-7, NK1-3
      nameNK1-2
      telecomNK1-5, NK1-6, NK1-40
         systemXTN.3
         valueXTN.1 (or XTN.12)
         useXTN.2 - but often indicated by field
         rankn/a
         periodN/A
      addressNK1-4
      genderNK1-15
      organizationNK1-13, NK1-30, NK1-31, NK1-32, NK1-41
         identifier
            useN/A
            typeCX.5
            systemCX.4 / EI-2-4
            valueCX.1 / EI.1
            periodCX.7 + CX.8
            assignerCX.4 / (CX.4,CX.9,CX.10)
   communication
      languagePID-15, LAN-2
      preferredPID-15
   generalPractitionerPD1-4
      identifier
         useN/A
         typeCX.5
         systemCX.4 / EI-2-4
         valueCX.1 / EI.1
         periodCX.7 + CX.8
         assignerCX.4 / (CX.4,CX.9,CX.10)
   managingOrganization
      identifier
         useN/A
         typeCX.5
         systemCX.4 / EI-2-4
         valueCX.1 / EI.1
         periodCX.7 + CX.8
         assignerCX.4 / (CX.4,CX.9,CX.10)
   link
      otherPID-3, MRG-1
         identifier
            useN/A
            typeCX.5
            systemCX.4 / EI-2-4
            valueCX.1 / EI.1
            periodCX.7 + CX.8
            assignerCX.4 / (CX.4,CX.9,CX.10)

Mappings for LOINC code for the element (http://loinc.org)

UKCorePatient
Patient
   birthDate21112-8