Testing IG
0.0.1 - CI Build
Testing IG, published by DBojicic. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/dbojicic/test-repo/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationdispense | Version: 0.0.1 | |||
| Active as of 2026-09-28 | Maturity Level: 1 | Computable Name: AUCoreMedicationDispense | ||
This profile sets minimum expectations for a MedicationDispense resource to record, search, and fetch information about the dispense of a medication associated with a patient. It is based on the AU Base MedicationDispense profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the MedicationDispense when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
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: ![]() ![]() | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUBaseMedicationDispense | A dispense record for a medication for a patient in an Australian healthcare context Constraints: mdd-1 | ||||||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||
![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() |
0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required) | |||||||||||||||||
![]() ![]() ![]() |
0..1 | integer | Number of this dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number | |||||||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||
![]() ![]() |
?!SOΣ | 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.
| ||||||||||||||||
![]() ![]() |
SOΣ | 1..1 | What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
| |||||||||||||||||
![]() ![]() ![]() |
CodeableConcept | |||||||||||||||||||
![]() ![]() ![]() |
Reference(Medication) | |||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | CodeableConcept | Coded Dispensed Medication Binding: SNOMEDCTMedicationCodes (example)
| ||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Reference(AU Core Medication) | Dispensed Medication
| ||||||||||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who the dispense is for
| ||||||||||||||||
![]() ![]() |
SO | 0..* | BackboneElement | Who performed event
| ||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | Device | AU Core RelatedPerson) | Individual who was performing
| ||||||||||||||||
![]() ![]() |
SO | 0..* | Reference(AU Core MedicationRequest) | Medication order that authorizes the dispense
| ||||||||||||||||
![]() ![]() |
SO | 0..1 | SimpleQuantity(4.0.1) | Amount dispensed
| ||||||||||||||||
![]() ![]() |
SOΣC | 0..1 | dateTime | When product was packaged and reviewed Constraints: au-core-meddisp-01
| ||||||||||||||||
![]() ![]() |
SO | 0..* | Annotation | Information about the dispense
| ||||||||||||||||
![]() ![]() |
SO | 0..* | AUBaseDosage | How the medication is to be used by the patient or administered by the caregiver
| ||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||||||||||||||
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 | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| MedicationDispense.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-meddisp-01 | error | MedicationDispense.whenPrepared | If a date is provided, it shall be precise to at least the day |
$this.hasValue() implies $this.toString().length() >= 10
|
| 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 AUBaseMedicationDispense
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| MedicationDispense.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-meddisp-01 | error | MedicationDispense.whenPrepared | If a date is provided, it shall be precise to at least the day |
$this.hasValue() implies $this.toString().length() >= 10
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUBaseMedicationDispense | A dispense record for a medication for a patient in an Australian healthcare context Constraints: mdd-1 | ||||||||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||||||
![]() ![]() |
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 | |||||||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() |
0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required) | |||||||||||||||||
![]() ![]() ![]() |
0..1 | integer | Number of this dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number | |||||||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||
![]() ![]() |
0..* | Identifier, AULocalDispenseIdentifier | External identifier | |||||||||||||||||
![]() ![]() |
0..* | Reference(Procedure) | Event that dispense is part of | |||||||||||||||||
![]() ![]() |
?!SOΣ | 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.
| ||||||||||||||||
![]() ![]() |
0..1 | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | ||||||||||||||||||
![]() ![]() ![]() |
CodeableConcept | |||||||||||||||||||
![]() ![]() ![]() |
Reference(DetectedIssue) | |||||||||||||||||||
![]() ![]() |
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. | |||||||||||||||||
![]() ![]() |
SOΣ | 1..1 | What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
| |||||||||||||||||
![]() ![]() ![]() |
CodeableConcept | |||||||||||||||||||
![]() ![]() ![]() |
Reference(Medication) | |||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | CodeableConcept | Coded Dispensed Medication Binding: SNOMEDCTMedicationCodes (example)
| ||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Medication primary text | ||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Reference(AU Core Medication) | Dispensed Medication
| ||||||||||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who the dispense is for
| ||||||||||||||||
![]() ![]() |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event | |||||||||||||||||
![]() ![]() |
0..* | Reference(Resource) | Information that supports the dispensing of the medication | |||||||||||||||||
![]() ![]() |
SO | 0..* | BackboneElement | Who performed event
| ||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||
![]() ![]() ![]() |
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. | |||||||||||||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | Device | AU Core RelatedPerson) | Individual who was performing
| ||||||||||||||||
![]() ![]() |
0..1 | Reference(Location) | Where the dispense occurred | |||||||||||||||||
![]() ![]() |
SO | 0..* | Reference(AU Core MedicationRequest) | Medication order that authorizes the dispense
| ||||||||||||||||
![]() ![]() |
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. | |||||||||||||||||
![]() ![]() |
SO | 0..1 | SimpleQuantity(4.0.1) | Amount dispensed
| ||||||||||||||||
![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Amount of medication expressed as a timing amount | |||||||||||||||||
![]() ![]() |
SOΣC | 0..1 | dateTime | When product was packaged and reviewed Constraints: au-core-meddisp-01
| ||||||||||||||||
![]() ![]() |
0..1 | dateTime | When product was given out | |||||||||||||||||
![]() ![]() |
0..1 | Reference(Location) | Where the medication was sent | |||||||||||||||||
![]() ![]() |
0..* | Reference(Patient | Practitioner) | Who collected the medication | |||||||||||||||||
![]() ![]() |
SO | 0..* | Annotation | Information about the dispense
| ||||||||||||||||
![]() ![]() |
SO | 0..* | AUBaseDosage | How the medication is to be used by the patient or administered by the caregiver
| ||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | integer | The order of the dosage instructions | ||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Patient or consumer oriented instructions | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Timing | When medication should be administered | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Take "as needed" (for x) Binding: Clinical Finding (preferred) | |||||||||||||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (preferred) | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Element | Amount of medication administered | ||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per dose | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per unit of time | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient | ||||||||||||||||
![]() ![]() |
0..1 | BackboneElement | Whether a substitution was performed on the dispense | |||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||
![]() ![]() ![]() |
1..1 | boolean | Whether a substitution was or was not performed on the dispense | |||||||||||||||||
![]() ![]() ![]() |
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. | |||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Why was substitution made Binding: Medicine Substitution Reason (preferred) | |||||||||||||||||
![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole) | Who is responsible for the substitution | |||||||||||||||||
![]() ![]() |
0..* | Reference(DetectedIssue) | Clinical issue with action | |||||||||||||||||
![]() ![]() |
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 | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| MedicationDispense.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| 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.additionalInstruction | Base | preferred | SNOMED CT Additional Dosage Instructions | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.asNeeded[x] | Base | preferred |
Clinical Finding
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationDispense.dosageInstruction.site | Base | preferred |
Body Site
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationDispense.dosageInstruction.route | Base | preferred |
Route of Administration
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationDispense.dosageInstruction.method | Base | preferred | SNOMED CT Administration Method Codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std. |
| MedicationDispense.substitution.type | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.4 |
| MedicationDispense.substitution.reason | Base | preferred |
Medicine Substitution Reason
|
⏿1.0.1 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-meddisp-01 | error | MedicationDispense.whenPrepared | If a date is provided, it shall be precise to at least the day |
$this.hasValue() implies $this.toString().length() >= 10
|
| 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 AUBaseMedicationDispense
Summary
Mandatory: 1 element
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUBaseMedicationDispense | A dispense record for a medication for a patient in an Australian healthcare context Constraints: mdd-1 | ||||||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||
![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() |
0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required) | |||||||||||||||||
![]() ![]() ![]() |
0..1 | integer | Number of this dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number | |||||||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||
![]() ![]() |
?!SOΣ | 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.
| ||||||||||||||||
![]() ![]() |
SOΣ | 1..1 | What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
| |||||||||||||||||
![]() ![]() ![]() |
CodeableConcept | |||||||||||||||||||
![]() ![]() ![]() |
Reference(Medication) | |||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | CodeableConcept | Coded Dispensed Medication Binding: SNOMEDCTMedicationCodes (example)
| ||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Reference(AU Core Medication) | Dispensed Medication
| ||||||||||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who the dispense is for
| ||||||||||||||||
![]() ![]() |
SO | 0..* | BackboneElement | Who performed event
| ||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | Device | AU Core RelatedPerson) | Individual who was performing
| ||||||||||||||||
![]() ![]() |
SO | 0..* | Reference(AU Core MedicationRequest) | Medication order that authorizes the dispense
| ||||||||||||||||
![]() ![]() |
SO | 0..1 | SimpleQuantity(4.0.1) | Amount dispensed
| ||||||||||||||||
![]() ![]() |
SOΣC | 0..1 | dateTime | When product was packaged and reviewed Constraints: au-core-meddisp-01
| ||||||||||||||||
![]() ![]() |
SO | 0..* | Annotation | Information about the dispense
| ||||||||||||||||
![]() ![]() |
SO | 0..* | AUBaseDosage | How the medication is to be used by the patient or administered by the caregiver
| ||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||||||||||||||
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 | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| MedicationDispense.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-meddisp-01 | error | MedicationDispense.whenPrepared | If a date is provided, it shall be precise to at least the day |
$this.hasValue() implies $this.toString().length() >= 10
|
| 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 AUBaseMedicationDispense
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUBaseMedicationDispense | A dispense record for a medication for a patient in an Australian healthcare context | |||||||
![]() ![]() |
SO | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
| ||||||
![]() ![]() |
SO | 1..1 | CodeableConcept, Reference(Medication) | What medication was supplied Slice: Unordered, Closed by type:$this
| ||||||
![]() ![]() ![]() |
SO | 0..1 | CodeableConcept | Coded Dispensed Medication
| ||||||
![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() |
SO | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| ||||||
![]() ![]() ![]() ![]() ![]() |
SO | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| ||||||
![]() ![]() ![]() |
SO | 0..1 | Reference(AU Core Medication) | Dispensed Medication
| ||||||
![]() ![]() |
SO | 1..1 | Reference(AU Core Patient) | Who the dispense is for
| ||||||
![]() ![]() |
SO | 0..* | BackboneElement | Who performed event
| ||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | Device | AU Core RelatedPerson) | Individual who was performing
| ||||||
![]() ![]() |
SO | 0..* | Reference(AU Core MedicationRequest) | Medication order that authorizes the dispense
| ||||||
![]() ![]() |
SO | 0..1 | SimpleQuantity(4.0.1) | Amount dispensed
| ||||||
![]() ![]() |
SOC | 0..1 | dateTime | When product was packaged and reviewed Constraints: au-core-meddisp-01
| ||||||
![]() ![]() |
SO | 0..* | Annotation | Information about the dispense
| ||||||
![]() ![]() |
SO | 0..* | AUBaseDosage | How the medication is to be used by the patient or administered by the caregiver
| ||||||
![]() ![]() ![]() |
SO | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||||
Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationDispense.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| MedicationDispense.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-meddisp-01 | error | MedicationDispense.whenPrepared | If a date is provided, it shall be precise to at least the day |
$this.hasValue() implies $this.toString().length() >= 10
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AUBaseMedicationDispense | A dispense record for a medication for a patient in an Australian healthcare context Constraints: mdd-1 | ||||||||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||||||
![]() ![]() |
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 | |||||||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() |
0..1 | Coding | Grounds for concurrent supply of medication URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply Binding: Concurrent Supply Grounds (required) | |||||||||||||||||
![]() ![]() ![]() |
0..1 | integer | Number of this dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number | |||||||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||
![]() ![]() |
0..* | Identifier, AULocalDispenseIdentifier | External identifier | |||||||||||||||||
![]() ![]() |
0..* | Reference(Procedure) | Event that dispense is part of | |||||||||||||||||
![]() ![]() |
?!SOΣ | 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.
| ||||||||||||||||
![]() ![]() |
0..1 | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | ||||||||||||||||||
![]() ![]() ![]() |
CodeableConcept | |||||||||||||||||||
![]() ![]() ![]() |
Reference(DetectedIssue) | |||||||||||||||||||
![]() ![]() |
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. | |||||||||||||||||
![]() ![]() |
SOΣ | 1..1 | What medication was supplied Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
| |||||||||||||||||
![]() ![]() ![]() |
CodeableConcept | |||||||||||||||||||
![]() ![]() ![]() |
Reference(Medication) | |||||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | CodeableConcept | Coded Dispensed Medication Binding: SNOMEDCTMedicationCodes (example)
| ||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Medication primary text | ||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Reference(AU Core Medication) | Dispensed Medication
| ||||||||||||||||
![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who the dispense is for
| ||||||||||||||||
![]() ![]() |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event | |||||||||||||||||
![]() ![]() |
0..* | Reference(Resource) | Information that supports the dispensing of the medication | |||||||||||||||||
![]() ![]() |
SO | 0..* | BackboneElement | Who performed event
| ||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||
![]() ![]() ![]() |
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. | |||||||||||||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | Device | AU Core RelatedPerson) | Individual who was performing
| ||||||||||||||||
![]() ![]() |
0..1 | Reference(Location) | Where the dispense occurred | |||||||||||||||||
![]() ![]() |
SO | 0..* | Reference(AU Core MedicationRequest) | Medication order that authorizes the dispense
| ||||||||||||||||
![]() ![]() |
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. | |||||||||||||||||
![]() ![]() |
SO | 0..1 | SimpleQuantity(4.0.1) | Amount dispensed
| ||||||||||||||||
![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Amount of medication expressed as a timing amount | |||||||||||||||||
![]() ![]() |
SOΣC | 0..1 | dateTime | When product was packaged and reviewed Constraints: au-core-meddisp-01
| ||||||||||||||||
![]() ![]() |
0..1 | dateTime | When product was given out | |||||||||||||||||
![]() ![]() |
0..1 | Reference(Location) | Where the medication was sent | |||||||||||||||||
![]() ![]() |
0..* | Reference(Patient | Practitioner) | Who collected the medication | |||||||||||||||||
![]() ![]() |
SO | 0..* | Annotation | Information about the dispense
| ||||||||||||||||
![]() ![]() |
SO | 0..* | AUBaseDosage | How the medication is to be used by the patient or administered by the caregiver
| ||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | integer | The order of the dosage instructions | ||||||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Patient or consumer oriented instructions | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Timing | When medication should be administered | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Take "as needed" (for x) Binding: Clinical Finding (preferred) | |||||||||||||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (preferred) | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Element | Amount of medication administered | ||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per dose | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per unit of time | |||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per administration | ||||||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient | ||||||||||||||||
![]() ![]() |
0..1 | BackboneElement | Whether a substitution was performed on the dispense | |||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||
![]() ![]() ![]() |
1..1 | boolean | Whether a substitution was or was not performed on the dispense | |||||||||||||||||
![]() ![]() ![]() |
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. | |||||||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Why was substitution made Binding: Medicine Substitution Reason (preferred) | |||||||||||||||||
![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole) | Who is responsible for the substitution | |||||||||||||||||
![]() ![]() |
0..* | Reference(DetectedIssue) | Clinical issue with action | |||||||||||||||||
![]() ![]() |
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 | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| MedicationDispense.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| MedicationDispense.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| 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.additionalInstruction | Base | preferred | SNOMED CT Additional Dosage Instructions | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.asNeeded[x] | Base | preferred |
Clinical Finding
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationDispense.dosageInstruction.site | Base | preferred |
Body Site
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationDispense.dosageInstruction.route | Base | preferred |
Route of Administration
|
⏿1.0.2 | tx.hl7.org.au |
| MedicationDispense.dosageInstruction.method | Base | preferred | SNOMED CT Administration Method Codes | 📦4.0.1 | FHIR Std. |
| MedicationDispense.dosageInstruction.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std. |
| MedicationDispense.substitution.type | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.4 |
| MedicationDispense.substitution.reason | Base | preferred |
Medicine Substitution Reason
|
⏿1.0.1 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| au-core-meddisp-01 | error | MedicationDispense.whenPrepared | If a date is provided, it shall be precise to at least the day |
$this.hasValue() implies $this.toString().length() >= 10
|
| 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 AUBaseMedicationDispense
Summary
Mandatory: 1 element
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron