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

AU Dosage [FMM Level 0]

This profile is provided for use in an Australian context with common local codings.

Examples

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

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

Australian realm Base Dosage profile.

This profile builds on Dosage.

This profile was published on Fri Sep 14 09:24:23 AEST 2018 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 Dosage:

  1. zero or more additionalInstruction sliced
    • zero or more additionalInstruction SNOMED CT Additional Instruction
  2. at most one asNeeded[x] sliced
    • asNeeded[x] Coded Reason For Take “as needed”
    • coding Clinical Finding (SNOMED CT)
  3. at most one site
  4. at most one route
    • at most one coding Route of Administration (SNOMED CT)
  5. at most one method
    • at most one coding SNOMED CT Administration Method
NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*Dosage information in an Australian healthcare context
... additionalInstruction CodeableConceptSlice: Unordered, Open by value:coding.system
... additionalInstruction 0..*CodeableConceptSNOMED CT Additional Instruction
Binding: SNOMED CT Additional Dosage Instructions (required)
... asNeeded[x] boolean, CodeableConceptSlice: Unordered, Open by type:$this
​... asNeeded[x] 0..1CodeableConceptCoded Reason For Take "as needed"
​.... coding CodingSlice: Unordered, Open by value:system
​.... coding 0..1CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)
... site 0..1CodeableConcept
.... coding 0..1CodingBinding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (required)
... route 0..1CodeableConcept
.... coding CodingSlice: Unordered, Open by value:system
.... coding 0..1CodingRoute of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (required)
... method 0..1CodeableConcept
.... coding CodingSlice: Unordered, Open by value:system
.... coding 0..1CodingSNOMED CT Administration Method
Binding: SNOMED CT Administration Method Codes (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage I0..*Dosage information in an Australian healthcare context
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... sequence Σ0..1integerThe order of the dosage instructions
... text Σ0..1stringFree text dosage instructions e.g. SIG
... additionalInstruction ΣCodeableConceptSupplemental instruction - e.g. "with meals"
Slice: Unordered, Open by value:coding.system
Binding: SNOMED CT Additional Dosage Instructions (example)
... additionalInstruction Σ0..*CodeableConceptSNOMED CT Additional Instruction
Binding: SNOMED CT Additional Dosage Instructions (required)
... patientInstruction Σ0..1stringPatient or consumer oriented instructions
... timing Σ0..1TimingWhen medication should be administered
... asNeeded[x] Σboolean, CodeableConceptTake "as needed" (for x)
Slice: Unordered, Open by type:$this
Binding: SNOMED CT Medication As Needed Reason Codes (example)
... asNeededCodeableConcept Σ0..1CodeableConceptCoded Reason For Take "as needed"
Binding: SNOMED CT Medication As Needed Reason 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..1CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... site Σ0..1CodeableConceptBody site to administer to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCode defined by a terminology system
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... route Σ0..1CodeableConceptHow drug should enter body
Binding: SNOMED CT Route 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..1CodingRoute of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMED CT Administration Method 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..1CodingSNOMED CT Administration Method
Binding: SNOMED CT Administration Method Codes (required)
.... text Σ0..1stringPlain text representation of the concept
... dose[x] Σ0..1Range, SimpleQuantityAmount of medication per dose
... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
... maxDosePerLifetime Σ0..1SimpleQuantityUpper limit on medication per lifetime of the patient
... rate[x] Σ0..1Ratio, Range, SimpleQuantityAmount of medication per unit of time

doco Documentation for this format

This profile contains the following variations from Dosage:

  1. zero or more additionalInstruction sliced
    • zero or more additionalInstruction SNOMED CT Additional Instruction
  2. at most one asNeeded[x] sliced
    • asNeeded[x] Coded Reason For Take “as needed”
    • coding Clinical Finding (SNOMED CT)
  3. at most one site
  4. at most one route
    • at most one coding Route of Administration (SNOMED CT)
  5. at most one method
    • at most one coding SNOMED CT Administration Method

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*Dosage information in an Australian healthcare context
... additionalInstruction CodeableConceptSlice: Unordered, Open by value:coding.system
... additionalInstruction 0..*CodeableConceptSNOMED CT Additional Instruction
Binding: SNOMED CT Additional Dosage Instructions (required)
... asNeeded[x] boolean, CodeableConceptSlice: Unordered, Open by type:$this
​... asNeeded[x] 0..1CodeableConceptCoded Reason For Take "as needed"
​.... coding CodingSlice: Unordered, Open by value:system
​.... coding 0..1CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)
... site 0..1CodeableConcept
.... coding 0..1CodingBinding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (required)
... route 0..1CodeableConcept
.... coding CodingSlice: Unordered, Open by value:system
.... coding 0..1CodingRoute of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (required)
... method 0..1CodeableConcept
.... coding CodingSlice: Unordered, Open by value:system
.... coding 0..1CodingSNOMED CT Administration Method
Binding: SNOMED CT Administration Method Codes (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage I0..*Dosage information in an Australian healthcare context
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... sequence Σ0..1integerThe order of the dosage instructions
... text Σ0..1stringFree text dosage instructions e.g. SIG
... additionalInstruction ΣCodeableConceptSupplemental instruction - e.g. "with meals"
Slice: Unordered, Open by value:coding.system
Binding: SNOMED CT Additional Dosage Instructions (example)
... additionalInstruction Σ0..*CodeableConceptSNOMED CT Additional Instruction
Binding: SNOMED CT Additional Dosage Instructions (required)
... patientInstruction Σ0..1stringPatient or consumer oriented instructions
... timing Σ0..1TimingWhen medication should be administered
... asNeeded[x] Σboolean, CodeableConceptTake "as needed" (for x)
Slice: Unordered, Open by type:$this
Binding: SNOMED CT Medication As Needed Reason Codes (example)
... asNeededCodeableConcept Σ0..1CodeableConceptCoded Reason For Take "as needed"
Binding: SNOMED CT Medication As Needed Reason 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..1CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... site Σ0..1CodeableConceptBody site to administer to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..1CodingCode defined by a terminology system
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... route Σ0..1CodeableConceptHow drug should enter body
Binding: SNOMED CT Route 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..1CodingRoute of Administration (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMED CT Administration Method 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..1CodingSNOMED CT Administration Method
Binding: SNOMED CT Administration Method Codes (required)
.... text Σ0..1stringPlain text representation of the concept
... dose[x] Σ0..1Range, SimpleQuantityAmount of medication per dose
... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
... maxDosePerLifetime Σ0..1SimpleQuantityUpper limit on medication per lifetime of the patient
... rate[x] Σ0..1Ratio, Range, SimpleQuantityAmount of medication per unit of time

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

none defined