Consolidated CDA (C-CDA)
3.0.0 - STU3
Consolidated CDA (C-CDA)
3.0.0 - STU3
This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Draft as of 2024-05-18 |
JSON representation of the ImmunizationsSection logical model.
{
"resourceType" : "StructureDefinition",
"id" : "ImmunizationsSection",
"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_bck1.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-ImmunizationsSection-definitions.html#Section\">Section</a><a name=\"Section\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;\" href=\"http://hl7.org/fhir/R5/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints (shall-immunization-activity)\">C</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\">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=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">Section</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=\"font-weight:bold\">XML Namespace: </span>urn:hl7-org:v3<br/>Elements defined in Ancestors:<a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ANY.html\" title=\"If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.\">@nullFlavor</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-InfrastructureRoot.html\" title=\"When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question\">realmCode</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-InfrastructureRoot.html\" title=\"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.\">typeId</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-InfrastructureRoot.html\" title=\"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\">templateId</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">@ID</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">@classCode</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">@moodCode</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">id</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">code</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">title</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">text</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">confidentialityCode</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">languageCode</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">subject</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">author</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">informant</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">entry</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Section.html\">component</a><br/><span style=\"opacity: 0.5\">Base for all types and resources</span><br/><span style=\"font-weight:bold\">Instance of this type are validated by templateId</span><br/><span style=\"font-weight:bold\" title=\"The root class that contains instances of this class\">Logical Container: </span><a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">ClinicalDocument (CDA Class)</a><br/><span style=\"font-weight:bold\">shall-immunization-activity: </span>If section/@nullFlavor is not present, SHALL contain at least one Immunization Activity</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ImmunizationsSection-definitions.html#Section.nullFlavor\">@nullFlavor</a><a name=\"Section.nullFlavor\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</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: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-cs-simple.html\" title=\"code\">cs</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">If a required section contains no information, the @nullFlavor MAY be set to NI</td></tr>\r\n<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_bck13.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_slice.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Slice Definition\" class=\"hierarchy\"/> <a style=\"font-style: italic\" href=\"StructureDefinition-ImmunizationsSection-definitions.html#Section.templateId\">Slices for templateId</a><a name=\"Section.templateId\"> </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=\"font-style: italic\"/><span style=\"font-style: italic\">1</span><span style=\"font-style: italic\">..</span><span style=\"opacity: 0.5; font-style: italic\">*</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 style=\"opacity: 0.5; font-style: italic\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-II.html\">II</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=\"font-weight:bold; font-style: italic\">Slice: </span><span style=\"font-style: italic\">Unordered, Open by value:root, value:extension</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck125.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end_slicer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_slice_item.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Slice Item\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ImmunizationsSection-definitions.html#Section.templateId:section\" title=\"Slice section\">templateId:section</a><a name=\"Section.templateId\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-II.html\">II</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<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_bck1250.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_slice.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-ImmunizationsSection-definitions.html#Section.templateId:section.root\">@root</a><a name=\"Section.templateId.root\"> </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\">1..<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 style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-oid.html\" title=\"string\">oid</a><span style=\"opacity: 0.5\">, </span><a style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-uuid.html\" title=\"string\">uuid</a><span style=\"opacity: 0.5\">, </span><a style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ruid.html\" title=\"string\">ruid</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=\"font-weight:bold\">Required Pattern: </span><span style=\"color: darkgreen\">2.16.840.1.113883.10.20.22.2.2.1</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1240.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end_slice.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_extension_simple.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Simple Extension\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ImmunizationsSection-definitions.html#Section.templateId:section.extension\">@extension</a><a name=\"Section.templateId.extension\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..<span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-st-simple.html\" title=\"string\">st</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">Required Pattern: </span><span style=\"color: darkgreen\">2015-08-01</span></td></tr>\r\n<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_bck11.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.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-ImmunizationsSection-definitions.html#Section.code\">code</a><a name=\"Section.code\"> </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\">1..<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 style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-CE.html\">CE</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">History of Immunization Narrative</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ImmunizationsSection-definitions.html#Section.code.code\">@code</a><a name=\"Section.code.code\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..<span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-cs-simple.html\" title=\"code\">cs</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">Required Pattern: </span><span style=\"color: darkgreen\">11369-6</span></td></tr>\r\n<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_bck100.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.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-ImmunizationsSection-definitions.html#Section.code.codeSystem\">@codeSystem</a><a name=\"Section.code.codeSystem\"> </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\">1..<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 style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-oid.html\" title=\"string\">oid</a><span style=\"opacity: 0.5\">, </span><a style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-uuid.html\" title=\"string\">uuid</a><span style=\"opacity: 0.5\">, </span><a style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ruid.html\" title=\"string\">ruid</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=\"font-weight:bold\">Required Pattern: </span><span style=\"color: darkgreen\">2.16.840.1.113883.6.1</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ImmunizationsSection-definitions.html#Section.title\">title</a><a name=\"Section.title\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..<span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ST.html\">ST</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<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_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.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-ImmunizationsSection-definitions.html#Section.text\">text</a><a name=\"Section.text\"> </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\">1..<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 style=\"opacity: 0.5\" href=\"http://hl7.org/fhir/R5/narrative.html#xhtml\">xhtml</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck03.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_slice.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Slice Definition\" class=\"hierarchy\"/> <a style=\"font-style: italic\" href=\"StructureDefinition-ImmunizationsSection-definitions.html#Section.entry\">Slices for entry</a><a name=\"Section.entry\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-style: italic\"/><span style=\"opacity: 0.5; font-style: italic\">0</span><span style=\"opacity: 0.5; font-style: italic\">..</span><span style=\"opacity: 0.5; font-style: italic\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5; font-style: italic\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Entry.html\">Entry</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-style: italic\">If section/@nullFlavor is not present...</span><br style=\"font-style: italic\"/><span style=\"font-weight:bold; font-style: italic\">Slice: </span><span style=\"font-style: italic\">Unordered, Open by profile:substanceAdministration</span></td></tr>\r\n<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_bck025.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end_slicer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_slice_item.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Slice Item\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ImmunizationsSection-definitions.html#Section.entry:activity\" title=\"Slice activity\">entry:activity</a><a name=\"Section.entry\"> </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\">0..*</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Entry.html\">Entry</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">(USCDI) Immunizations<br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0240.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end_slice.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ImmunizationsSection-definitions.html#Section.entry:activity.substanceAdministration\">substanceAdministration</a><a name=\"Section.entry.substanceAdministration\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..<span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-ImmunizationActivity.html\" title=\"http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration\">ImmunizationActivity</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; 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>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "not-applicable"
}
]
}
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:v3"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "section"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueUri" : "cda"
}
],
"url" : "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationsSection",
"identifier" : [
{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:hl7ii:2.16.840.1.113883.10.20.22.2.2.1:2015-08-01"
}
],
"version" : "3.0.0",
"name" : "ImmunizationsSection",
"title" : "Immunizations Section",
"status" : "draft",
"date" : "2024-05-18T00:16:25-05:00",
"publisher" : "Health Level Seven",
"contact" : [
{
"name" : "HL7 International - Structured Documents",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"description" : "The Immunizations Section defines a patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. The section should include current immunization status, and may contain the entire immunization history that is relevant to the period of time being summarized.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"fhirVersion" : "5.0.0",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "Section",
"path" : "Section",
"short" : "Base for all types and resources",
"definition" : "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "shall-immunization-activity",
"severity" : "error",
"human" : "If section/@nullFlavor is not present, SHALL contain at least one Immunization Activity",
"expression" : "nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity')).exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationsSection"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Section.nullFlavor",
"path" : "Section.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"short" : "If a required section contains no information, the @nullFlavor MAY be set to NI",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "Section.realmCode",
"path" : "Section.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" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "Section.typeId",
"path" : "Section.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" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Section.typeId.nullFlavor",
"path" : "Section.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "Section.typeId.assigningAuthorityName",
"path" : "Section.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Section.typeId.displayable",
"path" : "Section.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "Section.typeId.root",
"path" : "Section.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/uuid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "Section.typeId.extension",
"path" : "Section.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Section.templateId",
"path" : "Section.templateId",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "root"
},
{
"type" : "value",
"path" : "extension"
}
],
"rules" : "open"
},
"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" : 1,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Section.templateId:section",
"path" : "Section.templateId",
"sliceName" : "section",
"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" : 1,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Section.templateId:section.nullFlavor",
"path" : "Section.templateId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "Section.templateId:section.assigningAuthorityName",
"path" : "Section.templateId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Section.templateId:section.displayable",
"path" : "Section.templateId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "Section.templateId:section.root",
"path" : "Section.templateId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/uuid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"patternString" : "2.16.840.1.113883.10.20.22.2.2.1"
},
{
"id" : "Section.templateId:section.extension",
"path" : "Section.templateId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
],
"patternString" : "2015-08-01"
},
{
"id" : "Section.ID",
"path" : "Section.ID",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Section.ID",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "id",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/xs-ID"
]
}
]
},
{
"id" : "Section.classCode",
"path" : "Section.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Section.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DOCSECT",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer"
}
},
{
"id" : "Section.moodCode",
"path" : "Section.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Section.moodCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "EVN",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
}
},
{
"id" : "Section.id",
"path" : "Section.id",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Section.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Section.code",
"path" : "Section.code",
"short" : "History of Immunization Narrative",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Section.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-DocumentSectionType"
}
},
{
"id" : "Section.code.nullFlavor",
"path" : "Section.code.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "Section.code.code",
"path" : "Section.code.code",
"representation" : [
"xmlAttr"
],
"label" : "Code",
"definition" : "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"patternCode" : "11369-6"
},
{
"id" : "Section.code.codeSystem",
"path" : "Section.code.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CD.codeSystem",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/uuid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"patternString" : "2.16.840.1.113883.6.1"
},
{
"id" : "Section.code.codeSystemName",
"path" : "Section.code.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Section.code.codeSystemVersion",
"path" : "Section.code.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Section.code.displayName",
"path" : "Section.code.displayName",
"representation" : [
"xmlAttr"
],
"label" : "Display Name",
"definition" : "A name or title for the code, under which the sending system shows the code value to its users.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Section.code.sdtcValueSet",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSet"
}
],
"path" : "Section.code.sdtcValueSet",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.valueSet",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"
]
}
]
},
{
"id" : "Section.code.sdtcValueSetVersion",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSetVersion"
}
],
"path" : "Section.code.sdtcValueSetVersion",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.sdtcValueSetVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Section.code.originalText",
"path" : "Section.code.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "Section.code.qualifier",
"path" : "Section.code.qualifier",
"label" : "Qualifier",
"definition" : "Specifies additional codes that increase the specificity of the the primary code.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.qualifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
},
{
"id" : "Section.code.translation",
"path" : "Section.code.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id" : "Section.title",
"path" : "Section.title",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Section.title",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "Section.text",
"path" : "Section.text",
"representation" : [
"cdaText"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Section.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "xhtml"
}
]
},
{
"id" : "Section.confidentialityCode",
"path" : "Section.confidentialityCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Section.confidentialityCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "Section.languageCode",
"path" : "Section.languageCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Section.languageCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"id" : "Section.subject",
"path" : "Section.subject",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Section.subject",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Subject"
}
]
},
{
"id" : "Section.author",
"path" : "Section.author",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Section.author",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Author"
}
]
},
{
"id" : "Section.informant",
"path" : "Section.informant",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Section.informant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
}
]
},
{
"id" : "Section.entry",
"path" : "Section.entry",
"slicing" : {
"discriminator" : [
{
"type" : "profile",
"path" : "substanceAdministration"
}
],
"rules" : "open"
},
"short" : "If section/@nullFlavor is not present...",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Section.entry",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Entry"
}
]
},
{
"id" : "Section.entry:activity",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "Section.entry",
"sliceName" : "activity",
"short" : "(USCDI) Immunizations",
"comment" : "SHALL contain at least one [1..*] entry (CONF:1198-9019) such that it",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Section.entry",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Entry"
}
]
},
{
"id" : "Section.entry:activity.nullFlavor",
"path" : "Section.entry.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "Section.entry:activity.realmCode",
"path" : "Section.entry.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" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "Section.entry:activity.typeId",
"path" : "Section.entry.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" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Section.entry:activity.typeId.nullFlavor",
"path" : "Section.entry.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "Section.entry:activity.typeId.assigningAuthorityName",
"path" : "Section.entry.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Section.entry:activity.typeId.displayable",
"path" : "Section.entry.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "Section.entry:activity.typeId.root",
"path" : "Section.entry.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/uuid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "Section.entry:activity.typeId.extension",
"path" : "Section.entry.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Section.entry:activity.templateId",
"path" : "Section.entry.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" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Section.entry:activity.typeCode",
"path" : "Section.entry.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entry.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode" : "COMP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry"
}
},
{
"id" : "Section.entry:activity.contextConductionInd",
"path" : "Section.entry.contextConductionInd",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entry.contextConductionInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"fixedBoolean" : true
},
{
"id" : "Section.entry:activity.act",
"path" : "Section.entry.act",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entry.act",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Act"
}
]
},
{
"id" : "Section.entry:activity.encounter",
"path" : "Section.entry.encounter",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entry.encounter",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Encounter"
}
]
},
{
"id" : "Section.entry:activity.observation",
"path" : "Section.entry.observation",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entry.observation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Observation"
}
]
},
{
"id" : "Section.entry:activity.observationMedia",
"path" : "Section.entry.observationMedia",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entry.observationMedia",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia"
}
]
},
{
"id" : "Section.entry:activity.organizer",
"path" : "Section.entry.organizer",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entry.organizer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organizer"
}
]
},
{
"id" : "Section.entry:activity.procedure",
"path" : "Section.entry.procedure",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entry.procedure",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Procedure"
}
]
},
{
"id" : "Section.entry:activity.regionOfInterest",
"path" : "Section.entry.regionOfInterest",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entry.regionOfInterest",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest"
}
]
},
{
"id" : "Section.entry:activity.substanceAdministration",
"path" : "Section.entry.substanceAdministration",
"short" : "Base for all types and resources",
"definition" : "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
"comment" : "SHALL contain exactly one [1..1] Immunization Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.52:2015-08-01) (CONF:1198-15494).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Entry.substanceAdministration",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity"
]
}
],
"constraint" : [
{
"key" : "should-text-ref-value",
"severity" : "warning",
"human" : "SHOULD contain text/reference/@value",
"expression" : "text.reference.value.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity"
},
{
"key" : "should-doseQuantity",
"severity" : "warning",
"human" : "SHOULD contain doseQuantity",
"expression" : "doseQuantity.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity"
},
{
"key" : "dose-unit-or-admin-unit",
"severity" : "error",
"human" : "If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.",
"expression" : "doseQuantity.unit.exists() implies administrationUnitCode.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity"
},
{
"key" : "should-performer",
"severity" : "warning",
"human" : "SHOULD contain performer",
"expression" : "performer.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity"
},
{
"key" : "should-author",
"severity" : "warning",
"human" : "SHOULD contain author",
"expression" : "author.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Section.entry:activity.supply",
"path" : "Section.entry.supply",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Entry.supply",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Supply"
}
]
},
{
"id" : "Section.component",
"path" : "Section.component",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Section.component",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "Section.component.nullFlavor",
"path" : "Section.component.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "Section.component.realmCode",
"path" : "Section.component.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" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "Section.component.typeId",
"path" : "Section.component.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" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Section.component.typeId.nullFlavor",
"path" : "Section.component.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "Section.component.typeId.assigningAuthorityName",
"path" : "Section.component.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Section.component.typeId.displayable",
"path" : "Section.component.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "Section.component.typeId.root",
"path" : "Section.component.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/uuid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "Section.component.typeId.extension",
"path" : "Section.component.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Section.component.templateId",
"path" : "Section.component.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" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Section.component.typeCode",
"path" : "Section.component.typeCode",
"representation" : [
"xmlAttr"
],
"definition" : "Drawn from concept domain DocumentSectionType",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Section.component.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "COMP"
},
{
"id" : "Section.component.contextConductionInd",
"path" : "Section.component.contextConductionInd",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Section.component.contextConductionInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"fixedBoolean" : true
},
{
"id" : "Section.component.section",
"path" : "Section.component.section",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Section.component.section",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Section"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Section",
"path" : "Section",
"constraint" : [
{
"key" : "shall-immunization-activity",
"severity" : "error",
"human" : "If section/@nullFlavor is not present, SHALL contain at least one Immunization Activity",
"expression" : "nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity')).exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationsSection"
}
]
},
{
"id" : "Section.nullFlavor",
"path" : "Section.nullFlavor",
"short" : "If a required section contains no information, the @nullFlavor MAY be set to NI"
},
{
"id" : "Section.templateId",
"path" : "Section.templateId",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "root"
},
{
"type" : "value",
"path" : "extension"
}
],
"rules" : "open"
},
"min" : 1
},
{
"id" : "Section.templateId:section",
"path" : "Section.templateId",
"sliceName" : "section",
"min" : 1,
"max" : "1"
},
{
"id" : "Section.templateId:section.root",
"path" : "Section.templateId.root",
"min" : 1,
"patternString" : "2.16.840.1.113883.10.20.22.2.2.1"
},
{
"id" : "Section.templateId:section.extension",
"path" : "Section.templateId.extension",
"min" : 1,
"patternString" : "2015-08-01"
},
{
"id" : "Section.code",
"path" : "Section.code",
"short" : "History of Immunization Narrative",
"min" : 1
},
{
"id" : "Section.code.code",
"path" : "Section.code.code",
"min" : 1,
"patternCode" : "11369-6"
},
{
"id" : "Section.code.codeSystem",
"path" : "Section.code.codeSystem",
"min" : 1,
"patternString" : "2.16.840.1.113883.6.1"
},
{
"id" : "Section.title",
"path" : "Section.title",
"min" : 1
},
{
"id" : "Section.text",
"path" : "Section.text",
"min" : 1
},
{
"id" : "Section.entry",
"path" : "Section.entry",
"slicing" : {
"discriminator" : [
{
"type" : "profile",
"path" : "substanceAdministration"
}
],
"rules" : "open"
},
"short" : "If section/@nullFlavor is not present..."
},
{
"id" : "Section.entry:activity",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "Section.entry",
"sliceName" : "activity",
"short" : "(USCDI) Immunizations",
"comment" : "SHALL contain at least one [1..*] entry (CONF:1198-9019) such that it",
"min" : 0,
"max" : "*"
},
{
"id" : "Section.entry:activity.substanceAdministration",
"path" : "Section.entry.substanceAdministration",
"comment" : "SHALL contain exactly one [1..1] Immunization Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.52:2015-08-01) (CONF:1198-15494).",
"min" : 1,
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity"
]
}
]
}
]
}
}
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0 based on FHIR 5.0.0. Generated 2024-05-18
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change