Australian Base Implementation Guide (AU Base 2)

This page is part of the Australian Base IG (v1.0.1: 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 2]

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

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

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

This profile builds on Dosage.

This profile was published on Tue Aug 13 00:45:26 AEST 2019 as a draft by Health Level Seven Australia (Medications WG).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*Dosage information in an Australian healthcare context
... additionalInstruction (Slice Definition)Slice: Unordered, Open by value:coding.system
.... snomedAdditionalInstruction 0..*CodeableConceptSNOMED CT Additional Instruction
Binding: (unbound) (required)
... asNeeded[x] (Slice Definition)Slice: Unordered, Closed by type:$this
.... asNeededCodeableConcept 0..1CodeableConceptCoded Reason For Take "as needed"
..... coding (Slice Definition)Slice: Unordered, Open by value:system
...... snomedFinding 0..1CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*Dosage information in an Australian healthcare context
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... sequence Σ0..1integerThe order of the dosage instructions
... text Σ0..1stringFree text dosage instructions e.g. SIG
... additionalInstruction Σ(Slice Definition)Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Slice: Unordered, Open by value:coding.system
Binding: SNOMEDCTAdditionalDosageInstructions (example)
.... snomedAdditionalInstruction Σ0..*CodeableConceptSNOMED CT Additional Instruction
Binding: (unbound) (required)
... patientInstruction Σ0..1stringPatient or consumer oriented instructions
... timing Σ0..1TimingWhen medication should be administered
... asNeeded[x] Σ(Slice Definition)Take "as needed" (for x)
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
.... asNeededCodeableConcept Σ0..1CodeableConceptCoded Reason For Take "as needed"
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... snomedFinding Σ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: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... 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: SNOMEDCTRouteCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... snomedRoute Σ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: SNOMEDCTAdministrationMethodCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... snomedMethod Σ0..1CodingSNOMED CT Administration Method
Binding: SNOMEDCTAdministrationMethodCodes (required)
.... text Σ0..1stringPlain text representation of the concept
... doseAndRate ΣI0..*ElementAmount of medication administered
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example)
.... dose[x] Σ0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity
.... rate[x] Σ0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity
... 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

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*Dosage information in an Australian healthcare context
... additionalInstruction (Slice Definition)Slice: Unordered, Open by value:coding.system
.... snomedAdditionalInstruction 0..*CodeableConceptSNOMED CT Additional Instruction
Binding: (unbound) (required)
... asNeeded[x] (Slice Definition)Slice: Unordered, Closed by type:$this
.... asNeededCodeableConcept 0..1CodeableConceptCoded Reason For Take "as needed"
..... coding (Slice Definition)Slice: Unordered, Open by value:system
...... snomedFinding 0..1CodingClinical Finding (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*Dosage information in an Australian healthcare context
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... sequence Σ0..1integerThe order of the dosage instructions
... text Σ0..1stringFree text dosage instructions e.g. SIG
... additionalInstruction Σ(Slice Definition)Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Slice: Unordered, Open by value:coding.system
Binding: SNOMEDCTAdditionalDosageInstructions (example)
.... snomedAdditionalInstruction Σ0..*CodeableConceptSNOMED CT Additional Instruction
Binding: (unbound) (required)
... patientInstruction Σ0..1stringPatient or consumer oriented instructions
... timing Σ0..1TimingWhen medication should be administered
... asNeeded[x] Σ(Slice Definition)Take "as needed" (for x)
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
.... asNeededCodeableConcept Σ0..1CodeableConceptCoded Reason For Take "as needed"
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... snomedFinding Σ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: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... 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: SNOMEDCTRouteCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... snomedRoute Σ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: SNOMEDCTAdministrationMethodCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... snomedMethod Σ0..1CodingSNOMED CT Administration Method
Binding: SNOMEDCTAdministrationMethodCodes (required)
.... text Σ0..1stringPlain text representation of the concept
... doseAndRate ΣI0..*ElementAmount of medication administered
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example)
.... dose[x] Σ0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity
.... rate[x] Σ0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity
... 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

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