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
Official URL: http://hl7.org/cda/stds/core/StructureDefinition/ruid | Version: 2.0.0-sd | |||
Active as of 2024-05-16 | Computable Name: ruid |
HL7 Reserved Identifier Scheme (RUID)\nA globally unique string defined exclusively by HL7. Identifiers in this scheme are only defined by balloted HL7 specifications. Local communities or systems must never use such reserved identifiers based on bilateral negotiations.
HL7 reserved identifiers are strings that consist only of (US-ASCII) letters, digits and hyphens, where the first character must be a letter. HL7 may assign these reserved identifiers as mnemonic identifiers for major concepts of interest to HL7.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from string
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
string | C | 0..* | string | Primitive Type string ruid-pattern: An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen. |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..0 | |||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ruid-pattern | error | string | An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen. : matches('^[A-Za-z][A-Za-z0-9\\-]*$') and matches('^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$').not() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
string | C | 0..* | string | Primitive Type string ruid-pattern: An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen. |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ruid-pattern | error | string | An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen. : matches('^[A-Za-z][A-Za-z0-9\\-]*$') and matches('^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$').not() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
string | C | 0..* | string | Primitive Type string ruid-pattern: An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen. |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ruid-pattern | error | string | An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen. : matches('^[A-Za-z][A-Za-z0-9\\-]*$') and matches('^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$').not() |
This structure is derived from string
Differential View
This structure is derived from string
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
string | C | 0..* | string | Primitive Type string ruid-pattern: An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen. |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..0 | |||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ruid-pattern | error | string | An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen. : matches('^[A-Za-z][A-Za-z0-9\\-]*$') and matches('^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$').not() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
string | C | 0..* | string | Primitive Type string ruid-pattern: An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen. |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ruid-pattern | error | string | An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen. : matches('^[A-Za-z][A-Za-z0-9\\-]*$') and matches('^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$').not() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
string | C | 0..* | string | Primitive Type string ruid-pattern: An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen. |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ruid-pattern | error | string | An identifier that starts with a letter and contains any combination of letters, numbers, and hyphen. : matches('^[A-Za-z][A-Za-z0-9\\-]*$') and matches('^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$').not() |
This structure is derived from string
Other representations of profile: CSV, Excel, Schematron