This page is part of the CDA: Clinical Document Architecture (v2.0.0-sd-snapshot1: CDA2 Draft) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
Data Type Profile: uid - JSON Profile
JSON representation of the uid data type profile.
Raw json | Download
{
"resourceType" : "StructureDefinition",
"id" : "uid",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>Primitive type 'uid'</p>\n </div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:v3"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode" : "can-bind"
}
],
"url" : "http://hl7.org/cda/stds/core/StructureDefinition/uid",
"version" : "2.0.0-sd-snapshot1",
"name" : "uid",
"title" : "uid: Unique Identifier String",
"status" : "active",
"experimental" : false,
"date" : "2023-12-16T11:59:27-05:00",
"publisher" : "Health Level 7",
"contact" : [
{
"name" : "HL7 International - Structured Documents",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/structure"
},
{
"system" : "email",
"value" : "structdog@lists.HL7.org"
}
]
}
],
"description" : "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.",
"fhirVersion" : "5.0.0",
"kind" : "primitive-type",
"abstract" : false,
"type" : "string",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/string",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "string",
"path" : "string",
"short" : "Primitive Type string",
"definition" : "A sequence of Unicode characters",
"comment" : "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"min" : 0,
"max" : "*",
"base" : {
"path" : "string",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "uid-pattern",
"severity" : "error",
"human" : "Must conform to OID (#.#.#), UUID (32 hexadecimal digits separated by hyphens), or RUID (a letter followed by any combination of letters, numbers or hyphens)",
"expression" : "matches('^([0-2](\\\\.(0|[1-9][0-9]*))+)|([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})|([A-Za-z][A-Za-z0-9\\\\-]*)$')"
}
],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "string.id",
"path" : "string.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references)",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "string.extension",
"path" : "string.extension",
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "string.value",
"path" : "string.value",
"representation" : [
"xmlAttr"
],
"short" : "Primitive value for string",
"definition" : "The actual value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "string.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/regex",
"valueString" : "^[\\s\\S]+$"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"maxLength" : 1048576,
"isModifier" : false,
"isSummary" : false
}
]
},
"differential" : {
"element" : [
{
"id" : "string",
"path" : "string",
"constraint" : [
{
"key" : "uid-pattern",
"severity" : "error",
"human" : "Must conform to OID (#.#.#), UUID (32 hexadecimal digits separated by hyphens), or RUID (a letter followed by any combination of letters, numbers or hyphens)",
"expression" : "matches('^([0-2](\\\\.(0|[1-9][0-9]*))+)|([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})|([A-Za-z][A-Za-z0-9\\\\-]*)$')"
}
]
},
{
"id" : "string.id",
"path" : "string.id",
"max" : "0"
},
{
"id" : "string.extension",
"path" : "string.extension",
"max" : "0"
}
]
}
}
|
|
Propose a change