Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: TemplateDocumentReference - Mappings

Draft as of 2026-10-13

Mappings for the TemplateDocumentReference resource profile.

Mappings to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

NameWorkflow PatternFHIR CompositionRIM MappingCDA (R2)FiveWs Pattern MappingHL7 v2 MappingXDS metadata equivalentdoco
DocumentReference
Event
when describing a Composition
Document[classCode="DOC" and moodCode="EVN"]
when describing a CDA
DocumentReference / id
DocumentReference / meta
DocumentReference / meta / id
n/a
DocumentReference / meta / extension
n/a
DocumentReference / meta / versionId
DocumentReference / meta / lastUpdated
DocumentReference / meta / source
DocumentReference / meta / profile
DocumentReference / meta / security
DocumentReference / meta / Slices for tag
DocumentReference / meta / Slices for tag / tag:correlationId
DocumentReference / meta / Slices for tag / tag:correlationId / id
n/a
DocumentReference / meta / Slices for tag / tag:correlationId / extension
n/a
DocumentReference / meta / Slices for tag / tag:correlationId / system
./codeSystem
C*E.3
DocumentReference / meta / Slices for tag / tag:correlationId / version
./codeSystemVersion
C*E.7
DocumentReference / meta / Slices for tag / tag:correlationId / code
./code
C*E.1
DocumentReference / meta / Slices for tag / tag:correlationId / display
CV.displayName
C*E.2 - but note this is not well followed
DocumentReference / meta / Slices for tag / tag:correlationId / userSelected
CD.codingRationale
Sometimes implied by being first
DocumentReference / implicitRules
DocumentReference / language
DocumentReference / text
Act.text?
DocumentReference / contained
N/A
DocumentReference / extension
N/A
DocumentReference / modifierExtension
N/A
DocumentReference / masterIdentifier
Event.identifier
Composition.identifier
.id
ClinicalDocument/id
FiveWs.identifier
TXA-12
DocumentEntry.uniqueId
DocumentReference / identifier
Event.identifier
.id / .setId
FiveWs.identifier
TXA-16?
DocumentEntry.entryUUID
DocumentReference / status
Event.status
  • .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"
  • .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument"
  • .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"
FiveWs.status
TXA-19
DocumentEntry.availabilityStatus
DocumentReference / docStatus
Composition.status
.statusCode
FiveWs.status
TXA-17
DocumentReference / type
Event.code
Composition.type
./code
  • ClinicalDocument/code/@code The typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC
  • in which case the mapping step can be omitted.
FiveWs.class
TXA-2
DocumentEntry.type
DocumentReference / category
Composition.class
  • .outboundRelationship[typeCode="COMP].target[classCode="LIST"
  • moodCode="EVN"].code
  • Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service
  • based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual). Must be consistent with /ClinicalDocument/code/@code
FiveWs.class
DocumentEntry.class
DocumentReference / subject
Event.subject
Composition.subject
.participation[typeCode="SBJ"].role[typeCode="PAT"]
ClinicalDocument/recordTarget/
FiveWs.subject
PID-3 (No standard way to define a Practitioner or Group subject in HL7 v2 MDM message)
DocumentEntry.patientId
DocumentReference / date
Event.occurrence[x]
Composition.date
.availabilityTime[type="TS"]
FiveWs.recorded
DocumentReference / author
Event.performer.actor
Composition.author
.participation[typeCode="AUT"].role[classCode="ASSIGNED"]
ClinicalDocument/author
TXA-9 (No standard way to indicate a Device in HL7 v2 MDM message)
DocumentEntry.author
DocumentReference / authenticator
Event.performer.actor
Composition.attester
.participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
ClinicalDocument/legalAuthenticator
FiveWs.witness
TXA-10
DocumentEntry.legalAuthenticator
DocumentReference / custodian
Event.performer.actor
Composition.custodian
.participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]
DocumentReference / relatesTo
Composition.relatesTo
.outboundRelationship
DocumentEntry Associations
DocumentReference / relatesTo / id
n/a
DocumentReference / relatesTo / extension
n/a
DocumentReference / relatesTo / modifierExtension
N/A
DocumentReference / relatesTo / code
Composition.relatesTo.code
.outboundRelationship.typeCode
DocumentEntry Associations type
DocumentReference / relatesTo / target
Composition.relatesTo.target
  • .target[classCode="DOC"
  • moodCode="EVN"].id
DocumentEntry Associations reference
DocumentReference / description
.outboundRelationship[typeCode="SUBJ"].target.text
TXA-25
DocumentEntry.comments
DocumentReference / securityLabel
  • Composition.confidentiality
  • Composition.meta.security
.confidentialityCode
ClinicalDocument/confidentialityCode/@code
TXA-18
DocumentEntry.confidentialityCode
DocumentReference / Slices for content
Bundle(Composition+*)
document.text
DocumentReference / Slices for content / content:All Slices
DocumentReference / Slices for content / content:All Slices / id
n/a
DocumentReference / Slices for content / content:All Slices / extension
n/a
DocumentReference / Slices for content / content:All Slices / modifierExtension
N/A
DocumentReference / Slices for content / content:All Slices / attachment
  • Composition.language
  • Composition.title
  • Composition.date
document.text
  • ClinicalDocument/languageCode
  • ClinicalDocument/title
  • ClinicalDocument/date
TXA-3 for mime type
  • DocumentEntry.mimeType
  • DocumentEntry.languageCode
  • DocumentEntry.URI
  • DocumentEntry.size
  • DocumentEntry.hash
  • DocumentEntry.title
  • DocumentEntry.creationTime
DocumentReference / Slices for content / content:All Slices / format
Composition.meta.profile
document.text
derived from the IHE Profile or Implementation Guide templateID
DocumentEntry.formatCode
DocumentReference / Slices for content / content:template-message-body
Bundle(Composition+*)
document.text
DocumentReference / Slices for content / content:template-message-body / id
n/a
DocumentReference / Slices for content / content:template-message-body / Slices for extension
DocumentReference / Slices for content / content:template-message-body / Slices for extension
DocumentReference / Slices for content / content:template-message-body / Slices for extension / extension:contentType
DocumentReference / Slices for content / content:template-message-body / Slices for extension / extension:contentType / id
n/a
DocumentReference / Slices for content / content:template-message-body / Slices for extension / extension:contentType / extension
DocumentReference / Slices for content / content:template-message-body / Slices for extension / extension:contentType / url
N/A
DocumentReference / Slices for content / content:template-message-body / Slices for extension / extension:contentType / value[x]
N/A
DocumentReference / Slices for content / content:template-message-body / modifierExtension
N/A
DocumentReference / Slices for content / content:template-message-body / attachment
  • Composition.language
  • Composition.title
  • Composition.date
document.text
  • ClinicalDocument/languageCode
  • ClinicalDocument/title
  • ClinicalDocument/date
TXA-3 for mime type
  • DocumentEntry.mimeType
  • DocumentEntry.languageCode
  • DocumentEntry.URI
  • DocumentEntry.size
  • DocumentEntry.hash
  • DocumentEntry.title
  • DocumentEntry.creationTime
DocumentReference / Slices for content / content:template-message-body / attachment / id
n/a
DocumentReference / Slices for content / content:template-message-body / attachment / extension
n/a
DocumentReference / Slices for content / content:template-message-body / attachment / contentType
  • ./mediaType
  • ./charset
ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
DocumentReference / Slices for content / content:template-message-body / attachment / language
./language
DocumentReference / Slices for content / content:template-message-body / attachment / data
./data
ED.5
DocumentReference / Slices for content / content:template-message-body / attachment / url
./reference/literal
RP.1+RP.2 - if they refer to a URL (see v2.6)
DocumentReference / Slices for content / content:template-message-body / attachment / size
N/A (needs data type R3 proposal)
DocumentReference / Slices for content / content:template-message-body / attachment / hash
:ED/integrityCheckAlgorithm="SHA-1"]
DocumentReference / Slices for content / content:template-message-body / attachment / title
./title/data
DocumentReference / Slices for content / content:template-message-body / attachment / creation
N/A (needs data type R3 proposal)
DocumentReference / Slices for content / content:template-message-body / format
Composition.meta.profile
document.text
derived from the IHE Profile or Implementation Guide templateID
DocumentEntry.formatCode
DocumentReference / Slices for content / content:template-message-parameters
Bundle(Composition+*)
document.text
DocumentReference / Slices for content / content:template-message-parameters / id
n/a
DocumentReference / Slices for content / content:template-message-parameters / Slices for extension
DocumentReference / Slices for content / content:template-message-parameters / Slices for extension
DocumentReference / Slices for content / content:template-message-parameters / Slices for extension / extension:contentType
DocumentReference / Slices for content / content:template-message-parameters / Slices for extension / extension:contentType / id
n/a
DocumentReference / Slices for content / content:template-message-parameters / Slices for extension / extension:contentType / extension
DocumentReference / Slices for content / content:template-message-parameters / Slices for extension / extension:contentType / url
N/A
DocumentReference / Slices for content / content:template-message-parameters / Slices for extension / extension:contentType / value[x]
N/A
DocumentReference / Slices for content / content:template-message-parameters / modifierExtension
N/A
DocumentReference / Slices for content / content:template-message-parameters / attachment
  • Composition.language
  • Composition.title
  • Composition.date
document.text
  • ClinicalDocument/languageCode
  • ClinicalDocument/title
  • ClinicalDocument/date
TXA-3 for mime type
  • DocumentEntry.mimeType
  • DocumentEntry.languageCode
  • DocumentEntry.URI
  • DocumentEntry.size
  • DocumentEntry.hash
  • DocumentEntry.title
  • DocumentEntry.creationTime
DocumentReference / Slices for content / content:template-message-parameters / attachment / id
n/a
DocumentReference / Slices for content / content:template-message-parameters / attachment / extension
n/a
DocumentReference / Slices for content / content:template-message-parameters / attachment / contentType
  • ./mediaType
  • ./charset
ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
DocumentReference / Slices for content / content:template-message-parameters / attachment / language
./language
DocumentReference / Slices for content / content:template-message-parameters / attachment / data
./data
ED.5
DocumentReference / Slices for content / content:template-message-parameters / attachment / url
./reference/literal
RP.1+RP.2 - if they refer to a URL (see v2.6)
DocumentReference / Slices for content / content:template-message-parameters / attachment / size
N/A (needs data type R3 proposal)
DocumentReference / Slices for content / content:template-message-parameters / attachment / hash
:ED/integrityCheckAlgorithm="SHA-1"]
DocumentReference / Slices for content / content:template-message-parameters / attachment / title
./title/data
DocumentReference / Slices for content / content:template-message-parameters / attachment / creation
N/A (needs data type R3 proposal)
DocumentReference / Slices for content / content:template-message-parameters / format
Composition.meta.profile
document.text
derived from the IHE Profile or Implementation Guide templateID
DocumentEntry.formatCode
DocumentReference / Slices for content / content:template-attachment-file
Bundle(Composition+*)
document.text
DocumentReference / Slices for content / content:template-attachment-file / id
n/a
DocumentReference / Slices for content / content:template-attachment-file / Slices for extension
DocumentReference / Slices for content / content:template-attachment-file / Slices for extension
DocumentReference / Slices for content / content:template-attachment-file / Slices for extension / extension:contentType
DocumentReference / Slices for content / content:template-attachment-file / Slices for extension / extension:contentType / id
n/a
DocumentReference / Slices for content / content:template-attachment-file / Slices for extension / extension:contentType / extension
DocumentReference / Slices for content / content:template-attachment-file / Slices for extension / extension:contentType / url
N/A
DocumentReference / Slices for content / content:template-attachment-file / Slices for extension / extension:contentType / value[x]
N/A
DocumentReference / Slices for content / content:template-attachment-file / modifierExtension
N/A
DocumentReference / Slices for content / content:template-attachment-file / attachment
  • Composition.language
  • Composition.title
  • Composition.date
document.text
  • ClinicalDocument/languageCode
  • ClinicalDocument/title
  • ClinicalDocument/date
TXA-3 for mime type
  • DocumentEntry.mimeType
  • DocumentEntry.languageCode
  • DocumentEntry.URI
  • DocumentEntry.size
  • DocumentEntry.hash
  • DocumentEntry.title
  • DocumentEntry.creationTime
DocumentReference / Slices for content / content:template-attachment-file / attachment / id
n/a
DocumentReference / Slices for content / content:template-attachment-file / attachment / Slices for extension
n/a
DocumentReference / Slices for content / content:template-attachment-file / attachment / Slices for extension
DocumentReference / Slices for content / content:template-attachment-file / attachment / Slices for extension / extension:AttachmentExtension
DocumentReference / Slices for content / content:template-attachment-file / attachment / contentType
  • ./mediaType
  • ./charset
ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
DocumentReference / Slices for content / content:template-attachment-file / attachment / language
./language
DocumentReference / Slices for content / content:template-attachment-file / attachment / data
./data
ED.5
DocumentReference / Slices for content / content:template-attachment-file / attachment / url
./reference/literal
RP.1+RP.2 - if they refer to a URL (see v2.6)
DocumentReference / Slices for content / content:template-attachment-file / attachment / size
N/A (needs data type R3 proposal)
DocumentReference / Slices for content / content:template-attachment-file / attachment / hash
:ED/integrityCheckAlgorithm="SHA-1"]
DocumentReference / Slices for content / content:template-attachment-file / attachment / title
./title/data
DocumentReference / Slices for content / content:template-attachment-file / attachment / creation
N/A (needs data type R3 proposal)
DocumentReference / Slices for content / content:template-attachment-file / format
Composition.meta.profile
document.text
derived from the IHE Profile or Implementation Guide templateID
DocumentEntry.formatCode
DocumentReference / context
outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
DocumentReference / context / id
n/a
DocumentReference / context / extension
n/a
DocumentReference / context / modifierExtension
N/A
DocumentReference / context / encounter
Event.context
Composition.encounter
  • unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]
  • priorityNumber)/target[moodCode="EVN" and classCode=("ENC"
  • "PCPR") and isNormalAct])
FiveWs.context
DocumentReference / context / event
Composition.event.code
.code
DocumentEntry.eventCodeList
DocumentReference / context / period
Composition.event.period
.effectiveTime
ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/low/ @value --> ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/high/ @value
  • DocumentEntry.serviceStartTime
  • DocumentEntry.serviceStopTime
DocumentReference / context / facilityType
usually from a mapping to a local ValueSet
.participation[typeCode="LOC"].role[classCode="DSDLOC"].code
usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code
DocumentEntry.healthcareFacilityTypeCode
DocumentReference / context / practiceSetting
usually from a mapping to a local ValueSet
.participation[typeCode="LOC"].role[classCode="DSDLOC"].code
usually from a mapping to a local ValueSet
DocumentEntry.practiceSettingCode
DocumentReference / context / sourcePatientInfo
Composition.subject
.participation[typeCode="SBJ"].role[typeCode="PAT"]
ClinicalDocument/recordTarget/
  • DocumentEntry.sourcePatientInfo
  • DocumentEntry.sourcePatientId
DocumentReference / context / related
Composition.event.detail
./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct]
ClinicalDocument/relatedDocument
DocumentEntry.referenceIdList

doco Documentation for this format