NZ Shared Digital Health Record API
1.1.6 - release
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
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzepsMedicationDispense | Version: 1.1.6 | |||
| Draft as of 2025-08-19 | Computable Name: NzepsMedicationDispense | |||
Medication Dispense resource for use in NZ e-Prescription Service Medicines Data Repository
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  MedicationDispense |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient Constraints: mdd-1 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:nzeps-endorsement |
0..* | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement | |
| extension:nzeps-pharmacy-approval-original |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original | |
| extension:nzeps-funding-category |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category | |
| extension:nzeps-scriptno-local |
0..1 | string | NZePS Local Script Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-scriptno-local | |
 extension:nzeps-medication-copayment-paid |
1..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. | |
  medication[x] |
1..1 | CodeableConcept | What medication was supplied Binding: http://nzmt.org.nz/vs (preferred) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.status | Base | required | Medication dispense status codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.medication[x] | Base | preferred | http://nzmt.org.nz/vs | Not State | Unknown |
| 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
|
This structure is derived from MedicationDispense
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationDispense |
0..* | MedicationDispense | Dispensing a medication to a named patient | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:nzeps-endorsement |
0..* | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement | |
| extension:nzeps-pharmacy-approval-original |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original | |
| extension:nzeps-funding-category |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category | |
| extension:nzeps-scriptno-local |
0..1 | string | NZePS Local Script Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-scriptno-local | |
| extension:nzeps-medication-copayment-paid |
1..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid | |
| medication[x] |
1..1 | CodeableConcept | What medication was supplied Binding: http://nzmt.org.nz/vs (preferred) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.medication[x] | Base | preferred | http://nzmt.org.nz/vs | Not State | Unknown |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationDispense |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient Constraints: mdd-1 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:nzeps-endorsement |
0..* | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement | |||||
| extension:nzeps-pharmacy-approval-original |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original | |||||
| extension:nzeps-funding-category |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category | |||||
| extension:nzeps-scriptno-local |
0..1 | string | NZePS Local Script Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-scriptno-local | |||||
| extension:nzeps-medication-copayment-paid |
1..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | External identifier | |||||
 partOf |
0..* | Reference(Procedure) | Event that dispense is part of | |||||
| status |
1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. | |||||
 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 | CodeableConcept | What medication was supplied Binding: http://nzmt.org.nz/vs (preferred) | |||||
| subject |
0..1 | Reference(Patient | Group) | Who the dispense is for | |||||
| context |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event | |||||
| supportingInformation |
0..* | Reference(Resource) | Information that supports the dispensing of the medication | |||||
| performer |
0..* | BackboneElement | Who performed event | |||||
| 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 | |||||
| function |
0..1 | CodeableConcept | Who performed the dispense and what they did Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication. | |||||
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) | Individual who was performing | |||||
| location |
0..1 | Reference(Location) | Where the dispense occurred | |||||
| authorizingPrescription |
0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense | |||||
| 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 |
C | 0..1 | SimpleQuantity(4.0.1) | Amount dispensed Constraints: sqty-1 | ||||
| daysSupply |
C | 0..1 | SimpleQuantity(4.0.1) | Amount of medication expressed as a timing amount Constraints: sqty-1 | ||||
| whenPrepared |
0..1 | dateTime | When product was packaged and reviewed | |||||
| whenHandedOver |
0..1 | dateTime | When product was given out | |||||
| destination |
0..1 | Reference(Location) | Where the medication was sent | |||||
| receiver |
0..* | Reference(Patient | Practitioner) | Who collected the medication | |||||
| 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 | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.language | Base | preferred | Common Languages | 📍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 | preferred | http://nzmt.org.nz/vs | Not State | Unknown |
| 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.4 |
| MedicationDispense.substitution.type | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.4 |
| MedicationDispense.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.4 |
| 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
|
| sqty-1 | error | MedicationDispense.quantity, MedicationDispense.daysSupply | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from MedicationDispense
Summary
Mandatory: 2 elements
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationDispense |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient Constraints: mdd-1 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:nzeps-endorsement |
0..* | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement | |
| extension:nzeps-pharmacy-approval-original |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original | |
| extension:nzeps-funding-category |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category | |
| extension:nzeps-scriptno-local |
0..1 | string | NZePS Local Script Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-scriptno-local | |
| extension:nzeps-medication-copayment-paid |
1..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. | |
| medication[x] |
1..1 | CodeableConcept | What medication was supplied Binding: http://nzmt.org.nz/vs (preferred) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.status | Base | required | Medication dispense status codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.medication[x] | Base | preferred | http://nzmt.org.nz/vs | Not State | Unknown |
| 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
|
Differential View
This structure is derived from MedicationDispense
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationDispense |
0..* | MedicationDispense | Dispensing a medication to a named patient | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:nzeps-endorsement |
0..* | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement | |
| extension:nzeps-pharmacy-approval-original |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original | |
| extension:nzeps-funding-category |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category | |
| extension:nzeps-scriptno-local |
0..1 | string | NZePS Local Script Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-scriptno-local | |
| extension:nzeps-medication-copayment-paid |
1..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid | |
| medication[x] |
1..1 | CodeableConcept | What medication was supplied Binding: http://nzmt.org.nz/vs (preferred) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.medication[x] | Base | preferred | http://nzmt.org.nz/vs | Not State | Unknown |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationDispense |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient Constraints: mdd-1 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:nzeps-endorsement |
0..* | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement | |||||
| extension:nzeps-pharmacy-approval-original |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original | |||||
| extension:nzeps-funding-category |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category | |||||
| extension:nzeps-scriptno-local |
0..1 | string | NZePS Local Script Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-scriptno-local | |||||
| extension:nzeps-medication-copayment-paid |
1..1 | ?gen-e1? [CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid]] | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | External identifier | |||||
| partOf |
0..* | Reference(Procedure) | Event that dispense is part of | |||||
| status |
1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. | |||||
| 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 | CodeableConcept | What medication was supplied Binding: http://nzmt.org.nz/vs (preferred) | |||||
| subject |
0..1 | Reference(Patient | Group) | Who the dispense is for | |||||
| context |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event | |||||
| supportingInformation |
0..* | Reference(Resource) | Information that supports the dispensing of the medication | |||||
| performer |
0..* | BackboneElement | Who performed event | |||||
| 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 | |||||
| function |
0..1 | CodeableConcept | Who performed the dispense and what they did Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication. | |||||
| actor |
1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) | Individual who was performing | |||||
| location |
0..1 | Reference(Location) | Where the dispense occurred | |||||
| authorizingPrescription |
0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense | |||||
| 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 |
C | 0..1 | SimpleQuantity(4.0.1) | Amount dispensed Constraints: sqty-1 | ||||
| daysSupply |
C | 0..1 | SimpleQuantity(4.0.1) | Amount of medication expressed as a timing amount Constraints: sqty-1 | ||||
| whenPrepared |
0..1 | dateTime | When product was packaged and reviewed | |||||
| whenHandedOver |
0..1 | dateTime | When product was given out | |||||
| destination |
0..1 | Reference(Location) | Where the medication was sent | |||||
| receiver |
0..* | Reference(Patient | Practitioner) | Who collected the medication | |||||
| 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 | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.language | Base | preferred | Common Languages | 📍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 | preferred | http://nzmt.org.nz/vs | Not State | Unknown |
| 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.4 |
| MedicationDispense.substitution.type | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.4 |
| MedicationDispense.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.4 |
| 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
|
| sqty-1 | error | MedicationDispense.quantity, MedicationDispense.daysSupply | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from MedicationDispense
Summary
Mandatory: 2 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron