HL7 FHIR Implementation Guide: HealthBank IG Release 0.1.0 - TW | STU1
0.1.0 - ci-build

HL7 FHIR Implementation Guide: HealthBank IG Release 0.1.0 - TW | STU1 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: HealthBankPatient - Mappings

Draft as of 2024-08-16

Mappings for the Patient-HealthBank resource profile.

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

HealthBankPatient
Patient | Entity. Role, or Act, Patient[classCode=PAT]
text | Act.text?
contained | N/A
identifier | id
identifier (idCardNumber) | id
id | n/a
use | Role.code or implied by context
type | n/a, CD
id | n/a
coding | n/a, CV
id | n/a
system | ./codeSystem
version | ./codeSystemVersion
code | ./code
display | CV.displayName
userSelected | CD.codingRationale
text | ./originalText[mediaType/code="text/plain"]/data
system | II.root or Role.id.root
value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period | Role.effectiveTime or implied by context
assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
identifier (passportNumber) | id
id | n/a
use | Role.code or implied by context
type | n/a, CD
id | n/a
coding | n/a, CV
id | n/a
system | ./codeSystem
version | ./codeSystemVersion
code | ./code
display | CV.displayName
userSelected | CD.codingRationale
text | ./originalText[mediaType/code="text/plain"]/data
system | II.root or Role.id.root
value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period | Role.effectiveTime or implied by context
assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
identifier (residentNumber) | id
id | n/a
use | Role.code or implied by context
type | n/a, CD
id | n/a
coding | n/a, CV
id | n/a
system | ./codeSystem
version | ./codeSystemVersion
code | ./code
display | CV.displayName
userSelected | CD.codingRationale
text | ./originalText[mediaType/code="text/plain"]/data
system | II.root or Role.id.root
value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period | Role.effectiveTime or implied by context
assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
identifier (medicalRecord) | id
id | n/a
use | Role.code or implied by context
type | n/a, CD
id | n/a
coding | n/a, CV
id | n/a
system | ./codeSystem
version | ./codeSystemVersion
code | ./code
display | CV.displayName
userSelected | CD.codingRationale
text | ./originalText[mediaType/code="text/plain"]/data
system | II.root or Role.id.root
value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period | Role.effectiveTime or implied by context
assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
active | statusCode
name | name
name (official) | name
id | n/a
use | unique(./use)
text | ./formatted
family | ./part[partType = FAM]
given | ./part[partType = GIV]
prefix | ./part[partType = PFX]
suffix | ./part[partType = SFX]
period | ./usablePeriod[type="IVL<TS>"]
name (usual) | name
id | n/a
use | unique(./use)
text | ./formatted
family | ./part[partType = FAM]
given | ./part[partType = GIV]
prefix | ./part[partType = PFX]
suffix | ./part[partType = SFX]
period | ./usablePeriod[type="IVL<TS>"]
name (temp) | name
id | n/a
use | unique(./use)
text | ./formatted
period | ./usablePeriod[type="IVL<TS>"]
name (anonymous) | name
id | n/a
use | unique(./use)
text | ./formatted
period | ./usablePeriod[type="IVL<TS>"]
telecom | telecom
id | n/a
system | ./scheme
value | ./url
use | unique(./use)
rank | n/a
period | ./usablePeriod[type="IVL<TS>"]
gender | player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
birthDate | player[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
address | n/a, AD
maritalStatus | n/a, CD
multipleBirth[x] | player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
photo | player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
contact | player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
id | n/a
relationship | n/a, CD
name | name
id | n/a
use | unique(./use)
text | ./formatted
family | ./part[partType = FAM]
given | ./part[partType = GIV]
prefix | ./part[partType = PFX]
suffix | ./part[partType = SFX]
period | ./usablePeriod[type="IVL<TS>"]
telecom | telecom
id | n/a
system | ./scheme
value | ./url
use | unique(./use)
rank | n/a
period | ./usablePeriod[type="IVL<TS>"]
address | n/a, AD
gender | player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
organization | scoper
period | effectiveTime
communication | LanguageCommunication
id | n/a
language | n/a, CD
preferred | preferenceInd
generalPractitioner | subjectOf.CareEvent.performer.AssignedEntity
managingOrganization | scoper
link | outboundLink
id | n/a
other | id
type | typeCode

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

HealthBankPatient
Patient | ClinicalDocument.recordTarget.patientRole
identifier | .id
identifier (idCardNumber) | .id
identifier (passportNumber) | .id
identifier (residentNumber) | .id
identifier (medicalRecord) | .id
active | n/a
name | .patient.name
name (official) | .patient.name
name (usual) | .patient.name
name (temp) | .patient.name
name (anonymous) | .patient.name
telecom | .telecom
gender | .patient.administrativeGenderCode
birthDate | .patient.birthTime
deceased[x] | n/a
multipleBirth[x] | n/a
photo | n/a
contact | n/a
name | n/a
telecom | n/a
gender | n/a
organization | n/a
period | n/a
communication | patient.languageCommunication
preferred | .preferenceInd
generalPractitioner | n/a
managingOrganization | .providerOrganization
link | n/a
other | n/a
type | n/a

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

HealthBankPatient
Patient |
identifier | FiveWs.identifier
identifier (idCardNumber) | FiveWs.identifier
identifier (passportNumber) | FiveWs.identifier
identifier (residentNumber) | FiveWs.identifier
identifier (medicalRecord) | FiveWs.identifier
active | FiveWs.status

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

HealthBankPatient
Patient |
identifier | PID-3
identifier (idCardNumber) | PID-3
use | N/A
type | CE/CNE/CWE
coding | CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
system | C*E.3
version | C*E.7
code | C*E.1
display | C*E.2 - but note this is not well followed
userSelected | Sometimes implied by being first
text | C*E.9. But note many systems use C*E.2 for this
system | CX.4 / EI-2-4
value | CX.1 / EI.1
period | CX.7 + CX.8
assigner | CX.4 / (CX.4,CX.9,CX.10)
identifier (passportNumber) | PID-3
use | N/A
type | CE/CNE/CWE
coding | CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
system | C*E.3
version | C*E.7
code | C*E.1
display | C*E.2 - but note this is not well followed
userSelected | Sometimes implied by being first
text | C*E.9. But note many systems use C*E.2 for this
system | CX.4 / EI-2-4
value | CX.1 / EI.1
period | CX.7 + CX.8
assigner | CX.4 / (CX.4,CX.9,CX.10)
identifier (residentNumber) | PID-3
use | N/A
type | CE/CNE/CWE
coding | CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
system | C*E.3
version | C*E.7
code | C*E.1
display | C*E.2 - but note this is not well followed
userSelected | Sometimes implied by being first
text | C*E.9. But note many systems use C*E.2 for this
system | CX.4 / EI-2-4
value | CX.1 / EI.1
period | CX.7 + CX.8
assigner | CX.4 / (CX.4,CX.9,CX.10)
identifier (medicalRecord) | PID-3
use | N/A
type | CE/CNE/CWE
coding | CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
system | C*E.3
version | C*E.7
code | C*E.1
display | C*E.2 - but note this is not well followed
userSelected | Sometimes implied by being first
text | C*E.9. But note many systems use C*E.2 for this
system | CX.4 / EI-2-4
value | CX.1 / EI.1
period | CX.7 + CX.8
assigner | CX.4 / (CX.4,CX.9,CX.10)
name | PID-5, PID-9
name (official) | PID-5, PID-9
use | XPN.7, but often indicated by which field contains the name
text | implied by XPN.11
family | XPN.1/FN.1
given | XPN.2 + XPN.3
prefix | XPN.5
suffix | XPN/4
period | XPN.13 + XPN.14
name (usual) | PID-5, PID-9
use | XPN.7, but often indicated by which field contains the name
text | implied by XPN.11
family | XPN.1/FN.1
given | XPN.2 + XPN.3
prefix | XPN.5
suffix | XPN/4
period | XPN.13 + XPN.14
name (temp) | PID-5, PID-9
use | XPN.7, but often indicated by which field contains the name
text | implied by XPN.11
period | XPN.13 + XPN.14
name (anonymous) | PID-5, PID-9
use | XPN.7, but often indicated by which field contains the name
text | implied by XPN.11
period | XPN.13 + XPN.14
telecom | PID-13, PID-14, PID-40
system | XTN.3
value | XTN.1 (or XTN.12)
use | XTN.2 - but often indicated by field
rank | n/a
period | N/A
gender | PID-8
birthDate | PID-7
deceased[x] | PID-30 (bool) and PID-29 (datetime)
address | XAD
maritalStatus | CE/CNE/CWE
multipleBirth[x] | PID-24 (bool), PID-25 (integer)
photo | OBX-5 - needs a profile
contact |
relationship | CE/CNE/CWE
name | NK1-2
use | XPN.7, but often indicated by which field contains the name
text | implied by XPN.11
family | XPN.1/FN.1
given | XPN.2 + XPN.3
prefix | XPN.5
suffix | XPN/4
period | XPN.13 + XPN.14
telecom | NK1-5, NK1-6, NK1-40
system | XTN.3
value | XTN.1 (or XTN.12)
use | XTN.2 - but often indicated by field
rank | n/a
period | N/A
address | XAD
gender | NK1-15
organization | NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
communication |
language | CE/CNE/CWE
preferred | PID-15
generalPractitioner | PD1-4
link |
other | PID-3, MRG-1

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

HealthBankPatient
Patient |
birthDate | 21112-8