NGS IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: PatientTWNGS - Mappings

Draft as of 2025-01-13

Mappings for the Patient-twngs resource profile.

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

PatientTWNGS
Patient	Entity. Role, or Act, Patient[classCode=PAT]
meta	n/a, N/A
implicitRules	n/a
language	n/a
text	n/a, N/A, Act.text?
contained	Entity. Role, or Act, N/A
extension	n/a, N/A
extension (age)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (nationality)	n/a, N/A
id	n/a
extension	n/a, N/A
extension (code)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (period)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
url	N/A
modifierExtension	n/a, N/A
identifier	n/a, II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT], id
id	n/a
extension	n/a, N/A
use	n/a, Role.code or implied by context
type	n/a, CD, Role.code or implied by context
id	n/a
extension	n/a, N/A
coding	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
text	n/a, ./originalText[mediaType/code="text/plain"]/data
system	n/a, II.root or Role.id.root
value	n/a, II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period	n/a, IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"], Role.effectiveTime or implied by context
assigner	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
identifier (idCardNumber)	n/a, II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT], id
id	n/a
extension	n/a, N/A
use	n/a, Role.code or implied by context
type	n/a, CD, Role.code or implied by context
id	n/a
extension	n/a, N/A
coding	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
id	n/a
extension	n/a, N/A
extension (identifier-suffix)	n/a, N/A
id	n/a
extension	n/a, N/A
extension (suffix)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (valueSet)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
url	N/A
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
text	n/a, ./originalText[mediaType/code="text/plain"]/data
system	n/a, II.root or Role.id.root
value	n/a, II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period	n/a, IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"], Role.effectiveTime or implied by context
assigner	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
identifier (medicalRecord)	n/a, II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT], id
id	n/a
extension	n/a, N/A
use	n/a, Role.code or implied by context
type	n/a, CD, Role.code or implied by context
id	n/a
extension	n/a, N/A
coding	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
text	n/a, ./originalText[mediaType/code="text/plain"]/data
system	n/a, II.root or Role.id.root
value	n/a, II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period	n/a, IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"], Role.effectiveTime or implied by context
assigner	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
active	n/a, statusCode
name	n/a, EN (actually, PN), name
name (usual)	n/a, EN (actually, PN), name
id	n/a
extension	n/a, N/A
use	n/a, unique(./use)
text	n/a, ./formatted
family	n/a, ./part[partType = FAM]
given	n/a, ./part[partType = GIV]
prefix	n/a, ./part[partType = PFX]
suffix	n/a, ./part[partType = SFX]
period	n/a, IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"], ./usablePeriod[type="IVL<TS>"]
telecom	n/a, TEL, telecom
id	n/a
extension	n/a, N/A
system	n/a, ./scheme
value	n/a, ./url
use	n/a, unique(./use)
rank	n/a
period	n/a, IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"], ./usablePeriod[type="IVL<TS>"]
gender	n/a, player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
birthDate	n/a, player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
deceased[x]	n/a, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
address	n/a, AD, addr
id	n/a
extension	n/a, N/A
extension (room)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (floor)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (number)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (alley)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (lane)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (section)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (neighborhood)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (village)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
use	n/a, unique(./use)
type	n/a, unique(./use)
text	n/a, ./formatted
line	n/a, AD.part[parttype = AL]
city	n/a, AD.part[parttype = CTY]
district	n/a, AD.part[parttype = CNT | CPA]
state	n/a, AD.part[parttype = STA]
postalCode	n/a, AD.part[parttype = ZIP]
id	n/a
extension	n/a, N/A
extension (PostalCode)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A, CD
id	n/a
extension	n/a, N/A
coding	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
coding (PostalCode3)	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
coding (PostalCode5)	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
coding (PostalCode6)	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
text	n/a, ./originalText[mediaType/code="text/plain"]/data
country	n/a, AD.part[parttype = CNT]
period	n/a, IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"], ./usablePeriod[type="IVL<TS>"]
maritalStatus	n/a, CD, player[classCode=PSN]/maritalStatusCode
id	n/a
extension	n/a, N/A
coding	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
text	n/a, ./originalText[mediaType/code="text/plain"]/data
multipleBirth[x]	n/a, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
photo	n/a, ED, player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
contact	n/a, player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
id	n/a
extension	n/a, N/A
modifierExtension	n/a, N/A
relationship	n/a, CD, code
id	n/a
extension	n/a, N/A
coding	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
text	n/a, ./originalText[mediaType/code="text/plain"]/data
name	n/a, EN (actually, PN), name
id	n/a
extension	n/a, N/A
use	n/a, unique(./use)
text	n/a, ./formatted
family	n/a, ./part[partType = FAM]
given	n/a, ./part[partType = GIV]
prefix	n/a, ./part[partType = PFX]
suffix	n/a, ./part[partType = SFX]
period	n/a, IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"], ./usablePeriod[type="IVL<TS>"]
telecom	n/a, TEL, telecom
id	n/a
extension	n/a, N/A
system	n/a, ./scheme
value	n/a, ./url
use	n/a, unique(./use)
rank	n/a
period	n/a, IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"], ./usablePeriod[type="IVL<TS>"]
address	n/a, AD, addr
id	n/a
extension	n/a, N/A
extension (room)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (floor)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (number)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (alley)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (lane)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (section)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (neighborhood)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
extension (village)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A
use	n/a, unique(./use)
type	n/a, unique(./use)
text	n/a, ./formatted
line	n/a, AD.part[parttype = AL]
city	n/a, AD.part[parttype = CTY]
district	n/a, AD.part[parttype = CNT | CPA]
state	n/a, AD.part[parttype = STA]
postalCode	n/a, AD.part[parttype = ZIP]
id	n/a
extension	n/a, N/A
extension (PostalCode)	n/a, N/A
id	n/a
url	N/A
value[x]	n/a, N/A, CD
id	n/a
extension	n/a, N/A
coding	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
coding (PostalCode3)	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
coding (PostalCode5)	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
coding (PostalCode6)	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
text	n/a, ./originalText[mediaType/code="text/plain"]/data
country	n/a, AD.part[parttype = CNT]
period	n/a, IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"], ./usablePeriod[type="IVL<TS>"]
gender	n/a, player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
organization	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), scoper
period	n/a, IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"], effectiveTime
communication	n/a, LanguageCommunication
id	n/a
extension	n/a, N/A
modifierExtension	n/a, N/A
language	n/a, CD, player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
id	n/a
extension	n/a, N/A
coding	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
text	n/a, ./originalText[mediaType/code="text/plain"]/data
preferred	n/a, preferenceInd
generalPractitioner	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), subjectOf.CareEvent.performer.AssignedEntity
managingOrganization	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), scoper
link	n/a, outboundLink
id	n/a
extension	n/a, N/A
modifierExtension	n/a, N/A
other	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), id
type	n/a, typeCode

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

PatientTWNGS
Patient	ClinicalDocument.recordTarget.patientRole
identifier	.id
identifier (idCardNumber)	.id
identifier (medicalRecord)	.id
active	n/a
name	.patient.name
name (usual)	.patient.name
telecom	.telecom
gender	.patient.administrativeGenderCode
birthDate	.patient.birthTime
deceased[x]	n/a
address	.addr
maritalStatus	.patient.maritalStatusCode
multipleBirth[x]	n/a
photo	n/a
contact	n/a
relationship	n/a
name	n/a
telecom	n/a
address	n/a
gender	n/a
organization	n/a
period	n/a
communication	patient.languageCommunication
language	.languageCode
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)

PatientTWNGS
Patient
identifier	FiveWs.identifier
identifier (idCardNumber)	FiveWs.identifier
identifier (medicalRecord)	FiveWs.identifier
active	FiveWs.status

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

PatientTWNGS
Patient
identifier	CX / EI (occasionally, more often EI maps to a resource id or a URL), PID-3
use	N/A
type	CE/CNE/CWE, CX.5
coding	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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	DR, CX.7 + CX.8
assigner	CX.4 / (CX.4,CX.9,CX.10)
identifier (idCardNumber)	CX / EI (occasionally, more often EI maps to a resource id or a URL), PID-3
use	N/A
type	CE/CNE/CWE, CX.5
coding	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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	DR, CX.7 + CX.8
assigner	CX.4 / (CX.4,CX.9,CX.10)
identifier (medicalRecord)	CX / EI (occasionally, more often EI maps to a resource id or a URL), PID-3
use	N/A
type	CE/CNE/CWE, CX.5
coding	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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	DR, CX.7 + CX.8
assigner	CX.4 / (CX.4,CX.9,CX.10)
name	XPN, PID-5, PID-9
name (usual)	XPN, 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	DR, XPN.13 + XPN.14
telecom	XTN, 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	DR, N/A
gender	PID-8
birthDate	PID-7
deceased[x]	PID-30 (bool) and PID-29 (datetime)
address	XAD, PID-11
use	XAD.7
type	XAD.18
text	XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
line	XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
city	XAD.3
district	XAD.9
state	XAD.4
postalCode	XAD.5
extension
extension (PostalCode)
value[x]	CE/CNE/CWE
coding	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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
coding (PostalCode3)	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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
coding (PostalCode5)	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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
coding (PostalCode6)	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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
country	XAD.6
period	DR, XAD.12 / XAD.13 + XAD.14
maritalStatus	CE/CNE/CWE, PID-16
coding	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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
multipleBirth[x]	PID-24 (bool), PID-25 (integer)
photo	ED/RP, OBX-5 - needs a profile
contact
relationship	CE/CNE/CWE, NK1-7, NK1-3
coding	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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
name	XPN, 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	DR, XPN.13 + XPN.14
telecom	XTN, 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	DR, N/A
address	XAD, NK1-4
use	XAD.7
type	XAD.18
text	XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
line	XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
city	XAD.3
district	XAD.9
state	XAD.4
postalCode	XAD.5
extension
extension (PostalCode)
value[x]	CE/CNE/CWE
coding	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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
coding (PostalCode3)	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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
coding (PostalCode5)	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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
coding (PostalCode6)	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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
country	XAD.6
period	DR, XAD.12 / XAD.13 + XAD.14
gender	NK1-15
organization	NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
period	DR
communication
language	CE/CNE/CWE, PID-15, LAN-2
coding	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
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
preferred	PID-15
generalPractitioner	PD1-4
link
other	PID-3, MRG-1

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

PatientTWNGS
Patient
birthDate	21112-8