Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.1-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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Data Type Profile: ruid: HL7 Reserved Identifier Scheme

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:

• Use this PrimitiveType Constraint: CD: ConceptDescriptor (V3 Data Type), II: InstanceIdentifier (V3 Data Type) and SC: CharacterStringWithCode (V3 Data Type)

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

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

Constraints

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 ele-1: All FHIR elements must have a @value or children 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

Constraints

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

Constraints

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

Summary

Prohibited: 1 element

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

Constraints

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 ele-1: All FHIR elements must have a @value or children 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

Constraints

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

Constraints

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

Summary

Prohibited: 1 element

Other representations of profile: CSV, Excel, Schematron