NZ Shared Digital Health Record API
1.1.6 - release

NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.1.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions

Resource Profile: SDHRMedicationDispense - Mappings

Draft as of 2026-10-20

Mappings for the SDHRMedicationDispense resource profile.

Mappings to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

NameWorkflow PatternRIM MappingFiveWs Pattern MappingV3 Pharmacy Dispense RMIMHL7 v2 Mappingdoco
MedicationDispense
Event
Supply[moodCode=EVN]
MedicationDispense / id
MedicationDispense / meta
MedicationDispense / meta / id
n/a
MedicationDispense / meta / extension
MedicationDispense / meta / versionId
MedicationDispense / meta / lastUpdated
MedicationDispense / meta / source
MedicationDispense / meta / profile
MedicationDispense / meta / security
MedicationDispense / meta / tag
MedicationDispense / implicitRules
MedicationDispense / language
MedicationDispense / text
Act.text?
MedicationDispense / contained
N/A
MedicationDispense / Slices for extension
MedicationDispense / Slices for extension / extension:MedicationModified
MedicationDispense / Slices for extension / extension:InstructionsModified
MedicationDispense / modifierExtension
MedicationDispense / identifier
Event.identifier
.id
FiveWs.identifier
CombinedMedicationDispense.id
MedicationDispense / identifier / id
n/a
MedicationDispense / identifier / extension
n/a
MedicationDispense / identifier / use
Role.code or implied by context
N/A
MedicationDispense / identifier / type
Role.code or implied by context
CX.5
MedicationDispense / identifier / system
II.root or Role.id.root
CX.4 / EI-2-4
MedicationDispense / identifier / value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
MedicationDispense / identifier / period
Role.effectiveTime or implied by context
CX.7 + CX.8
MedicationDispense / identifier / assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
MedicationDispense / partOf
Event.partOf
  • .outboundRelationship[typeCode=COMP]/target[classCode=PROC
  • moodCode=EVN]
MedicationDispense / status
Event.status
.statusCode
FiveWs.status
CombinedMedicationDispense.SupplyEvent.statusCode
MedicationDispense / statusReason[x]
Event.statusReason
  • .outboundRelationship[typeCode=RSON]/target[classCode=OBS
  • moodCode=EVN
  • code="not done reason"].value
MedicationDispense / category
  • .inboundRelationship[typeCode=COMP].source[classCode=OBS
  • moodCode=EVN
  • code="type of medication dispense"].value
MedicationDispense / medication[x]
Event.code
.participation[typeCode=PRD].role
FiveWs.what[x]
CombinedMedicationRequest.component1.AdministrationRequest.consumable
RXD-2-Dispense/Give Code
MedicationDispense / medication[x] / id
n/a
MedicationDispense / medication[x] / extension
MedicationDispense / medication[x] / coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
MedicationDispense / medication[x] / coding / id
n/a
MedicationDispense / medication[x] / coding / extension
MedicationDispense / medication[x] / coding / system
./codeSystem
C*E.3
MedicationDispense / medication[x] / coding / version
./codeSystemVersion
C*E.7
MedicationDispense / medication[x] / coding / code
./code
C*E.1
MedicationDispense / medication[x] / coding / display
CV.displayName
C*E.2 - but note this is not well followed
MedicationDispense / medication[x] / coding / userSelected
CD.codingRationale
Sometimes implied by being first
MedicationDispense / medication[x] / text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
MedicationDispense / subject
Event.subject
.participation[typeCode=SBJ].role[classCode=PAT]
FiveWs.subject
PID-3-Patient ID List
MedicationDispense / subject / id
n/a
MedicationDispense / subject / extension
n/a
MedicationDispense / subject / reference
N/A
MedicationDispense / subject / type
N/A
MedicationDispense / subject / identifier
.identifier
MedicationDispense / subject / display
N/A
MedicationDispense / context
Event.context
  • .inboundRelationship[typeCode=COMP].source[classCode=ENC
  • moodCode=EVN
  • code="type of encounter or episode"]
MedicationDispense / supportingInformation
  • .outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG
  • ENC
  • PROC
  • SPLY
  • SBADM
  • OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN
  • DEF
  • INT PRMS
  • RQO
  • PRP
  • APT
  • ARQ
  • GOL)]
FiveWs.context
MedicationDispense / performer
Event.performer
.participation[typeCode=PRF]
MedicationDispense / location
.participation[typeCode=LOC].role
MedicationDispense / authorizingPrescription
Event.basedOn
.outboundRelationship[typeCode=FLFS].target[moodCode=RQO]
CombinedMedicationDispense.inFulfillmentOf
ORC-2 Placer Order Number
MedicationDispense / type
.code
CombinedMedicationDispense.SupplyEvent.code
RXD-33-Dispense Type
MedicationDispense / quantity
.quantity
CombinedMedicationDispense.SupplyEvent.quantity
RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system
MedicationDispense / daysSupply
effectiveUseTime
  • TQ1.6 Timing/Quantity Segment Service Duration. Prior to v2.5
  • ORC.7.3 Common Order Segment / Quantity/Timing / Duration component. This is a formatted string
  • first character for the time unit (e.g.
  • D=days)
  • followed by the value. For example
  • “D14” represents “14 days supply” From v2.5 on
  • TQ1.6 Timing/Quantity Segment / Service Duration. This is a CQ data type (<Quantity (NM)> ^ <Units (CWE)>)
  • thus for days supply
  • assuming the unit of measure is “days”
  • the numeric value is TQ1.6.1 (…|14^ For backwards compatibility
  • ORC.7 was permitted through v2.6. Both forms (field and segment) may be present in v2.5
  • v2.5.1
  • and v2.6
MedicationDispense / whenPrepared
type=IVL_TS].low
CombinedMedicationDispense.SupplyEvent.effectiveTime
RXD-3-Date/Time Dispensed
MedicationDispense / whenHandedOver
Event.occurrence[x]
type=IVL_TS].high
CombinedMedicationDispense.SupplyEvent.effectiveTime
RXD-3-Date/Time Dispensed
MedicationDispense / destination
.participation[typeCode=DST].role
CombinedMedicationDispense.SupplyEvent.destination
RXD-13 Dispense-to Location; RXD-30 Dispense to Pharmacy; RXD-31 Dispense to Pharmacy Address
MedicationDispense / receiver
.participation[typeCode=RCV].role
CombinedMedicationDispense.SupplyEvent.receiver
MedicationDispense / note
Event.note
  • .inboundRelationship[typeCode=SUBJ]/source[classCode=ACT
  • moodCode=EVN]
RXD-9 Dispense Notes
MedicationDispense / dosageInstruction
  • .outboundRelationship[typeCode=COMP].target[classCode=SBADM
  • moodCode=INT]
MedicationDispense / dosageInstruction / id
n/a
MedicationDispense / dosageInstruction / extension
MedicationDispense / dosageInstruction / modifierExtension
MedicationDispense / dosageInstruction / sequence
.text
TQ1-1
MedicationDispense / dosageInstruction / text
.text
RXO-6; RXE-21
MedicationDispense / dosageInstruction / additionalInstruction
.text
RXO-7
MedicationDispense / dosageInstruction / patientInstruction
.text
RXO-7
MedicationDispense / dosageInstruction / timing
.effectiveTime
MedicationDispense / dosageInstruction / asNeeded[x]
  • .outboundRelationship[typeCode=PRCN].target[classCode=OBS
  • moodCode=EVN
  • code="as needed"].value=boolean or codable concept
TQ1-9
MedicationDispense / dosageInstruction / site
.approachSiteCode
RXR-2
MedicationDispense / dosageInstruction / route
.routeCode
RXR-1
MedicationDispense / dosageInstruction / method
.doseQuantity
RXR-4
MedicationDispense / dosageInstruction / doseAndRate
TQ1-2
MedicationDispense / dosageInstruction / maxDosePerPeriod
.maxDoseQuantity
  • RXO-23
  • RXE-19
MedicationDispense / dosageInstruction / maxDosePerAdministration
not supported
MedicationDispense / dosageInstruction / maxDosePerLifetime
not supported
MedicationDispense / substitution
  • .outboundRelationship[typeCode=COMP].target[classCode=SUBST
  • moodCode=EVN]
CombinedMedicationDispense.substitutionMade
MedicationDispense / detectedIssue
  • .inboundRelationship[typeCode=SUBJ]/source[classCode=ALRT
  • moodCode=EVN].value
MedicationDispense / eventHistory
  • .inboundRelationship(typeCode=SUBJ].source[classCode=CACT
  • moodCode=EVN]

doco Documentation for this format