New Zealand MWS IG
1.1.0 - Release
New Zealand MWS IG
1.1.0 - Release
New Zealand MWS IG - Local Development build (v1.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/MwsMedicationDispense | Version: 1.1.0 | |||
| Active as of 2025-01-28 | Computable Name: MwsMedicationDispense | |||
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationDispense |
C | 0..* | NzepsMedicationDispense | Dispensing a medication to a named patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management mdd-1: whenHandedOver cannot be before whenPrepared |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   nzeps-endorsement |
0..* | (Complex) | NZePS Endorsement URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| nzeps-pharmacy-approval-original |
Σ | 0..1 | string | NZePS Original Pharmacy Approval Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| nzeps-funding-category |
0..1 | string | NZePS Funding Category URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| nzeps-scriptno-local |
Σ | 0..1 | string | NZePS Local Script Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-scriptno-local ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 nzeps-medication-copayment-paid |
1..1 | boolean | NZePS Medication Co-Payment Payment Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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. ele-1: All FHIR elements must have a @value or children |
  medication[x] |
Σ | 1..1 | CodeableConcept | What medication was supplied Binding: http://nzmt.org.nz/vs (preferred) ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1from the FHIR Standard | |
| MedicationDispense.medication[x] | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs |
This structure is derived from NzepsMedicationDispense
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense |
0..* | NzepsMedicationDispense | Dispensing a medication to a named patient | |
  Slices for extension |
Content/Rules for all slices | |||
 extension:nzeps-pharmacy-approval-original |
Σ | 0..1 | NzepsPharmacyApprovalOriginal | NZePS Original Pharmacy Approval Number |
| extension:nzeps-scriptno-local |
Σ | 0..1 | NzepsScriptnoLocal | NZePS Local Script Number |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationDispense |
C | 0..* | NzepsMedicationDispense | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared | ||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| nzeps-endorsement |
0..* | (Complex) | NZePS Endorsement URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement | |||||
| nzeps-pharmacy-approval-original |
Σ | 0..1 | string | NZePS Original Pharmacy Approval Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original | ||||
| nzeps-funding-category |
0..1 | string | NZePS Funding Category URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category | |||||
| nzeps-scriptno-local |
Σ | 0..1 | string | NZePS Local Script Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-scriptno-local | ||||
| nzeps-medication-copayment-paid |
1..1 | boolean | NZePS Medication Co-Payment Payment Indicator 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 |
0..1 | SimpleQuantity | Amount dispensed | |||||
| daysSupply |
0..1 | SimpleQuantity | Amount of medication expressed as a timing amount | |||||
| 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 | Conformance | ValueSet | URI | |||
| MedicationDispense.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1from the FHIR Standard | ||||
| MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reasonfrom the FHIR Standard | ||||
| MedicationDispense.category | preferred | MedicationDispense Category Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-categoryfrom the FHIR Standard | ||||
| MedicationDispense.medication[x] | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | ||||
| MedicationDispense.performer.function | example | MedicationDispense Performer Function Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-performer-functionfrom the FHIR Standard | ||||
| MedicationDispense.type | example | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
| MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
| MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
This structure is derived from NzepsMedicationDispense
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense |
C | 0..* | NzepsMedicationDispense | Dispensing a medication to a named patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management mdd-1: whenHandedOver cannot be before whenPrepared |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| nzeps-endorsement |
0..* | (Complex) | NZePS Endorsement URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| nzeps-pharmacy-approval-original |
Σ | 0..1 | string | NZePS Original Pharmacy Approval Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| nzeps-funding-category |
0..1 | string | NZePS Funding Category URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| nzeps-scriptno-local |
Σ | 0..1 | string | NZePS Local Script Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-scriptno-local ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| nzeps-medication-copayment-paid |
1..1 | boolean | NZePS Medication Co-Payment Payment Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-medication-copayment-paid ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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. ele-1: All FHIR elements must have a @value or children |
| medication[x] |
Σ | 1..1 | CodeableConcept | What medication was supplied Binding: http://nzmt.org.nz/vs (preferred) ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1from the FHIR Standard | |
| MedicationDispense.medication[x] | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs |
Differential View
This structure is derived from NzepsMedicationDispense
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense |
0..* | NzepsMedicationDispense | Dispensing a medication to a named patient | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:nzeps-pharmacy-approval-original |
Σ | 0..1 | NzepsPharmacyApprovalOriginal | NZePS Original Pharmacy Approval Number |
| extension:nzeps-scriptno-local |
Σ | 0..1 | NzepsScriptnoLocal | NZePS Local Script Number |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationDispense |
C | 0..* | NzepsMedicationDispense | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared | ||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| nzeps-endorsement |
0..* | (Complex) | NZePS Endorsement URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-endorsement | |||||
| nzeps-pharmacy-approval-original |
Σ | 0..1 | string | NZePS Original Pharmacy Approval Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-pharmacy-approval-original | ||||
| nzeps-funding-category |
0..1 | string | NZePS Funding Category URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-funding-category | |||||
| nzeps-scriptno-local |
Σ | 0..1 | string | NZePS Local Script Number URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-scriptno-local | ||||
| nzeps-medication-copayment-paid |
1..1 | boolean | NZePS Medication Co-Payment Payment Indicator 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 |
0..1 | SimpleQuantity | Amount dispensed | |||||
| daysSupply |
0..1 | SimpleQuantity | Amount of medication expressed as a timing amount | |||||
| 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 | Conformance | ValueSet | URI | |||
| MedicationDispense.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1from the FHIR Standard | ||||
| MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reasonfrom the FHIR Standard | ||||
| MedicationDispense.category | preferred | MedicationDispense Category Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-categoryfrom the FHIR Standard | ||||
| MedicationDispense.medication[x] | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | ||||
| MedicationDispense.performer.function | example | MedicationDispense Performer Function Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-performer-functionfrom the FHIR Standard | ||||
| MedicationDispense.type | example | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
| MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
| MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
This structure is derived from NzepsMedicationDispense
Other representations of profile: CSV, Excel, Schematron