FHIR IG analytics| Package | hl7.fhir.uv.xver-r4b.r3 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-ext-R4B-Dosage.doseAndRate.json |
| FHIR Version | R3 |
| Source | http://hl7.org/fhir/uv/xver-r4b.r3/0.1.0/StructureDefinition-ext-R4B-Dosage.doseAndRate.html |
| URL | http://hl7.org/fhir/4.3/StructureDefinition/extension-Dosage.doseAndRate |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-03-17T21:02:03.8104715+00:00 |
| Name | ExtensionDosage_DoseAndRate |
| Title | R4B: Amount of medication administered (new) |
| Realm | uv |
| Authority | hl7 |
| Description | R4B: `Dosage.doseAndRate` (new:Element) |
| Purpose | This extension is part of the cross-version definitions generated to enable use of the element `Dosage.doseAndRate` as defined in FHIR R4B in FHIR STU3. The source element is defined as: `Dosage.doseAndRate` 0..* `Element` Across FHIR versions, the element set has been mapped as: * R4B: `Dosage.doseAndRate` 0..* `Element` * R4: `Dosage.doseAndRate` 0..* `Element` Following are the generation technical comments: Element `Dosage.doseAndRate` has a context of Dosage based on following the parent source element upwards and mapping to `Dosage`. Element `Dosage.doseAndRate` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). |
| Type | Extension |
| Kind | complex-type |
No resources found
| ValueSet | ||
| hl7.fhir.uv.xver-r4b.r3#0.1.0 | R4B-dose-rate-type-for-R3 | Cross-version ValueSet R4B.DoseAndRateType for use in FHIR STU3 |
No extension usage examples found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition ext-R4B-Dosage.doseAndRate
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..* | Extension | R4B: Amount of medication administered (new) | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:type | 0..1 | Extension | R4B: The kind of dose or rate specified (new) | |
  url | 1..1 | uri | "type" | |
  value[x] | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: R4BDoseRateTypeForR3 (0.1.0) (example) | |
| extension:dose | 0..1 | Extension | R4B: dose | |
| url | 1..1 | uri | "dose" | |
 value[x] | 0..1 | Amount of medication per dose | ||
 valueRange | Range | |||
 valueQuantity | Quantity(SimpleQuantity) | |||
 extension:rate | 0..1 | Extension | R4B: rate additional types | |
| url | 1..1 | uri | "rate" | |
| value[x] | 0..1 | Amount of medication per unit of time | ||
| valueRatio | Ratio | |||
| valueRange | Range | |||
| url | 1..1 | uri | "http://hl7.org/fhir/4.3/StructureDefinition/extension-Dosage.doseAndRate" | |
| value[x] | 0..0 | Value of extension | ||
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "ext-R4B-Dosage.doseAndRate",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"extension": [
{
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r4b.r3"
},
{
"url": "version",
"valueString": "0.1.0"
},
{
"url": "uri",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3"
}
]
}
}
],
"url": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Dosage.doseAndRate",
"version": "0.1.0",
"name": "ExtensionDosage_DoseAndRate",
"title": "R4B: Amount of medication administered (new)",
"status": "active",
"experimental": false,
"date": "2026-03-17T21:02:03.8104715+00:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "R4B: `Dosage.doseAndRate` (new:Element)",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"purpose": "This extension is part of the cross-version definitions generated to enable use of the\r\nelement `Dosage.doseAndRate` as defined in FHIR R4B\r\nin FHIR STU3.\r\n\r\nThe source element is defined as:\r\n`Dosage.doseAndRate` 0..* `Element`\r\n\r\nAcross FHIR versions, the element set has been mapped as:\r\n* R4B: `Dosage.doseAndRate` 0..* `Element`\n* R4: `Dosage.doseAndRate` 0..* `Element`\r\n\r\nFollowing are the generation technical comments:\r\nElement `Dosage.doseAndRate` has a context of Dosage based on following the parent source element upwards and mapping to `Dosage`.\nElement `Dosage.doseAndRate` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"contextType": "datatype",
"context": [
"Dosage"
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "R4B: Amount of medication administered (new)",
"definition": "R4B: `Dosage.doseAndRate` (new:Element)",
"comment": "Element `Dosage.doseAndRate` has a context of Dosage based on following the parent source element upwards and mapping to `Dosage`.\nElement `Dosage.doseAndRate` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:type",
"path": "Extension.extension",
"sliceName": "type",
"short": "R4B: The kind of dose or rate specified (new)",
"definition": "R4B: `Dosage.doseAndRate.type` (new:CodeableConcept)",
"comment": "Element `Dosage.doseAndRate.type` is part of an existing definition because parent element `Dosage.doseAndRate` requires a cross-version extension.\nElement `Dosage.doseAndRate.type` has a context of Dosage based on following the parent source element upwards and mapping to `Dosage`.\nElement `Dosage.doseAndRate.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"requirements": "If the type is not populated, assume to be \"ordered\". Element `Dosage.doseAndRate.type` is part of an existing definition because parent element `Dosage.doseAndRate` requires a cross-version extension.\nElement `Dosage.doseAndRate.type` has a context of Dosage based on following the parent source element upwards and mapping to `Dosage`.\nElement `Dosage.doseAndRate.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:type.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:type.extension",
"path": "Extension.extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:type.url",
"path": "Extension.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "type",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:type.value[x]",
"path": "Extension.extension.value[x]",
"short": "The kind of dose or rate specified",
"definition": "The kind of dose or rate specified, for example, ordered or calculated.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"valueSetUri": "http://hl7.org/fhir/uv/xver/ValueSet/R4B-dose-rate-type-for-R3|0.1.0"
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:dose",
"path": "Extension.extension",
"sliceName": "dose",
"short": "R4B: dose",
"definition": "R4B: `Dosage.doseAndRate.dose[x]`",
"comment": "Element `Dosage.doseAndRate.dose[x]` is part of an existing definition because parent element `Dosage.doseAndRate` requires a cross-version extension.\nElement `Dosage.doseAndRate.dose[x]` is mapped to FHIR STU3 element `Dosage.dose[x]` as `SourceIsBroaderThanTarget`.\nThe target context `Dosage.dose[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `Dosage`.\nNote 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.",
"requirements": "The amount of therapeutic or other substance given at one administration event. Element `Dosage.doseAndRate.dose[x]` is part of an existing definition because parent element `Dosage.doseAndRate` requires a cross-version extension.\nElement `Dosage.doseAndRate.dose[x]` is mapped to FHIR STU3 element `Dosage.dose[x]` as `SourceIsBroaderThanTarget`.\nThe target context `Dosage.dose[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `Dosage`.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:dose.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:dose.extension",
"path": "Extension.extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:dose.url",
"path": "Extension.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "dose",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:dose.value[x]",
"path": "Extension.extension.value[x]",
"short": "Amount of medication per dose",
"definition": "Amount of medication per dose.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Range"
},
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:rate",
"path": "Extension.extension",
"sliceName": "rate",
"short": "R4B: rate additional types",
"definition": "R4B: `Dosage.doseAndRate.rate[x]` additional types (Ratio, Range)",
"comment": "Element `Dosage.doseAndRate.rate[x]` is part of an existing definition because parent element `Dosage.doseAndRate` requires a cross-version extension.\nElement `Dosage.doseAndRate.rate[x]` is mapped to FHIR STU3 element `Dosage.rate[x]` as `SourceIsBroaderThanTarget`.\nThe mappings for `Dosage.doseAndRate.rate[x]` do not cover the following types: Range, Ratio.\nThe target context `Dosage.rate[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `Dosage`.\nIt 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.\r\rIt 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 grammer 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.",
"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. Element `Dosage.doseAndRate.rate[x]` is part of an existing definition because parent element `Dosage.doseAndRate` requires a cross-version extension.\nElement `Dosage.doseAndRate.rate[x]` is mapped to FHIR STU3 element `Dosage.rate[x]` as `SourceIsBroaderThanTarget`.\nThe mappings for `Dosage.doseAndRate.rate[x]` do not cover the following types: Range, Ratio.\nThe target context `Dosage.rate[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `Dosage`.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension.extension:rate.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:rate.extension",
"path": "Extension.extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:rate.url",
"path": "Extension.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "rate",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:rate.value[x]",
"path": "Extension.extension.value[x]",
"short": "Amount of medication per unit of time",
"definition": "Amount of medication per unit of time.",
"comment": "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.\r\rIt 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 grammer 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.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Ratio"
},
{
"code": "Range"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.url",
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Dosage.doseAndRate",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 0,
"max": "0",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "Meta"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "R4B: Amount of medication administered (new)",
"definition": "R4B: `Dosage.doseAndRate` (new:Element)",
"comment": "Element `Dosage.doseAndRate` has a context of Dosage based on following the parent source element upwards and mapping to `Dosage`.\nElement `Dosage.doseAndRate` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
}
},
{
"id": "Extension.extension:type",
"path": "Extension.extension",
"sliceName": "type",
"short": "R4B: The kind of dose or rate specified (new)",
"definition": "R4B: `Dosage.doseAndRate.type` (new:CodeableConcept)",
"comment": "Element `Dosage.doseAndRate.type` is part of an existing definition because parent element `Dosage.doseAndRate` requires a cross-version extension.\nElement `Dosage.doseAndRate.type` has a context of Dosage based on following the parent source element upwards and mapping to `Dosage`.\nElement `Dosage.doseAndRate.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"requirements": "If the type is not populated, assume to be \"ordered\". Element `Dosage.doseAndRate.type` is part of an existing definition because parent element `Dosage.doseAndRate` requires a cross-version extension.\nElement `Dosage.doseAndRate.type` has a context of Dosage based on following the parent source element upwards and mapping to `Dosage`.\nElement `Dosage.doseAndRate.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
}
},
{
"id": "Extension.extension:type.url",
"path": "Extension.extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "type"
},
{
"id": "Extension.extension:type.value[x]",
"path": "Extension.extension.value[x]",
"short": "The kind of dose or rate specified",
"definition": "The kind of dose or rate specified, for example, ordered or calculated.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"valueSetUri": "http://hl7.org/fhir/uv/xver/ValueSet/R4B-dose-rate-type-for-R3|0.1.0"
}
},
{
"id": "Extension.extension:dose",
"path": "Extension.extension",
"sliceName": "dose",
"short": "R4B: dose",
"definition": "R4B: `Dosage.doseAndRate.dose[x]`",
"comment": "Element `Dosage.doseAndRate.dose[x]` is part of an existing definition because parent element `Dosage.doseAndRate` requires a cross-version extension.\nElement `Dosage.doseAndRate.dose[x]` is mapped to FHIR STU3 element `Dosage.dose[x]` as `SourceIsBroaderThanTarget`.\nThe target context `Dosage.dose[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `Dosage`.\nNote 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.",
"requirements": "The amount of therapeutic or other substance given at one administration event. Element `Dosage.doseAndRate.dose[x]` is part of an existing definition because parent element `Dosage.doseAndRate` requires a cross-version extension.\nElement `Dosage.doseAndRate.dose[x]` is mapped to FHIR STU3 element `Dosage.dose[x]` as `SourceIsBroaderThanTarget`.\nThe target context `Dosage.dose[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `Dosage`.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
}
},
{
"id": "Extension.extension:dose.url",
"path": "Extension.extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "dose"
},
{
"id": "Extension.extension:dose.value[x]",
"path": "Extension.extension.value[x]",
"short": "Amount of medication per dose",
"definition": "Amount of medication per dose.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Range"
},
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
]
},
{
"id": "Extension.extension:rate",
"path": "Extension.extension",
"sliceName": "rate",
"short": "R4B: rate additional types",
"definition": "R4B: `Dosage.doseAndRate.rate[x]` additional types (Ratio, Range)",
"comment": "Element `Dosage.doseAndRate.rate[x]` is part of an existing definition because parent element `Dosage.doseAndRate` requires a cross-version extension.\nElement `Dosage.doseAndRate.rate[x]` is mapped to FHIR STU3 element `Dosage.rate[x]` as `SourceIsBroaderThanTarget`.\nThe mappings for `Dosage.doseAndRate.rate[x]` do not cover the following types: Range, Ratio.\nThe target context `Dosage.rate[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `Dosage`.\nIt 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.\r\rIt 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 grammer 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.",
"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. Element `Dosage.doseAndRate.rate[x]` is part of an existing definition because parent element `Dosage.doseAndRate` requires a cross-version extension.\nElement `Dosage.doseAndRate.rate[x]` is mapped to FHIR STU3 element `Dosage.rate[x]` as `SourceIsBroaderThanTarget`.\nThe mappings for `Dosage.doseAndRate.rate[x]` do not cover the following types: Range, Ratio.\nThe target context `Dosage.rate[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `Dosage`.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
}
},
{
"id": "Extension.extension:rate.url",
"path": "Extension.extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "rate"
},
{
"id": "Extension.extension:rate.value[x]",
"path": "Extension.extension.value[x]",
"short": "Amount of medication per unit of time",
"definition": "Amount of medication per unit of time.",
"comment": "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.\r\rIt 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 grammer 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.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Ratio"
},
{
"code": "Range"
}
]
},
{
"id": "Extension.url",
"path": "Extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Dosage.doseAndRate"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"min": 0,
"max": "0",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
}
}
]
}
}