Australian Base Implementation Guide (AU Base 1)
This page is part of the Australian Base IG (v1.0.2: AU Base 1 on STU3) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
AU Base Medication Dispense [FMM Level 2]
This profile defines a medication dispense structure including core localisation concepts for use as a dispense record in an Australian context.
Full medication definitions as a Medication resource can be referenced or codings are use be used to define relevant drug/medication concepts. This includes coding as:
These definitions represent common data held in the MedicationDispense.identifier element:
Extensions used in this profile:
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-medicationdispense
This profile defines a medication dispense structure including core localisation concepts for use as a dispense record in an Australian context.
This profile builds on MedicationDispense.
This profile was published on Fri Apr 26 09:07:00 AEST 2019 as a draft by Health Level Seven Australia (Medications WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This profile contains the following variations from MedicationDispense:
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationDispense | 0..* | A dispense record for a medication for a patient in an Australian healthcare context | ||
  extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
| grounds-for-concurrent-supply | 0..1 | Coding | Grounds for Concurrent Supply of Medication URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply Binding: Grounds for Concurrent Supply (required) | |
| dispense-number | 0..1 | integer | Number of this Dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number | |
| medication-brand-name | 0..1 | string | Medication Brand Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name | |
| medication-generic-name | 0..1 | string | Medication Generic Drug Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name | |
 identifier | Identifier | Slice: Unordered, Open by value:system, value:type | ||
| identifier | 0..* | Identifier | Local Dispense Identifier | |
  type | 1..1 | CodeableConcept | Coded identifier type for local dispense identifier Binding: v2 Identifier Type - AU Extended (required) | |
 coding | 1..1 | Coding | ||
| system | 1..1 | uri | Fixed Value: http://hl7.org.au/fhir/v2/0203 | |
 code | 1..1 | code | Fixed Value: LDI | |
| text | 1..1 | string | Fixed Value: Local Dispense Identifier | |
| system | 1..1 | uri | Namespace for local dispense record identifier | |
| value | 1..1 | string | Dispense record identifier | |
 assigner | 1..1 | Reference(Organization) | ||
 display | 1..1 | string | ||
| medication[x] | CodeableConcept, Reference(AU Base Medication) | Slice: Unordered, Open by type:$this | ||
 medication[x] | I | 1..1 | CodeableConcept | Coded Dispensed Medication inv-amt-tpuu: AMT TPUU valueset membership required inv-amt-tpp: AMT TPU valueset membership required inv-amt-tp: AMT TP valueset membership required inv-amp-mpuu: AMT MPUU valueset membership required inv-amt-mpp: AMT MPP valueset membership required inv-amt-mp: AMT MP valueset membership required inv-amt-ctpp: AMT CTPP valueset membership required |
| coding | Coding | Slice: Unordered, Open by value:system, value:code | ||
| coding | 0..* | Coding | PBS Item Code Binding: PBS Medicines Item Codes (required) | |
| coding | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (required) | |
| coding | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required) | |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
| medication-type | 0..1 | Coding | Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |
| coding | 0..1 | Coding | MIMS Package Binding: MIMS Terminology (required) | |
| text | 0..1 | string | Medication primary text | |
 medication[x] | 1..1 | Reference(AU Base Medication) | Dispensed Medication | |
| authorizingPrescription | 0..* | Reference(http://hl7.org.au/fhir/StructureDefinition/au-prescription) | ||
| dosageInstruction | 0..* | AUBaseDosage | ||
| additionalInstruction | CodeableConcept | Slice: Unordered, Open by value:coding.system | ||
| asNeeded[x] | boolean, CodeableConcept | Slice: Unordered, Open by type:$this | ||
| asNeeded[x] | 0..1 | boolean, CodeableConcept | ||
| coding | Slice: Unordered, Open by value:system | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense | I | 0..* | A dispense record for a medication for a patient in an Australian healthcare context | |
 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| grounds-for-concurrent-supply | I | 0..1 | Coding | Grounds for Concurrent Supply of Medication URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply Binding: Grounds for Concurrent Supply (required) |
| dispense-number | I | 0..1 | integer | Number of this Dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number |
| medication-brand-name | I | 0..1 | string | Medication Brand Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name |
| medication-generic-name | I | 0..1 | string | Medication Generic Drug Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Identifier | External identifier Slice: Unordered, Open by value:system, value:type | ||
| identifier | 0..* | Identifier | Local Dispense Identifier | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Coded identifier type for local dispense identifier Binding: v2 Identifier Type - AU Extended (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LDI |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Local Dispense Identifier |
| system | Σ | 1..1 | uri | Namespace for local dispense record identifier Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
| value | Σ | 1..1 | string | Dispense record identifier Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 1..1 | string | Text alternative for the resource |
| partOf | 0..* | Reference(Procedure) | Event that dispense is part of | |
| status | ?!Σ | 0..1 | code | preparation | in-progress | on-hold | completed | entered-in-error | stopped Binding: MedicationDispenseStatus (required) |
| category | 0..1 | CodeableConcept | Type of medication dispense Binding: MedicationDispenseCategory (preferred) | |
 medication[x] | Σ | 1..1 | CodeableConcept, Reference(AU Base Medication) | What medication was supplied Binding: SNOMED CT Medication Codes (example) |
| medicationCodeableConcept | ΣI | 1..1 | CodeableConcept | Coded Dispensed Medication Binding: SNOMED CT Medication Codes (example) inv-amt-tpuu: AMT TPUU valueset membership required inv-amt-tpp: AMT TPU valueset membership required inv-amt-tp: AMT TP valueset membership required inv-amp-mpuu: AMT MPUU valueset membership required inv-amt-mpp: AMT MPP valueset membership required inv-amt-mp: AMT MP valueset membership required inv-amt-ctpp: AMT CTPP valueset membership required |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code | |
| coding | Σ | 0..* | Coding | PBS Item Code Binding: PBS Medicines Item Codes (required) |
| coding | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (required) |
| coding | Σ | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| medication-type | 0..1 | Coding | Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/medication-type" | |
| valueCoding | 1..1 | Coding | Value of extension Binding: Medication Type (required) | |
| system | Σ | 0..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding | Σ | 0..1 | Coding | MIMS Package Binding: MIMS Terminology (required) |
| text | Σ | 0..1 | string | Medication primary text |
| medicationReference | Σ | 1..1 | Reference(AU Base Medication) | Dispensed Medication |
| 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 | I | 0..* | BackboneElement | Who performed event |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| actor | 1..1 | Reference(Practitioner | Organization | Patient | Device | RelatedPerson) | Individual who was performing | |
| onBehalfOf | 0..1 | Reference(Organization) | Organization organization was acting for | |
| authorizingPrescription | 0..* | Reference(http://hl7.org.au/fhir/StructureDefinition/au-prescription) | Medication order that authorizes the dispense | |
| type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
| 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 | I | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| sequence | Σ | 0..1 | integer | The order of the dosage instructions |
| text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
| additionalInstruction | Σ | CodeableConcept | Supplemental instruction - e.g. "with meals" Slice: Unordered, Open by value:coding.system Binding: SNOMED CT Additional Dosage Instructions (example) | |
| additionalInstruction | Σ | 0..* | CodeableConcept | SNOMED CT Additional Instruction Binding: SNOMED CT Additional Dosage Instructions (required) |
| patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions |
| timing | Σ | 0..1 | Timing | When medication should be administered |
| asNeeded[x] | Σ | 0..1 | boolean, CodeableConcept | Take "as needed" (for x) Binding: SNOMED CT Medication As Needed Reason Codes (example) |
| asNeeded[x] | Σ | 0..1 | boolean, CodeableConcept | Take "as needed" (for x) Binding: SNOMED CT Medication As Needed Reason Codes (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| asNeededCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Reason For Take "as needed" Binding: SNOMED CT Medication As Needed Reason Codes (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 0..1 | Coding | Clinical Finding (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMED CT Route Codes (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 0..1 | Coding | Route of Administration (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMED CT Administration Method Codes (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 0..1 | Coding | SNOMED CT Administration Method Binding: SNOMED CT Administration Method Codes (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| dose[x] | Σ | 0..1 | Range, SimpleQuantity | Amount of medication per dose |
| maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
| maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
| maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
| rate[x] | Σ | 0..1 | Ratio, Range, SimpleQuantity | Amount of medication per unit of time |
| substitution | I | 0..1 | BackboneElement | Whether a substitution was performed on the dispense |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| 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) | |
| reason | 0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example) | |
| responsibleParty | 0..* | Reference(Practitioner) | Who is responsible for the substitution | |
| detectedIssue | 0..* | Reference(DetectedIssue) | Clinical issue with action | |
| notDone | 0..1 | boolean | Whether the dispense was or was not performed | |
| notDoneReason[x] | 0..1 | CodeableConcept, Reference(DetectedIssue) | Why a dispense was not performed | |
| eventHistory | 0..* | Reference(Provenance) | A list of releveant lifecycle events | |
| Documentation for this format | ||||
This profile contains the following variations from MedicationDispense:
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense | 0..* | A dispense record for a medication for a patient in an Australian healthcare context | ||
| extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
| grounds-for-concurrent-supply | 0..1 | Coding | Grounds for Concurrent Supply of Medication URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply Binding: Grounds for Concurrent Supply (required) | |
| dispense-number | 0..1 | integer | Number of this Dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number | |
| medication-brand-name | 0..1 | string | Medication Brand Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name | |
| medication-generic-name | 0..1 | string | Medication Generic Drug Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name | |
| identifier | Identifier | Slice: Unordered, Open by value:system, value:type | ||
| identifier | 0..* | Identifier | Local Dispense Identifier | |
| type | 1..1 | CodeableConcept | Coded identifier type for local dispense identifier Binding: v2 Identifier Type - AU Extended (required) | |
| coding | 1..1 | Coding | ||
| system | 1..1 | uri | Fixed Value: http://hl7.org.au/fhir/v2/0203 | |
| code | 1..1 | code | Fixed Value: LDI | |
| text | 1..1 | string | Fixed Value: Local Dispense Identifier | |
| system | 1..1 | uri | Namespace for local dispense record identifier | |
| value | 1..1 | string | Dispense record identifier | |
| assigner | 1..1 | Reference(Organization) | ||
| display | 1..1 | string | ||
| medication[x] | CodeableConcept, Reference(AU Base Medication) | Slice: Unordered, Open by type:$this | ||
| medication[x] | I | 1..1 | CodeableConcept | Coded Dispensed Medication inv-amt-tpuu: AMT TPUU valueset membership required inv-amt-tpp: AMT TPU valueset membership required inv-amt-tp: AMT TP valueset membership required inv-amp-mpuu: AMT MPUU valueset membership required inv-amt-mpp: AMT MPP valueset membership required inv-amt-mp: AMT MP valueset membership required inv-amt-ctpp: AMT CTPP valueset membership required |
| coding | Coding | Slice: Unordered, Open by value:system, value:code | ||
| coding | 0..* | Coding | PBS Item Code Binding: PBS Medicines Item Codes (required) | |
| coding | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (required) | |
| coding | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required) | |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
| medication-type | 0..1 | Coding | Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |
| coding | 0..1 | Coding | MIMS Package Binding: MIMS Terminology (required) | |
| text | 0..1 | string | Medication primary text | |
| medication[x] | 1..1 | Reference(AU Base Medication) | Dispensed Medication | |
| authorizingPrescription | 0..* | Reference(http://hl7.org.au/fhir/StructureDefinition/au-prescription) | ||
| dosageInstruction | 0..* | AUBaseDosage | ||
| additionalInstruction | CodeableConcept | Slice: Unordered, Open by value:coding.system | ||
| asNeeded[x] | boolean, CodeableConcept | Slice: Unordered, Open by type:$this | ||
| asNeeded[x] | 0..1 | boolean, CodeableConcept | ||
| coding | Slice: Unordered, Open by value:system | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense | I | 0..* | A dispense record for a medication for a patient in an Australian healthcare context | |
| 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| grounds-for-concurrent-supply | I | 0..1 | Coding | Grounds for Concurrent Supply of Medication URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply Binding: Grounds for Concurrent Supply (required) |
| dispense-number | I | 0..1 | integer | Number of this Dispense URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number |
| medication-brand-name | I | 0..1 | string | Medication Brand Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name |
| medication-generic-name | I | 0..1 | string | Medication Generic Drug Name URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Identifier | External identifier Slice: Unordered, Open by value:system, value:type | ||
| identifier | 0..* | Identifier | Local Dispense Identifier | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Coded identifier type for local dispense identifier Binding: v2 Identifier Type - AU Extended (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LDI |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 1..1 | string | Plain text representation of the concept Fixed Value: Local Dispense Identifier |
| system | Σ | 1..1 | uri | Namespace for local dispense record identifier Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
| value | Σ | 1..1 | string | Dispense record identifier Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 1..1 | string | Text alternative for the resource |
| partOf | 0..* | Reference(Procedure) | Event that dispense is part of | |
| status | ?!Σ | 0..1 | code | preparation | in-progress | on-hold | completed | entered-in-error | stopped Binding: MedicationDispenseStatus (required) |
| category | 0..1 | CodeableConcept | Type of medication dispense Binding: MedicationDispenseCategory (preferred) | |
| medication[x] | Σ | 1..1 | CodeableConcept, Reference(AU Base Medication) | What medication was supplied Binding: SNOMED CT Medication Codes (example) |
| medicationCodeableConcept | ΣI | 1..1 | CodeableConcept | Coded Dispensed Medication Binding: SNOMED CT Medication Codes (example) inv-amt-tpuu: AMT TPUU valueset membership required inv-amt-tpp: AMT TPU valueset membership required inv-amt-tp: AMT TP valueset membership required inv-amp-mpuu: AMT MPUU valueset membership required inv-amt-mpp: AMT MPP valueset membership required inv-amt-mp: AMT MP valueset membership required inv-amt-ctpp: AMT CTPP valueset membership required |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code | |
| coding | Σ | 0..* | Coding | PBS Item Code Binding: PBS Medicines Item Codes (required) |
| coding | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN for Medicines (required) |
| coding | Σ | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| medication-type | 0..1 | Coding | Class of Medication Coding URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/medication-type" | |
| valueCoding | 1..1 | Coding | Value of extension Binding: Medication Type (required) | |
| system | Σ | 0..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding | Σ | 0..1 | Coding | MIMS Package Binding: MIMS Terminology (required) |
| text | Σ | 0..1 | string | Medication primary text |
| medicationReference | Σ | 1..1 | Reference(AU Base Medication) | Dispensed Medication |
| 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 | I | 0..* | BackboneElement | Who performed event |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| actor | 1..1 | Reference(Practitioner | Organization | Patient | Device | RelatedPerson) | Individual who was performing | |
| onBehalfOf | 0..1 | Reference(Organization) | Organization organization was acting for | |
| authorizingPrescription | 0..* | Reference(http://hl7.org.au/fhir/StructureDefinition/au-prescription) | Medication order that authorizes the dispense | |
| type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
| 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 | I | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| sequence | Σ | 0..1 | integer | The order of the dosage instructions |
| text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
| additionalInstruction | Σ | CodeableConcept | Supplemental instruction - e.g. "with meals" Slice: Unordered, Open by value:coding.system Binding: SNOMED CT Additional Dosage Instructions (example) | |
| additionalInstruction | Σ | 0..* | CodeableConcept | SNOMED CT Additional Instruction Binding: SNOMED CT Additional Dosage Instructions (required) |
| patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions |
| timing | Σ | 0..1 | Timing | When medication should be administered |
| asNeeded[x] | Σ | 0..1 | boolean, CodeableConcept | Take "as needed" (for x) Binding: SNOMED CT Medication As Needed Reason Codes (example) |
| asNeeded[x] | Σ | 0..1 | boolean, CodeableConcept | Take "as needed" (for x) Binding: SNOMED CT Medication As Needed Reason Codes (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| asNeededCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Reason For Take "as needed" Binding: SNOMED CT Medication As Needed Reason Codes (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 0..1 | Coding | Clinical Finding (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..1 | Coding | Code defined by a terminology system Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMED CT Route Codes (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 0..1 | Coding | Route of Administration (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMED CT Administration Method Codes (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 0..1 | Coding | SNOMED CT Administration Method Binding: SNOMED CT Administration Method Codes (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| dose[x] | Σ | 0..1 | Range, SimpleQuantity | Amount of medication per dose |
| maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
| maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
| maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
| rate[x] | Σ | 0..1 | Ratio, Range, SimpleQuantity | Amount of medication per unit of time |
| substitution | I | 0..1 | BackboneElement | Whether a substitution was performed on the dispense |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| 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) | |
| reason | 0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example) | |
| responsibleParty | 0..* | Reference(Practitioner) | Who is responsible for the substitution | |
| detectedIssue | 0..* | Reference(DetectedIssue) | Clinical issue with action | |
| notDone | 0..1 | boolean | Whether the dispense was or was not performed | |
| notDoneReason[x] | 0..1 | CodeableConcept, Reference(DetectedIssue) | Why a dispense was not performed | |
| eventHistory | 0..* | Reference(Provenance) | A list of releveant lifecycle events | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-medicationdispense
none defined
© AU Base 1 on FHIR STU3 (IG Publisher v3.0.1-11917) generated on Sat, Jun 1, 2019 11:30+1000. |
