Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.4.0: R1 Draft) based on FHIR (HL7® FHIR® Standard) R3. The current version which supersedes this version is 6.0.0. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-dispenserecord

AU Base Dispense Record

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

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

Description of Australian dispense record

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.

Australian Dispense Record

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..*Australian Dispense Record
... identifier IdentifierSlice: Unordered, Open by value:system
... identifier 0..*IdentifierETP vendor identifier
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (extensible)
..... coding 1..1CodingRequired Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"ETP"}
..... text 1..1stringFixed Value: ETP Identifier
.... system 1..1uriETP Vendor Identifier System URL
.... value 1..1stringETP Vendor Identifier
.... assigner 1..1Reference(Organization)ETP Vendor
..... display 1..1stringETP Vendor Name
... identifier 0..*IdentifierLocal Script Number
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (extensible)
..... coding 1..1CodingRequired Pattern: {"code":"LPN"}
..... text 1..1stringFixed Value: Local Prescription Number
.... system 1..1uri
.... value 1..1string
.... assigner 1..1Reference(Organization)
..... display 1..1string
... medicationReference 1..1Reference(AU Base Medication)
... subject 0..1Reference(AU Base Patient), Reference(Patient), Reference(Group)
... 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)

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
... grounds-for-concurrent-supply 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
Binding: Grounds for concurrent supply (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier IdentifierExternal identifier
Slice: Unordered, Open by value:system
... identifier 0..*IdentifierETP vendor identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"ETP"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: ETP Identifier
.... system Σ1..1uriETP Vendor Identifier System URL
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringETP Vendor Identifier
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)ETP Vendor
..... id 0..1stringxml:id (or equivalent in JSON)
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ1..1stringETP Vendor Name
... identifier 0..*IdentifierLocal Script Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: {"code":"LPN"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Local Prescription Number
.... 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)
..... 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)
... medicationReference Σ1..1Reference(AU Base Medication)What medication was supplied
... subject Σ0..1Reference(AU Base Patient), Reference(Patient), Reference(Group)Who the dispense is for
... context 0..1Reference(Encounter), Reference(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), Reference(Organization), Reference(Patient), Reference(Device), Reference(RelatedPerson)Individual who was performing
.... onBehalfOf 0..1Reference(Organization)Organization organization was acting for
... authorizingPrescription 0..*Reference(MedicationRequest)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(Patient), Reference(Practitioner)Who collected the medication
... note 0..*AnnotationInformation about the dispense
... dosageInstruction 0..*DosageHow 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

Australian Dispense Record

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..*Australian Dispense Record
... identifier IdentifierSlice: Unordered, Open by value:system
... identifier 0..*IdentifierETP vendor identifier
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (extensible)
..... coding 1..1CodingRequired Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"ETP"}
..... text 1..1stringFixed Value: ETP Identifier
.... system 1..1uriETP Vendor Identifier System URL
.... value 1..1stringETP Vendor Identifier
.... assigner 1..1Reference(Organization)ETP Vendor
..... display 1..1stringETP Vendor Name
... identifier 0..*IdentifierLocal Script Number
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (extensible)
..... coding 1..1CodingRequired Pattern: {"code":"LPN"}
..... text 1..1stringFixed Value: Local Prescription Number
.... system 1..1uri
.... value 1..1string
.... assigner 1..1Reference(Organization)
..... display 1..1string
... medicationReference 1..1Reference(AU Base Medication)
... subject 0..1Reference(AU Base Patient), Reference(Patient), Reference(Group)
... 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)

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
... grounds-for-concurrent-supply 0..1CodingExtension
URL: http://hl7.org.au/fhir/StructureDefinition/grounds-for-concurrent-supply
Binding: Grounds for concurrent supply (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier IdentifierExternal identifier
Slice: Unordered, Open by value:system
... identifier 0..*IdentifierETP vendor identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"ETP"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: ETP Identifier
.... system Σ1..1uriETP Vendor Identifier System URL
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringETP Vendor Identifier
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)ETP Vendor
..... id 0..1stringxml:id (or equivalent in JSON)
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ1..1stringETP Vendor Name
... identifier 0..*IdentifierLocal Script Number
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingCode defined by a terminology system

Required Pattern: {"code":"LPN"}
..... text Σ1..1stringPlain text representation of the concept
Fixed Value: Local Prescription Number
.... 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)
..... 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)
... medicationReference Σ1..1Reference(AU Base Medication)What medication was supplied
... subject Σ0..1Reference(AU Base Patient), Reference(Patient), Reference(Group)Who the dispense is for
... context 0..1Reference(Encounter), Reference(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), Reference(Organization), Reference(Patient), Reference(Device), Reference(RelatedPerson)Individual who was performing
.... onBehalfOf 0..1Reference(Organization)Organization organization was acting for
... authorizingPrescription 0..*Reference(MedicationRequest)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(Patient), Reference(Practitioner)Who collected the medication
... note 0..*AnnotationInformation about the dispense
... dosageInstruction 0..*DosageHow 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