This page is part of the FHIR Specification (v4.1.0: Release 4B Ballot #1). 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
Vocabulary Work Group | Maturity Level: 1 | Informative | Use Context: Any |
Detailed Descriptions for the elements in the extension.
Extension | |||||||||||||
Element Id | Extension | ||||||||||||
Definition | This extension declares a group of concepts that is generated into the ValueSet.expansion.contains hierarchy when the expansion is generated for a UI. THere is no inherent assigned meaning to the hierarchy; it is used to help the user navigate the concepts. Each group has a display and/or a code, and a list of members, which are either concepts in the value set, or other groups (by code). | ||||||||||||
Cardinality | 0..* This element is affected by the following invariants: ele-1 | ||||||||||||
Comments | Note that there are inter-relationships between concept status/properties and the way the groups are built; these are described and documented in the (value set hierarchical example)[d.html]. Note that this extension should be ignored when the expansion is not generated for UI. | ||||||||||||
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(code) | |||||||||||||
Element Id | Extension.extension:code | ||||||||||||
Definition | A reference to a code from the include.system that defines the meaning associated with the group. Note that including the code in this extension does not include the code in the value set; if the code is intended to be in the value set, it must be listed directly as well. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Comments | If there is no code, the group purely exists for display, and has no underlying meaning. | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:code.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:code.extension | ||||||||||||
Definition | An 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:code.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 | code | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:code.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 | code | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(display) | |||||||||||||
Element Id | Extension.extension:display | ||||||||||||
Definition | The description for the group (goes in ValueSet.expansion.contains.dispaly). All groups need a display; this can only be omitted if there is a code that can be used to determine the display. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:display.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:display.extension | ||||||||||||
Definition | An 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:display.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 | display | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:display.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 | string | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension(member) | |||||||||||||
Element Id | Extension.extension:member | ||||||||||||
Definition | One of more codes that identify codes in the expansion or other groups. | ||||||||||||
Cardinality | 1..* | ||||||||||||
Type | Extension | ||||||||||||
Comments | A group without a code can be included by giving it an id and using #[id] in place of the code. | ||||||||||||
Invariants |
| ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:member.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:member.extension | ||||||||||||
Definition | An 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:member.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 | member | ||||||||||||
Extension.extension.value[x] | |||||||||||||
Element Id | Extension.extension:member.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 | code | ||||||||||||
[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/valueset-expand-group | ||||||||||||
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, 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 |
|