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: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRMedicationDispense | Version: 1.1.6 | |||
| Draft as of 2026-10-20 | 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
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 |
  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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   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) | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
 system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nzeps-scid-item-id (extensions allowed) | |
| status |
1..1 | code | Dispense status Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. Required Pattern: completed (extensions allowed) | |
| medication[x] |
1..1 | CodeableConcept | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. | |
| extension |
0..0 | 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 | ||
 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 (extensions allowed) | |
| authorizingPrescription |
0..* | Reference(MedicationRequest) | Reference to the authorising prescription | |
| quantity |
C | 0..1 | SimpleQuantity(4.0.1) | Dispensed quantity Constraints: sqty-1 |
| whenHandedOver |
0..1 | dateTime | Time the medication was handed to the patient | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| 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. |
| 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})$')
|
| sqty-1 | error | MedicationDispense.quantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from MedicationDispense
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| 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 | ||
| language |
0..0 | Language of the resource content | ||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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..0 | Extension | ||
| identifier |
1..1 | Identifier | NZePS prescription item ID (SCID + item sequence number) | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nzeps-scid-item-id (extensions allowed) | |
| partOf |
0..0 | Event that dispense is part of | ||
| status |
1..1 | code | Dispense status Required Pattern: completed (extensions allowed) | |
| statusReason[x] |
0..0 | Why a dispense was not performed | ||
| medication[x] |
1..1 | CodeableConcept | What medication was supplied | |
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
 coding |
||||
 id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| version |
0..0 | Version of the system - if relevant | ||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| 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 (extensions allowed) | |
| display |
0..0 | Text alternative for the resource | ||
| context |
0..0 | Encounter / Episode associated with event | ||
| supportingInformation |
0..0 | Information that supports the dispensing of the medication | ||
| 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..0 | Amount of medication expressed as a timing amount | ||
| whenHandedOver |
0..1 | dateTime | Time the medication was handed to the patient | |
| destination |
0..0 | Where the medication was sent | ||
| receiver |
0..0 | Who collected the medication | ||
| note |
0..0 | Information about the dispense | ||
| dosageInstruction |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| sequence |
0..0 | The order of the dosage instructions | ||
| text |
0..0 | Free text dosage instructions e.g. SIG | ||
| additionalInstruction |
0..0 | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" | ||
| patientInstruction |
0..1 | string | Patient instructions | |
| timing |
0..0 | When medication should be administered | ||
| asNeeded[x] |
0..0 | Take "as needed" (for x) | ||
| site |
0..0 | Body site to administer to | ||
| method |
0..0 | Technique for administering medication | ||
| doseAndRate |
0..0 | Amount of medication administered | ||
| maxDosePerPeriod |
0..0 | Upper limit on medication per unit of time | ||
| maxDosePerAdministration |
0..0 | Upper limit on medication per administration | ||
| maxDosePerLifetime |
0..0 | Upper limit on medication per lifetime of the patient | ||
| substitution |
0..0 | Whether a substitution was performed on the dispense | ||
| detectedIssue |
0..0 | Clinical issue with action | ||
| eventHistory |
0..0 | A list of relevant lifecycle events | ||
| Documentation for this format | ||||
| 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})$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | |
| extension |
0..0 | 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 | ||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nzeps-scid-item-id (extensions allowed) | |
| value |
0..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | Dispense status Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. Required Pattern: completed (extensions allowed) | |
| 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: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. | |
| extension |
0..0 | 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 | ||
| coding |
0..* | Coding | Code defined by a terminology system | |
| extension |
0..0 | 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 | ||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| text |
0..1 | string | Plain text representation of the concept | |
| 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 (extensions allowed) | |
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |
| 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 |
C | 0..1 | SimpleQuantity(4.0.1) | Dispensed quantity Constraints: sqty-1 |
| whenPrepared |
0..1 | dateTime | When product was packaged and reviewed | |
| whenHandedOver |
0..1 | dateTime | Time the medication was handed to the patient | |
| dosageInstruction |
0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |
| extension |
0..0 | 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 | ||
| patientInstruction |
0..1 | string | Patient instructions | |
| 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. | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| MedicationDispense.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| MedicationDispense.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| MedicationDispense.status | Base | required | Medication dispense status 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.4 |
| MedicationDispense.dosageInstruction.route | Base | example | SNOMED CT Route 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.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
|
| 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})$')
|
| sqty-1 | error | MedicationDispense.quantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from MedicationDispense
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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) | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nzeps-scid-item-id (extensions allowed) | |
| status |
1..1 | code | Dispense status Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. Required Pattern: completed (extensions allowed) | |
| medication[x] |
1..1 | CodeableConcept | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. | |
| extension |
0..0 | 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 | ||
| 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 (extensions allowed) | |
| authorizingPrescription |
0..* | Reference(MedicationRequest) | Reference to the authorising prescription | |
| quantity |
C | 0..1 | SimpleQuantity(4.0.1) | Dispensed quantity Constraints: sqty-1 |
| whenHandedOver |
0..1 | dateTime | Time the medication was handed to the patient | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| 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. |
| 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})$')
|
| sqty-1 | error | MedicationDispense.quantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
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 | |
| id |
1..1 | id | MDR dispense record identifier (SCID + item sequence number + dispense sequence number) | |
| meta |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| 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 | ||
| language |
0..0 | Language of the resource content | ||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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..0 | Extension | ||
| identifier |
1..1 | Identifier | NZePS prescription item ID (SCID + item sequence number) | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nzeps-scid-item-id (extensions allowed) | |
| partOf |
0..0 | Event that dispense is part of | ||
| status |
1..1 | code | Dispense status Required Pattern: completed (extensions allowed) | |
| statusReason[x] |
0..0 | Why a dispense was not performed | ||
| medication[x] |
1..1 | CodeableConcept | What medication was supplied | |
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| coding |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| version |
0..0 | Version of the system - if relevant | ||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| 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 (extensions allowed) | |
| display |
0..0 | Text alternative for the resource | ||
| context |
0..0 | Encounter / Episode associated with event | ||
| supportingInformation |
0..0 | Information that supports the dispensing of the medication | ||
| 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..0 | Amount of medication expressed as a timing amount | ||
| whenHandedOver |
0..1 | dateTime | Time the medication was handed to the patient | |
| destination |
0..0 | Where the medication was sent | ||
| receiver |
0..0 | Who collected the medication | ||
| note |
0..0 | Information about the dispense | ||
| dosageInstruction |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| sequence |
0..0 | The order of the dosage instructions | ||
| text |
0..0 | Free text dosage instructions e.g. SIG | ||
| additionalInstruction |
0..0 | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" | ||
| patientInstruction |
0..1 | string | Patient instructions | |
| timing |
0..0 | When medication should be administered | ||
| asNeeded[x] |
0..0 | Take "as needed" (for x) | ||
| site |
0..0 | Body site to administer to | ||
| method |
0..0 | Technique for administering medication | ||
| doseAndRate |
0..0 | Amount of medication administered | ||
| maxDosePerPeriod |
0..0 | Upper limit on medication per unit of time | ||
| maxDosePerAdministration |
0..0 | Upper limit on medication per administration | ||
| maxDosePerLifetime |
0..0 | Upper limit on medication per lifetime of the patient | ||
| substitution |
0..0 | Whether a substitution was performed on the dispense | ||
| detectedIssue |
0..0 | Clinical issue with action | ||
| eventHistory |
0..0 | A list of relevant lifecycle events | ||
| Documentation for this format | ||||
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | |
| extension |
0..0 | 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 | ||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nzeps-scid-item-id (extensions allowed) | |
| value |
0..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| status |
1..1 | code | Dispense status Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event. Required Pattern: completed (extensions allowed) | |
| 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: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. | |
| extension |
0..0 | 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 | ||
| coding |
0..* | Coding | Code defined by a terminology system | |
| extension |
0..0 | 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 | ||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| text |
0..1 | string | Plain text representation of the concept | |
| 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 (extensions allowed) | |
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |
| 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 |
C | 0..1 | SimpleQuantity(4.0.1) | Dispensed quantity Constraints: sqty-1 |
| whenPrepared |
0..1 | dateTime | When product was packaged and reviewed | |
| whenHandedOver |
0..1 | dateTime | Time the medication was handed to the patient | |
| dosageInstruction |
0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |
| extension |
0..0 | 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 | ||
| patientInstruction |
0..1 | string | Patient instructions | |
| 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. | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| MedicationDispense.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| MedicationDispense.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| MedicationDispense.status | Base | required | Medication dispense status 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.4 |
| MedicationDispense.dosageInstruction.route | Base | example | SNOMED CT Route 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.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
|
| 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})$')
|
| sqty-1 | error | MedicationDispense.quantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from MedicationDispense
Other representations of profile: CSV, Excel, Schematron