Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions
Active as of 2024-10-25 |
Definitions for the oid data type profile.
Guidance on how to interpret the contents of this table can be found here
0. string | |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | 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 | |
Control | 0..0 |
4. string.extension | |
Control | 0..0 |
Guidance on how to interpret the contents of this table can be found here
0. string | |
Definition | A sequence of Unicode characters |
Short | Primitive Type string |
Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
Control | 0..* |
Is Modifier | false |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Summary | false |
Invariants | ele-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. |
Short | xml:id (or equivalent in JSON)Unique id for inter-element referencing |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
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. |
Short | ExtensionAdditional 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. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-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 |
Short | Primitive Type string |
Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
Control | 0..* |
Is Modifier | false |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Summary | false |
Invariants | ele-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) |
Short | xml:id (or equivalent in JSON) |
Control | 0..0 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
4. string.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..0 |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-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 |
Short | Primitive value for string |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Max Length: | 1048576 |