Universal API Implementation Guide - Local Development build (v1.1.19). See the Directory of published versions

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

Resource Profile: UapiRelatedPerson - Mappings

Active as of 2021-06-04

Mappings for the uapi-relatedPerson resource profile.

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

UapiRelatedPerson
RelatedPerson	Entity. Role, or Act, role
text	Act.text?
contained	N/A
extension	N/A
modifierExtension	N/A
identifier	.id
active	.statusCode
patient	scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id
id	n/a
extension	n/a
reference	N/A
type	N/A
identifier	.identifier
display	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>"]
telecom (Phone)	telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Email)	telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
gender	administrativeGender
birthDate	player.birthTime
address	addr
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

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

UapiRelatedPerson
RelatedPerson	administrative.individual
identifier	FiveWs.identifier
active	FiveWs.status
relationship	FiveWs.class
period	FiveWs.done[x]

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

UapiRelatedPerson
RelatedPerson
identifier	NK1-33
patient	PID-3
relationship	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
telecom (Phone)	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
telecom (Email)	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
gender	NK1-15
address	NK1-4