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
Active as of 2024-12-18 |
JSON representation of the oid data type profile.
{
"resourceType" : "StructureDefinition",
"id" : "oid",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>Primitive type 'oid'</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/oid",
"version" : "2.0.1-sd",
"name" : "oid",
"title" : "oid: ISO Object Identifier",
"status" : "active",
"experimental" : false,
"date" : "2024-12-18T02:39:25+00: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 globally unique string representing an ISO Object Identifier (OID) in a form that consists only of numbers and dots (e.g., '2.16.840.1.113883.3.1').",
"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" : "oid-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]*))+$')"
}
],
"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" : "oid-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]*))+$')"
}
]
},
{
"id" : "string.id",
"path" : "string.id",
"max" : "0"
},
{
"id" : "string.extension",
"path" : "string.extension",
"max" : "0"
}
]
}
}