SGHI FHIR Profile Implementation Guide
0.1.0 - ci-build

SGHI FHIR Profile Implementation Guide, published by Kathurima Kimathi. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/sil_fhir_profile_ig/ and changes regularly. See the Directory of published versions

## Data Type Profile: SGHIDosage - Detailed Descriptions

Draft as of 2026-05-21

Definitions for the dosage data type profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Dosage
Definition | Indicates how the medication is/was taken or should be taken by the patient.
Short | How the medication is/was taken or should be taken
Control | 0..*
Is Modifier | false
Invariants | dos-1: AsNeededFor can only be set if AsNeeded is empty or true (asNeededFor.empty() or asNeeded.empty() or asNeeded) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Dosage.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. Dosage.additionalInstruction
Definition | Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").
Short | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Comments | Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or take "immediately following drug x") should be populated in dosage.text.
Control | 0..*
Binding | For example codes, see SNOMEDCTAdditionalDosageInstructions http://hl7.org/fhir/ValueSet/additional-instruction-codes|5.0.0 (example to `http://hl7.org/fhir/ValueSet/additional-instruction-codes|5.0.0` ) A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Dosage.timing
Definition | When medication should be administered.
Short | When medication should be administered
Comments | This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.
Control | 10..1
Type | Timing
Is Modifier | false
Summary | true
Requirements | The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Dosage.asNeededFor
Definition | Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).
Short | Take "as needed" (for x)
Comments | Can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be False, then the dose is given according to the schedule and is not "prn" or "as needed".
Control | 0..* This element is affected by the following invariants: dos-1
Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes http://hl7.org/fhir/ValueSet/medication-as-needed-reason|5.0.0 (example to `http://hl7.org/fhir/ValueSet/medication-as-needed-reason|5.0.0` ) A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Dosage.site
Definition | Body site to administer to.
Short | Body site to administer to
Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension http://hl7.org/fhir/StructureDefinition/bodySite. May be a summary code, or a reference to a very precise definition of the location, or both.
Control | 0..1
Binding | The codes SHALL be taken from For example codes, see SGHI Body Site Value Set http://hl7.org/fhir/ValueSet/approach-site-codes|5.0.0 (required to `https://fhir.slade360.co.ke/fhir/ValueSet/body-site-value-set` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | A coded specification of the anatomic site where the medication first enters the body.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Dosage.route
Definition | How drug should enter body.
Short | How drug should enter body
Control | 10..1
Binding | The codes SHALL be taken from For example codes, see Route Of Administration http://hl7.org/fhir/ValueSet/route-codes|5.0.0 (required to `https://fhir.slade360.co.ke/fhir/ValueSet/route-of-administration` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Dosage.method
Definition | Technique for administering medication.
Short | Technique for administering medication
Comments | Terminologies used often pre-coordinate this term with the route and or form of administration.
Control | 0..1
Binding | The codes SHALL be taken from For example codes, see SGHI Method Of Medication Administration http://hl7.org/fhir/ValueSet/administration-method-codes|5.0.0 (required to `https://fhir.slade360.co.ke/fhir/ValueSet/method-of-administration` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Dosage.doseAndRate
Definition | Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.
Short | Amount of medication administered, to be administered or typical amount to be administered
Control | 10..*
Type | Element
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Dosage.doseAndRate.type
Definition | The kind of dose or rate specified, for example, ordered or calculated.
Short | The kind of dose or rate specified
Control | 0..1
Binding | For example codes, see DoseAndRateType http://terminology.hl7.org/ValueSet/dose-rate-type (example to `http://terminology.hl7.org/ValueSet/dose-rate-type` ) The kind of dose or rate specified.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | If the type is not populated, assume to be "ordered".
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Dosage.doseAndRate.dose[x]
Definition | Amount of medication per dose.
Short | Amount of medication per dose
Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.
Control | 0..1
Type | Choice of: Range, Quantity(SimpleQuantity)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Requirements | The amount of therapeutic or other substance given at one administration event.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.dose[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
22. Dosage.doseAndRate.dose[x]:doseQuantity
Slice Name | doseQuantity
Definition | Amount of medication per dose.
Short | Amount of medication per dose
Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.
Control | 0..1
Binding | The codes SHALL be taken from For codes, see Combined Dosage Unit ValueSet (required to `https://fhir.slade360.co.ke/fhir/ValueSet/combined-dosage-unit-vs` )
Type | Quantity(SimpleQuantity, SimpleQuantity), Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Requirements | The amount of therapeutic or other substance given at one administration event.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Dosage.doseAndRate.dose[x]:doseRange
Slice Name | doseRange
Definition | Amount of medication per dose.
Short | Amount of medication per dose
Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.
Control | 0..1
Type | Range, Quantity(SimpleQuantity)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Requirements | The amount of therapeutic or other substance given at one administration event.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Dosage.doseAndRate.rate[x]
Definition | Amount of medication per unit of time.
Short | Amount of medication per unit of time
Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.
Control | 0..1
Type | Choice of: Ratio, Range, Quantity(SimpleQuantity)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.rate[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
28. Dosage.doseAndRate.rate[x]:rateRatio
Slice Name | rateRatio
Definition | Amount of medication per unit of time.
Short | Amount of medication per unit of time
Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.
Control | 0..1
Type | Ratio, Quantity(SimpleQuantity), Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Dosage.doseAndRate.rate[x]:rateRange
Slice Name | rateRange
Definition | Amount of medication per unit of time.
Short | Amount of medication per unit of time
Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.
Control | 0..1
Type | Range, Quantity(SimpleQuantity), Ratio
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Dosage
2. Dosage.additionalInstruction
Type | CodeableConcept(SGHI CodeableConcept)
4. Dosage.timing
Control | 1..?
6. Dosage.asNeededFor
Type | CodeableConcept(SGHI CodeableConcept)
8. Dosage.site
Binding | The codes SHALL be taken from SGHI Body Site Value Set (required to `https://fhir.slade360.co.ke/fhir/ValueSet/body-site-value-set` )
Type | CodeableConcept(SGHI CodeableConcept)
10. Dosage.route
Control | 1..?
Binding | The codes SHALL be taken from Route Of Administration (required to `https://fhir.slade360.co.ke/fhir/ValueSet/route-of-administration` )
Type | CodeableConcept(SGHI CodeableConcept)
12. Dosage.method
Binding | The codes SHALL be taken from SGHI Method Of Medication Administration (required to `https://fhir.slade360.co.ke/fhir/ValueSet/method-of-administration` )
Type | CodeableConcept(SGHI CodeableConcept)
14. Dosage.doseAndRate
Control | 1..?
16. Dosage.doseAndRate.type
Type | CodeableConcept(SGHI CodeableConcept)
18. Dosage.doseAndRate.dose[x]
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.dose[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
20. Dosage.doseAndRate.dose[x]:doseQuantity
Slice Name | doseQuantity
Control | 0..1
Binding | The codes SHALL be taken from Combined Dosage Unit ValueSet (required to `https://fhir.slade360.co.ke/fhir/ValueSet/combined-dosage-unit-vs` )
Type | Quantity(SimpleQuantity)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
22. Dosage.doseAndRate.dose[x]:doseRange
Slice Name | doseRange
Control | 0..1
Type | Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
24. Dosage.doseAndRate.dose[x]:doseRange.low
26. Dosage.doseAndRate.dose[x]:doseRange.low.system
Fixed Value | `http://unitsofmeasure.org`
28. Dosage.doseAndRate.dose[x]:doseRange.high
30. Dosage.doseAndRate.dose[x]:doseRange.high.system
Fixed Value | `http://unitsofmeasure.org`
32. Dosage.doseAndRate.rate[x]
Type | Choice of: Ratio, Range, Quantity(SimpleQuantity)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.rate[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
34. Dosage.doseAndRate.rate[x]:rateRatio
Slice Name | rateRatio
Control | 0..1
Type | Ratio
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
36. Dosage.doseAndRate.rate[x]:rateRatio.numerator
38. Dosage.doseAndRate.rate[x]:rateRatio.numerator.system
Fixed Value | `http://unitsofmeasure.org`
40. Dosage.doseAndRate.rate[x]:rateRatio.denominator
42. Dosage.doseAndRate.rate[x]:rateRatio.denominator.system
Fixed Value | `http://unitsofmeasure.org`
44. Dosage.doseAndRate.rate[x]:rateRange
Slice Name | rateRange
Control | 0..1
Type | Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
46. Dosage.doseAndRate.rate[x]:rateRange.low
48. Dosage.doseAndRate.rate[x]:rateRange.low.system
Fixed Value | `http://unitsofmeasure.org`
50. Dosage.doseAndRate.rate[x]:rateRange.high
52. Dosage.doseAndRate.rate[x]:rateRange.high.system
Fixed Value | `http://unitsofmeasure.org`

Guidance on how to interpret the contents of this table can be foundhere

0. Dosage
Definition | Indicates how the medication is/was taken or should be taken by the patient.
Short | How the medication is/was taken or should be taken
Control | 0..*
Is Modifier | false
Invariants | dos-1: AsNeededFor can only be set if AsNeeded is empty or true (`asNeededFor.empty() or asNeeded.empty() or asNeeded`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. Dosage.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
4. Dosage.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Dosage.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Dosage.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
8. Dosage.sequence
Definition | Indicates the order in which the dosage instructions should be applied or interpreted.
Short | The order of the dosage instructions
Control | 0..1
Type | integer
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. Dosage.text
Definition | Free text dosage instructions e.g. SIG.
Short | Free text dosage instructions e.g. SIG
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Dosage.additionalInstruction
Definition | Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").
Short | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Comments | Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or take "immediately following drug x") should be populated in dosage.text.
Control | 0..*
Binding | For example codes, see SNOMEDCTAdditionalDosageInstructions (example to `http://hl7.org/fhir/ValueSet/additional-instruction-codes|5.0.0` ) A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. Dosage.patientInstruction
Definition | Instructions in terms that are understood by the patient or consumer.
Short | Patient or consumer oriented instructions
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. Dosage.timing
Definition | When medication should be administered.
Short | When medication should be administered
Comments | This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.
Control | 1..1
Type | Timing
Is Modifier | false
Summary | true
Requirements | The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. Dosage.asNeeded
Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option).
Short | Take "as needed"
Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated.
Control | 0..1 This element is affected by the following invariants: dos-1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Dosage.asNeededFor
Definition | Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept).
Short | Take "as needed" (for x)
Comments | Can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be False, then the dose is given according to the schedule and is not "prn" or "as needed".
Control | 0..* This element is affected by the following invariants: dos-1
Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes (example to `http://hl7.org/fhir/ValueSet/medication-as-needed-reason|5.0.0` ) A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Dosage.site
Definition | Body site to administer to.
Short | Body site to administer to
Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension http://hl7.org/fhir/StructureDefinition/bodySite. May be a summary code, or a reference to a very precise definition of the location, or both.
Control | 0..1
Binding | The codes SHALL be taken from SGHI Body Site Value Set (required to `https://fhir.slade360.co.ke/fhir/ValueSet/body-site-value-set` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | A coded specification of the anatomic site where the medication first enters the body.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. Dosage.route
Definition | How drug should enter body.
Short | How drug should enter body
Control | 1..1
Binding | The codes SHALL be taken from Route Of Administration (required to `https://fhir.slade360.co.ke/fhir/ValueSet/route-of-administration` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Dosage.method
Definition | Technique for administering medication.
Short | Technique for administering medication
Comments | Terminologies used often pre-coordinate this term with the route and or form of administration.
Control | 0..1
Binding | The codes SHALL be taken from SGHI Method Of Medication Administration (required to `https://fhir.slade360.co.ke/fhir/ValueSet/method-of-administration` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Dosage.doseAndRate
Definition | Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.
Short | Amount of medication administered, to be administered or typical amount to be administered
Control | 1..*
Type | Element
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. Dosage.doseAndRate.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
32. Dosage.doseAndRate.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
34. Dosage.doseAndRate.type
Definition | The kind of dose or rate specified, for example, ordered or calculated.
Short | The kind of dose or rate specified
Control | 0..1
Binding | For example codes, see DoseAndRateType (example to `http://terminology.hl7.org/ValueSet/dose-rate-type` ) The kind of dose or rate specified.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | If the type is not populated, assume to be "ordered".
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. Dosage.doseAndRate.dose[x]
Definition | Amount of medication per dose.
Short | Amount of medication per dose
Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.
Control | 0..1
Type | Choice of: Range, Quantity(SimpleQuantity)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Requirements | The amount of therapeutic or other substance given at one administration event.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.dose[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
38. Dosage.doseAndRate.dose[x]:doseQuantity
Slice Name | doseQuantity
Definition | Amount of medication per dose.
Short | Amount of medication per dose
Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.
Control | 0..1
Binding | The codes SHALL be taken from Combined Dosage Unit ValueSet (required to `https://fhir.slade360.co.ke/fhir/ValueSet/combined-dosage-unit-vs` )
Type | Quantity(SimpleQuantity)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Requirements | The amount of therapeutic or other substance given at one administration event.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. Dosage.doseAndRate.dose[x]:doseRange
Slice Name | doseRange
Definition | Amount of medication per dose.
Short | Amount of medication per dose
Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.
Control | 0..1
Type | Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Requirements | The amount of therapeutic or other substance given at one administration event.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. Dosage.doseAndRate.dose[x]:doseRange.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
44. Dosage.doseAndRate.dose[x]:doseRange.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.dose[x].extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
46. Dosage.doseAndRate.dose[x]:doseRange.low
Definition | The low limit. The boundary is inclusive.
Short | Low limit
Comments | If the low element is missing, the low boundary is not known.
Control | 0..1 This element is affected by the following invariants: rng-2
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. Dosage.doseAndRate.dose[x]:doseRange.low.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
50. Dosage.doseAndRate.dose[x]:doseRange.low.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.dose[x].low.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
52. Dosage.doseAndRate.dose[x]:doseRange.low.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Dosage.doseAndRate.dose[x]:doseRange.low.comparator
Definition | Not allowed to be used in this context
Short | < | <= | >= | > | ad - how to understand the value
Control | 0..0
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. Dosage.doseAndRate.dose[x]:doseRange.low.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. Dosage.doseAndRate.dose[x]:doseRange.low.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Control | 0..1 This element is affected by the following invariants: qty-3
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Fixed Value | `http://unitsofmeasure.org`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. Dosage.doseAndRate.dose[x]:doseRange.low.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: qty-3
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. Dosage.doseAndRate.dose[x]:doseRange.high
Definition | The high limit. The boundary is inclusive.
Short | High limit
Comments | If the high element is missing, the high boundary is not known.
Control | 0..1 This element is affected by the following invariants: rng-2
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. Dosage.doseAndRate.dose[x]:doseRange.high.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
66. Dosage.doseAndRate.dose[x]:doseRange.high.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.dose[x].high.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
68. Dosage.doseAndRate.dose[x]:doseRange.high.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. Dosage.doseAndRate.dose[x]:doseRange.high.comparator
Definition | Not allowed to be used in this context
Short | < | <= | >= | > | ad - how to understand the value
Control | 0..0
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. Dosage.doseAndRate.dose[x]:doseRange.high.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. Dosage.doseAndRate.dose[x]:doseRange.high.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Control | 0..1 This element is affected by the following invariants: qty-3
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Fixed Value | `http://unitsofmeasure.org`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. Dosage.doseAndRate.dose[x]:doseRange.high.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: qty-3
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. Dosage.doseAndRate.rate[x]
Definition | Amount of medication per unit of time.
Short | Amount of medication per unit of time
Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.
Control | 0..1
Type | Choice of: Ratio, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.rate[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
80. Dosage.doseAndRate.rate[x]:rateRatio
Slice Name | rateRatio
Definition | Amount of medication per unit of time.
Short | Amount of medication per unit of time
Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.
Control | 0..1
Type | Ratio
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. Dosage.doseAndRate.rate[x]:rateRatio.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
84. Dosage.doseAndRate.rate[x]:rateRatio.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.rate[x].extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
86. Dosage.doseAndRate.rate[x]:rateRatio.numerator
Definition | The value of the numerator.
Short | Numerator value
Control | 0..1 This element is affected by the following invariants: rat-1
Type | Quantity
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. Dosage.doseAndRate.rate[x]:rateRatio.numerator.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
90. Dosage.doseAndRate.rate[x]:rateRatio.numerator.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.rate[x].numerator.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
92. Dosage.doseAndRate.rate[x]:rateRatio.numerator.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. Dosage.doseAndRate.rate[x]:rateRatio.numerator.comparator
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short | < | <= | >= | > | ad - how to understand the value
Control | 0..1
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. Dosage.doseAndRate.rate[x]:rateRatio.numerator.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. Dosage.doseAndRate.rate[x]:rateRatio.numerator.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Control | 0..1 This element is affected by the following invariants: qty-3
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Fixed Value | `http://unitsofmeasure.org`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. Dosage.doseAndRate.rate[x]:rateRatio.numerator.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: qty-3
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. Dosage.doseAndRate.rate[x]:rateRatio.denominator
Definition | The value of the denominator.
Short | Denominator value
Control | 0..1 This element is affected by the following invariants: rat-1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. Dosage.doseAndRate.rate[x]:rateRatio.denominator.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
106. Dosage.doseAndRate.rate[x]:rateRatio.denominator.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.rate[x].denominator.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
108. Dosage.doseAndRate.rate[x]:rateRatio.denominator.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. Dosage.doseAndRate.rate[x]:rateRatio.denominator.comparator
Definition | Not allowed to be used in this context
Short | < | <= | >= | > | ad - how to understand the value
Control | 0..0
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. Dosage.doseAndRate.rate[x]:rateRatio.denominator.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. Dosage.doseAndRate.rate[x]:rateRatio.denominator.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Control | 0..1 This element is affected by the following invariants: qty-3
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Fixed Value | `http://unitsofmeasure.org`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. Dosage.doseAndRate.rate[x]:rateRatio.denominator.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: qty-3
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. Dosage.doseAndRate.rate[x]:rateRange
Slice Name | rateRange
Definition | Amount of medication per unit of time.
Short | Amount of medication per unit of time
Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.
Control | 0..1
Type | Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
120. Dosage.doseAndRate.rate[x]:rateRange.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
122. Dosage.doseAndRate.rate[x]:rateRange.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.rate[x].extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
124. Dosage.doseAndRate.rate[x]:rateRange.low
Definition | The low limit. The boundary is inclusive.
Short | Low limit
Comments | If the low element is missing, the low boundary is not known.
Control | 0..1 This element is affected by the following invariants: rng-2
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. Dosage.doseAndRate.rate[x]:rateRange.low.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
128. Dosage.doseAndRate.rate[x]:rateRange.low.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.rate[x].low.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
130. Dosage.doseAndRate.rate[x]:rateRange.low.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
132. Dosage.doseAndRate.rate[x]:rateRange.low.comparator
Definition | Not allowed to be used in this context
Short | < | <= | >= | > | ad - how to understand the value
Control | 0..0
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
134. Dosage.doseAndRate.rate[x]:rateRange.low.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
136. Dosage.doseAndRate.rate[x]:rateRange.low.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Control | 0..1 This element is affected by the following invariants: qty-3
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Fixed Value | `http://unitsofmeasure.org`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
138. Dosage.doseAndRate.rate[x]:rateRange.low.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: qty-3
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
140. Dosage.doseAndRate.rate[x]:rateRange.high
Definition | The high limit. The boundary is inclusive.
Short | High limit
Comments | If the high element is missing, the high boundary is not known.
Control | 0..1 This element is affected by the following invariants: rng-2
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. Dosage.doseAndRate.rate[x]:rateRange.high.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
144. Dosage.doseAndRate.rate[x]:rateRange.high.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Dosage.doseAndRate.rate[x].high.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
146. Dosage.doseAndRate.rate[x]:rateRange.high.value
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short | Numerical value (with implicit precision)
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Precision is handled implicitly in almost all cases of measurement.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
148. Dosage.doseAndRate.rate[x]:rateRange.high.comparator
Definition | Not allowed to be used in this context
Short | < | <= | >= | > | ad - how to understand the value
Control | 0..0
Binding | The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0` ) How the Quantity should be understood and represented.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing | If there is no comparator, then there is no modification of the value
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
150. Dosage.doseAndRate.rate[x]:rateRange.high.unit
Definition | A human-readable form of the unit.
Short | Unit representation
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
152. Dosage.doseAndRate.rate[x]:rateRange.high.system
Definition | The identification of the system that provides the coded form of the unit.
Short | System that defines coded unit form
Control | 0..1 This element is affected by the following invariants: qty-3
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to know the system that defines the coded form of the unit.
Fixed Value | `http://unitsofmeasure.org`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
154. Dosage.doseAndRate.rate[x]:rateRange.high.code
Definition | A computer processable form of the unit in some unit representation system.
Short | Coded form of the unit
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control | 0..1 This element is affected by the following invariants: qty-3
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
156. Dosage.maxDosePerPeriod
Definition | Upper limit on medication per unit of time.
Short | Upper limit on medication per unit of time
Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day".
Control | 0..*
Type | Ratio
Is Modifier | false
Summary | true
Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
158. Dosage.maxDosePerAdministration
Definition | Upper limit on medication per administration.
Short | Upper limit on medication per administration
Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.
Control | 0..1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | true
Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject per administration.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
160. Dosage.maxDosePerLifetime
Definition | Upper limit on medication per lifetime of the patient.
Short | Upper limit on medication per lifetime of the patient
Control | 0..1
Type | Quantity(SimpleQuantity)
Is Modifier | false
Summary | true
Requirements | The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)