Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.9.3: AU Base 1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-dispenserecord

AU Base Dispense Record [FMM Level 0]

This profile defines a dispense record information structure including core localisation concepts for Australia.

Identifiers

These definitions represent common data held in the MedicationDispense.identifier element:

  • Local Dispense Identifier - dispenser system identifier for this record.

Extensions

Extensions used in this profile:

  • MedicationDispense: Grounds for Concurrent Supply [1]
  • MedicationDispense: Dispense Number [1]
  • MedicationDispense.medication.coding: Medication Type [1]

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-dispenserecord

Australian realm dispense record profile.

This profile builds on MedicationDispense.

This profile was published on Thu May 11 09:51:36 AEST 2017 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:

  1. zero or more extension sliced
    • at most one groundsForConcurrentSupply extension
    • at most one dispenseNumber extension
  2. zero or more identifier sliced
    • zero or more identifier Local Dispense Identifier
  3. exactly one medication[x] sliced
    • medication[x] Coded medication
    • coding Medication PBS coding (ignore item context)
    • coding Medication Package GTIN
    • coding AMT Trade Product Pack
      • Type of medication coding extension
    • coding AMT Medicinal Product Pack
      • Type of medication coding extension
    • coding AMT Containered Trade Product Pack
      • Type of medication coding extension
    • coding AMT Trade Product Unit of Use
      • Type of medication coding extension
    • coding AMT Medicinal Product Unit of Use
      • Type of medication coding extension
    • coding AMT Trade Product
      • Type of medication coding extension
    • coding AMT Medicinal Product
      • Type of medication coding extension
    • coding MIMS Package
    • medication[x] Dispensed medication (Reference as: au-medication)
  4. at most one subject Subject of dispened medication (Reference as: au-patient | Group)
  5. zero or more authorizingPrescription (Reference as: au-prescription)
  6. zero or more receiver (Reference as: au-patient | au-practitioner)
  7. zero or more dosageInstruction
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..*Australian dispense record
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... grounds-for-concurrent-supply 0..1CodingGrounds 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..1integerNumber of this dispense
URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
... identifier IdentifierSlice: Unordered, Open by value:system, value:type
... identifier 0..*IdentifierLocal Dispense Identifier
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding 1..1Coding
...... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
...... code 1..1codeFixed Value: LDI
..... text 1..1stringFixed Value: Local Dispense Identifier
.... system 1..1uri
.... value 1..1string
.... assigner 1..1Reference(Organization)
..... display 1..1string
... medication[x] CodeableConcept, Reference(AU Base Medication)Slice: Unordered, Open by type:$this
​... medication[x] 1..1CodeableConceptCoded medication
​.... coding CodingSlice: Unordered, Open by value:system, value:code
​.... coding 0..*CodingMedication PBS coding (ignore item context)
Binding: PBS Medicines Item Codes (required)
​.... coding 0..*CodingMedication Package GTIN
Binding: GTIN for Medicines (required)
​.... coding 0..1CodingAMT Trade Product Pack
Binding: AMT Trade Product Pack (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPG","display":"Branded package with no container"}
​.... coding 0..1CodingAMT Medicinal Product Pack
Binding: AMT Medicinal Product Pack (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPG","display":"Unbranded package with no container"}
​.... coding 0..1CodingAMT Containered Trade Product Pack
Binding: AMT Containered Trade Product Pack (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPGC","display":"Branded package with container"}
​.... coding 0..1CodingAMT Trade Product Unit of Use
Binding: AMT Trade Product Unit of Use (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPDSF","display":"Branded product with strengths and form"}
​.... coding 0..1CodingAMT Medicinal Product Unit of Use
Binding: AMT Medicinal Product Unit of Use (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPDSF","display":"Unbranded product with strengths and form"}
​.... coding 0..1CodingAMT Trade Product
Binding: AMT Trade Product (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPD","display":"Branded product with no strengths or form"}
​.... coding 0..1CodingAMT Medicinal Product
Binding: AMT Medicinal Product (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPD","display":"Unbranded product with no strengths or form"}
​.... coding 0..1CodingMIMS Package
Binding: MIMS Terminology (required)
​... medication[x] 1..1Reference(AU Base Medication)Dispensed medication
... subject 0..1Reference(AU Base Patient | Group)Subject of dispened medication
... authorizingPrescription 0..*Reference(AU Base Prescription)
... receiver 0..*Reference(AU Base Patient | AU Base Practitioner)
... dosageInstruction 0..*AUBaseDosage

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense I0..*Australian dispense record
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... grounds-for-concurrent-supply I0..1CodingGrounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
Binding: Grounds for Concurrent Supply (required)
... dispense-number I0..1integerNumber of this dispense
URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier IdentifierExternal identifier
Slice: Unordered, Open by value:system, value:type
... identifier 0..*IdentifierLocal Dispense Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: LDI
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Local Dispense Identifier
.... system Σ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ1..1stringText alternative for the resource
... partOf 0..*Reference(Procedure)Event that dispense is part of
... status ?!Σ0..1codepreparation | in-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationDispenseStatus (required)
... category 0..1CodeableConceptType of medication dispense
Binding: MedicationDispenseCategory (preferred)
... medication[x] ΣCodeableConcept, Reference(AU Base Medication)What medication was supplied
Slice: Unordered, Open by type:$this
Binding: SNOMED CT Medication Codes (example)
... medicationCodeableConcept Σ1..1CodeableConceptCoded medication
Binding: SNOMED CT Medication Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
.... coding Σ0..*CodingMedication PBS coding (ignore item context)
Binding: PBS Medicines Item Codes (required)
.... coding Σ0..*CodingMedication Package GTIN
Binding: GTIN for Medicines (required)
.... coding Σ0..1CodingAMT Trade Product Pack
Binding: AMT Trade Product Pack (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPG","display":"Branded package with no container"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingAMT Medicinal Product Pack
Binding: AMT Medicinal Product Pack (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPG","display":"Unbranded package with no container"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingAMT Containered Trade Product Pack
Binding: AMT Containered Trade Product Pack (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPGC","display":"Branded package with container"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingAMT Trade Product Unit of Use
Binding: AMT Trade Product Unit of Use (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPDSF","display":"Branded product with strengths and form"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingAMT Medicinal Product Unit of Use
Binding: AMT Medicinal Product Unit of Use (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPDSF","display":"Unbranded product with strengths and form"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingAMT Trade Product
Binding: AMT Trade Product (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPD","display":"Branded product with no strengths or form"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingAMT Medicinal Product
Binding: AMT Medicinal Product (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPD","display":"Unbranded product with no strengths or form"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text Σ0..1stringPlain text representation of the concept
... medicationReference Σ1..1Reference(AU Base Medication)Dispensed medication
... subject Σ0..1Reference(AU Base Patient | Group)Subject of dispened medication
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter / Episode associated with event
... supportingInformation 0..*Reference(Resource)Information that supports the dispensing of the medication
... performer I0..*BackboneElementWho performed event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... actor 1..1Reference(Practitioner | Organization | Patient | Device | RelatedPerson)Individual who was performing
.... onBehalfOf 0..1Reference(Organization)Organization organization was acting for
... authorizingPrescription 0..*Reference(AU Base Prescription)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example)
... quantity 0..1SimpleQuantityAmount dispensed
... daysSupply 0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..1Reference(Location)Where the medication was sent
... receiver 0..*Reference(AU Base Patient | AU Base Practitioner)Who collected the medication
... note 0..*AnnotationInformation about the dispense
... dosageInstruction 0..*AUBaseDosageHow the medication is to be used by the patient or administered by the caregiver
... substitution I0..1BackboneElementWhether a substitution was performed on the dispense
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... wasSubstituted 1..1booleanWhether a substitution was or was not performed on the dispense
.... type 0..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example)
.... reason 0..*CodeableConceptWhy 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..1booleanWhether the dispense was or was not performed
... notDoneReason[x] 0..1CodeableConcept, Reference(DetectedIssue)Why a dispense was not performed
... eventHistory 0..*Reference(Provenance)A list of releveant lifecycle events

doco Documentation for this format

This profile contains the following variations from MedicationDispense:

  1. zero or more extension sliced
    • at most one groundsForConcurrentSupply extension
    • at most one dispenseNumber extension
  2. zero or more identifier sliced
    • zero or more identifier Local Dispense Identifier
  3. exactly one medication[x] sliced
    • medication[x] Coded medication
    • coding Medication PBS coding (ignore item context)
    • coding Medication Package GTIN
    • coding AMT Trade Product Pack
      • Type of medication coding extension
    • coding AMT Medicinal Product Pack
      • Type of medication coding extension
    • coding AMT Containered Trade Product Pack
      • Type of medication coding extension
    • coding AMT Trade Product Unit of Use
      • Type of medication coding extension
    • coding AMT Medicinal Product Unit of Use
      • Type of medication coding extension
    • coding AMT Trade Product
      • Type of medication coding extension
    • coding AMT Medicinal Product
      • Type of medication coding extension
    • coding MIMS Package
    • medication[x] Dispensed medication (Reference as: au-medication)
  4. at most one subject Subject of dispened medication (Reference as: au-patient | Group)
  5. zero or more authorizingPrescription (Reference as: au-prescription)
  6. zero or more receiver (Reference as: au-patient | au-practitioner)
  7. zero or more dosageInstruction

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..*Australian dispense record
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... grounds-for-concurrent-supply 0..1CodingGrounds 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..1integerNumber of this dispense
URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
... identifier IdentifierSlice: Unordered, Open by value:system, value:type
... identifier 0..*IdentifierLocal Dispense Identifier
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding 1..1Coding
...... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
...... code 1..1codeFixed Value: LDI
..... text 1..1stringFixed Value: Local Dispense Identifier
.... system 1..1uri
.... value 1..1string
.... assigner 1..1Reference(Organization)
..... display 1..1string
... medication[x] CodeableConcept, Reference(AU Base Medication)Slice: Unordered, Open by type:$this
​... medication[x] 1..1CodeableConceptCoded medication
​.... coding CodingSlice: Unordered, Open by value:system, value:code
​.... coding 0..*CodingMedication PBS coding (ignore item context)
Binding: PBS Medicines Item Codes (required)
​.... coding 0..*CodingMedication Package GTIN
Binding: GTIN for Medicines (required)
​.... coding 0..1CodingAMT Trade Product Pack
Binding: AMT Trade Product Pack (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPG","display":"Branded package with no container"}
​.... coding 0..1CodingAMT Medicinal Product Pack
Binding: AMT Medicinal Product Pack (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPG","display":"Unbranded package with no container"}
​.... coding 0..1CodingAMT Containered Trade Product Pack
Binding: AMT Containered Trade Product Pack (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPGC","display":"Branded package with container"}
​.... coding 0..1CodingAMT Trade Product Unit of Use
Binding: AMT Trade Product Unit of Use (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPDSF","display":"Branded product with strengths and form"}
​.... coding 0..1CodingAMT Medicinal Product Unit of Use
Binding: AMT Medicinal Product Unit of Use (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPDSF","display":"Unbranded product with strengths and form"}
​.... coding 0..1CodingAMT Trade Product
Binding: AMT Trade Product (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPD","display":"Branded product with no strengths or form"}
​.... coding 0..1CodingAMT Medicinal Product
Binding: AMT Medicinal Product (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
​...... valueCoding 1..1CodingFixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPD","display":"Unbranded product with no strengths or form"}
​.... coding 0..1CodingMIMS Package
Binding: MIMS Terminology (required)
​... medication[x] 1..1Reference(AU Base Medication)Dispensed medication
... subject 0..1Reference(AU Base Patient | Group)Subject of dispened medication
... authorizingPrescription 0..*Reference(AU Base Prescription)
... receiver 0..*Reference(AU Base Patient | AU Base Practitioner)
... dosageInstruction 0..*AUBaseDosage

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense I0..*Australian dispense record
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... grounds-for-concurrent-supply I0..1CodingGrounds for concurrent supply of medication
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
Binding: Grounds for Concurrent Supply (required)
... dispense-number I0..1integerNumber of this dispense
URL: http://hl7.org.au/fhir/StructureDefinition/dispense-number
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier IdentifierExternal identifier
Slice: Unordered, Open by value:system, value:type
... identifier 0..*IdentifierLocal Dispense Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: LDI
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Local Dispense Identifier
.... system Σ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ1..1stringText alternative for the resource
... partOf 0..*Reference(Procedure)Event that dispense is part of
... status ?!Σ0..1codepreparation | in-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationDispenseStatus (required)
... category 0..1CodeableConceptType of medication dispense
Binding: MedicationDispenseCategory (preferred)
... medication[x] ΣCodeableConcept, Reference(AU Base Medication)What medication was supplied
Slice: Unordered, Open by type:$this
Binding: SNOMED CT Medication Codes (example)
... medicationCodeableConcept Σ1..1CodeableConceptCoded medication
Binding: SNOMED CT Medication Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
.... coding Σ0..*CodingMedication PBS coding (ignore item context)
Binding: PBS Medicines Item Codes (required)
.... coding Σ0..*CodingMedication Package GTIN
Binding: GTIN for Medicines (required)
.... coding Σ0..1CodingAMT Trade Product Pack
Binding: AMT Trade Product Pack (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPG","display":"Branded package with no container"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingAMT Medicinal Product Pack
Binding: AMT Medicinal Product Pack (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPG","display":"Unbranded package with no container"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingAMT Containered Trade Product Pack
Binding: AMT Containered Trade Product Pack (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPGC","display":"Branded package with container"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingAMT Trade Product Unit of Use
Binding: AMT Trade Product Unit of Use (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPDSF","display":"Branded product with strengths and form"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingAMT Medicinal Product Unit of Use
Binding: AMT Medicinal Product Unit of Use (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPDSF","display":"Unbranded product with strengths and form"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingAMT Trade Product
Binding: AMT Trade Product (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"BPD","display":"Branded product with no strengths or form"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingAMT Medicinal Product
Binding: AMT Medicinal Product (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingType of medication coding
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
Fixed Value: {"system":"http://hl7.org.au/fhir/CodeSystem/medication-type","code":"UPD","display":"Unbranded product with no strengths or form"}
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text Σ0..1stringPlain text representation of the concept
... medicationReference Σ1..1Reference(AU Base Medication)Dispensed medication
... subject Σ0..1Reference(AU Base Patient | Group)Subject of dispened medication
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter / Episode associated with event
... supportingInformation 0..*Reference(Resource)Information that supports the dispensing of the medication
... performer I0..*BackboneElementWho performed event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... actor 1..1Reference(Practitioner | Organization | Patient | Device | RelatedPerson)Individual who was performing
.... onBehalfOf 0..1Reference(Organization)Organization organization was acting for
... authorizingPrescription 0..*Reference(AU Base Prescription)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example)
... quantity 0..1SimpleQuantityAmount dispensed
... daysSupply 0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared Σ0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver 0..1dateTimeWhen product was given out
... destination 0..1Reference(Location)Where the medication was sent
... receiver 0..*Reference(AU Base Patient | AU Base Practitioner)Who collected the medication
... note 0..*AnnotationInformation about the dispense
... dosageInstruction 0..*AUBaseDosageHow the medication is to be used by the patient or administered by the caregiver
... substitution I0..1BackboneElementWhether a substitution was performed on the dispense
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... wasSubstituted 1..1booleanWhether a substitution was or was not performed on the dispense
.... type 0..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example)
.... reason 0..*CodeableConceptWhy 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..1booleanWhether the dispense was or was not performed
... notDoneReason[x] 0..1CodeableConcept, Reference(DetectedIssue)Why a dispense was not performed
... eventHistory 0..*Reference(Provenance)A list of releveant lifecycle events

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-dispenserecord

none defined