Defining URL: | https://fhir.medirecords.com/StructureDefinition/mr-medication-dosage |
Version: | 1.3.0 |
Name: | MRDosage |
Title: | MediRecords Medication Dosage |
Status: | Active as of 2023-12-21 01:01:27+0000 |
Definition: | MediRecords Medication Dosage profile to record details about the dosage prescribed |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://fhir.medirecords.com/StructureDefinition/mr-medication-dosage
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseDosage
This structure is derived from AUBaseDosage
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context | |
text | S | 1..1 | string | Free text dosage instructions e.g. SIG |
additionalInstruction | S | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" |
timing | ||||
repeat | ||||
boundsPeriod | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
start | S | 0..1 | dateTime | Estimated start of course based on prescription start date |
end | S | 0..1 | dateTime | Estimated end of course based on prescription start date and number of doses supplied |
frequency | S | 0..1 | positiveInt | Event occurs frequency times per period |
period | S | 0..1 | decimal | Event occurs frequency times per period |
periodUnit | S | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) |
code | ||||
text | S | 0..1 | string | Free text description of the frequency |
asNeededBoolean | S | 0..1 | boolean | Take "as needed" (for x) |
route | S | 0..1 | CodeableConcept | How drug should enter body |
doseAndRate | 0..1 | Element | Amount of medication administered | |
doseQuantity | 0..1 | SimpleQuantity | A fixed quantity (no comparator) | |
value | S | 0..1 | decimal | Numerical value (with implicit precision) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
sequence | Σ | 0..1 | integer | The order of the dosage instructions |
text | SΣ | 1..1 | string | Free text dosage instructions e.g. SIG |
additionalInstruction | SΣ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) |
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions |
timing | Σ | 0..1 | Timing | When medication should be administered |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | Σ | 0..* | dateTime | When the event occurs |
repeat | ΣC | 0..1 | Element | When the event is to occur |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
bounds[x]:boundsPeriod | Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
start | SΣC | 0..1 | dateTime | Estimated start of course based on prescription start date |
end | SΣC | 0..1 | dateTime | Estimated end of course based on prescription start date and number of doses supplied |
count | Σ | 0..1 | positiveInt | Number of times to repeat |
countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat |
duration | Σ | 0..1 | decimal | How long when it happens |
durationMax | Σ | 0..1 | decimal | How long when it happens (Max) |
durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
frequency | SΣ | 0..1 | positiveInt | Event occurs frequency times per period |
frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
period | SΣ | 0..1 | decimal | Event occurs frequency times per period |
periodMax | Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
periodUnit | SΣ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
timeOfDay | Σ | 0..* | time | Time of day for action |
when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | SΣ | 0..1 | string | Free text description of the frequency |
Slices for asNeeded[x] | Σ | 0..1 | Take "as needed" (for x) Slice: Unordered, Open by type:$this Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred) | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
asNeeded[x]:asNeededBoolean | SΣ | 0..1 | boolean | Take "as needed" (for x) |
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred) |
route | SΣ | 0..1 | CodeableConcept | How drug should enter body Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred) |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) |
doseAndRate | Σ | 0..1 | Element | Amount of medication administered |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. |
Slices for dose[x] | Σ | 0..1 | Amount of medication per dose Slice: Unordered, Open by type:$this | |
doseRange | Range | |||
doseQuantity | Quantity(SimpleQuantity) | |||
dose[x]:doseQuantity | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
value | SΣ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | Σ | 0..1 | string | Unit representation |
system | ΣC | 0..1 | uri | System that defines coded unit form |
code | Σ | 0..1 | code | Coded form of the unit |
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |
rateRatio | Ratio | |||
rateRange | Range | |||
rateQuantity | Quantity(SimpleQuantity) | |||
maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context | |
text | Σ | 1..1 | string | Free text dosage instructions e.g. SIG |
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) |
timing | Σ | 0..1 | Timing | When medication should be administered |
repeat | ΣC | 0..1 | Element | When the event is to occur |
bounds[x]:boundsPeriod | Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits |
start | ΣC | 0..1 | dateTime | Estimated start of course based on prescription start date |
end | ΣC | 0..1 | dateTime | Estimated end of course based on prescription start date and number of doses supplied |
frequency | Σ | 0..1 | positiveInt | Event occurs frequency times per period |
period | Σ | 0..1 | decimal | Event occurs frequency times per period |
periodUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + |
text | Σ | 0..1 | string | Free text description of the frequency |
asNeeded[x]:asNeededBoolean | Σ | 0..1 | boolean | Take "as needed" (for x) |
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred) |
doseAndRate | Σ | 0..1 | Element | Amount of medication administered |
dose[x]:doseQuantity | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) |
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) |
Documentation for this format |
This structure is derived from AUBaseDosage
Differential View
This structure is derived from AUBaseDosage
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context | |
text | S | 1..1 | string | Free text dosage instructions e.g. SIG |
additionalInstruction | S | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" |
timing | ||||
repeat | ||||
boundsPeriod | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
start | S | 0..1 | dateTime | Estimated start of course based on prescription start date |
end | S | 0..1 | dateTime | Estimated end of course based on prescription start date and number of doses supplied |
frequency | S | 0..1 | positiveInt | Event occurs frequency times per period |
period | S | 0..1 | decimal | Event occurs frequency times per period |
periodUnit | S | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) |
code | ||||
text | S | 0..1 | string | Free text description of the frequency |
asNeededBoolean | S | 0..1 | boolean | Take "as needed" (for x) |
route | S | 0..1 | CodeableConcept | How drug should enter body |
doseAndRate | 0..1 | Element | Amount of medication administered | |
doseQuantity | 0..1 | SimpleQuantity | A fixed quantity (no comparator) | |
value | S | 0..1 | decimal | Numerical value (with implicit precision) |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Dosage | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
sequence | Σ | 0..1 | integer | The order of the dosage instructions |
text | SΣ | 1..1 | string | Free text dosage instructions e.g. SIG |
additionalInstruction | SΣ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) |
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions |
timing | Σ | 0..1 | Timing | When medication should be administered |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | Σ | 0..* | dateTime | When the event occurs |
repeat | ΣC | 0..1 | Element | When the event is to occur |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
bounds[x]:boundsPeriod | Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
start | SΣC | 0..1 | dateTime | Estimated start of course based on prescription start date |
end | SΣC | 0..1 | dateTime | Estimated end of course based on prescription start date and number of doses supplied |
count | Σ | 0..1 | positiveInt | Number of times to repeat |
countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat |
duration | Σ | 0..1 | decimal | How long when it happens |
durationMax | Σ | 0..1 | decimal | How long when it happens (Max) |
durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
frequency | SΣ | 0..1 | positiveInt | Event occurs frequency times per period |
frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
period | SΣ | 0..1 | decimal | Event occurs frequency times per period |
periodMax | Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
periodUnit | SΣ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
timeOfDay | Σ | 0..* | time | Time of day for action |
when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | SΣ | 0..1 | string | Free text description of the frequency |
Slices for asNeeded[x] | Σ | 0..1 | Take "as needed" (for x) Slice: Unordered, Open by type:$this Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 (preferred) | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
asNeeded[x]:asNeededBoolean | SΣ | 0..1 | boolean | Take "as needed" (for x) |
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred) |
route | SΣ | 0..1 | CodeableConcept | How drug should enter body Binding: https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 (preferred) |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) |
doseAndRate | Σ | 0..1 | Element | Amount of medication administered |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. |
Slices for dose[x] | Σ | 0..1 | Amount of medication per dose Slice: Unordered, Open by type:$this | |
doseRange | Range | |||
doseQuantity | Quantity(SimpleQuantity) | |||
dose[x]:doseQuantity | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
value | SΣ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | Σ | 0..1 | string | Unit representation |
system | ΣC | 0..1 | uri | System that defines coded unit form |
code | Σ | 0..1 | code | Coded form of the unit |
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |
rateRatio | Ratio | |||
rateRange | Range | |||
rateQuantity | Quantity(SimpleQuantity) | |||
maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructions |
Dosage.timing.repeat.durationUnit | required | UnitsOfTime |
Dosage.timing.repeat.periodUnit | required | UnitsOfTime |
Dosage.timing.repeat.dayOfWeek | required | DaysOfWeek |
Dosage.timing.repeat.when | required | EventTiming |
Dosage.timing.code | preferred | TimingAbbreviation |
Dosage.asNeeded[x] | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 |
Dosage.site | preferred | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Dosage.route | preferred | https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 |
Dosage.method | preferred | SNOMEDCTAdministrationMethodCodes |
Dosage.doseAndRate.type | example | DoseAndRateType |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |