This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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 | Specifies an invariant that is enforced in the context of an instantiated resource. | ||||||||||||
Short Display | A constraint on the target resource | ||||||||||||
Cardinality | 0..* | ||||||||||||
Comments | Can be used on any definitional artifact to define an invariant that is enforced in the context of an instantiated resource. The invariant expression will have access to | ||||||||||||
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(key) | |||||||||||||
Element Id | Extension.extension:key | ||||||||||||
Definition | A unique identifier for the invariant (unique in the context of the resource). | ||||||||||||
Short Display | Unique identifier | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Extension | ||||||||||||
Comments | Any error or outcome messages or warnings should include this id to allow the source of the message to be determined. | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:key.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:key.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:key.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 | key | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:key.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 | id | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(requirements) | |||||||||||||
Element Id | Extension.extension:requirements | ||||||||||||
Definition | A brief description of why the invariant is necessary or appropriate. | ||||||||||||
Short Display | Why the invariant is defined | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:requirements.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:requirements.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:requirements.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 | requirements | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:requirements.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(severity) | |||||||||||||
Element Id | Extension.extension:severity | ||||||||||||
Definition | Whether the invariant indicates an error condition or a warning. | ||||||||||||
Short Display | error | warning | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:severity.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:severity.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:severity.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 | severity | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:severity.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 SHALL be taken from ConstraintSeverity | ||||||||||||
Type | code | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(expression) | |||||||||||||
Element Id | Extension.extension:expression | ||||||||||||
Definition | An expression providing a formal representation of the invariant condition. | ||||||||||||
Short Display | The invariant expression | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Extension | ||||||||||||
Comments | The expression will have access to | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:expression.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:expression.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:expression.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 | expression | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:expression.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 | Expression | ||||||||||||
[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/cqf-targetInvariant | ||||||||||||
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 |
|