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

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

## Resource Profile: TemplateDocumentReference - Mappings

Draft as of 2026-03-03

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

Name | Workflow Pattern | FHIR Composition | RIM Mapping | CDA (R2) | FiveWs Pattern Mapping | HL7 v2 Mapping | XDS metadata equivalent
--- | --- | --- | --- | --- | --- | --- | ---
DocumentReference | Event | when describing a Composition | Document[classCode="DOC" and moodCode="EVN"] | when describing a CDA |  |  |
id |  |  |  |  |  |  |
meta |  |  |  |  |  |  |
implicitRules |  |  |  |  |  |  |
language |  |  |  |  |  |  |
text |  |  | Act.text? |  |  |  |
contained |  |  | N/A |  |  |  |
extension |  |  | N/A |  |  |  |
modifierExtension |  |  | N/A |  |  |  |
masterIdentifier | Event.identifier | Composition.identifier | .id | ClinicalDocument/id | FiveWs.identifier | TXA-12 | DocumentEntry.uniqueId
identifier | Event.identifier |  | .id / .setId |  | FiveWs.identifier | TXA-16? | DocumentEntry.entryUUID
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
docStatus |  | Composition.status | .statusCode |  | FiveWs.status | TXA-17 |
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
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
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
date | Event.occurrence[x] | Composition.date | .availabilityTime[type="TS"] |  | FiveWs.recorded |  |
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
authenticator | Event.performer.actor | Composition.attester | .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"] | ClinicalDocument/legalAuthenticator | FiveWs.witness | TXA-10 | DocumentEntry.legalAuthenticator
custodian | Event.performer.actor | Composition.custodian | .participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"] |  |  |  |
relatesTo |  | Composition.relatesTo | .outboundRelationship |  |  |  | DocumentEntry Associations
id |  |  | n/a |  |  |  |
extension |  |  | n/a |  |  |  |
modifierExtension |  |  | N/A |  |  |  |
code |  | Composition.relatesTo.code | .outboundRelationship.typeCode |  |  |  | DocumentEntry Associations type
target |  | Composition.relatesTo.target | .target[classCode="DOC" moodCode="EVN"].id |  |  |  | DocumentEntry Associations reference
description |  |  | .outboundRelationship[typeCode="SUBJ"].target.text |  |  | TXA-25 | DocumentEntry.comments
securityLabel |  | Composition.confidentiality Composition.meta.security | .confidentialityCode | ClinicalDocument/confidentialityCode/@code |  | TXA-18 | DocumentEntry.confidentialityCode
content |  | Bundle(Composition+*) | document.text |  |  |  |
id |  |  | n/a |  |  |  |
extension |  |  | n/a |  |  |  |
modifierExtension |  |  | N/A |  |  |  |
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
format |  | Composition.meta.profile | document.text | derived from the IHE Profile or Implementation Guide templateID |  |  | DocumentEntry.formatCode
context |  |  | outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT'] |  |  |  |
id |  |  | n/a |  |  |  |
extension |  |  | n/a |  |  |  |
modifierExtension |  |  | N/A |  |  |  |
encounter | Event.context | Composition.encounter | unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()] priorityNumber)/target[moodCode="EVN" and classCode=("ENC" "PCPR") and isNormalAct]) |  | FiveWs.context |  |
event |  | Composition.event.code | .code |  |  |  | DocumentEntry.eventCodeList
period |  | Composition.event.period | .effectiveTime | ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/low/ @value --> ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/high/ @value |  |  | DocumentEntry.serviceStartTime DocumentEntry.serviceStopTime
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
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
sourcePatientInfo |  | Composition.subject | .participation[typeCode="SBJ"].role[typeCode="PAT"] | ClinicalDocument/recordTarget/ |  |  | DocumentEntry.sourcePatientInfo DocumentEntry.sourcePatientId
related |  | Composition.event.detail | ./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct] | ClinicalDocument/relatedDocument |  |  | DocumentEntry.referenceIdList
Documentation for this format