Clinical Document Architecture
2.0.1 - active

Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions

Data Type Profile: xs:ID - Detailed Descriptions

Active as of 2023-10-03

Definitions for the xs-ID data type profile.

Guidance on how to interpret the contents of this table can be found here

0. id
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. id.id
Control0..0
4. id.extension
Control0..0

Guidance on how to interpret the contents of this table can be found here

0. id
Definition

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

ShortPrimitive Type id
Comments

RFC 4122

Control0..*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. id.id
Definition

unique id for the element within a resource (for internal references)


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

Shortxml:id (or equivalent in JSON)Unique id for inter-element referencing
Control0..01
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. id.extension
Definition

An Extension


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 managable, 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.

ShortExtensionAdditional content defined by implementations
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.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

Guidance on how to interpret the contents of this table can be found here

0. id
Definition

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

ShortPrimitive Type id
Comments

RFC 4122

Control0..*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. id.id
Definition

unique id for the element within a resource (for internal references)

Shortxml:id (or equivalent in JSON)
Control0..0
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. id.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. id.value
Definition

Primitive value for id

ShortPrimitive value for id
Control0..1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse