This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4
FHIR Infrastructure Work Group | Maturity Level: 1 | Informative | Use Context: Any |
Detailed Descriptions for the elements in the extension.
Extension | |||||||||||||
Element Id | Extension | ||||||||||||
Definition | Specifies that a date is relative to some event. The event happens [Duration] after [Event]. | ||||||||||||
Short Display | Relative Date Criteria | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Comments | This extension is used when a precise date is not known, but rather, the date will be relative to some future event (e.g. Do this 2 weeks after an operation). | ||||||||||||
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. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
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. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
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(target) | |||||||||||||
Element Id | Extension.extension:target | ||||||||||||
Definition | The event that the date(time) is relative to. | ||||||||||||
Short Display | Event that the date is relative to | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Extension | ||||||||||||
Comments | This can be a reference to a particular event, or a kind of event (usually where the kind would not happen very frequently). | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:target.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 Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:target.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:target.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
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 | target | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:target.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | CodeableReference | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(targetPath) | |||||||||||||
Element Id | Extension.extension:targetPath | ||||||||||||
Definition | The path to the element of the target that specifies the anchoring date or timeframe for the relative date. | ||||||||||||
Short Display | Relative to which element on the event | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Comments | The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing. | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:targetPath.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 Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:targetPath.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:targetPath.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
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 | targetPath | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:targetPath.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | string | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(relationship) | |||||||||||||
Element Id | Extension.extension:relationship | ||||||||||||
Definition | Defines the relationship between the event and the date. | ||||||||||||
Short Display | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:relationship.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 Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:relationship.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:relationship.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
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 | relationship | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:relationship.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Terminology Binding | null The codes SHOULD be taken from ActionRelationshipType | ||||||||||||
Type | code | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(offset) | |||||||||||||
Element Id | Extension.extension:offset | ||||||||||||
Definition | The duration or range of durations relative to the event that the date(time) will happen. | ||||||||||||
Short Display | Duration after the event | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.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. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:offset.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:offset.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
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.value[x] | |||||||||||||
Element Id | Extension.extension:offset.value[x] | ||||||||||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||
Short Display | Value of extension | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Choice of: Duration, Range | ||||||||||||
[x] Note | See Choice of Datatypes 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. | ||||||||||||
Short Display | identifies the meaning of the extension | ||||||||||||
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/relative-date | ||||||||||||
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). | ||||||||||||
Short Display | Value of extension | ||||||||||||
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, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
|