Clinical Document Architecture
2.0.1 - active

Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions

Data Type Profile: uid: Unique Identifier String

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/uid Version: 2.0.1
Active as of 2023-10-03 Computable Name: uid

A unique identifier string is a character string which identifies an object in a globally unique and timeless manner. The allowable formats and values and procedures of this data type are strictly controlled by HL7. At this time, user-assigned identifiers may be certain character representations of ISO Object Identifiers (OID) and DCE Universally Unique Identifiers (UUID). HL7 also reserves the right to assign other forms of UIDs (RUID), such as mnemonic identifiers for code systems.

Usage:

  • This PrimitiveType Constraint is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from string

NameFlagsCard.TypeDescription & Constraintsdoco
.. string C0..*stringPrimitive Type string
uid-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)
... id 0..0
... extension 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
uid-patternerrorstringMust 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]*))+)|([0-9A-Z]{8}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{12})|([A-Za-z][A-Za-z0-9\\-]*)$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. string C0..*stringPrimitive Type string
uid-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)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
uid-patternerrorstringMust 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]*))+)|([0-9A-Z]{8}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{12})|([A-Za-z][A-Za-z0-9\\-]*)$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. string C0..*stringPrimitive Type string
uid-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)
... value 0..1stringPrimitive value for string
Max Length: 1048576

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
uid-patternerrorstringMust 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]*))+)|([0-9A-Z]{8}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{12})|([A-Za-z][A-Za-z0-9\\-]*)$')

This structure is derived from string

Summary

Prohibited: 2 elements

Differential View

This structure is derived from string

NameFlagsCard.TypeDescription & Constraintsdoco
.. string C0..*stringPrimitive Type string
uid-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)
... id 0..0
... extension 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
uid-patternerrorstringMust 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]*))+)|([0-9A-Z]{8}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{12})|([A-Za-z][A-Za-z0-9\\-]*)$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. string C0..*stringPrimitive Type string
uid-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)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
uid-patternerrorstringMust 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]*))+)|([0-9A-Z]{8}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{12})|([A-Za-z][A-Za-z0-9\\-]*)$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. string C0..*stringPrimitive Type string
uid-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)
... value 0..1stringPrimitive value for string
Max Length: 1048576

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
uid-patternerrorstringMust 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]*))+)|([0-9A-Z]{8}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{12})|([A-Za-z][A-Za-z0-9\\-]*)$')

This structure is derived from string

Summary

Prohibited: 2 elements

 

Other representations of profile: CSV, Excel, Schematron