This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). 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 R3
Vocabulary Work Group | Maturity Level: 1 | Informative | Use Context: Any |
Detailed Descriptions for the elements in the extension.
Extension | |||||||||||||
Element Id | Extension | ||||||||||||
Definition | Human readable names for the codesystem. | ||||||||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||||||
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. | ||||||||||||
Control | 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. | ||||||||||||
Control | 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. | ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension(name) | |||||||||||||
Element Id | Extension.extension:name | ||||||||||||
Definition | This name is intended to be human readable, short and as specific as possible and to convey the purpose of the value set. It is considered to be the name of the value set. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | Extension | ||||||||||||
Comments | This need not be unique. However, some use cases require uniqueness within a namespace and therefore best practice would be to make the name unique. | ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:name.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:name.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Control | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:name.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Control | 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 | name | ||||||||||||
Extension.extension.valueString | |||||||||||||
Element Id | Extension.extension:name.valueString | ||||||||||||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension(preferred) | |||||||||||||
Element Id | Extension.extension:preferred | ||||||||||||
Definition | Flag that this Name in this Name Language is the preferred human-readable signifier in this language. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Extension | ||||||||||||
Comments | There may be multiple human readable names in a given language, and this flag indicates which of them is preferred for the given language. | ||||||||||||
Extension.extension.id | |||||||||||||
Element Id | Extension.extension:preferred.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Extension.extension.extension | |||||||||||||
Element Id | Extension.extension:preferred.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Control | 0..0 | ||||||||||||
Type | Extension | ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Extension.extension.url | |||||||||||||
Element Id | Extension.extension:preferred.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Control | 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 | preferred | ||||||||||||
Extension.extension.valueBoolean | |||||||||||||
Element Id | Extension.extension:preferred.valueBoolean | ||||||||||||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||||||||||||
Control | 0..1 | ||||||||||||
Type | boolean | ||||||||||||
Extension.url | |||||||||||||
Element Id | Extension.url | ||||||||||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||
Control | 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/codesystem-otherName | ||||||||||||
Extension.value[x] | |||||||||||||
Element Id | Extension.value[x] | ||||||||||||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||||||||||||
Control | 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, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] |