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

1.0 StructureDefinition-au-medicationstatement

AU Base Medication Statement [FMM Level 2]

This profile defines a medication statement structure including core localisation concepts for use in an Australian context.

Medication Reference/Coding

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:

  • PBS Item Code - Pharmaceutical Benefits Scheme coding, claiming context is not relevant as medicine coding.
  • GTIN - Global Trade Item Number, physical product reference.
  • AMT Code - Australian Medicines Terminology, national drug terminology.
  • MIMS Package - commonly used medicine coding.

Extensions

Extensions used in this profile:

  • MedicationStatement: Long Term [1]
  • MedicationStatement.medication.coding: Medication Type [1]
  • MedicationStatement: Medication Brand Name [1]
  • MedicationStatement: Medication Generic Drug Name [1]

Examples

Practitioner reports patient is taking Roferon-A three times a week on Mon Wed Sat

Long-term use of medication Zoloft

Practitioner reports patient has had Diflucan

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

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

This profile defines a medication statement structure including core localisation concepts for use in an Australian context.

This profile builds on MedicationStatement.

This profile was published on Fri May 05 10:53:27 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 MedicationStatement:

  1. extension sliced
    • Medication Long Term Indicator extension
    • Medication Brand Name extension
    • Medication Generic Drug Name extension
  2. medication[x] Medication Detail sliced
    • medication[x] Coded Medication
    • coding PBS Item Code
    • coding Medication Package Global Trade Item Number (GTIN)
    • coding AMT Medicines
      • Type of Medication Coding extension
    • coding MIMS Package
    • medication[x] Medication Reference (Reference as: au-medication)
  3. reasonNotTaken
    • coding Reason Not Taken (SNOMED CT)
    • coding Reason For Medication (SNOMED CT)
  4. dosage
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..*A record of medication being taken by a patient in an Australian healthcare context
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... medication-long-term 0..*booleanMedication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
... medication-brand-name 0..*stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..*stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... medication[x] CodeableConcept, Reference(AU Base Medication)Medication Detail
Slice: Unordered, Open by type:$this
​... medication[x] I1..1CodeableConceptCoded 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 CodingMedication Codes
Slice: Unordered, Open by value:system, value:code
​.... coding 0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
​.... coding 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
​.... coding 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingClass 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..1CodingMIMS Package
Binding: MIMS Terminology (required)
​... medication[x] 1..1Reference(AU Base Medication)Medication Reference
... dosage 0..*AUBaseDosage

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement I0..*A record of medication being taken by a patient in an Australian healthcare context
... 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)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... medication-long-term I0..*booleanMedication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
... medication-brand-name I0..*stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..*stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifier
... basedOn Σ0..*Reference(MedicationRequest | CarePlan | ProcedureRequest | ReferralRequest)Fulfils plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation)Part of referenced event
... context Σ0..1Reference(Encounter | EpisodeOfCare)Encounter / Episode associated with MedicationStatement
... status ?!Σ1..1codeactive | completed | entered-in-error | intended | stopped | on-hold
Binding: MedicationStatementStatus (required)
... category Σ0..1CodeableConceptType of medication usage
Binding: MedicationStatementCategory (preferred)
... medication[x] Σ1..1CodeableConcept, Reference(AU Base Medication)Medication Detail
Binding: SNOMED CT Medication Codes (example)
... medicationCodeableConcept ΣI1..1CodeableConceptCoded 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingMedication Codes
Slice: Unordered, Open by value:system, value:code
.... coding Σ0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
.... coding Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
.... coding Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingClass 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..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text Σ0..1stringPlain text representation of the concept
... medicationReference Σ1..1Reference(AU Base Medication)Medication Reference
... effective[x] Σ0..1dateTime, PeriodThe date/time or interval when the medication was taken
... dateAsserted Σ0..1dateTimeWhen the statement was asserted?
... informationSource 0..1Reference(Patient | Practitioner | RelatedPerson | Organization)Person or organization that provided the information about the taking of this medication
... subject Σ1..1Reference(Patient | Group)Who is/was taking the medication
... derivedFrom 0..*Reference(Resource)Additional supporting information
... taken ?!Σ1..1codey | n | unk | na
Binding: MedicationStatementTaken (required)
... reasonNotTaken I0..*CodeableConceptTrue if asserting medication was not given
Binding: SNOMED CT Drugs not taken/completed 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
.... coding Σ0..1CodingReason Not Taken (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-not-taken-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... reasonCode 0..*CodeableConceptReason for why the medication is being/was taken
Binding: Condition/Problem/Diagnosis 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
.... coding Σ0..1CodingReason For Medication (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... reasonReference 0..*Reference(Condition | Observation)Condition or observation that supports why the medication is being/was taken
... note 0..*AnnotationFurther information about the statement
... dosage I0..*AUBaseDosageDosage information in an Australian healthcare context

doco Documentation for this format

This profile contains the following variations from MedicationStatement:

  1. extension sliced
    • Medication Long Term Indicator extension
    • Medication Brand Name extension
    • Medication Generic Drug Name extension
  2. medication[x] Medication Detail sliced
    • medication[x] Coded Medication
    • coding PBS Item Code
    • coding Medication Package Global Trade Item Number (GTIN)
    • coding AMT Medicines
      • Type of Medication Coding extension
    • coding MIMS Package
    • medication[x] Medication Reference (Reference as: au-medication)
  3. reasonNotTaken
    • coding Reason Not Taken (SNOMED CT)
    • coding Reason For Medication (SNOMED CT)
  4. dosage

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..*A record of medication being taken by a patient in an Australian healthcare context
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... medication-long-term 0..*booleanMedication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
... medication-brand-name 0..*stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..*stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... medication[x] CodeableConcept, Reference(AU Base Medication)Medication Detail
Slice: Unordered, Open by type:$this
​... medication[x] I1..1CodeableConceptCoded 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 CodingMedication Codes
Slice: Unordered, Open by value:system, value:code
​.... coding 0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
​.... coding 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
​.... coding 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
​..... extension 0..*ExtensionSlice: Unordered, Open by value:url
​..... medication-type 0..1CodingClass 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..1CodingMIMS Package
Binding: MIMS Terminology (required)
​... medication[x] 1..1Reference(AU Base Medication)Medication Reference
... dosage 0..*AUBaseDosage

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement I0..*A record of medication being taken by a patient in an Australian healthcare context
... 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)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... medication-long-term I0..*booleanMedication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
... medication-brand-name I0..*stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..*stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifier
... basedOn Σ0..*Reference(MedicationRequest | CarePlan | ProcedureRequest | ReferralRequest)Fulfils plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation)Part of referenced event
... context Σ0..1Reference(Encounter | EpisodeOfCare)Encounter / Episode associated with MedicationStatement
... status ?!Σ1..1codeactive | completed | entered-in-error | intended | stopped | on-hold
Binding: MedicationStatementStatus (required)
... category Σ0..1CodeableConceptType of medication usage
Binding: MedicationStatementCategory (preferred)
... medication[x] Σ1..1CodeableConcept, Reference(AU Base Medication)Medication Detail
Binding: SNOMED CT Medication Codes (example)
... medicationCodeableConcept ΣI1..1CodeableConceptCoded 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..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingMedication Codes
Slice: Unordered, Open by value:system, value:code
.... coding Σ0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
.... coding Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
.... coding Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingClass 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..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text Σ0..1stringPlain text representation of the concept
... medicationReference Σ1..1Reference(AU Base Medication)Medication Reference
... effective[x] Σ0..1dateTime, PeriodThe date/time or interval when the medication was taken
... dateAsserted Σ0..1dateTimeWhen the statement was asserted?
... informationSource 0..1Reference(Patient | Practitioner | RelatedPerson | Organization)Person or organization that provided the information about the taking of this medication
... subject Σ1..1Reference(Patient | Group)Who is/was taking the medication
... derivedFrom 0..*Reference(Resource)Additional supporting information
... taken ?!Σ1..1codey | n | unk | na
Binding: MedicationStatementTaken (required)
... reasonNotTaken I0..*CodeableConceptTrue if asserting medication was not given
Binding: SNOMED CT Drugs not taken/completed 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
.... coding Σ0..1CodingReason Not Taken (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-not-taken-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... reasonCode 0..*CodeableConceptReason for why the medication is being/was taken
Binding: Condition/Problem/Diagnosis 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
.... coding Σ0..1CodingReason For Medication (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... reasonReference 0..*Reference(Condition | Observation)Condition or observation that supports why the medication is being/was taken
... note 0..*AnnotationFurther information about the statement
... dosage I0..*AUBaseDosageDosage information in an Australian healthcare context

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

none defined