CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®)
1.1.0 - STU1 Update

This page is part of the CARIN Blue Button Implementation Guide (v1.1.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: C4BBPatient - Mappings

Mappings for the C4BB-Patient resource profile.

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

C4BBPatient
PatientEntity. Role, or Act, Patient[classCode=PAT]
   meta
      idn/a
      extensionn/a
   textAct.text?
   containedN/A
   extension (birthsex)player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
   modifierExtensionN/A
   identifierid
      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
   identifier (memberid)id
      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
   identifier (uniquememberid)id
      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
   activestatusCode
   namename
      idn/a
      extensionn/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
      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
   deceased[x]player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
   deceased[x] (deceasedDateTime)player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
   deceased[x] (deceasedBoolean)player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
   addressaddr
      idn/a
      extensionn/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
      telecomtelecom
      addressaddr
      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
      preferredpreferenceInd
   generalPractitionersubjectOf.CareEvent.performer.AssignedEntity
   managingOrganizationscoper
   linkoutboundLink
      idn/a
      extensionn/a
      modifierExtensionN/A
      otherid
      typetypeCode

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

C4BBPatient
PatientClinicalDocument.recordTarget.patientRole
   identifier.id
   identifier (memberid).id
   identifier (uniquememberid).id
   activen/a
   name.patient.name
   telecom.telecom
   gender.patient.administrativeGenderCode
   birthDate.patient.birthTime
   deceased[x]n/a
   deceased[x] (deceasedDateTime)n/a
   deceased[x] (deceasedBoolean)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)

C4BBPatient
Patient
   identifierFiveWs.identifier
   identifier (memberid)FiveWs.identifier
   identifier (uniquememberid)FiveWs.identifier
   activeFiveWs.status

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

C4BBPatient
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)
   identifier (memberid)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)
   identifier (uniquememberid)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
      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
   genderPID-8
   birthDatePID-7
   deceased[x]PID-30 (bool) and PID-29 (datetime)
   deceased[x] (deceasedDateTime)PID-30 (bool) and PID-29 (datetime)
   deceased[x] (deceasedBoolean)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
      addressNK1-4
      genderNK1-15
      organizationNK1-13, NK1-30, NK1-31, NK1-32, NK1-41
   communication
      languagePID-15, LAN-2
      preferredPID-15
   generalPractitionerPD1-4
   link
      otherPID-3, MRG-1

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

C4BBPatient
Patient
   birthDate21112-8