This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
FHIR Infrastructure Work Group | Maturity Level: 1 | Informative | Use Context: Any |
Detailed Descriptions for the elements in the extension.
Extension | |||||||||||||
Element Id | Extension | ||||||||||||
Definition | Conditions that apply to this set of dosing instructions. | ||||||||||||
Cardinality | 0..* | ||||||||||||
Invariants |
| ||||||||||||
Extension.id | |||||||||||||
Element Id | Extension.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension | |||||||||||||
Element Id | Extension.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 manageable, 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. | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
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. | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension(meetGoal) | |||||||||||||
Element Id | Extension.extension:meetGoal | ||||||||||||
Definition | Follow the dosage instructions until the specified goal is met. | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:meetGoal.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:meetGoal.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.extension(offset) | |||||||||||||
Element Id | Extension.extension:meetGoal.extension:offset | ||||||||||||
Definition | Specifies the offset before or after the goal is met to follow the instructions. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.extension.id | |||||||||||||
Element Id | Extension.extension:meetGoal.extension:offset.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension.extension | |||||||||||||
Element Id | Extension.extension:meetGoal.extension:offset.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.extension.url | |||||||||||||
Element Id | Extension.extension:meetGoal.extension:offset.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | 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. | ||||||||||||
Fixed Value | offset | ||||||||||||
Extension.extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:meetGoal.extension:offset.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Duration | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.extension(goal) | |||||||||||||
Element Id | Extension.extension:meetGoal.extension:goal | ||||||||||||
Definition | The specific goal to meet to follow the dosage instructions. | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.extension.id | |||||||||||||
Element Id | Extension.extension:meetGoal.extension:goal.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension.extension | |||||||||||||
Element Id | Extension.extension:meetGoal.extension:goal.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.extension.url | |||||||||||||
Element Id | Extension.extension:meetGoal.extension:goal.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | 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. | ||||||||||||
Fixed Value | goal | ||||||||||||
Extension.extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:meetGoal.extension:goal.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Choice of: string, Reference(Goal) | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:meetGoal.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | 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. | ||||||||||||
Fixed Value | meetGoal | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:meetGoal.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(whenTrigger) | |||||||||||||
Element Id | Extension.extension:whenTrigger | ||||||||||||
Definition | A condition that causes the dosage instructions to be followed. | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:whenTrigger.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:whenTrigger.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.extension(offset) | |||||||||||||
Element Id | Extension.extension:whenTrigger.extension:offset | ||||||||||||
Definition | Specifies the offset before or after the trigger happens to follow the instructions. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.extension.id | |||||||||||||
Element Id | Extension.extension:whenTrigger.extension:offset.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension.extension | |||||||||||||
Element Id | Extension.extension:whenTrigger.extension:offset.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.extension.url | |||||||||||||
Element Id | Extension.extension:whenTrigger.extension:offset.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | 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. | ||||||||||||
Fixed Value | offset | ||||||||||||
Extension.extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:whenTrigger.extension:offset.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Duration | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.extension(trigger) | |||||||||||||
Element Id | Extension.extension:whenTrigger.extension:trigger | ||||||||||||
Definition | The event that causes the dosage instruction to be followed. | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.extension.id | |||||||||||||
Element Id | Extension.extension:whenTrigger.extension:trigger.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension.extension | |||||||||||||
Element Id | Extension.extension:whenTrigger.extension:trigger.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.extension.url | |||||||||||||
Element Id | Extension.extension:whenTrigger.extension:trigger.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | 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. | ||||||||||||
Fixed Value | trigger | ||||||||||||
Extension.extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:whenTrigger.extension:trigger.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Choice of: string, Reference(Procedure) | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:whenTrigger.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | 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. | ||||||||||||
Fixed Value | whenTrigger | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:whenTrigger.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(precondition) | |||||||||||||
Element Id | Extension.extension:precondition | ||||||||||||
Definition | A condition that must (or must not) be present for the dosage instructions to be followed. | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:precondition.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:precondition.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.extension(doesNotOccur) | |||||||||||||
Element Id | Extension.extension:precondition.extension:doesNotOccur | ||||||||||||
Definition | If set to 'true', indicates that the condition must not be present for the dosage instructions to be followed. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.extension.id | |||||||||||||
Element Id | Extension.extension:precondition.extension:doesNotOccur.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension.extension | |||||||||||||
Element Id | Extension.extension:precondition.extension:doesNotOccur.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.extension.url | |||||||||||||
Element Id | Extension.extension:precondition.extension:doesNotOccur.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | 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. | ||||||||||||
Fixed Value | doesNotOccur | ||||||||||||
Extension.extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:precondition.extension:doesNotOccur.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | boolean | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.extension(condition) | |||||||||||||
Element Id | Extension.extension:precondition.extension:condition | ||||||||||||
Definition | The event that causes the dosage instruction to be followed. | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.extension.id | |||||||||||||
Element Id | Extension.extension:precondition.extension:condition.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension.extension | |||||||||||||
Element Id | Extension.extension:precondition.extension:condition.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.extension.url | |||||||||||||
Element Id | Extension.extension:precondition.extension:condition.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | 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. | ||||||||||||
Fixed Value | condition | ||||||||||||
Extension.extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:precondition.extension:condition.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Reference(ActivityDefinition) | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:precondition.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | 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. | ||||||||||||
Fixed Value | precondition | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:precondition.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.url | |||||||||||||
Element Id | Extension.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Comments | 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. | ||||||||||||
Fixed Value | http://hl7.org/fhir/StructureDefinition/dosage-conditions | ||||||||||||
Extension.value[x] | |||||||||||||
Element Id | Extension.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Invariants |
|