Consolidated CDA Release 2.2
2.2 - CI Build
Unknown state code 'US'
Consolidated CDA Release 2.2
2.2 - CI Build
Unknown state code 'US'
Consolidated CDA Release 2.2 - Local Development build (v2.2). See the Directory of published versions
| Active as of 2023-05-30 |
JSON representation of the 2.16.840.1.113883.10.20.29.1 resource profile.
{
"resourceType" : "StructureDefinition",
"id" : "2.16.840.1.113883.10.20.29.1",
"meta" : {
"versionId" : "3",
"lastUpdated" : "2022-05-13T19:09:31.563+00:00",
"source" : "#kniLtlGhdA7knl9h"
},
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-2.16.840.1.113883.10.20.29.1-definitions.html#ClinicalDocument\">ClinicalDocument</a><a name=\"ClinicalDocument\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-2.16.840.1.113883.10.20.22.1.1.html\">USRealmHeader</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Base for all types and resources</span></td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.29.1",
"identifier" : [
{
"value" : "urn:hl7ii:2.16.840.1.113883.10.20.29.1:2015-08-01"
}
],
"version" : "2.2",
"name" : "USRealmHeaderforPatientGeneratedDocument",
"title" : "US Realm Header for Patient Generated Document",
"status" : "active",
"date" : "2023-05-30T19:31:57+00:00",
"publisher" : "Health Level Seven",
"contact" : [
{
"name" : "HL7 International - Structured Documents",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166:-2",
"code" : "US"
}
]
}
],
"fhirVersion" : "4.0.1",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "resource",
"abstract" : false,
"type" : "ClinicalDocument",
"baseDefinition" : "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "ClinicalDocument",
"path" : "ClinicalDocument",
"short" : "Base for all types and resources",
"definition" : "Base definition for all types defined in FHIR type system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.classCode",
"path" : "ClinicalDocument.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "DOCCLIN",
"fixedCode" : "DOCCLIN",
"binding" : {
"strength" : "extensible",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActClass"
}
},
{
"id" : "ClinicalDocument.moodCode",
"path" : "ClinicalDocument.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.moodCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "EVN",
"fixedCode" : "EVN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActMood"
}
},
{
"id" : "ClinicalDocument.realmCode",
"path" : "ClinicalDocument.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.typeId",
"path" : "ClinicalDocument.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.typeId",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.templateId",
"path" : "ClinicalDocument.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.id",
"path" : "ClinicalDocument.id",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.code",
"path" : "ClinicalDocument.code",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.code",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/ValueSet/doc-typecodes"
}
},
{
"id" : "ClinicalDocument.title",
"path" : "ClinicalDocument.title",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.title",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.effectiveTime",
"path" : "ClinicalDocument.effectiveTime",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.effectiveTime",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode",
"path" : "ClinicalDocument.confidentialityCode",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.confidentialityCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.languageCode",
"path" : "ClinicalDocument.languageCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.languageCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-HumanLanguage"
}
},
{
"id" : "ClinicalDocument.setId",
"path" : "ClinicalDocument.setId",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.setId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.versionNumber",
"path" : "ClinicalDocument.versionNumber",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.versionNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/INT"
}
]
},
{
"id" : "ClinicalDocument.copyTime",
"path" : "ClinicalDocument.copyTime",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.copyTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget",
"path" : "ClinicalDocument.recordTarget",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.recordTarget",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/RecordTarget"
}
]
},
{
"id" : "ClinicalDocument.author",
"path" : "ClinicalDocument.author",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.author",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Author"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer",
"path" : "ClinicalDocument.dataEnterer",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.dataEnterer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/DataEnterer"
}
]
},
{
"id" : "ClinicalDocument.informant",
"path" : "ClinicalDocument.informant",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.informant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Informant"
}
]
},
{
"id" : "ClinicalDocument.custodian",
"path" : "ClinicalDocument.custodian",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.custodian",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Custodian"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient",
"path" : "ClinicalDocument.informationRecipient",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.informationRecipient",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/InformationRecipient"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator",
"path" : "ClinicalDocument.legalAuthenticator",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.legalAuthenticator",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/LegalAuthenticator"
}
]
},
{
"id" : "ClinicalDocument.authenticator",
"path" : "ClinicalDocument.authenticator",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.authenticator",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Authenticator"
}
]
},
{
"id" : "ClinicalDocument.participant",
"path" : "ClinicalDocument.participant",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.participant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Participant1"
}
]
},
{
"id" : "ClinicalDocument.inFulfillmentOf",
"path" : "ClinicalDocument.inFulfillmentOf",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.inFulfillmentOf",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/InFulfillmentOf"
}
]
},
{
"id" : "ClinicalDocument.documentationOf",
"path" : "ClinicalDocument.documentationOf",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.documentationOf",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/DocumentationOf"
}
]
},
{
"id" : "ClinicalDocument.relatedDocument",
"path" : "ClinicalDocument.relatedDocument",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.relatedDocument",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/RelatedDocument"
}
]
},
{
"id" : "ClinicalDocument.authorization",
"path" : "ClinicalDocument.authorization",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.authorization",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Authorization"
}
]
},
{
"id" : "ClinicalDocument.componentOf",
"path" : "ClinicalDocument.componentOf",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.componentOf",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/ComponentOf"
}
]
},
{
"id" : "ClinicalDocument.component",
"path" : "ClinicalDocument.component",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.component",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/cda/StructureDefinition/Component2"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "ClinicalDocument",
"path" : "ClinicalDocument"
}
]
}
}
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccdar2dot2#2.2 based on FHIR 4.0.1. Generated 2023-05-30
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change