Australian Base Implementation Guide

This page is part of AU Base v4.0.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-dosage

AU Base Dosage [FMM 2]

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

The purpose of this profile is to provide national level agreement on core localised concepts.

This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Extensions

No extensions are used in this profile.

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 2021-07-07 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..*DosageDosage information in an Australian healthcare context
... additionalInstruction 0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
... asNeeded[x] 0..1boolean, CodeableConceptTake "as needed" (for x)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
... site 0..1CodeableConceptBody site to administer to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
... route 0..1CodeableConceptHow drug should enter body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
... method 0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*DosageDosage 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 Σ0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
... patientInstruction Σ0..1stringPatient or consumer oriented instructions
... timing Σ0..1TimingWhen medication should be administered
... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... site Σ0..1CodeableConceptBody site to administer to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
... route Σ0..1CodeableConceptHow drug should enter body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
... doseAndRate Σ0..*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): The kind of dose or rate specified.

.... dose[x] Σ0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity(SimpleQuantity)
.... rate[x] Σ0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
... 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..*DosageDosage information in an Australian healthcare context
... additionalInstruction 0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
... asNeeded[x] 0..1boolean, CodeableConceptTake "as needed" (for x)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
... site 0..1CodeableConceptBody site to administer to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
... route 0..1CodeableConceptHow drug should enter body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
... method 0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Dosage 0..*DosageDosage 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 Σ0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
... patientInstruction Σ0..1stringPatient or consumer oriented instructions
... timing Σ0..1TimingWhen medication should be administered
... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... site Σ0..1CodeableConceptBody site to administer to
Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred)
... route Σ0..1CodeableConceptHow drug should enter body
Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred)
... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
... doseAndRate Σ0..*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): The kind of dose or rate specified.

.... dose[x] Σ0..1Amount of medication per dose
..... doseRangeRange
..... doseQuantityQuantity(SimpleQuantity)
.... rate[x] Σ0..1Amount of medication per unit of time
..... rateRatioRatio
..... rateRangeRange
..... rateQuantityQuantity(SimpleQuantity)
... 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

Issues & Feedback