This page is part of the MatchSync Implementation Guide (v0.1.0: Release Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

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

Resource Profile: MSPatient - Mappings

Draft as of 2024-11-11

Mappings for the mspatient resource profile.

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

MSPatient
Patient	Entity. Role, or Act, Patient[classCode=PAT]
meta
id	n/a
extension	n/a
security
security (TransplantCenter)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	Act.text?
contained	N/A
extension (birthsex)	player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
modifierExtension	N/A
identifier	id
id	n/a
extension	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
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
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
photo	player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
contact	player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
id	n/a
extension	n/a
modifierExtension	N/A
relationship	code
name	name
telecom	telecom
address	addr
gender	player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
organization	scoper
period	effectiveTime
communication	LanguageCommunication
id	n/a
extension	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)

MSPatient
Patient	ClinicalDocument.recordTarget.patientRole
identifier	.id
active	n/a
name	.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)

MSPatient
Patient
identifier	FiveWs.identifier
active	FiveWs.status

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

MSPatient
Patient
meta
security
security (TransplantCenter)
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
identifier	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
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)
photo	OBX-5 - needs a profile
contact
relationship	NK1-7, NK1-3
name	NK1-2
telecom	NK1-5, NK1-6, NK1-40
address	NK1-4
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)

MSPatient
Patient
birthDate	21112-8