Clinical Document Architecture
2.0.0-sd - release

This page is part of the CDA: Clinical Document Architecture (v2.0.0-sd: CDA2 - Informative) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Data Type Profile: oid - Detailed Descriptions

Active as of 2024-05-17

Definitions for the oid data type profile.

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

0. string
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsoid-pattern: Must conform to OID (#.#.#), UUID (32 hexadecimal digits separated by hyphens), or RUID (a letter followed by any combination of letters, numbers or hyphens) (matches('^[0-2](\\.(0|[1-9][0-9]*))+$'))
2. string.id
Control0..0
4. string.extension
Control0..0

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

0. string
Definition

A sequence of Unicode characters

ShortPrimitive Type string
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

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()))
oid-pattern: Must conform to OID (#.#.#), UUID (32 hexadecimal digits separated by hyphens), or RUID (a letter followed by any combination of letters, numbers or hyphens) (matches('^[0-2](\\.(0|[1-9][0-9]*))+$'))
2. string.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. string.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. string
Definition

A sequence of Unicode characters

ShortPrimitive Type string
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

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()))
oid-pattern: Must conform to OID (#.#.#), UUID (32 hexadecimal digits separated by hyphens), or RUID (a letter followed by any combination of letters, numbers or hyphens) (matches('^[0-2](\\.(0|[1-9][0-9]*))+$'))
2. string.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. string.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. string.value
Definition

The actual value

ShortPrimitive value for string
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Max Length:1048576