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: uuid: DCE Universal Unique Identifier

A globally unique string representing a DCE Universal Unique Identifier (UUID) in the common UUID format that consists of 5 hyphen-separated groups of hexadecimal digits having 8, 4, 4, 4, and 12 places respectively.

NOTE: The output of UUID related programs and functions may use all sorts of forms, upper case, lower case, and with or without the hyphens that group the digits. This variate output must be postprocessed to conform to the HL7 specification, i.e., the hyphens must be inserted for the 8-4-4-4-12 grouping. Historically, CDA also required that all hexadecimal digits must be converted to upper case, but due to real-world issues encountered when enforcing this rule, it has been relaxed to allow for upper or lower case letters. Additionally, FHIR requires that UUID's be communicated using only lower case letters, so for broader compatibility, implementers are encouraged to use lower case letters.

Usages:

• Use this Primitive Type Profile: 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    Filter: Bindings Constraints Obligations
string	C	0..*	string	Primitive Type string Constraints: uuid-pattern
id		0..0
extension		0..0
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
uuid-pattern	error	string	Must contain 5 hyphen-separated groups of hexadecimal digits having 8, 4, 4, 4, and 12 places respectively. : 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}$')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
string	C	0..*	string	Primitive Type string Constraints: uuid-pattern
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())
uuid-pattern	error	string	Must contain 5 hyphen-separated groups of hexadecimal digits having 8, 4, 4, 4, and 12 places respectively. : 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}$')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
string	C	0..*	string	Primitive Type string Constraints: uuid-pattern
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())
uuid-pattern	error	string	Must contain 5 hyphen-separated groups of hexadecimal digits having 8, 4, 4, 4, and 12 places respectively. : 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}$')

This structure is derived from string

Summary

Prohibited: 2 elements

Differential View

This structure is derived from string

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
string	C	0..*	string	Primitive Type string Constraints: uuid-pattern
id		0..0
extension		0..0
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
uuid-pattern	error	string	Must contain 5 hyphen-separated groups of hexadecimal digits having 8, 4, 4, 4, and 12 places respectively. : 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}$')

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
string	C	0..*	string	Primitive Type string Constraints: uuid-pattern
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())
uuid-pattern	error	string	Must contain 5 hyphen-separated groups of hexadecimal digits having 8, 4, 4, 4, and 12 places respectively. : 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}$')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
string	C	0..*	string	Primitive Type string Constraints: uuid-pattern
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())
uuid-pattern	error	string	Must contain 5 hyphen-separated groups of hexadecimal digits having 8, 4, 4, 4, and 12 places respectively. : 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}$')

This structure is derived from string

Summary

Prohibited: 2 elements

Other representations of profile: CSV, Excel, Schematron