Release 4B

This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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

Extension expand-group - Detailed Descriptions

Vocabulary Work Group Maturity Level: 1InformativeUse Context: Any

Detailed Descriptions for the elements in the extension.

Extension
Element IdExtension
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).

Cardinality0..* 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
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or children unless an empty Parameters resourcehasValue() or (children().count() > id.count()) or $this is Parameters
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
Extension.id
Element IdExtension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typeid
Extension.extension
Element IdExtension.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.

Cardinality0..*
TypeExtension
Alternate Namesextensions, 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
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Extension.extension(code)
Element IdExtension.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.

Cardinality0..1
TypeExtension
Comments

If there is no code, the group purely exists for display, and has no underlying meaning.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
Extension.extension.id
Element IdExtension.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.

Cardinality0..1
Typeid
Extension.extension.extension
Element IdExtension.extension:code.extension
Definition

An Extension

Cardinality0..0
TypeExtension
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Extension.extension.url
Element IdExtension.extension:code.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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 Valuecode
Extension.extension.value[x]
Element IdExtension.extension:code.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality1..1
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Extension.extension(display)
Element IdExtension.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.

Cardinality0..1
TypeExtension
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
Extension.extension.id
Element IdExtension.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.

Cardinality0..1
Typeid
Extension.extension.extension
Element IdExtension.extension:display.extension
Definition

An Extension

Cardinality0..0
TypeExtension
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Extension.extension.url
Element IdExtension.extension:display.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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 Valuedisplay
Extension.extension.value[x]
Element IdExtension.extension:display.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality1..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Extension.extension(member)
Element IdExtension.extension:member
Definition

One of more codes that identify codes in the expansion or other groups.

Cardinality1..*
TypeExtension
Comments

A group without a code can be included by giving it an id and using #[id] in place of the code.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
Extension.extension.id
Element IdExtension.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.

Cardinality0..1
Typeid
Extension.extension.extension
Element IdExtension.extension:member.extension
Definition

An Extension

Cardinality0..0
TypeExtension
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Extension.extension.url
Element IdExtension.extension:member.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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 Valuemember
Extension.extension.value[x]
Element IdExtension.extension:member.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality1..1
Typecode
[x] NoteSee Choice of Data Types for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Extension.url
Element IdExtension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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 Valuehttp://hl7.org/fhir/StructureDefinition/valueset-expand-group
Extension.value[x]
Element IdExtension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..0
TypeChoice 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, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
[x] NoteSee Choice of Data Types for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())