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. Page versions: R5 R4 R3

1.0 StructureDefinition-au-medication

AU Base Medication

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

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

Medication record for Australian context

This profile builds on Medication.

This profile was published on Thu May 11 10:06:07 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.

AU Base Medication profile contains:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*Australian context Medication information
... code 0..1CodeableConceptCoding for the Medicine
.... coding CodingSlice: Unordered, Open by value:system, value:code
.... coding 0..*CodingMedication PBS coding
Binding: PBS Medicines Item Codes (required)
.... coding 0..*CodingMedication Package GTIN
Binding: GTIN for Medicines (required)
.... coding 0..*CodingAMT Trade Product Pack
Binding: AMT Trade Product Pack (required)
.... coding 0..*CodingAMT Medicinal Product Pack
Binding: AMT Medicinal Product Pack (required)
... manufacturer 0..1Reference(PBS Pharmaceutical Manufacturer)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*Australian context Medication information
... 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..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code Σ0..1CodeableConceptCoding for the Medicine
Binding: SNOMED CT Medication Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
.... coding Σ0..*CodingMedication PBS coding
Binding: PBS Medicines Item Codes (required)
.... coding Σ0..*CodingMedication Package GTIN
Binding: GTIN for Medicines (required)
.... coding Σ0..*CodingAMT Trade Product Pack
Binding: AMT Trade Product Pack (required)
.... coding Σ0..*CodingAMT Medicinal Product Pack
Binding: AMT Medicinal Product Pack (required)
.... text Σ0..1stringPlain text representation of the concept
... status Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationStatus (required)
... isBrand Σ0..1booleanTrue if a brand
... isOverTheCounter Σ0..1booleanTrue if medication does not require a prescription
... manufacturer Σ0..1Reference(PBS Pharmaceutical Manufacturer)Manufacturer of the item
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMED CT Form Codes (example)
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] 1..1CodeableConcept, Reference(Substance), Reference(Medication)The product contained
.... isActive 0..1booleanActive ingredient indicator
.... amount 0..1RatioQuantity of ingredient present
... package I0..1BackboneElementDetails about packaged medications
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: MedicationContainer (example)
.... content I0..*BackboneElementWhat is in the package
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... item[x] 1..1CodeableConcept, Reference(Medication)The item in the package
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch I0..*BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringIdentifier assigned to batch
..... expirationDate 0..1dateTimeWhen batch will expire
... image 0..*AttachmentPicture of the medication

doco Documentation for this format

AU Base Medication profile contains:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*Australian context Medication information
... code 0..1CodeableConceptCoding for the Medicine
.... coding CodingSlice: Unordered, Open by value:system, value:code
.... coding 0..*CodingMedication PBS coding
Binding: PBS Medicines Item Codes (required)
.... coding 0..*CodingMedication Package GTIN
Binding: GTIN for Medicines (required)
.... coding 0..*CodingAMT Trade Product Pack
Binding: AMT Trade Product Pack (required)
.... coding 0..*CodingAMT Medicinal Product Pack
Binding: AMT Medicinal Product Pack (required)
... manufacturer 0..1Reference(PBS Pharmaceutical Manufacturer)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*Australian context Medication information
... 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..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code Σ0..1CodeableConceptCoding for the Medicine
Binding: SNOMED CT Medication Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
.... coding Σ0..*CodingMedication PBS coding
Binding: PBS Medicines Item Codes (required)
.... coding Σ0..*CodingMedication Package GTIN
Binding: GTIN for Medicines (required)
.... coding Σ0..*CodingAMT Trade Product Pack
Binding: AMT Trade Product Pack (required)
.... coding Σ0..*CodingAMT Medicinal Product Pack
Binding: AMT Medicinal Product Pack (required)
.... text Σ0..1stringPlain text representation of the concept
... status Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationStatus (required)
... isBrand Σ0..1booleanTrue if a brand
... isOverTheCounter Σ0..1booleanTrue if medication does not require a prescription
... manufacturer Σ0..1Reference(PBS Pharmaceutical Manufacturer)Manufacturer of the item
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMED CT Form Codes (example)
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] 1..1CodeableConcept, Reference(Substance), Reference(Medication)The product contained
.... isActive 0..1booleanActive ingredient indicator
.... amount 0..1RatioQuantity of ingredient present
... package I0..1BackboneElementDetails about packaged medications
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: MedicationContainer (example)
.... content I0..*BackboneElementWhat is in the package
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... item[x] 1..1CodeableConcept, Reference(Medication)The item in the package
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch I0..*BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringIdentifier assigned to batch
..... expirationDate 0..1dateTimeWhen batch will expire
... image 0..*AttachmentPicture of the medication

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-medication

none defined