RIVO-Noord Zorgviewer Implementation Guide - Local Development build (v1.9.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: DocumentReference - Mappings

Active as of 2024-12-10

Mappings for the DocumentReference resource profile.

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

DocumentReference
DocumentReference	Entity. Role, or Act, Document[classCode="DOC" and moodCode="EVN"]
text	Act.text?
contained	N/A
extension	N/A
modifierExtension	N/A
masterIdentifier	.id
identifier	.id / .setId
status	interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"
type	./code
class	.outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
subject	.participation[typeCode="SBJ"].role[typeCode="PAT"]
indexed	.availabilityTime[type="TS"]
author	.participation[typeCode="AUT"].role[classCode="ASSIGNED"]
authenticator	.participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
relatesTo	.outboundRelationship
id	n/a
extension	n/a
modifierExtension	N/A
code	.outboundRelationship.typeCode
target	.target[classCode="DOC", moodCode="EVN"].id
description	.outboundRelationship[typeCode="SUBJ"].target.text
securityLabel	.confidentialityCode
content	document.text
id	n/a
extension	n/a
modifierExtension	N/A
attachment	document.text
id	n/a
extension	n/a
contentType	./mediaType, ./charset
language	./language
url	./reference/literal
size	N/A (needs data type R3 proposal)
hash	.integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]
title	./title/data
format	document.text
context	outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
id	n/a
extension	n/a
modifierExtension	N/A
encounter	unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])
event	.code
period	.effectiveTime
id	n/a
extension	n/a
start	./low
end	./high
facilityType	.participation[typeCode="LOC"].role[classCode="DSDLOC"].code
practiceSetting	.participation[typeCode="LOC"].role[classCode="DSDLOC"].code
sourcePatientInfo	.participation[typeCode="SBJ"].role[typeCode="PAT"]
related	./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct]
id	n/a
extension	n/a
modifierExtension	N/A
identifier	./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct] .id
ref	./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct].text.reference

Mappings for W5 Mapping (http://hl7.org/fhir/w5)

DocumentReference
DocumentReference	infrastructure.documents
masterIdentifier	id
identifier	id
status	status
type	class
class	class
subject	who.focus
indexed	when.recorded
author	who.author
authenticator	who.witness
context
encounter	context

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

DocumentReference
DocumentReference
masterIdentifier	TXA-12
identifier	TXA-16?
status	TXA-19
type	TXA-2
subject	PID-3 (No standard way to define a Practitioner or Group subject in HL7 v2 MDM message)
author	TXA-9 (No standard way to indicate a Device in HL7 v2 MDM message)
authenticator	TXA-10
description	TXA-25
securityLabel	TXA-18
content
attachment	TXA-3 for mime type
contentType	ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
url	RP.1+RP.2 - if they refer to a URL (see v2.6)
context
period
start	DR.1
end	DR.2

Mappings for XDS metadata equivalent (http://ihe.net/xds)

DocumentReference
DocumentReference
masterIdentifier	DocumentEntry.uniqueId
identifier	DocumentEntry.entryUUID
status	DocumentEntry status
type	DocumentEntry.type
class	DocumentEntry.class
subject	DocumentEntry.patientId
indexed	DocumentEntry.submissionTime
author	DocumentEntry.author
authenticator	DocumentEntry.legalAuthenticator
relatesTo
code	DocumentEntry Associations type
target	DocumentEntry Associations reference
description	DocumentEntry.description
securityLabel	DocumentEntry.confidentialityCode
content
attachment	DocumentEntry.mimeType DocumentEntry.languageCode DocumentEntry.URI DocumentEntry.size DocumentEntry.hash DocumentEntry.title
format	DocumentEntry.formatCode
context
event	DocumentEntry.eventCodeList
period	DocumentEntry.serviceStartTime DocumentEntry.serviceStopTime
facilityType	DocumentEntry.healthcareFacilityTypeCode
practiceSetting	DocumentEntry.practiceSettingCode
sourcePatientInfo	DocumentEntry.sourcePatientInfo DocumentEntry.sourcePatientId
related	DocumentEntry.referenceIdList