NZ Shared Digital Health Record API
1.1.0 - release

NZ Shared Digital Health Record API - Local Development build (v1.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SDHRMedicationDispense

Official URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRMedicationDispense Version: 1.1.0
Draft as of 2026-07-22 Computable Name: SDHRMedicationDispense

DRAFT PROFILE: MedicationDispense resource for Shared Digital Health Record. This profile constrains MedicationDispense to the SDHR subset of MDR medication dispense content.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: mdd-1
... id Σ 1..1 id MDR dispense record identifier (SCID + item sequence number + dispense sequence number)
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:MedicationModified 1..1 boolean NZePS modified medication flag
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified
.... extension:InstructionsModified 1..1 boolean NZePS modified instructions flag
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code Dispense status
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
Required Pattern: completed
... medication[x] Σ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject Σ 1..1 Reference(Patient) Patient for the dispense event
.... reference ΣC 1..1 string Must be an absolute URL reference to the patient on the NHI system. See constraints for details.
Constraints: nhi-url-format
.... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Patient
... authorizingPrescription 0..* Reference(MedicationRequest) Reference to the authorising prescription
... quantity 0..1 SimpleQuantity(4.0.1) Dispensed quantity
... daysSupply 0..1 SimpleQuantity(4.0.1) Days of supply
... whenHandedOver 0..1 dateTime Time the medication was handed to the patient
... destination 0..1 Reference(Location) Dispense destination location
... receiver 0..1 Reference(Patient | Practitioner) Person who received the dispense

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
nhi-url-format error MedicationDispense.subject.reference Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense Dispensing a medication to a named patient
... id 1..1 id MDR dispense record identifier (SCID + item sequence number + dispense sequence number)
... meta
.... source 0..0 Identifies where the resource comes from
.... profile 0..0 Profiles this resource claims to conform to
.... security 0..1 Coding Security Labels applied to this resource
.... tag 0..0 Tags applied to this resource
... implicitRules 0..0 A set of rules under which this content was created
... text 0..0 Text summary of the resource, for human interpretation
... contained 0..0 Contained, inline Resources
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:MedicationModified 1..1 boolean NZePS modified medication flag
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified
.... extension:InstructionsModified 1..1 boolean NZePS modified instructions flag
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified
... identifier 1..1 Identifier NZePS prescription item ID (SCID + item sequence number)
... status 1..1 code Dispense status
Required Pattern: completed
... subject 1..1 Reference(Patient) Patient for the dispense event
.... reference C 1..1 string Must be an absolute URL reference to the patient on the NHI system. See constraints for details.
Constraints: nhi-url-format
.... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Patient
.... display 0..0 Text alternative for the resource
... performer 0..0 Who performed event
... authorizingPrescription 0..* Reference(MedicationRequest) Reference to the authorising prescription
... quantity 0..1 SimpleQuantity(4.0.1) Dispensed quantity
... daysSupply 0..1 SimpleQuantity(4.0.1) Days of supply
... whenHandedOver 0..1 dateTime Time the medication was handed to the patient
... destination 0..1 Reference(Location) Dispense destination location
... receiver 0..1 Reference(Patient | Practitioner) Person who received the dispense
... dosageInstruction
.... patientInstruction 0..1 string Patient instructions

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
nhi-url-format error MedicationDispense.subject.reference Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: mdd-1
... id Σ 1..1 id MDR dispense record identifier (SCID + item sequence number + dispense sequence number)
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... security Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:MedicationModified 1..1 boolean NZePS modified medication flag
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified
.... extension:InstructionsModified 1..1 boolean NZePS modified instructions flag
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 1..1 Identifier NZePS prescription item ID (SCID + item sequence number)
... partOf 0..* Reference(Procedure) Event that dispense is part of
... status ?!Σ 1..1 code Dispense status
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
Required Pattern: completed
... statusReason[x] 0..1 Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.
.... statusReasonCodeableConcept CodeableConcept
.... statusReasonReference Reference(DetectedIssue)
... category 0..1 CodeableConcept Type of medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
... medication[x] Σ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject Σ 1..1 Reference(Patient) Patient for the dispense event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Must be an absolute URL reference to the patient on the NHI system. See constraints for details.
Constraints: nhi-url-format
.... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Patient
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... location 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription 0..* Reference(MedicationRequest) Reference to the authorising prescription
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
... quantity 0..1 SimpleQuantity(4.0.1) Dispensed quantity
... daysSupply 0..1 SimpleQuantity(4.0.1) Days of supply
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver 0..1 dateTime Time the medication was handed to the patient
... destination 0..1 Reference(Location) Dispense destination location
... receiver 0..1 Reference(Patient | Practitioner) Person who received the dispense
... note 0..* Annotation Information about the dispense
... dosageInstruction 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
.... patientInstruction Σ 0..1 string Patient instructions
.... timing Σ 0..1 Timing When medication should be administered
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
... substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.
.... reason 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
.... responsibleParty 0..* Reference(Practitioner | PractitionerRole) Who is responsible for the substitution
... detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
... eventHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.statusReason[x] Base example Medication dispense status reason codes 📍4.0.1 FHIR Std.
MedicationDispense.category Base preferred Medication dispense category codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationDispense.performer.​function Base example Medication dispense performer function codes 📍4.0.1 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📦3.0.0 THO v7.2
MedicationDispense.dosageInstruction.​additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.2
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.2

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
nhi-url-format error MedicationDispense.subject.reference Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

This structure is derived from MedicationDispense

Summary

Mandatory: 7 elements
Prohibited: 9 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: mdd-1
... id Σ 1..1 id MDR dispense record identifier (SCID + item sequence number + dispense sequence number)
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:MedicationModified 1..1 boolean NZePS modified medication flag
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified
.... extension:InstructionsModified 1..1 boolean NZePS modified instructions flag
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code Dispense status
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
Required Pattern: completed
... medication[x] Σ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject Σ 1..1 Reference(Patient) Patient for the dispense event
.... reference ΣC 1..1 string Must be an absolute URL reference to the patient on the NHI system. See constraints for details.
Constraints: nhi-url-format
.... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Patient
... authorizingPrescription 0..* Reference(MedicationRequest) Reference to the authorising prescription
... quantity 0..1 SimpleQuantity(4.0.1) Dispensed quantity
... daysSupply 0..1 SimpleQuantity(4.0.1) Days of supply
... whenHandedOver 0..1 dateTime Time the medication was handed to the patient
... destination 0..1 Reference(Location) Dispense destination location
... receiver 0..1 Reference(Patient | Practitioner) Person who received the dispense

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
nhi-url-format error MedicationDispense.subject.reference Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

Differential View

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense Dispensing a medication to a named patient
... id 1..1 id MDR dispense record identifier (SCID + item sequence number + dispense sequence number)
... meta
.... source 0..0 Identifies where the resource comes from
.... profile 0..0 Profiles this resource claims to conform to
.... security 0..1 Coding Security Labels applied to this resource
.... tag 0..0 Tags applied to this resource
... implicitRules 0..0 A set of rules under which this content was created
... text 0..0 Text summary of the resource, for human interpretation
... contained 0..0 Contained, inline Resources
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:MedicationModified 1..1 boolean NZePS modified medication flag
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified
.... extension:InstructionsModified 1..1 boolean NZePS modified instructions flag
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified
... identifier 1..1 Identifier NZePS prescription item ID (SCID + item sequence number)
... status 1..1 code Dispense status
Required Pattern: completed
... subject 1..1 Reference(Patient) Patient for the dispense event
.... reference C 1..1 string Must be an absolute URL reference to the patient on the NHI system. See constraints for details.
Constraints: nhi-url-format
.... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Patient
.... display 0..0 Text alternative for the resource
... performer 0..0 Who performed event
... authorizingPrescription 0..* Reference(MedicationRequest) Reference to the authorising prescription
... quantity 0..1 SimpleQuantity(4.0.1) Dispensed quantity
... daysSupply 0..1 SimpleQuantity(4.0.1) Days of supply
... whenHandedOver 0..1 dateTime Time the medication was handed to the patient
... destination 0..1 Reference(Location) Dispense destination location
... receiver 0..1 Reference(Patient | Practitioner) Person who received the dispense
... dosageInstruction
.... patientInstruction 0..1 string Patient instructions

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
nhi-url-format error MedicationDispense.subject.reference Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
Constraints: mdd-1
... id Σ 1..1 id MDR dispense record identifier (SCID + item sequence number + dispense sequence number)
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... security Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:MedicationModified 1..1 boolean NZePS modified medication flag
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-modified
.... extension:InstructionsModified 1..1 boolean NZePS modified instructions flag
URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-instructions-modified
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 1..1 Identifier NZePS prescription item ID (SCID + item sequence number)
... partOf 0..* Reference(Procedure) Event that dispense is part of
... status ?!Σ 1..1 code Dispense status
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.
Required Pattern: completed
... statusReason[x] 0..1 Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.
.... statusReasonCodeableConcept CodeableConcept
.... statusReasonReference Reference(DetectedIssue)
... category 0..1 CodeableConcept Type of medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
... medication[x] Σ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject Σ 1..1 Reference(Patient) Patient for the dispense event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Must be an absolute URL reference to the patient on the NHI system. See constraints for details.
Constraints: nhi-url-format
.... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Patient
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... location 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription 0..* Reference(MedicationRequest) Reference to the authorising prescription
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
... quantity 0..1 SimpleQuantity(4.0.1) Dispensed quantity
... daysSupply 0..1 SimpleQuantity(4.0.1) Days of supply
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver 0..1 dateTime Time the medication was handed to the patient
... destination 0..1 Reference(Location) Dispense destination location
... receiver 0..1 Reference(Patient | Practitioner) Person who received the dispense
... note 0..* Annotation Information about the dispense
... dosageInstruction 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
.... patientInstruction Σ 0..1 string Patient instructions
.... timing Σ 0..1 Timing When medication should be administered
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
... substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.
.... reason 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
.... responsibleParty 0..* Reference(Practitioner | PractitionerRole) Who is responsible for the substitution
... detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
... eventHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
MedicationDispense.status Base required Medication dispense status codes 📍4.0.1 FHIR Std.
MedicationDispense.statusReason[x] Base example Medication dispense status reason codes 📍4.0.1 FHIR Std.
MedicationDispense.category Base preferred Medication dispense category codes 📍4.0.1 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
MedicationDispense.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationDispense.performer.​function Base example Medication dispense performer function codes 📍4.0.1 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📦3.0.0 THO v7.2
MedicationDispense.dosageInstruction.​additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​route Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.
MedicationDispense.dosageInstruction.​doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📦3.0.0 THO v7.2
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📦3.0.0 THO v7.2

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
nhi-url-format error MedicationDispense.subject.reference Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')

This structure is derived from MedicationDispense

Summary

Mandatory: 7 elements
Prohibited: 9 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron