OpenMRS Core FHIR Implementation Guide - 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: OMRSRelatedPerson - Mappings

Active as of 2024-12-11

Mappings for the omrs-related-person resource profile.

Mappings for FHIR HL7 vs OMRS (Relationship)

This mapping defines how a FHIR RelatedPerson resource corresponds to an OpenMRS Relationship. In OpenMRS, a Relationship connects two Person objects, while in FHIR, a RelatedPerson represents a person with a connection to a patient.

OMRSRelatedPerson
RelatedPerson	OMRS Relationship	This profile maps to RelatedPerson in OMRS FHIR2
id	Relationship.uuid
identifier
system	RelatedPerson
value	Person/{personA.uuid}
patient	Relationship.personB
name
family	Relationship.personA.names.family
given	Relationship.personA.names.given
gender	Relationship.personA.gender
birthDate	Relationship.personA.birthdate
address	Relationship.personA.addresses
period
start	Relationship.startDate
end	Relationship.endDate

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

OMRSRelatedPerson
RelatedPerson	Entity. Role, or Act, role
text	Act.text?
contained	N/A
extension	N/A
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
patient	scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id
relationship	code
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
gender	administrativeGender
birthDate	player.birthTime
address	addr
photo	player[classCode='PSN' and determinerCode='INSTANCE']/desc
period	.effectiveTime
id	n/a
extension	n/a
start	./low
end	./high
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)

OMRSRelatedPerson
RelatedPerson
identifier	FiveWs.identifier
active	FiveWs.status
relationship	FiveWs.class
period	FiveWs.done[x]

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

OMRSRelatedPerson
RelatedPerson
identifier	NK1-33
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)
patient	PID-3
relationship	NK1-3
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
gender	NK1-15
address	NK1-4
photo	OBX-5 - needs a profile
period
start	DR.1
end	DR.2