US Public Health Profiles Library
1.0.0 - STU1 United States of America flag

US Public Health Profiles Library, published by HL7 Public Health Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-us-ph-common-library-ig/ and changes regularly. See the Directory of published versions

Resource Profile: USPublicHealthPatient - Mappings

Active as of 2023-10-04

Mappings for the us-ph-patient resource profile.

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

USPublicHealthPatient
PatientEntity. Role, or Act, Patient[classCode=PAT]
   textAct.text?
   containedN/A
   extension
   extension (race)
      idn/a
      extension
      extension (ombCategory)
         idn/a
         extensionn/a
         urlN/A
         value[x]N/A
      extension (detailed)
         idn/a
         extensionn/a
         urlN/A
         value[x]N/A
      extension (text)
         idn/a
         extensionn/a
         urlN/A
         value[x]N/A
      extension (dataAbsentReason)ANY.nullFlavor
         idn/a
         urlN/A
         value[x]N/A
      urlN/A
   extension (ethnicity)
      idn/a
      extension
      extension (ombCategory)
         idn/a
         extensionn/a
         urlN/A
         value[x]N/A
      extension (detailed)
         idn/a
         extensionn/a
         urlN/A
         value[x]N/A
      extension (text)
         idn/a
         extensionn/a
         urlN/A
         value[x]N/A
      extension (dataAbsentReason)ANY.nullFlavor
         idn/a
         urlN/A
         value[x]N/A
      urlN/A
   extension (birthsex)player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
   modifierExtensionN/A
   identifierid
      idn/a
      extensionn/a
      extension (dataAbsentReason)ANY.nullFlavor
         idn/a
         urlN/A
         value[x]N/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
      idn/a
      extensionn/a
      extension (dataAbsentReason)ANY.nullFlavor
         idn/a
         urlN/A
         value[x]N/A
      useunique(./use)
      text./formatted
      family./part[partType = FAM]
      given./part[partType = GIV]
      prefix./part[partType = PFX]
      suffix./part[partType = SFX]
      period./usablePeriod[type="IVL<TS>"]
   telecomtelecom
      idn/a
      extensionn/a
      extension (dataAbsentReason)ANY.nullFlavor
         idn/a
         urlN/A
         value[x]N/A
      system./scheme
      value./url
      useunique(./use)
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   telecom (phone)telecom
      idn/a
      extensionn/a
      extension (dataAbsentReason)ANY.nullFlavor
      system./scheme
      value./url
      useunique(./use)
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   telecom (email)telecom
      idn/a
      extensionn/a
      extension (dataAbsentReason)ANY.nullFlavor
      system./scheme
      value./url
      useunique(./use)
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   genderplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
      extension
      extension (dataAbsentReason)ANY.nullFlavor
         idn/a
         urlN/A
         value[x]N/A
   birthDateplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
      extension
      extension (dataAbsentReason)ANY.nullFlavor
         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
      extensionn/a
      extension (dataAbsentReason)ANY.nullFlavor
         idn/a
         urlN/A
         value[x]N/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
      extensionn/a
      modifierExtensionN/A
      relationshipcode
      namename
         idn/a
         extensionn/a
         extension (dataAbsentReason)ANY.nullFlavor
            idn/a
            urlN/A
            value[x]N/A
         useunique(./use)
         text./formatted
         family./part[partType = FAM]
         given./part[partType = GIV]
         prefix./part[partType = PFX]
         suffix./part[partType = SFX]
         period./usablePeriod[type="IVL<TS>"]
      telecomtelecom
         idn/a
         extensionn/a
         extension (dataAbsentReason)ANY.nullFlavor
            idn/a
            urlN/A
            value[x]N/A
         system./scheme
         value./url
         useunique(./use)
         rankn/a
         period./usablePeriod[type="IVL<TS>"]
      addressaddr
         idn/a
         extensionn/a
         extension (dataAbsentReason)ANY.nullFlavor
            idn/a
            urlN/A
            value[x]N/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>"]
      genderplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
      organizationscoper
      periodeffectiveTime
   communicationLanguageCommunication
      idn/a
      extensionn/a
      modifierExtensionN/A
      languageplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
         idn/a
         extensionn/a
         extension (dataAbsentReason)ANY.nullFlavor
            idn/a
            urlN/A
            value[x]N/A
         codingunion(., ./translation)
         text./originalText[mediaType/code="text/plain"]/data
      preferredpreferenceInd
   generalPractitionersubjectOf.CareEvent.performer.AssignedEntity
   managingOrganizationscoper
   linkoutboundLink
      idn/a
      extensionn/a
      modifierExtensionN/A
      otherid
      typetypeCode

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

USPublicHealthPatient
PatientClinicalDocument.recordTarget.patientRole
   identifier.id
   activen/a
   name.patient.name
   telecom.telecom
   telecom (phone).telecom
   telecom (email).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)

USPublicHealthPatient
Patient
   identifierFiveWs.identifier
   activeFiveWs.status

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

USPublicHealthPatient
Patient
   identifierPID-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
      useXPN.7, but often indicated by which field contains the name
      textimplied by XPN.11
      familyXPN.1/FN.1
      givenXPN.2 + XPN.3
      prefixXPN.5
      suffixXPN/4
      periodXPN.13 + XPN.14
   telecomPID-13, PID-14, PID-40
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   telecom (phone)PID-13, PID-14, PID-40
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   telecom (email)PID-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
         useXPN.7, but often indicated by which field contains the name
         textimplied by XPN.11
         familyXPN.1/FN.1
         givenXPN.2 + XPN.3
         prefixXPN.5
         suffixXPN/4
         periodXPN.13 + XPN.14
      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
         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
      genderNK1-15
      organizationNK1-13, NK1-30, NK1-31, NK1-32, NK1-41
   communication
      languagePID-15, LAN-2
         codingC*E.1-8, C*E.10-22
         textC*E.9. But note many systems use C*E.2 for this
      preferredPID-15
   generalPractitionerPD1-4
   link
      otherPID-3, MRG-1

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

USPublicHealthPatient
Patient
   birthDate21112-8