Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• History

Resource Profile: InterweavePatient - Mappings

Draft as of 2024-07-15

Mappings for the Interweave-Patient resource profile.

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

InterweavePatient
Patient	Entity. Role, or Act, Patient[classCode=PAT]
meta
extension	n/a
tag
tag (Source)
extension	n/a
system	./codeSystem
code	./code
display	CV.displayName
userSelected	CD.codingRationale
tag (Provenance)
extension	n/a
system	./codeSystem
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	Act.text?
contained	N/A
extension
extension (birthPlace)
id	n/a
url	N/A
value[x]	N/A
extension (birthSex)
extension (cadavericDonor)
id	n/a
url	N/A
value[x]	N/A
extension (contactPreference)
extension (deathNotificationStatus)
extension (ethnicCategory)
id	n/a
url	N/A
value[x]	N/A
extension (residentialStatus)
extension (patientInterpreterRequired)
id	n/a
url	N/A
value[x]	N/A
modifierExtension	N/A
identifier	id
identifier (nhsNumber)	id
id	n/a
extension	n/a
extension (nhsNumberVerificationStatus)
id	n/a
url	N/A
value[x]	N/A
use	Role.code or implied by context
type	Role.code or implied by context
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
extension	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 (other)	name
id	n/a
extension	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
extension	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
extension
extension (birthTime)
id	n/a
url	N/A
value[x]	N/A
deceased[x]	player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
address	addr
id	n/a
extension	n/a
use	unique(./use)
type	unique(./use)
text	./formatted
line	AD.part[parttype = AL]
city	AD.part[parttype = CTY]
district	AD.part[parttype = CNT | CPA]
state	AD.part[parttype = STA]
postalCode	AD.part[parttype = ZIP]
country	AD.part[parttype = CNT]
period	./usablePeriod[type="IVL<TS>"]
maritalStatus	player[classCode=PSN]/maritalStatusCode
multipleBirth[x]	player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
contact	player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
id	n/a
modifierExtension	N/A
relationship	code
id	n/a
extension	n/a
coding	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
name	name
id	n/a
extension	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
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
address	addr
id	n/a
extension	n/a
use	unique(./use)
type	unique(./use)
text	./formatted
line	AD.part[parttype = AL]
city	AD.part[parttype = CTY]
district	AD.part[parttype = CNT | CPA]
state	AD.part[parttype = STA]
postalCode	AD.part[parttype = ZIP]
country	AD.part[parttype = CNT]
period	./usablePeriod[type="IVL<TS>"]
gender	player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
organization	scoper
period	effectiveTime
communication	LanguageCommunication
id	n/a
extension
extension (proficiency)
id	n/a
extension	n/a
extension (level)
id	n/a
url	N/A
value[x]	N/A
extension (type)
id	n/a
url	N/A
value[x]	N/A
url	N/A
modifierExtension	N/A
language	player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
preferred	preferenceInd
generalPractitioner	subjectOf.CareEvent.performer.AssignedEntity
managingOrganization	scoper
link	outboundLink
id	n/a
extension	n/a
modifierExtension	N/A
other	id
type	typeCode

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

InterweavePatient
Patient	ClinicalDocument.recordTarget.patientRole
identifier	.id
identifier (nhsNumber)	.id
active	n/a
name	.patient.name
name (official)	.patient.name
name (other)	.patient.name
telecom	.telecom
gender	.patient.administrativeGenderCode
birthDate	.patient.birthTime
deceased[x]	n/a
address	.addr
maritalStatus	.patient.maritalStatusCode
multipleBirth[x]	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)

InterweavePatient
Patient
identifier	FiveWs.identifier
identifier (nhsNumber)	FiveWs.identifier
active	FiveWs.status

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

InterweavePatient
Patient
meta
tag
tag (Source)
system	C*E.3
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
tag (Provenance)
system	C*E.3
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
identifier	PID-3
identifier (nhsNumber)	PID-3
use	N/A
type	CX.5
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 (other)	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
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	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
country	XAD.6
period	XAD.12 / XAD.13 + XAD.14
maritalStatus	PID-16
multipleBirth[x]	PID-24 (bool), PID-25 (integer)
contact
relationship	NK1-7, NK1-3
coding	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	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	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
country	XAD.6
period	XAD.12 / XAD.13 + XAD.14
gender	NK1-15
organization	NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
communication
language	PID-15, LAN-2
preferred	PID-15
generalPractitioner	PD1-4
link
other	PID-3, MRG-1

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

InterweavePatient
Patient
birthDate	21112-8