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. For a full list of available versions, see the Directory of published versions
| Active as of 2024-05-18 |
JSON representation of the USRealmHeaderforPatientGeneratedDocument logical model.
{
"resourceType" : "StructureDefinition",
"id" : "USRealmHeaderforPatientGeneratedDocument",
"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-USRealmHeaderforPatientGeneratedDocument-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-USRealmHeader.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=\"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-ClinicalDocument.html\">@classCode</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">@moodCode</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.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-ClinicalDocument.html\" title=\"ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = "POCD_HD000040" (which is the unique identifier for the CDA, Release Two Hierarchical Description).\">typeId</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.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-ClinicalDocument.html\">id</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">code</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">title</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\" title=\"The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.\">sdtcStatusCode</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">effectiveTime</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">confidentialityCode</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">languageCode</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">setId</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">versionNumber</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">copyTime</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">recordTarget</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">author</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">dataEnterer</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">informant</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">custodian</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">informationRecipient</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">legalAuthenticator</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">authenticator</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">participant</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">inFulfillmentOf</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">documentationOf</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">relatedDocument</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">authorization</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">componentOf</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-ClinicalDocument.html\">component</a>, <a href=\"StructureDefinition-USRealmHeader.html\">realmCode</a>, <a href=\"StructureDefinition-USRealmHeader.html\">typeId</a>, <a href=\"StructureDefinition-USRealmHeader.html\">templateId</a>, <a href=\"StructureDefinition-USRealmHeader.html\">templateId</a>, <a href=\"StructureDefinition-USRealmHeader.html\">id</a>, <a href=\"StructureDefinition-USRealmHeader.html\">code</a>, <a href=\"StructureDefinition-USRealmHeader.html\">title</a>, <a href=\"StructureDefinition-USRealmHeader.html\">effectiveTime</a>, <a href=\"StructureDefinition-USRealmHeader.html\">languageCode</a>, <a href=\"StructureDefinition-USRealmHeader.html\">setId</a>, <a href=\"StructureDefinition-USRealmHeader.html\">versionNumber</a>, <a href=\"StructureDefinition-USRealmHeader.html\">recordTarget</a>, <a href=\"StructureDefinition-USRealmHeader.html\">author</a>, <a href=\"StructureDefinition-USRealmHeader.html\">dataEnterer</a>, <a href=\"StructureDefinition-USRealmHeader.html\">informant</a>, <a href=\"StructureDefinition-USRealmHeader.html\">informant</a>, <a href=\"StructureDefinition-USRealmHeader.html\">informant</a>, <a href=\"StructureDefinition-USRealmHeader.html\">custodian</a>, <a href=\"StructureDefinition-USRealmHeader.html\">informationRecipient</a>, <a href=\"StructureDefinition-USRealmHeader.html\">legalAuthenticator</a>, <a href=\"StructureDefinition-USRealmHeader.html\">authenticator</a>, <a href=\"StructureDefinition-USRealmHeader.html\">participant</a>, <a href=\"StructureDefinition-USRealmHeader.html\">inFulfillmentOf</a>, <a href=\"StructureDefinition-USRealmHeader.html\">documentationOf</a>, <a href=\"StructureDefinition-USRealmHeader.html\">authorization</a>, <a href=\"StructureDefinition-USRealmHeader.html\">componentOf</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></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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.templateId\">templateId</a><a name=\"ClinicalDocument.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\">2..<span style=\"opacity: 0.5\">*</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-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_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\"/> Slices for templateId<a name=\"ClinicalDocument.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\"/><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\">Content/Rules for all slices</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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.templateId:us-patient-gen-doc\" title=\"Slice us-patient-gen-doc\">templateId:us-patient-gen-doc</a><a name=\"ClinicalDocument.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.templateId:us-patient-gen-doc.root\">@root</a><a name=\"ClinicalDocument.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.29.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.templateId:us-patient-gen-doc.extension\">@extension</a><a name=\"ClinicalDocument.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\">2024-05-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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.recordTarget\">recordTarget</a><a name=\"ClinicalDocument.recordTarget\"> </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>..1</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-RecordTarget.html\">RecordTarget</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The recordTarget records the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element. \n\nIf the document receiver is interested in setting up a translator for the encounter with the patient, the receiver of the document will have to infer the need for a translator, based upon the language skills identified for the patient, the patient's language of preference and the predominant language used by the organization receiving the CDA.\n\nHL7 Vocabulary simply describes guardian as a relationship to a ward. This need not be a formal legal relationship. When a guardian relationship exists for the patient, it can be represented, regardless of who is present at the time the document is generated. This need not be a formal legal relationship. A child's parent can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "mother" for the child's mom or "father" for the child's dad. An elderly person's child can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of "daughter" or "son", or if a legal relationship existed, the relationship of "legal guardian" could be encoded.</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_bck101.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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.recordTarget.patientRole\">patientRole</a><a name=\"ClinicalDocument.recordTarget.patientRole\"> </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\">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: #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-PatientRole.html\">PatientRole</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_bck1010.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.recordTarget.patientRole.id\">id</a><a name=\"ClinicalDocument.recordTarget.patientRole.id\"> </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\">*</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-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\"/></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_bck1011.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.recordTarget.patientRole.patient\">patient</a><a name=\"ClinicalDocument.recordTarget.patientRole.patient\"> </a></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=\"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 (should-languageCommunication)\">C</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\">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: #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-Patient.html\">Patient</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\">should-languageCommunication: </span>SHOULD contain languageCommunication</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_bck10111.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_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: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.recordTarget.patientRole.patient.guardian\">guardian</a><a name=\"ClinicalDocument.recordTarget.patientRole.patient.guardian\"> </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 (should-id, should-code)\">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\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</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-Guardian.html\">Guardian</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\">should-id: </span>SHOULD contain id<br/><span style=\"font-weight:bold\">should-code: </span>SHOULD contain code</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_bck101110.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_vline.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.recordTarget.patientRole.patient.guardian.id\">id</a><a name=\"ClinicalDocument.recordTarget.patientRole.patient.guardian.id\"> </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\">*</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-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_bck101100.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_vline.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.recordTarget.patientRole.patient.guardian.code\">code</a><a name=\"ClinicalDocument.recordTarget.patientRole.patient.guardian.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\"><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: 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\"/></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_bck10101.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_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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.recordTarget.patientRole.patient.languageCommunication\">languageCommunication</a><a name=\"ClinicalDocument.recordTarget.patientRole.patient.languageCommunication\"> </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\">*</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-LanguageCommunication.html\">LanguageCommunication</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\">(USCDI) Preferred Language</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_bck101010.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_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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode\">languageCode</a><a name=\"ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode\"> </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 style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-CS.html\">CS</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\">Binding: </span><a href=\"http://hl7.org/fhir/R5/valueset-all-languages.html\" title=\"http://hl7.org/fhir/ValueSet/all-languages\">AllLanguages</a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\">required</a>)</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_bck101000.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_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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd\">preferenceInd</a><a name=\"ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd\"> </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-BL.html\">BL</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Indicates a preference for information about care delivery and treatments be communicated (or translated if needed) into this language.\n\nIf more than one languageCommunication is present, only one languageCommunication element SHALL have a preferenceInd with a value of 1.</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_bck1000.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.recordTarget.patientRole.providerOrganization\">providerOrganization</a><a name=\"ClinicalDocument.recordTarget.patientRole.providerOrganization\"> </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\">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: 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-Organization.html\">Organization</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">If present, this organization represents the provider organization where the person is claiming to be a patient.</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_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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.author\">author</a><a name=\"ClinicalDocument.author\"> </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\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</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-Author.html\">Author</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The author element represents the creator of the clinical document. The author may be a device, or a person. The person is the patient or the patient's advocate.</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_bck101.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.author.assignedAuthor\">assignedAuthor</a><a name=\"ClinicalDocument.author.assignedAuthor\"> </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 (should-code)\">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 style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-AssignedAuthor.html\">AssignedAuthor</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\">should-code: </span>SHOULD contain code</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_bck1010.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.author.assignedAuthor.id\">id</a><a name=\"ClinicalDocument.author.assignedAuthor.id\"> </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\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</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-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_bck1001.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.author.assignedAuthor.code\">code</a><a name=\"ClinicalDocument.author.assignedAuthor.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\"><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: 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\">When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient.</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_bck10000.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_blank.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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.author.assignedAuthor.code.code\">@code</a><a name=\"ClinicalDocument.author.assignedAuthor.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\"><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: #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\">Binding: </span><a href=\"https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.12.1/expansion\" title=\"http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1\">Personal And Legal Relationship Role Type <img src=\"external.png\" alt=\".\"/></a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#preferred\" title=\"Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.\">preferred</a>)</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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.dataEnterer\">dataEnterer</a><a name=\"ClinicalDocument.dataEnterer\"> </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\">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: 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-DataEnterer.html\">DataEnterer</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The dataEnterer element represents the person who transferred the content, written or dictated by someone else, into the clinical document. The guiding rule of thumb is that an author provides the content found within the header or body of the document, subject to their own interpretation, and the dataEnterer adds that information to the electronic system. In other words, a dataEnterer transfers information from one source to another (e.g., transcription from paper form to electronic system). If the dataEnterer is missing, this role is assumed to be played by the author.</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_bck101.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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.dataEnterer.assignedEntity\">assignedEntity</a><a name=\"ClinicalDocument.dataEnterer.assignedEntity\"> </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\">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: #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-AssignedEntity.html\">AssignedEntity</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_bck1000.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.dataEnterer.assignedEntity.code\">code</a><a name=\"ClinicalDocument.dataEnterer.assignedEntity.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\"><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: 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\"><span style=\"font-weight:bold\">Binding: </span><a href=\"https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.12.1/expansion\" title=\"http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1\">Personal And Legal Relationship Role Type <img src=\"external.png\" alt=\".\"/></a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#preferred\" title=\"Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.\">preferred</a>)</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_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: #F7F7F7; background-color: inherit\" title=\"Slice Definition\" class=\"hierarchy\"/> Slices for informant<a name=\"ClinicalDocument.informant\"> </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\"/><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\">Content/Rules for all slices</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_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: white; background-color: inherit\" title=\"Slice Item\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.informant:non-provider\" title=\"Slice non-provider\">informant:non-provider</a><a name=\"ClinicalDocument.informant\"> </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\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</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-Informant.html\">Informant</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\">The informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient.</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_bck1241.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_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.informant:non-provider.relatedEntity\">relatedEntity</a><a name=\"ClinicalDocument.informant.relatedEntity\"> </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\">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: #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-RelatedEntity.html\">RelatedEntity</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_bck12401.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_blank.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.informant:non-provider.relatedEntity.code\">code</a><a name=\"ClinicalDocument.informant.relatedEntity.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\"><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 (should-us-code-attr)\">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\">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: 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\"><span style=\"font-weight:bold\">should-us-code-attr: </span>SHOULD contain @code</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_bck124000.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_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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.informant:non-provider.relatedEntity.code.code\">@code</a><a name=\"ClinicalDocument.informant.relatedEntity.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\"><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\"><span style=\"font-weight:bold\">Binding: </span><a href=\"https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.12.1/expansion\" title=\"http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1\">Personal And Legal Relationship Role Type <img src=\"external.png\" alt=\".\"/></a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#preferred\" title=\"Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.\">preferred</a>)</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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.custodian\">custodian</a><a name=\"ClinicalDocument.custodian\"> </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 style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Custodian.html\">Custodian</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The custodian element represents the organization or person that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian. The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document (e.g., CDA could include scanned copy of original), the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. Also, the custodian may be the patient or an organization acting on behalf of the patient, such as a PHR organization.</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_bck101.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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.custodian.assignedCustodian\">assignedCustodian</a><a name=\"ClinicalDocument.custodian.assignedCustodian\"> </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\">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: #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-AssignedCustodian.html\">AssignedCustodian</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_bck1001.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization\">representedCustodianOrganization</a><a name=\"ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization\"> </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 style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-CustodianOrganization.html\">CustodianOrganization</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The representedCustodianOrganization may be the person when the document is not maintained by an organization.</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_bck10000.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_blank.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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id\">id</a><a name=\"ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id\"> </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\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</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-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\">The combined @root and @extension attributes record the custodian organization's identity in a secure, trusted, and unique way.</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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.informationRecipient\">informationRecipient</a><a name=\"ClinicalDocument.informationRecipient\"> </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\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</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-InformationRecipient.html\">InformationRecipient</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The informationRecipient element records the intended recipient of the information at the time the document is created. For example, in cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to be the scoping organization for that chart.</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_bck101.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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.informationRecipient.intendedRecipient\">intendedRecipient</a><a name=\"ClinicalDocument.informationRecipient.intendedRecipient\"> </a></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=\"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 (should-id)\">C</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\">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: #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-IntendedRecipient.html\">IntendedRecipient</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\">should-id: </span>SHOULD contain id</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_bck1001.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.informationRecipient.intendedRecipient.id\">id</a><a name=\"ClinicalDocument.informationRecipient.intendedRecipient.id\"> </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 (should-root)\">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\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</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-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\">The combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.<br/><span style=\"font-weight:bold\">should-root: </span>SHOULD contain @root</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_bck10000.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_blank.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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.informationRecipient.intendedRecipient.id.root\">@root</a><a name=\"ClinicalDocument.informationRecipient.intendedRecipient.id.root\"> </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-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: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">For a provider, the id/@root ="2.16.840.1.113883.4.6" indicates the National Provider Identifier where id/@extension is the NPI number for the provider.\n\nThe ids MAY reference the id of a person or organization entity specified elsewhere in the document.</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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.legalAuthenticator\">legalAuthenticator</a><a name=\"ClinicalDocument.legalAuthenticator\"> </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\">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: 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-LegalAuthenticator.html\">LegalAuthenticator</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">In a patient authored document, the legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. (Note that per the following section, there may also be one or more document authenticators.) \n\nBased on local practice, patient authored documents may be provided without legal authentication. This implies that a patient authored document that does not contain this element has not been legally authenticated.\n\nThe act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. All patient documents have the potential for legal authentication, given the appropriate legal authority.\n\nLocal policies MAY choose to delegate the function of legal authentication to a device or system that generates the document. In these cases, the legal authenticator is the person accepting responsibility for the document, not the generating device or system.\n\nNote that the legal authenticator, if present, must be a person.</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_bck101.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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.legalAuthenticator.assignedEntity\">assignedEntity</a><a name=\"ClinicalDocument.legalAuthenticator.assignedEntity\"> </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\">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: #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-AssignedEntity.html\">AssignedEntity</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_bck1010.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.legalAuthenticator.assignedEntity.id\">id</a><a name=\"ClinicalDocument.legalAuthenticator.assignedEntity.id\"> </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\">*</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-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\">The combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.</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_bck1001.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.legalAuthenticator.assignedEntity.code\">code</a><a name=\"ClinicalDocument.legalAuthenticator.assignedEntity.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\"><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-CE.html\">CE</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_bck10000.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_blank.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.legalAuthenticator.assignedEntity.code.code\">@code</a><a name=\"ClinicalDocument.legalAuthenticator.assignedEntity.code.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\"><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: 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-cs-simple.html\" title=\"code\">cs</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\">Binding: </span><a href=\"https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.12.1/expansion\" title=\"http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1\">Personal And Legal Relationship Role Type <img src=\"external.png\" alt=\".\"/></a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#preferred\" title=\"Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.\">preferred</a>)</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_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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.authenticator\">authenticator</a><a name=\"ClinicalDocument.authenticator\"> </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\">*</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-Authenticator.html\">Authenticator</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\">The authenticator identifies a participant or participants who attest to the accuracy of the information in the document.</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_bck101.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.authenticator.assignedEntity\">assignedEntity</a><a name=\"ClinicalDocument.authenticator.assignedEntity\"> </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 (should-code)\">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 style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-AssignedEntity.html\">AssignedEntity</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\">should-code: </span>SHOULD contain code</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_bck1010.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.authenticator.assignedEntity.id\">id</a><a name=\"ClinicalDocument.authenticator.assignedEntity.id\"> </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\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</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-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\">The combined @root and @extension attributes to record the authenticator's identity in a secure, trusted, and unique way.</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_bck1000.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.authenticator.assignedEntity.code\">code</a><a name=\"ClinicalDocument.authenticator.assignedEntity.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\"><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: 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\"><span style=\"font-weight:bold\">Binding: </span><a href=\"https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.12.1/expansion\" title=\"http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1\">Personal And Legal Relationship Role Type <img src=\"external.png\" alt=\".\"/></a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#preferred\" title=\"Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.\">preferred</a>)</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_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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.participant\">participant</a><a name=\"ClinicalDocument.participant\"> </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\">*</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-Participant1.html\">Participant1</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The participant element identifies other supporting participants, including parents, relatives, caregivers, insurance policyholders, guarantors, and other participants related in some way to the patient. \n\nA supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin)</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_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: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.participant.typeCode\">@typeCode</a><a name=\"ClinicalDocument.participant.typeCode\"> </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 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: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Unless otherwise specified by the document specific header constraints, when participant/@typeCode is IND, associatedEntity/@classCode SHALL be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes STATIC 2011-09-30</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_bck101.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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.participant.associatedEntity\">associatedEntity</a><a name=\"ClinicalDocument.participant.associatedEntity\"> </a></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=\"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 (should-code)\">C</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\">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: #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-AssociatedEntity.html\">AssociatedEntity</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\">should-code: </span>SHOULD contain code</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_bck1000.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.participant.associatedEntity.code\">code</a><a name=\"ClinicalDocument.participant.associatedEntity.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\"><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: 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\"><span style=\"font-weight:bold\">Binding: </span><a href=\"https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.12.1/expansion\" title=\"http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1\">Personal And Legal Relationship Role Type <img src=\"external.png\" alt=\".\"/></a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#preferred\" title=\"Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.\">preferred</a>)</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_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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.inFulfillmentOf\">inFulfillmentOf</a><a name=\"ClinicalDocument.inFulfillmentOf\"> </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\">*</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-InFulfillmentOf.html\">InFulfillmentOf</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\">The inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists' report of an x-ray.</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_bck101.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.inFulfillmentOf.order\">order</a><a name=\"ClinicalDocument.inFulfillmentOf.order\"> </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 style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Order.html\">Order</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_bck1000.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.inFulfillmentOf.order.id\">id</a><a name=\"ClinicalDocument.inFulfillmentOf.order.id\"> </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\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</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-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\">A scheduled appointment or service event in a practice management system may be represented using this id element.</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_bck01.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_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.documentationOf\">documentationOf</a><a name=\"ClinicalDocument.documentationOf\"> </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\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</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-DocumentationOf.html\">DocumentationOf</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_bck001.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.documentationOf.serviceEvent\">serviceEvent</a><a name=\"ClinicalDocument.documentationOf.serviceEvent\"> </a></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=\"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 (should-code, should-performer)\">C</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\">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: #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-ServiceEvent.html\">ServiceEvent</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\">A serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template.</span><br/><span style=\"font-weight:bold\">should-code: </span>SHOULD contain code<br/><span style=\"font-weight:bold\">should-performer: </span>SHOULD contain performer</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_bck0010.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.documentationOf.serviceEvent.code\">code</a><a name=\"ClinicalDocument.documentationOf.serviceEvent.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\"><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: 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\">The code should be selected from a value set established by the document-level template for a specific type of Patient Generated Document.</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_bck0001.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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.documentationOf.serviceEvent.performer\">performer</a><a name=\"ClinicalDocument.documentationOf.serviceEvent.performer\"> </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\">*</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-Performer1.html\">Performer1</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\">The performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.</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_bck00011.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_blank.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.documentationOf.serviceEvent.performer.functionCode\">functionCode</a><a name=\"ClinicalDocument.documentationOf.serviceEvent.performer.functionCode\"> </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\">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: 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\">When indicating the performer was the primary care physician, implementers should indicate "PCP" as the functionCode</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_bck000100.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_blank.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: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code\">@code</a><a name=\"ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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\"><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\"><span style=\"font-weight:bold\">Binding: </span><a href=\"https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.1.11.10267/expansion\" title=\"http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.10267\">ParticipationFunction <img src=\"external.png\" alt=\".\"/></a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\">required</a>)</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_bck00001.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_blank.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity\">assignedEntity</a><a name=\"ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity\"> </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 style=\"opacity: 0.5\" href=\"http://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-AssignedEntity.html\">AssignedEntity</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_bck000010.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_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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id\">id</a><a name=\"ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id\"> </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\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</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-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\">The combined @root and @extension attributes record the performer's identity in a secure, trusted, and unique way.</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_bck000000.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_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.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-USRealmHeaderforPatientGeneratedDocument-definitions.html#ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code\">code</a><a name=\"ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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\"><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: 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\">If the assignedEntity is an individual, the code SHOULD be selected from value set PersonalandLegalRelationshipRoleType value set<br/><span style=\"font-weight:bold\">Binding: </span><a href=\"https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.12.1/expansion\" title=\"http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1\">Personal And Legal Relationship Role Type <img src=\"external.png\" alt=\".\"/></a> (<a href=\"http://hl7.org/fhir/R5/terminologies.html#preferred\" title=\"Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.\">preferred</a>)</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" : "ClinicalDocument"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueUri" : "cda"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}
],
"url" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument",
"identifier" : [
{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:hl7ii:2.16.840.1.113883.10.20.29.1:2024-05-01"
}
],
"version" : "3.0.0",
"name" : "USRealmHeaderforPatientGeneratedDocument",
"title" : "US Realm Header for Patient Generated Document",
"status" : "active",
"date" : "2024-05-18T00:42:57-05:00",
"publisher" : "Health Level Seven",
"contact" : [
{
"name" : "HL7 International - Structured Documents",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"description" : "This template focuses on the patient or related person in the roles of author and other participants and is designed to be used in conjunction with the US Realm Header. It includes additional conformances which further constrain the US Realm Header. \nThe Patient Generated Document Header template is not a separate document type. The document body may contain any structured or unstructured content from C-CDA.",
"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/ClinicalDocument",
"baseDefinition" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "ClinicalDocument",
"path" : "ClinicalDocument",
"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" : "4537-6380",
"severity" : "error",
"human" : "If setId is present versionNumber **SHALL** be present (CONF:4537-6380).",
"expression" : "setId.exists() implies versionNumber.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "4537-6387",
"severity" : "error",
"human" : "If versionNumber is present setId **SHALL** be present (CONF:4537-6387).",
"expression" : "versionNumber.exists() implies setId.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-legalAuthenticator",
"severity" : "warning",
"human" : "SHOULD contain legalAuthenticator",
"expression" : "legalAuthenticator.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-relatedParticipant",
"severity" : "warning",
"human" : "Documents SHOULD contain a RelatedPerson participant",
"expression" : "participant.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant').exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.nullFlavor",
"path" : "ClinicalDocument.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" : "ClinicalDocument.classCode",
"path" : "ClinicalDocument.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DOCCLIN",
"binding" : {
"strength" : "example",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
}
},
{
"id" : "ClinicalDocument.moodCode",
"path" : "ClinicalDocument.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.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" : "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",
"comment" : "SHALL contain exactly one [1..1] realmCode=\"US\" (CONF:4537-16791).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "ClinicalDocument.realmCode.nullFlavor",
"path" : "ClinicalDocument.realmCode.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" : "ClinicalDocument.realmCode.code",
"path" : "ClinicalDocument.realmCode.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" : "US"
},
{
"id" : "ClinicalDocument.realmCode.codeSystem",
"path" : "ClinicalDocument.realmCode.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"max" : "0",
"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"
]
}
]
},
{
"id" : "ClinicalDocument.realmCode.codeSystemName",
"path" : "ClinicalDocument.realmCode.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.realmCode.codeSystemVersion",
"path" : "ClinicalDocument.realmCode.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.realmCode.displayName",
"path" : "ClinicalDocument.realmCode.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" : "0",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.realmCode.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" : "ClinicalDocument.realmCode.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" : "ClinicalDocument.realmCode.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" : "ClinicalDocument.realmCode.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" : "ClinicalDocument.realmCode.originalText",
"path" : "ClinicalDocument.realmCode.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.realmCode.qualifier",
"path" : "ClinicalDocument.realmCode.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" : "ClinicalDocument.realmCode.translation",
"path" : "ClinicalDocument.realmCode.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id" : "ClinicalDocument.typeId",
"path" : "ClinicalDocument.typeId",
"definition" : "ClinicalDocument.typeId is a technology-neutral explicit reference to this CDA, Release Two specification, and must be valued as follows: ClinicalDocument.typeId.root = \"2.16.840.1.113883.1.3\" (which is the OID for HL7 Registered models); ClinicalDocument.typeId.extension = \"POCD_HD000040\" (which is the unique identifier for the CDA, Release Two Hierarchical Description).",
"comment" : "SHALL contain exactly one [1..1] typeId (CONF:4537-5361).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.typeId.nullFlavor",
"path" : "ClinicalDocument.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" : "ClinicalDocument.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.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" : "ClinicalDocument.typeId.displayable",
"path" : "ClinicalDocument.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" : "ClinicalDocument.typeId.root",
"path" : "ClinicalDocument.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"comment" : "This typeId SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.1.3\" (CONF:4537-5250).",
"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" : "ClinicalDocument.typeId.extension",
"path" : "ClinicalDocument.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"comment" : "This typeId SHALL contain exactly one [1..1] @extension=\"POCD_HD000040\" (CONF:4537-5251).",
"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"
]
}
],
"fixedString" : "POCD_HD000040"
},
{
"id" : "ClinicalDocument.templateId",
"path" : "ClinicalDocument.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" : 2,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.templateId:us-realm",
"path" : "ClinicalDocument.templateId",
"sliceName" : "us-realm",
"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" : "ClinicalDocument.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.templateId:us-realm.nullFlavor",
"path" : "ClinicalDocument.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" : "ClinicalDocument.templateId:us-realm.assigningAuthorityName",
"path" : "ClinicalDocument.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" : "ClinicalDocument.templateId:us-realm.displayable",
"path" : "ClinicalDocument.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" : "ClinicalDocument.templateId:us-realm.root",
"path" : "ClinicalDocument.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.1.1"
},
{
"id" : "ClinicalDocument.templateId:us-realm.extension",
"path" : "ClinicalDocument.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" : "2024-05-01"
},
{
"id" : "ClinicalDocument.templateId:us-patient-gen-doc",
"path" : "ClinicalDocument.templateId",
"sliceName" : "us-patient-gen-doc",
"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" : "ClinicalDocument.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.templateId:us-patient-gen-doc.nullFlavor",
"path" : "ClinicalDocument.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" : "ClinicalDocument.templateId:us-patient-gen-doc.assigningAuthorityName",
"path" : "ClinicalDocument.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" : "ClinicalDocument.templateId:us-patient-gen-doc.displayable",
"path" : "ClinicalDocument.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" : "ClinicalDocument.templateId:us-patient-gen-doc.root",
"path" : "ClinicalDocument.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.29.1"
},
{
"id" : "ClinicalDocument.templateId:us-patient-gen-doc.extension",
"path" : "ClinicalDocument.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" : "2024-05-01"
},
{
"id" : "ClinicalDocument.id",
"path" : "ClinicalDocument.id",
"short" : "**SHALL** be a globally unique identifier for the document (CONF:4537-9991).",
"comment" : "SHALL contain exactly one [1..1] id (CONF:4537-5363).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.code",
"path" : "ClinicalDocument.code",
"short" : "**SHALL** specify the particular kind of document (e.g., History and Physical, Discharge Summary, Progress Note) (CONF:4537-9992).",
"comment" : "SHALL contain exactly one [1..1] code (CONF:4537-5253).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.code",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/doc-typecodes"
}
},
{
"id" : "ClinicalDocument.code.nullFlavor",
"path" : "ClinicalDocument.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" : "0",
"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" : "ClinicalDocument.code.code",
"path" : "ClinicalDocument.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"
]
}
]
},
{
"id" : "ClinicalDocument.code.codeSystem",
"path" : "ClinicalDocument.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" : "ClinicalDocument.code.codeSystemName",
"path" : "ClinicalDocument.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" : "ClinicalDocument.code.codeSystemVersion",
"path" : "ClinicalDocument.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" : "ClinicalDocument.code.displayName",
"path" : "ClinicalDocument.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" : "ClinicalDocument.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" : "ClinicalDocument.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" : "ClinicalDocument.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" : "ClinicalDocument.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" : "ClinicalDocument.code.originalText",
"path" : "ClinicalDocument.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" : "ClinicalDocument.code.qualifier",
"path" : "ClinicalDocument.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" : "ClinicalDocument.code.translation",
"path" : "ClinicalDocument.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" : "ClinicalDocument.title",
"path" : "ClinicalDocument.title",
"short" : "The title can either be a locally defined name or the displayName corresponding to clinicalDocument/code",
"comment" : "SHALL contain exactly one [1..1] title (CONF:4537-5254).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.title",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.sdtcStatusCode",
"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" : "statusCode"
}
],
"path" : "ClinicalDocument.sdtcStatusCode",
"definition" : "The statusCode extension attribute allows the implementer to identify a ClinicalDocument that is in other than the completed state. It was created to support the Structured Form Definition IG to identify that the document itself is an unfinished product currently being completed for a patient.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.sdtcStatusCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActStatus"
}
},
{
"id" : "ClinicalDocument.effectiveTime",
"path" : "ClinicalDocument.effectiveTime",
"short" : "Base for all types and resources",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"comment" : "SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5256).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.effectiveTime",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
]
}
],
"constraint" : [
{
"key" : "ts-shall-day",
"severity" : "error",
"human" : "**SHALL** be precise to at least the day",
"expression" : "nullFlavor.exists() or value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
},
{
"key" : "ts-should-minute",
"severity" : "warning",
"human" : "**SHOULD** be precise to at least the minute",
"expression" : "nullFlavor.exists() or value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode",
"path" : "ClinicalDocument.confidentialityCode",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.confidentialityCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode.nullFlavor",
"path" : "ClinicalDocument.confidentialityCode.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" : "0",
"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" : "ClinicalDocument.confidentialityCode.code",
"path" : "ClinicalDocument.confidentialityCode.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"
]
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.16926"
}
},
{
"id" : "ClinicalDocument.confidentialityCode.codeSystem",
"path" : "ClinicalDocument.confidentialityCode.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"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"
]
}
]
},
{
"id" : "ClinicalDocument.confidentialityCode.codeSystemName",
"path" : "ClinicalDocument.confidentialityCode.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" : "ClinicalDocument.confidentialityCode.codeSystemVersion",
"path" : "ClinicalDocument.confidentialityCode.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" : "ClinicalDocument.confidentialityCode.displayName",
"path" : "ClinicalDocument.confidentialityCode.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" : "ClinicalDocument.confidentialityCode.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" : "ClinicalDocument.confidentialityCode.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" : "ClinicalDocument.confidentialityCode.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" : "ClinicalDocument.confidentialityCode.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" : "ClinicalDocument.confidentialityCode.originalText",
"path" : "ClinicalDocument.confidentialityCode.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" : "ClinicalDocument.confidentialityCode.qualifier",
"path" : "ClinicalDocument.confidentialityCode.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" : "ClinicalDocument.confidentialityCode.translation",
"path" : "ClinicalDocument.confidentialityCode.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" : "ClinicalDocument.languageCode",
"path" : "ClinicalDocument.languageCode",
"comment" : "SHALL contain exactly one [1..1] languageCode, which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.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" : "ClinicalDocument.setId",
"path" : "ClinicalDocument.setId",
"comment" : "MAY contain zero or one [0..1] setId (CONF:4537-5261).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.setId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.versionNumber",
"path" : "ClinicalDocument.versionNumber",
"comment" : "MAY contain zero or one [0..1] versionNumber (CONF:4537-5264).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.versionNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/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/cda/stds/core/StructureDefinition/TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget",
"path" : "ClinicalDocument.recordTarget",
"short" : "The recordTarget records the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element. \n\nIf the document receiver is interested in setting up a translator for the encounter with the patient, the receiver of the document will have to infer the need for a translator, based upon the language skills identified for the patient, the patient's language of preference and the predominant language used by the organization receiving the CDA.\n\nHL7 Vocabulary simply describes guardian as a relationship to a ward. This need not be a formal legal relationship. When a guardian relationship exists for the patient, it can be represented, regardless of who is present at the time the document is generated. This need not be a formal legal relationship. A child's parent can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of \"mother\" for the child's mom or \"father\" for the child's dad. An elderly person's child can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of \"daughter\" or \"son\", or if a legal relationship existed, the relationship of \"legal guardian\" could be encoded.",
"comment" : "SHALL contain exactly one [1..1] recordTarget (CONF:1198-28460).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.recordTarget",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/RecordTarget"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.nullFlavor",
"path" : "ClinicalDocument.recordTarget.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" : "ClinicalDocument.recordTarget.realmCode",
"path" : "ClinicalDocument.recordTarget.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" : "ClinicalDocument.recordTarget.typeId",
"path" : "ClinicalDocument.recordTarget.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" : "ClinicalDocument.recordTarget.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.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" : "ClinicalDocument.recordTarget.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.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" : "ClinicalDocument.recordTarget.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.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" : "ClinicalDocument.recordTarget.typeId.root",
"path" : "ClinicalDocument.recordTarget.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" : "ClinicalDocument.recordTarget.typeId.extension",
"path" : "ClinicalDocument.recordTarget.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" : "ClinicalDocument.recordTarget.templateId",
"path" : "ClinicalDocument.recordTarget.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" : "ClinicalDocument.recordTarget.typeCode",
"path" : "ClinicalDocument.recordTarget.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "RecordTarget.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "RCT",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id" : "ClinicalDocument.recordTarget.contextControlCode",
"path" : "ClinicalDocument.recordTarget.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "RecordTarget.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole",
"path" : "ClinicalDocument.recordTarget.patientRole",
"comment" : "This recordTarget SHALL contain exactly one [1..1] patientRole (CONF:1198-28461).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RecordTarget.patientRole",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PatientRole"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.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" : "ClinicalDocument.recordTarget.patientRole.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.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" : "ClinicalDocument.recordTarget.patientRole.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.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" : "ClinicalDocument.recordTarget.patientRole.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.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" : "ClinicalDocument.recordTarget.patientRole.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.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" : "ClinicalDocument.recordTarget.patientRole.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.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" : "ClinicalDocument.recordTarget.patientRole.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.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" : "ClinicalDocument.recordTarget.patientRole.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.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" : "ClinicalDocument.recordTarget.patientRole.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.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" : "ClinicalDocument.recordTarget.patientRole.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "PatientRole.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PAT",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.id",
"path" : "ClinicalDocument.recordTarget.patientRole.id",
"comment" : "This patientRole SHALL contain at least one [1..*] id (CONF:1198-28462).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "PatientRole.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy",
"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" : "identifiedBy"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PatientRole.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.addr",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.addr",
"short" : "(USCDI) Address",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"comment" : "This patientRole SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5271).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "PatientRole.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
]
}
],
"constraint" : [
{
"key" : "shall-city",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"expression" : "nullFlavor.exists() or item.city.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-streetAddressLine",
"severity" : "error",
"human" : "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"expression" : "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10024",
"severity" : "error",
"human" : "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10025",
"severity" : "error",
"human" : "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-max-ad-parts",
"severity" : "error",
"human" : "SHALL have at most one of each: state, city, postalCode, and country",
"expression" : "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.telecom",
"short" : "(USCDI) Phone Number / Email",
"min" : 1,
"max" : "*",
"base" : {
"path" : "PatientRole.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
],
"constraint" : [
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.telecom.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" : "ClinicalDocument.recordTarget.patientRole.telecom.value",
"path" : "ClinicalDocument.recordTarget.patientRole.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "url",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/url"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.telecom.use",
"path" : "ClinicalDocument.recordTarget.patientRole.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"comment" : "Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-5375).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient",
"path" : "ClinicalDocument.recordTarget.patientRole.patient",
"comment" : "This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-28465).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PatientRole.patient",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Patient"
}
],
"constraint" : [
{
"key" : "4537-32993",
"severity" : "error",
"human" : "If sdtc:deceasedInd=\"true\", then sdtc:deceasedTime **SHALL** be present with either a @value or @nullFlavor=UNK (CONF:4537-32993).",
"expression" : "sdtcDeceasedInd.exists(value='true') implies sdtcDeceasedTime.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "4537-21000",
"severity" : "error",
"human" : "If sdtc:deceasedTime/@value is present, then sdtc:deceasedInd SHALL be present with value=true",
"expression" : "sdtcDeceasedTime.value.exists() implies sdtcDeceasedInd.exists(value='true')",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-maritalStatusCode",
"severity" : "warning",
"human" : "SHOULD contain maritalStatusCode",
"expression" : "maritalStatusCode.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-us-languageCommunication",
"severity" : "warning",
"human" : "SHOULD contain languageCommunication",
"expression" : "languageCommunication.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-languageCommunication",
"severity" : "warning",
"human" : "SHOULD contain languageCommunication",
"expression" : "languageCommunication.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.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" : "ClinicalDocument.recordTarget.patientRole.patient.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.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" : "ClinicalDocument.recordTarget.patientRole.patient.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.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" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.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" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.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" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.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" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.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" : "ClinicalDocument.recordTarget.patientRole.patient.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.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" : "ClinicalDocument.recordTarget.patientRole.patient.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.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" : "ClinicalDocument.recordTarget.patientRole.patient.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.determinerCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.id",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.id",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.name",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.name",
"short" : "Base for all types and resources",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"comment" : "This patient SHALL contain at least one [1..*] US Realm Patient Name (PTN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1) (CONF:4537-5284).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Patient.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
]
}
],
"constraint" : [
{
"key" : "pn-no-ls",
"severity" : "error",
"human" : "No PN name part may have a qualifier of LS.",
"expression" : "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/PN"
},
{
"key" : "shall-family",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] family (CONF:81-7159).",
"expression" : "nullFlavor.exists() or item.family.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
},
{
"key" : "shall-given",
"severity" : "error",
"human" : "SHALL contain at least one [1..*] given (CONF:81-7157).",
"expression" : "nullFlavor.exists() or item.given.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
},
{
"key" : "shall-max-suffix",
"severity" : "error",
"human" : "There may be at most one suffix",
"expression" : "(item.suffix.empty() or item.suffix.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
},
{
"key" : "81-7278",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7278).",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc",
"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" : "desc"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDesc",
"definition" : "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcDesc",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.administrativeGenderCode",
"comment" : "This patient SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:4537-6394).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.administrativeGenderCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.1"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthTime",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthTime",
"short" : "(USCDI) Date of Birth - **MAY** be precise to the minute (CONF:4537-32418) (For cases where information about newborn's time of birth needs to be captured)",
"comment" : "This patient SHALL contain exactly one [1..1] birthTime (CONF:4537-5298).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.birthTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS"
}
],
"constraint" : [
{
"key" : "ts-shall-year",
"severity" : "error",
"human" : "**SHALL** be precise to at least the year",
"expression" : "nullFlavor.exists() or value.toString().length() >= 4",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "ts-should-day",
"severity" : "warning",
"human" : "**SHOULD** be precise to at least the day",
"expression" : "nullFlavor.exists() or value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd",
"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" : "deceasedInd"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedInd",
"short" : "sdtc:deceasedInd",
"comment" : "This patient MAY contain zero or one [0..1] sdtc:deceasedInd (CONF:4537-32990).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcDeceasedInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime",
"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" : "deceasedTime"
},
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcDeceasedTime",
"short" : "(USCDI) Date of Death",
"comment" : "This patient MAY contain zero or one [0..1] sdtc:deceasedTime (CONF:4537-32988).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcDeceasedTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS"
}
],
"constraint" : [
{
"key" : "should-value-att",
"severity" : "warning",
"human" : "SHOULD contain @value",
"expression" : "value.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "ts-shall-year",
"severity" : "error",
"human" : "**SHALL** be precise to at least the year",
"expression" : "nullFlavor.exists() or value.toString().length() >= 4",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "ts-should-day",
"severity" : "warning",
"human" : "**SHOULD** be precise to at least the day",
"expression" : "nullFlavor.exists() or value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd",
"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" : "multipleBirthInd"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthInd",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcMultipleBirthInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber",
"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" : "multipleBirthOrderNumber"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcMultipleBirthOrderNumber",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.sdtcMultipleBirthOrderNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/INT-POS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.maritalStatusCode",
"comment" : "This patient SHOULD contain zero or one [0..1] maritalStatusCode, which SHALL be selected from ValueSet Marital Status urn:oid:2.16.840.1.113883.1.11.12212 DYNAMIC (CONF:4537-5303).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.maritalStatusCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12212"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.religiousAffiliationCode",
"comment" : "This patient MAY contain zero or one [0..1] religiousAffiliationCode, which SHALL be selected from ValueSet Religious Affiliation urn:oid:2.16.840.1.113883.1.11.19185 DYNAMIC (CONF:4537-5317).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.religiousAffiliationCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19185"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.raceCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.raceCode",
"short" : "(USCDI) Race",
"comment" : "This patient SHALL contain exactly one [1..1] raceCode, which SHALL be selected from ValueSet Race Category Excluding Nulls urn:oid:2.16.840.1.113883.3.2074.1.1.3 DYNAMIC (CONF:4537-5322).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.raceCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.2074.1.1.3"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode",
"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" : "raceCode"
},
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcRaceCode",
"short" : "(USCDI) Race - The sdtc:raceCode is only used to record additional values when the patient has indicated multiple races or additional race detail beyond the five categories required for Meaningful Use Stage 2. The prefix sdtc: SHALL be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the additional raceCode elements.",
"comment" : "This patient MAY contain zero or more [0..*] sdtc:raceCode, which SHALL be selected from ValueSet Race Value Set urn:oid:2.16.840.1.113883.1.11.14914 DYNAMIC (CONF:4537-7263).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.sdtcRaceCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.14914"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.ethnicGroupCode",
"short" : "(USCDI) Ethnicity",
"comment" : "This patient SHALL contain exactly one [1..1] ethnicGroupCode, which SHALL be selected from ValueSet Ethnicity urn:oid:2.16.840.1.114222.4.11.837 DYNAMIC (CONF:4537-5323).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.ethnicGroupCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.837"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode",
"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" : "ethnicGroupCode"
},
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.sdtcEthnicGroupCode",
"short" : "(USCDI) Ethnicity",
"comment" : "This patient MAY contain zero or more [0..*] ethnicGroupCode, which SHALL be selected from ValueSet Detailed Ethnicity urn:oid:2.16.840.1.114222.4.11.877 DYNAMIC (CONF:4537-32901).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.sdtcEthnicGroupCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.877"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian",
"comment" : "This patient MAY contain zero or more [0..*] guardian (CONF:1198-28469).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.guardian",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Guardian"
}
],
"constraint" : [
{
"key" : "should-us-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-us-addr",
"severity" : "warning",
"human" : "SHOULD contain addr",
"expression" : "addr.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-us-telecom",
"severity" : "warning",
"human" : "SHOULD contain telecom",
"expression" : "telecom.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-id",
"severity" : "warning",
"human" : "SHOULD contain id",
"expression" : "id.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
},
{
"key" : "should-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Guardian.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "GUARD",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAgent"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.id",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.id",
"comment" : "The guardian, if present, SHOULD contain zero or more [0..*] id (CONF:1198-28470).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Guardian.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy",
"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" : "identifiedBy"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Guardian.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.code",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.code",
"comment" : "The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28473).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Guardian.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.addr",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.addr",
"short" : "Base for all types and resources",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"comment" : "The guardian, if present, SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5359).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Guardian.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
]
}
],
"constraint" : [
{
"key" : "shall-city",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"expression" : "nullFlavor.exists() or item.city.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-streetAddressLine",
"severity" : "error",
"human" : "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"expression" : "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10024",
"severity" : "error",
"human" : "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10025",
"severity" : "error",
"human" : "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-max-ad-parts",
"severity" : "error",
"human" : "SHALL have at most one of each: state, city, postalCode, and country",
"expression" : "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom",
"comment" : "The guardian, if present, SHOULD contain zero or more [0..*] telecom (CONF:4537-5382).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Guardian.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
],
"constraint" : [
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "url",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/url"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"comment" : "The telecom, if present, SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7993).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson",
"comment" : "The guardian, if present, SHALL contain exactly one [1..1] guardianPerson (CONF:4537-5385).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Guardian.guardianPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.name",
"short" : "Base for all types and resources",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"comment" : "This guardianPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5386).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Person.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
]
}
],
"constraint" : [
{
"key" : "pn-no-ls",
"severity" : "error",
"human" : "No PN name part may have a qualifier of LS.",
"expression" : "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/PN"
},
{
"key" : "81-9371",
"severity" : "error",
"human" : "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"expression" : "conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
},
{
"key" : "81-9372",
"severity" : "error",
"human" : "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"expression" : "item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcDesc",
"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" : "desc"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcDesc",
"definition" : "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcDesc",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship",
"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" : "asPatientRelationship"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship",
"definition" : "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PRS"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.determinerCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.code",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianPerson.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.guardianOrganization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Guardian.guardianOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace",
"comment" : "This patient MAY contain zero or one [0..1] birthplace (CONF:4537-5395).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.birthplace",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Birthplace"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Birthplace.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "BIRTHPL",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassPassive"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place",
"comment" : "The birthplace, if present, SHALL contain exactly one [1..1] place (CONF:4537-5396).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Birthplace.place",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Place"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Place.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PLC",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassPlace"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Place.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.name",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Place.name",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EN"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr",
"comment" : "This place SHALL contain exactly one [1..1] addr (CONF:4537-5397).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Place.addr",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD"
}
],
"constraint" : [
{
"key" : "4537-5402",
"severity" : "error",
"human" : "If country is US, this addr **SHALL** contain exactly one [1..1] state, which **SHALL** be selected from ValueSet US Core USPS State *DYNAMIC* (CONF:4537-5402).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "4537-5403",
"severity" : "warning",
"human" : "If country is US, this addr **MAY** contain zero or one [0..1] postalCode, which **SHALL** be selected from ValueSet PostalCode urn:oid:2.16.840.1.113883.3.88.12.80.2 *DYNAMIC* (CONF:4537-5403).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.empty() or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.isNotOrdered",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.isNotOrdered",
"representation" : [
"xmlAttr"
],
"label" : "Is Not Ordered",
"definition" : "A boolean value specifying whether the order of the address parts is known or not. While the address parts are always a Sequence, the order in which they are presented may or may not be known. Where this matters, the isNotOrdered property can be used to convey this information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.isNotOrdered",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.use",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "A set of codes advising a system or user which address in a set of like addresses to select for a given purpose.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAPostalAddressUse"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item",
"definition" : "A series of items that constitute the address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.item",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/fhir/StructureDefinition/Base"
}
],
"constraint" : [
{
"key" : "AD-1",
"severity" : "error",
"human" : "Can only have only one of the possible item elements in each choice",
"expression" : "(delimiter | country | state | county | city | postalCode | streetAddressLine | houseNumber | houseNumberNumeric | direction | streetName | streetNameBase | streetNameType | additionalLocator | unitID | unitType | careOf | censusTract | deliveryAddressLine | deliveryInstallationType | deliveryInstallationArea | deliveryInstallationQualifier | deliveryMode | deliveryModeIdentifier | buildingNumberSuffix | postBox | precinct | xmlText).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter",
"definition" : "Delimiters are printed without framing white space. If no value component is provided, the delimiter appears as a line break.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.delimiter",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.delimiter.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DEL"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country",
"definition" : "Country",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.country",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.country.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CNT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state",
"definition" : "A sub-unit of a country with limited sovereignty in a federally organized country.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.state",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.state.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "STA"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county",
"definition" : "A sub-unit of a state or province. (49 of the United States of America use the term \"county;\" Louisiana uses the term \"parish\".)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.county",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.county.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CPA"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city",
"definition" : "The name of the city, town, village, or other community or delivery center",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.city",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.city.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CTY"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode",
"definition" : "A postal code designating a region defined by the postal service.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.postalCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postalCode.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ZIP"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine",
"definition" : "Street address line",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.streetAddressLine",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetAddressLine.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "SAL"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber",
"definition" : "The number of a building, house or lot alongside the street. Also known as \"primary street number\". This does not number the street but rather the building.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.houseNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumber.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "BNR"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric",
"definition" : "The numeric portion of a building number",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.houseNumberNumeric",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.houseNumberNumeric.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "BNN"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction",
"definition" : "Direction (e.g., N, S, W, E)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.direction",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.direction.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DIR"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName",
"definition" : "Name of a roadway or artery recognized by a municipality (including street type and direction)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.streetName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetName.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "STR"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase",
"definition" : "The base name of a roadway or artery recognized by a municipality (excluding street type and direction)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.streetNameBase",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameBase.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "STB"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType",
"definition" : "The designation given to the street. (e.g. Street, Avenue, Crescent, etc.)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.streetNameType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.streetNameType.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "STTYP"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator",
"definition" : "This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., \"3rd floor, Appt. 342\"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch \"t.o.\" means \"opposite to\" for house boats located across the street facing houses).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.additionalLocator",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.additionalLocator.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ADL"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID",
"definition" : "The number or name of a specific unit contained within a building or complex, as assigned by that building or complex.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.unitID",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitID.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "UNID"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType",
"definition" : "Indicates the type of specific unit contained within a building or complex. E.g. Appartment, Floor",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.unitType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.unitType.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "UNIT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf",
"definition" : "The name of the party who will take receipt at the specified address, and will take on responsibility for ensuring delivery to the target recipient",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.careOf",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.careOf.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CAR"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract",
"definition" : "A geographic sub-unit delineated for demographic purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.censusTract",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.censusTract.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CEN"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine",
"definition" : "A delivery address line is frequently used instead of breaking out delivery mode, delivery installation, etc. An address generally has only a delivery address line or a street address line, but not both.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.deliveryAddressLine",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryAddressLine.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DAL"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType",
"definition" : "Indicates the type of delivery installation (the facility to which the mail will be delivered prior to final shipping via the delivery mode.) Example: post office, letter carrier depot, community mail center, station, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.deliveryInstallationType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationType.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DINST"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea",
"definition" : "The location of the delivery installation, usually a town or city, and is only required if the area is different from the municipality. Area to which mail delivery service is provided from any postal facility or service such as an individual letter carrier, rural route, or postal route.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.deliveryInstallationArea",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationArea.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DINSTA"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier",
"definition" : "A number, letter or name identifying a delivery installation. E.g., for Station A, the delivery installation qualifier would be 'A'.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.deliveryInstallationQualifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryInstallationQualifier.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DINSTQ"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode",
"definition" : "Indicates the type of service offered, method of delivery. For example: post office box, rural route, general delivery, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.deliveryMode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryMode.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DMOD"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier",
"definition" : "Represents the routing information such as a letter carrier route number. It is the identifying number of the designator (the box number or rural route number).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.deliveryModeIdentifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.deliveryModeIdentifier.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DMODID"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix",
"definition" : "Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.buildingNumberSuffix",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.buildingNumberSuffix.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "BNS"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox",
"definition" : "A numbered box located in a post station.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.postBox",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.postBox.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "POB"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct",
"definition" : "A subsection of a municipality",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.precinct",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ADXP"
}
],
"constraint" : [
{
"key" : "text-null",
"severity" : "error",
"human" : "xmlText and nullFlavor are mutually exclusive (one must be present)",
"expression" : "(xmlText | nullFlavor).count() = 1",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.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" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.representation",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.representation",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the representation of the binary data that is the content of the binary data value",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.representation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "TXT"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.mediaType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.mediaType",
"representation" : [
"xmlAttr"
],
"label" : "Media Type",
"definition" : "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.mediaType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "text/plain"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.language",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.language",
"representation" : [
"xmlAttr"
],
"label" : "Language",
"definition" : "For character based information the language property specifies the human language of the text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ST.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.partType",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.precinct.partType",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies the type of the address part",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ADXP.partType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PRE"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.xmlText",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.item.xmlText",
"representation" : [
"xmlText"
],
"short" : "Allows for mixed text content",
"comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AD.item.xmlText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.birthplace.place.addr.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "A General Timing Specification (GTS) specifying the periods of time during which the address can be used. This is used to specify different addresses for different times of the week or year.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AD.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean" : true
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication",
"short" : "(USCDI) Preferred Language",
"comment" : "This patient SHOULD contain zero or more [0..*] languageCommunication which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC (CONF:XXX).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.languageCommunication",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication"
}
],
"constraint" : [
{
"key" : "should-proficiencyLevelCode",
"severity" : "warning",
"human" : "SHOULD contain proficiencyLevelCode",
"expression" : "proficiencyLevelCode.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-preferenceInd",
"severity" : "warning",
"human" : "SHOULD contain preferenceInd",
"expression" : "preferenceInd.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.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" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode",
"min" : 1,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.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" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.modeCode",
"comment" : "The languageCommunication, if present, MAY contain zero or one [0..1] modeCode, which SHALL be selected from ValueSet LanguageAbilityMode urn:oid:2.16.840.1.113883.1.11.12249 DYNAMIC (CONF:4537-5409).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.modeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12249"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.proficiencyLevelCode",
"comment" : "The languageCommunication, if present, SHOULD contain zero or one [0..1] proficiencyLevelCode, which SHALL be selected from ValueSet LanguageAbilityProficiency urn:oid:2.16.840.1.113883.1.11.12199 DYNAMIC (CONF:4537-9965).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.proficiencyLevelCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.12199"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd",
"short" : "Indicates a preference for information about care delivery and treatments be communicated (or translated if needed) into this language.\n\nIf more than one languageCommunication is present, only one languageCommunication element SHALL have a preferenceInd with a value of 1.",
"comment" : "The languageCommunication, if present, MAY contain zero or one [0..1] preferenceInd (CONF:1198-28475).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LanguageCommunication.preferenceInd",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization",
"label" : "If present, this organization represents the provider organization where the person is claiming to be a patient.",
"short" : "If present, this organization represents the provider organization where the person is claiming to be a patient.",
"comment" : "This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:1198-28476).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PatientRole.providerOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.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" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.realmCode",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.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" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.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" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.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" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.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" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.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" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.root",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.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" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.typeId.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.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" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.templateId",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.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" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ORG",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id",
"comment" : "The providerOrganization, if present, SHALL contain at least one [1..*] id (CONF:4537-5417).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Organization.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.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" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.assigningAuthorityName",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.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" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.displayable",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.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" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.root",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.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.",
"comment" : "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-16820).",
"min" : 0,
"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"
]
}
],
"constraint" : [
{
"key" : "should-npi",
"severity" : "warning",
"human" : "SHOULD be NPI",
"expression" : "$this = '2.16.840.1.113883.4.6'",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.name",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.name",
"comment" : "The providerOrganization, if present, SHALL contain at least one [1..*] name (CONF:4537-5419).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Organization.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ON"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom",
"comment" : "The providerOrganization, if present, SHALL contain at least one [1..*] telecom (CONF:4537-5420).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Organization.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
],
"constraint" : [
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.nullFlavor",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.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" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "url",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/url"
]
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
],
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"comment" : "Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7994).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.addr",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.addr",
"short" : "Base for all types and resources",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"comment" : "The providerOrganization, if present, SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5422).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Organization.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
]
}
],
"constraint" : [
{
"key" : "shall-city",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"expression" : "nullFlavor.exists() or item.city.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-streetAddressLine",
"severity" : "error",
"human" : "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"expression" : "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10024",
"severity" : "error",
"human" : "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10025",
"severity" : "error",
"human" : "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-max-ad-parts",
"severity" : "error",
"human" : "SHALL have at most one of each: state, city, postalCode, and country",
"expression" : "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.standardIndustryClassCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.standardIndustryClassCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization.asOrganizationPartOf",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.asOrganizationPartOf",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf"
}
]
},
{
"id" : "ClinicalDocument.author",
"path" : "ClinicalDocument.author",
"short" : "The author element represents the creator of the clinical document. The author may be a device, or a person. The person is the patient or the patient's advocate.",
"comment" : "SHALL contain at least one [1..*] author (CONF:1198-28477).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.author",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Author"
}
]
},
{
"id" : "ClinicalDocument.author.nullFlavor",
"path" : "ClinicalDocument.author.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" : "ClinicalDocument.author.realmCode",
"path" : "ClinicalDocument.author.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" : "ClinicalDocument.author.typeId",
"path" : "ClinicalDocument.author.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" : "ClinicalDocument.author.typeId.nullFlavor",
"path" : "ClinicalDocument.author.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" : "ClinicalDocument.author.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.author.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" : "ClinicalDocument.author.typeId.displayable",
"path" : "ClinicalDocument.author.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" : "ClinicalDocument.author.typeId.root",
"path" : "ClinicalDocument.author.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" : "ClinicalDocument.author.typeId.extension",
"path" : "ClinicalDocument.author.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" : "ClinicalDocument.author.templateId",
"path" : "ClinicalDocument.author.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" : "ClinicalDocument.author.typeCode",
"path" : "ClinicalDocument.author.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Author.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "AUT",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id" : "ClinicalDocument.author.contextControlCode",
"path" : "ClinicalDocument.author.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Author.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
}
},
{
"id" : "ClinicalDocument.author.functionCode",
"path" : "ClinicalDocument.author.functionCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Author.functionCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.author.time",
"path" : "ClinicalDocument.author.time",
"short" : "Base for all types and resources",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"comment" : "Such authors SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5445).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Author.time",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
]
}
],
"constraint" : [
{
"key" : "ts-shall-day",
"severity" : "error",
"human" : "**SHALL** be precise to at least the day",
"expression" : "nullFlavor.exists() or value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
},
{
"key" : "ts-should-minute",
"severity" : "warning",
"human" : "**SHOULD** be precise to at least the minute",
"expression" : "nullFlavor.exists() or value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor",
"path" : "ClinicalDocument.author.assignedAuthor",
"comment" : "Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-28478).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Author.assignedAuthor",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor"
}
],
"constraint" : [
{
"key" : "4537-16790",
"severity" : "error",
"human" : "There **SHALL** be exactly one assignedAuthor/assignedPerson or exactly one assignedAuthor/assignedAuthoringDevice (CONF:4537-16790).",
"expression" : "(assignedPerson | assignedAuthoringDevice).count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-id-npi",
"severity" : "warning",
"human" : "SHOULD contain an id with root='2.16.840.1.113883.4.6' (NPI)",
"expression" : "id.where(root = '2.16.840.1.113883.4.6')",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-us-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.realmCode",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.typeId",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.typeId.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.typeId.displayable",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.typeId.root",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.typeId.extension",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.templateId",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.classCode",
"path" : "ClinicalDocument.author.assignedAuthor.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id",
"path" : "ClinicalDocument.author.assignedAuthor.id",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "root"
}
],
"rules" : "open"
},
"comment" : "This assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-28479).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedAuthor.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:npi",
"path" : "ClinicalDocument.author.assignedAuthor.id",
"sliceName" : "npi",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "should-extension",
"severity" : "warning",
"human" : "SHOULD contain extension",
"expression" : "extension.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:npi.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.id.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"short" : "If NPI is unknown, set @nullFlavor to UNK",
"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" : "ClinicalDocument.author.assignedAuthor.id:npi.assigningAuthorityName",
"path" : "ClinicalDocument.author.assignedAuthor.id.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" : "ClinicalDocument.author.assignedAuthor.id:npi.displayable",
"path" : "ClinicalDocument.author.assignedAuthor.id.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" : "ClinicalDocument.author.assignedAuthor.id:npi.root",
"path" : "ClinicalDocument.author.assignedAuthor.id.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.",
"comment" : "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-32884).",
"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.4.6"
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id:npi.extension",
"path" : "ClinicalDocument.author.assignedAuthor.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"comment" : "SHOULD contain zero or one [0..1] @extension (CONF:4537-32885).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy",
"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" : "identifiedBy"
}
],
"path" : "ClinicalDocument.author.assignedAuthor.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedAuthor.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code",
"path" : "ClinicalDocument.author.assignedAuthor.code",
"short" : "When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient.",
"comment" : "This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:1198-28481).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDARoleCode"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "0",
"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" : "ClinicalDocument.author.assignedAuthor.code.code",
"path" : "ClinicalDocument.author.assignedAuthor.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"
]
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.codeSystem",
"path" : "ClinicalDocument.author.assignedAuthor.code.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"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"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.codeSystemName",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.code.codeSystemVersion",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.code.displayName",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.code.originalText",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.code.qualifier",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.code.translation",
"path" : "ClinicalDocument.author.assignedAuthor.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" : "ClinicalDocument.author.assignedAuthor.addr",
"path" : "ClinicalDocument.author.assignedAuthor.addr",
"short" : "Base for all types and resources",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"comment" : "This assignedAuthor SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5452).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedAuthor.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
]
}
],
"constraint" : [
{
"key" : "shall-city",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"expression" : "nullFlavor.exists() or item.city.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-streetAddressLine",
"severity" : "error",
"human" : "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"expression" : "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10024",
"severity" : "error",
"human" : "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10025",
"severity" : "error",
"human" : "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-max-ad-parts",
"severity" : "error",
"human" : "SHALL have at most one of each: state, city, postalCode, and country",
"expression" : "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.telecom",
"path" : "ClinicalDocument.author.assignedAuthor.telecom",
"comment" : "This assignedAuthor SHALL contain at least one [1..*] telecom (CONF:4537-5428).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedAuthor.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
],
"constraint" : [
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.telecom.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.telecom.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" : "ClinicalDocument.author.assignedAuthor.telecom.value",
"path" : "ClinicalDocument.author.assignedAuthor.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "url",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/url"
]
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
],
"path" : "ClinicalDocument.author.assignedAuthor.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.telecom.use",
"path" : "ClinicalDocument.author.assignedAuthor.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"comment" : "Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7995).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson",
"comment" : "MAY contain assignedPerson",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.assignedPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.realmCode",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.displayable",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.root",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.typeId.extension",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.templateId",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.classCode",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson.name",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.name",
"short" : "Base for all types and resources",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"comment" : "The assignedPerson, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-16789).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Person.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
]
}
],
"constraint" : [
{
"key" : "pn-no-ls",
"severity" : "error",
"human" : "No PN name part may have a qualifier of LS.",
"expression" : "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/PN"
},
{
"key" : "81-9371",
"severity" : "error",
"human" : "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"expression" : "conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
},
{
"key" : "81-9372",
"severity" : "error",
"human" : "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"expression" : "item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcDesc",
"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" : "desc"
}
],
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcDesc",
"definition" : "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcDesc",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship",
"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" : "asPatientRelationship"
}
],
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship",
"definition" : "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.realmCode",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.templateId",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.classCode",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PRS"
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE"
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.code",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice",
"comment" : "MAY contain assignedAuthoringDevice",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.assignedAuthoringDevice",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.realmCode",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.nullFlavor",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.displayable",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.root",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.typeId.extension",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.templateId",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.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" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuthoringDevice.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DEV",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassDevice"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuthoringDevice.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.code",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AuthoringDevice.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.manufacturerModelName",
"comment" : "The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] manufacturerModelName (CONF:4537-16784).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AuthoringDevice.manufacturerModelName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SC"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.softwareName",
"comment" : "The assignedAuthoringDevice, if present, SHALL contain exactly one [1..1] softwareName (CONF:4537-16785).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AuthoringDevice.softwareName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SC"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample"
}
},
{
"id" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity",
"path" : "ClinicalDocument.author.assignedAuthor.assignedAuthoringDevice.asMaintainedEntity",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AuthoringDevice.asMaintainedEntity",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/MaintainedEntity"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.representedOrganization",
"path" : "ClinicalDocument.author.assignedAuthor.representedOrganization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedAuthor.representedOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer",
"path" : "ClinicalDocument.dataEnterer",
"short" : "The dataEnterer element represents the person who transferred the content, written or dictated by someone else, into the clinical document. The guiding rule of thumb is that an author provides the content found within the header or body of the document, subject to their own interpretation, and the dataEnterer adds that information to the electronic system. In other words, a dataEnterer transfers information from one source to another (e.g., transcription from paper form to electronic system). If the dataEnterer is missing, this role is assumed to be played by the author.",
"comment" : "MAY contain zero or one [0..1] dataEnterer (CONF:1198-28678).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.dataEnterer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/DataEnterer"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.nullFlavor",
"path" : "ClinicalDocument.dataEnterer.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" : "ClinicalDocument.dataEnterer.realmCode",
"path" : "ClinicalDocument.dataEnterer.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" : "ClinicalDocument.dataEnterer.typeId",
"path" : "ClinicalDocument.dataEnterer.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" : "ClinicalDocument.dataEnterer.typeId.nullFlavor",
"path" : "ClinicalDocument.dataEnterer.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" : "ClinicalDocument.dataEnterer.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.dataEnterer.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" : "ClinicalDocument.dataEnterer.typeId.displayable",
"path" : "ClinicalDocument.dataEnterer.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" : "ClinicalDocument.dataEnterer.typeId.root",
"path" : "ClinicalDocument.dataEnterer.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" : "ClinicalDocument.dataEnterer.typeId.extension",
"path" : "ClinicalDocument.dataEnterer.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" : "ClinicalDocument.dataEnterer.templateId",
"path" : "ClinicalDocument.dataEnterer.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" : "ClinicalDocument.dataEnterer.typeCode",
"path" : "ClinicalDocument.dataEnterer.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DataEnterer.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ENT",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id" : "ClinicalDocument.dataEnterer.contextControlCode",
"path" : "ClinicalDocument.dataEnterer.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DataEnterer.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
}
},
{
"id" : "ClinicalDocument.dataEnterer.time",
"path" : "ClinicalDocument.dataEnterer.time",
"short" : "Base for all types and resources",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DataEnterer.time",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
]
}
],
"constraint" : [
{
"key" : "ts-shall-day",
"severity" : "error",
"human" : "**SHALL** be precise to at least the day",
"expression" : "nullFlavor.exists() or value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
},
{
"key" : "ts-should-minute",
"severity" : "warning",
"human" : "**SHOULD** be precise to at least the minute",
"expression" : "nullFlavor.exists() or value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity",
"path" : "ClinicalDocument.dataEnterer.assignedEntity",
"comment" : "The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28679).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DataEnterer.assignedEntity",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.nullFlavor",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.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" : "ClinicalDocument.dataEnterer.assignedEntity.realmCode",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.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" : "ClinicalDocument.dataEnterer.assignedEntity.typeId",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.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" : "ClinicalDocument.dataEnterer.assignedEntity.typeId.nullFlavor",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.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" : "ClinicalDocument.dataEnterer.assignedEntity.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.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" : "ClinicalDocument.dataEnterer.assignedEntity.typeId.displayable",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.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" : "ClinicalDocument.dataEnterer.assignedEntity.typeId.root",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.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" : "ClinicalDocument.dataEnterer.assignedEntity.typeId.extension",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.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" : "ClinicalDocument.dataEnterer.assignedEntity.templateId",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.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" : "ClinicalDocument.dataEnterer.assignedEntity.classCode",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.id",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.id",
"comment" : "This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-5443).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.id.nullFlavor",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.id.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" : "ClinicalDocument.dataEnterer.assignedEntity.id.assigningAuthorityName",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.id.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" : "ClinicalDocument.dataEnterer.assignedEntity.id.displayable",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.id.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" : "ClinicalDocument.dataEnterer.assignedEntity.id.root",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.id.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.",
"comment" : "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-16821).",
"min" : 0,
"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"
]
}
],
"constraint" : [
{
"key" : "should-npi",
"severity" : "warning",
"human" : "SHOULD be NPI",
"expression" : "$this = '2.16.840.1.113883.4.6'",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.id.extension",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy",
"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" : "identifiedBy"
}
],
"path" : "ClinicalDocument.dataEnterer.assignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.code",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.code",
"comment" : "This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28680).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.addr",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.addr",
"short" : "Base for all types and resources",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"comment" : "This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5460).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
]
}
],
"constraint" : [
{
"key" : "shall-city",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"expression" : "nullFlavor.exists() or item.city.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-streetAddressLine",
"severity" : "error",
"human" : "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"expression" : "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10024",
"severity" : "error",
"human" : "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10025",
"severity" : "error",
"human" : "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-max-ad-parts",
"severity" : "error",
"human" : "SHALL have at most one of each: state, city, postalCode, and country",
"expression" : "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.telecom",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.telecom",
"comment" : "This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5466).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
],
"constraint" : [
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.nullFlavor",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.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" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.value",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "url",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/url"
]
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
],
"path" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.use",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"comment" : "Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7996).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson",
"comment" : "This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5469).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.assignedPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.nullFlavor",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.realmCode",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.nullFlavor",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.displayable",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.root",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.typeId.extension",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.templateId",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.name",
"short" : "Base for all types and resources",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"comment" : "This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5470).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Person.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
]
}
],
"constraint" : [
{
"key" : "pn-no-ls",
"severity" : "error",
"human" : "No PN name part may have a qualifier of LS.",
"expression" : "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/PN"
},
{
"key" : "81-9371",
"severity" : "error",
"human" : "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"expression" : "conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
},
{
"key" : "81-9372",
"severity" : "error",
"human" : "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"expression" : "item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcDesc",
"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" : "desc"
}
],
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcDesc",
"definition" : "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcDesc",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"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" : "asPatientRelationship"
}
],
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"definition" : "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.realmCode",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PRS"
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE"
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.dataEnterer.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.representedOrganization",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.representedOrganization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.representedOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient",
"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" : "patient"
}
],
"path" : "ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.sdtcPatient",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/StructureDefinition/Base"
}
]
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient.id",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.dataEnterer.assignedEntity.sdtcPatient.id",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.sdtcPatient.id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informant",
"path" : "ClinicalDocument.informant",
"slicing" : {
"discriminator" : [
{
"type" : "exists",
"path" : "relatedEntity"
},
{
"type" : "exists",
"path" : "assignedEntity"
}
],
"rules" : "open"
},
"comment" : "MAY contain zero or more [0..*] informant (CONF:4537-31355) such that it",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.informant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
}
]
},
{
"id" : "ClinicalDocument.informant:provider",
"path" : "ClinicalDocument.informant",
"sliceName" : "provider",
"short" : "The informant element describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.",
"comment" : "MAY contain zero or more [0..*] informant (CONF:4537-8001) such that it",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.informant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.nullFlavor",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:provider.realmCode",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:provider.typeId",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:provider.typeId.nullFlavor",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:provider.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:provider.typeId.displayable",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:provider.typeId.root",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:provider.typeId.extension",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:provider.templateId",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:provider.typeCode",
"path" : "ClinicalDocument.informant.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INF",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id" : "ClinicalDocument.informant:provider.contextControlCode",
"path" : "ClinicalDocument.informant.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
}
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity",
"path" : "ClinicalDocument.informant.assignedEntity",
"comment" : "SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8002).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Informant.assignedEntity",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.nullFlavor",
"path" : "ClinicalDocument.informant.assignedEntity.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" : "ClinicalDocument.informant:provider.assignedEntity.realmCode",
"path" : "ClinicalDocument.informant.assignedEntity.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" : "ClinicalDocument.informant:provider.assignedEntity.typeId",
"path" : "ClinicalDocument.informant.assignedEntity.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" : "ClinicalDocument.informant:provider.assignedEntity.typeId.nullFlavor",
"path" : "ClinicalDocument.informant.assignedEntity.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" : "ClinicalDocument.informant:provider.assignedEntity.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.informant.assignedEntity.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" : "ClinicalDocument.informant:provider.assignedEntity.typeId.displayable",
"path" : "ClinicalDocument.informant.assignedEntity.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" : "ClinicalDocument.informant:provider.assignedEntity.typeId.root",
"path" : "ClinicalDocument.informant.assignedEntity.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" : "ClinicalDocument.informant:provider.assignedEntity.typeId.extension",
"path" : "ClinicalDocument.informant.assignedEntity.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" : "ClinicalDocument.informant:provider.assignedEntity.templateId",
"path" : "ClinicalDocument.informant.assignedEntity.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" : "ClinicalDocument.informant:provider.assignedEntity.classCode",
"path" : "ClinicalDocument.informant.assignedEntity.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.id",
"path" : "ClinicalDocument.informant.assignedEntity.id",
"short" : "If assignedEntity/id is a provider then this id, **SHOULD** include zero or one [0..1] id where id/@root =\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-9946).",
"comment" : "This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-9945).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.sdtcIdentifiedBy",
"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" : "identifiedBy"
}
],
"path" : "ClinicalDocument.informant.assignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.code",
"path" : "ClinicalDocument.informant.assignedEntity.code",
"comment" : "This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-32174).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
}
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.addr",
"path" : "ClinicalDocument.informant.assignedEntity.addr",
"short" : "Base for all types and resources",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"comment" : "This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-8220).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
]
}
],
"constraint" : [
{
"key" : "shall-city",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"expression" : "nullFlavor.exists() or item.city.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-streetAddressLine",
"severity" : "error",
"human" : "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"expression" : "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10024",
"severity" : "error",
"human" : "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10025",
"severity" : "error",
"human" : "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-max-ad-parts",
"severity" : "error",
"human" : "SHALL have at most one of each: state, city, postalCode, and country",
"expression" : "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.telecom",
"path" : "ClinicalDocument.informant.assignedEntity.telecom",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson",
"comment" : "This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-8221).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.assignedPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.nullFlavor",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.realmCode",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.nullFlavor",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.displayable",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.root",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.typeId.extension",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.templateId",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.classCode",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.determinerCode",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.name",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.name",
"short" : "Base for all types and resources",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"comment" : "This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-8222).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Person.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
]
}
],
"constraint" : [
{
"key" : "pn-no-ls",
"severity" : "error",
"human" : "No PN name part may have a qualifier of LS.",
"expression" : "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/PN"
},
{
"key" : "81-9371",
"severity" : "error",
"human" : "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"expression" : "conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
},
{
"key" : "81-9372",
"severity" : "error",
"human" : "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"expression" : "item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcDesc",
"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" : "desc"
}
],
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcDesc",
"definition" : "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcDesc",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"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" : "asPatientRelationship"
}
],
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"definition" : "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.realmCode",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PRS"
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE"
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.informant.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.representedOrganization",
"path" : "ClinicalDocument.informant.assignedEntity.representedOrganization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.representedOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.sdtcPatient",
"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" : "patient"
}
],
"path" : "ClinicalDocument.informant.assignedEntity.sdtcPatient",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.sdtcPatient",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/StructureDefinition/Base"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.assignedEntity.sdtcPatient.id",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.informant.assignedEntity.sdtcPatient.id",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.sdtcPatient.id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informant:provider.relatedEntity",
"path" : "ClinicalDocument.informant.relatedEntity",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Informant.relatedEntity",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity"
}
]
},
{
"id" : "ClinicalDocument.informant:non-provider",
"path" : "ClinicalDocument.informant",
"sliceName" : "non-provider",
"short" : "The informant element describes an information source (who is not a provider) for any content within the clinical document. This informant would be used when the source of information has a personal relationship with the patient or is the patient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.informant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
}
]
},
{
"id" : "ClinicalDocument.informant:non-provider.nullFlavor",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:non-provider.realmCode",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:non-provider.typeId",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:non-provider.typeId.nullFlavor",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:non-provider.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:non-provider.typeId.displayable",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:non-provider.typeId.root",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:non-provider.typeId.extension",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:non-provider.templateId",
"path" : "ClinicalDocument.informant.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" : "ClinicalDocument.informant:non-provider.typeCode",
"path" : "ClinicalDocument.informant.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INF",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id" : "ClinicalDocument.informant:non-provider.contextControlCode",
"path" : "ClinicalDocument.informant.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Informant.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
}
},
{
"id" : "ClinicalDocument.informant:non-provider.assignedEntity",
"path" : "ClinicalDocument.informant.assignedEntity",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Informant.assignedEntity",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
}
]
},
{
"id" : "ClinicalDocument.informant:non-provider.relatedEntity",
"path" : "ClinicalDocument.informant.relatedEntity",
"comment" : "SHALL contain exactly one [1..1] relatedEntity (CONF:1198-28682).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Informant.relatedEntity",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity"
}
]
},
{
"id" : "ClinicalDocument.informant:non-provider.relatedEntity.nullFlavor",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.realmCode",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.typeId",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.typeId.nullFlavor",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.typeId.displayable",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.typeId.root",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.typeId.extension",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.templateId",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.classCode",
"path" : "ClinicalDocument.informant.relatedEntity.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "RelatedEntity.classCode",
"min" : 1,
"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/CDARoleClassMutualRelationship"
}
},
{
"id" : "ClinicalDocument.informant:non-provider.relatedEntity.code",
"path" : "ClinicalDocument.informant.relatedEntity.code",
"comment" : "This relatedEntity MAY contain zero or one [0..1] code (CONF:1198-28683).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RelatedEntity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"constraint" : [
{
"key" : "should-us-code-attr",
"severity" : "warning",
"human" : "SHOULD contain @code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType"
}
},
{
"id" : "ClinicalDocument.informant:non-provider.relatedEntity.code.nullFlavor",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.code.code",
"path" : "ClinicalDocument.informant.relatedEntity.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.",
"comment" : "The code, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28684).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.informant:non-provider.relatedEntity.code.codeSystem",
"path" : "ClinicalDocument.informant.relatedEntity.code.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"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"
]
}
]
},
{
"id" : "ClinicalDocument.informant:non-provider.relatedEntity.code.codeSystemName",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.code.codeSystemVersion",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.code.displayName",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.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" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.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" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.code.originalText",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.code.qualifier",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.code.translation",
"path" : "ClinicalDocument.informant.relatedEntity.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" : "ClinicalDocument.informant:non-provider.relatedEntity.addr",
"path" : "ClinicalDocument.informant.relatedEntity.addr",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RelatedEntity.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD"
}
]
},
{
"id" : "ClinicalDocument.informant:non-provider.relatedEntity.telecom",
"path" : "ClinicalDocument.informant.relatedEntity.telecom",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RelatedEntity.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.informant:non-provider.relatedEntity.effectiveTime",
"path" : "ClinicalDocument.informant.relatedEntity.effectiveTime",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RelatedEntity.effectiveTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}
]
},
{
"id" : "ClinicalDocument.informant:non-provider.relatedEntity.relatedPerson",
"path" : "ClinicalDocument.informant.relatedEntity.relatedPerson",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RelatedEntity.relatedPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.custodian",
"path" : "ClinicalDocument.custodian",
"short" : "The custodian element represents the organization or person that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian. The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document (e.g., CDA could include scanned copy of original), the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. Also, the custodian may be the patient or an organization acting on behalf of the patient, such as a PHR organization.",
"comment" : "SHALL contain exactly one [1..1] custodian (CONF:1198-28685).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.custodian",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Custodian"
}
]
},
{
"id" : "ClinicalDocument.custodian.nullFlavor",
"path" : "ClinicalDocument.custodian.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" : "ClinicalDocument.custodian.realmCode",
"path" : "ClinicalDocument.custodian.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" : "ClinicalDocument.custodian.typeId",
"path" : "ClinicalDocument.custodian.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" : "ClinicalDocument.custodian.typeId.nullFlavor",
"path" : "ClinicalDocument.custodian.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" : "ClinicalDocument.custodian.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.custodian.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" : "ClinicalDocument.custodian.typeId.displayable",
"path" : "ClinicalDocument.custodian.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" : "ClinicalDocument.custodian.typeId.root",
"path" : "ClinicalDocument.custodian.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" : "ClinicalDocument.custodian.typeId.extension",
"path" : "ClinicalDocument.custodian.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" : "ClinicalDocument.custodian.templateId",
"path" : "ClinicalDocument.custodian.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" : "ClinicalDocument.custodian.typeCode",
"path" : "ClinicalDocument.custodian.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Custodian.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CST",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian",
"path" : "ClinicalDocument.custodian.assignedCustodian",
"comment" : "This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-28686).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Custodian.assignedCustodian",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AssignedCustodian"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.nullFlavor",
"path" : "ClinicalDocument.custodian.assignedCustodian.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" : "ClinicalDocument.custodian.assignedCustodian.realmCode",
"path" : "ClinicalDocument.custodian.assignedCustodian.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" : "ClinicalDocument.custodian.assignedCustodian.typeId",
"path" : "ClinicalDocument.custodian.assignedCustodian.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" : "ClinicalDocument.custodian.assignedCustodian.typeId.nullFlavor",
"path" : "ClinicalDocument.custodian.assignedCustodian.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" : "ClinicalDocument.custodian.assignedCustodian.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.custodian.assignedCustodian.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" : "ClinicalDocument.custodian.assignedCustodian.typeId.displayable",
"path" : "ClinicalDocument.custodian.assignedCustodian.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" : "ClinicalDocument.custodian.assignedCustodian.typeId.root",
"path" : "ClinicalDocument.custodian.assignedCustodian.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" : "ClinicalDocument.custodian.assignedCustodian.typeId.extension",
"path" : "ClinicalDocument.custodian.assignedCustodian.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" : "ClinicalDocument.custodian.assignedCustodian.templateId",
"path" : "ClinicalDocument.custodian.assignedCustodian.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" : "ClinicalDocument.custodian.assignedCustodian.classCode",
"path" : "ClinicalDocument.custodian.assignedCustodian.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedCustodian.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization",
"short" : "The representedCustodianOrganization may be the person when the document is not maintained by an organization.",
"comment" : "This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:1198-28687).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedCustodian.representedCustodianOrganization",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.nullFlavor",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.realmCode",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.nullFlavor",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.displayable",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.root",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.typeId.extension",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.templateId",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.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" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CustodianOrganization.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ORG",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization"
}
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CustodianOrganization.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id",
"short" : "The combined @root and @extension attributes record the custodian organization's identity in a secure, trusted, and unique way.",
"comment" : "This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:1198-28688).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "CustodianOrganization.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.nullFlavor",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.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" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.assigningAuthorityName",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.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" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.displayable",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.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" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.root",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.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.",
"comment" : "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-16822).",
"min" : 0,
"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"
]
}
],
"constraint" : [
{
"key" : "should-npi",
"severity" : "warning",
"human" : "SHOULD be NPI",
"expression" : "$this = '2.16.840.1.113883.4.6'",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.name",
"comment" : "This representedCustodianOrganization SHALL contain exactly one [1..1] name (CONF:4537-5524).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CustodianOrganization.name",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ON"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom",
"comment" : "This representedCustodianOrganization SHALL contain exactly one [1..1] telecom (CONF:4537-5525).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CustodianOrganization.telecom",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
],
"constraint" : [
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.nullFlavor",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.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" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "url",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/url"
]
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
],
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"comment" : "This telecom SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7998).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.sdtcTelecom",
"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" : "telecom"
}
],
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.sdtcTelecom",
"short" : "The stdc:telecom extension can be used to provide additional telecom elements for the custodian organization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CustodianOrganization.sdtcTelecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.addr",
"short" : "Base for all types and resources",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"comment" : "This representedCustodianOrganization SHALL contain exactly one [1..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5559).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CustodianOrganization.addr",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
]
}
],
"constraint" : [
{
"key" : "shall-city",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"expression" : "nullFlavor.exists() or item.city.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-streetAddressLine",
"severity" : "error",
"human" : "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"expression" : "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10024",
"severity" : "error",
"human" : "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10025",
"severity" : "error",
"human" : "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-max-ad-parts",
"severity" : "error",
"human" : "SHALL have at most one of each: state, city, postalCode, and country",
"expression" : "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient",
"path" : "ClinicalDocument.informationRecipient",
"short" : "The informationRecipient element records the intended recipient of the information at the time the document is created. For example, in cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to be the scoping organization for that chart.",
"comment" : "MAY contain zero or more [0..*] informationRecipient (CONF:1198-28690).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.informationRecipient",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.nullFlavor",
"path" : "ClinicalDocument.informationRecipient.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" : "ClinicalDocument.informationRecipient.realmCode",
"path" : "ClinicalDocument.informationRecipient.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" : "ClinicalDocument.informationRecipient.typeId",
"path" : "ClinicalDocument.informationRecipient.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" : "ClinicalDocument.informationRecipient.typeId.nullFlavor",
"path" : "ClinicalDocument.informationRecipient.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" : "ClinicalDocument.informationRecipient.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.informationRecipient.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" : "ClinicalDocument.informationRecipient.typeId.displayable",
"path" : "ClinicalDocument.informationRecipient.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" : "ClinicalDocument.informationRecipient.typeId.root",
"path" : "ClinicalDocument.informationRecipient.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" : "ClinicalDocument.informationRecipient.typeId.extension",
"path" : "ClinicalDocument.informationRecipient.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" : "ClinicalDocument.informationRecipient.templateId",
"path" : "ClinicalDocument.informationRecipient.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" : "ClinicalDocument.informationRecipient.typeCode",
"path" : "ClinicalDocument.informationRecipient.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "InformationRecipient.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode" : "PRCP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-xInformationRecipient|2.0.0"
}
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient",
"comment" : "The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-28691).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "InformationRecipient.intendedRecipient",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient"
}
],
"constraint" : [
{
"key" : "should-id",
"severity" : "warning",
"human" : "SHOULD contain id",
"expression" : "id.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.nullFlavor",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.realmCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.typeId",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.typeId.nullFlavor",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.typeId.displayable",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.typeId.root",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.typeId.extension",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.templateId",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.classCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "IntendedRecipient.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAInformationRecipientRole"
}
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.id",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.id",
"short" : "The combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.",
"comment" : "This intendedRecipient SHOULD contain zero or more [0..*] id (CONF:1198-28692).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "IntendedRecipient.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint" : [
{
"key" : "should-root",
"severity" : "warning",
"human" : "SHOULD contain @root",
"expression" : "root.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.id.nullFlavor",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.id.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" : "ClinicalDocument.informationRecipient.intendedRecipient.id.assigningAuthorityName",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.id.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" : "ClinicalDocument.informationRecipient.intendedRecipient.id.displayable",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.id.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" : "ClinicalDocument.informationRecipient.intendedRecipient.id.root",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.id.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"short" : "For a provider, the id/@root =\"2.16.840.1.113883.4.6\" indicates the National Provider Identifier where id/@extension is the NPI number for the provider.\n\nThe ids MAY reference the id of a person or organization entity specified elsewhere in the document.",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"comment" : "The id, if present, SHOULD contain zero or one [0..1] @root (CONF:1198-28693).",
"min" : 0,
"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"
]
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.id.extension",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy",
"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" : "identifiedBy"
}
],
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "IntendedRecipient.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.addr",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.addr",
"min" : 0,
"max" : "*",
"base" : {
"path" : "IntendedRecipient.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.telecom",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.telecom",
"min" : 0,
"max" : "*",
"base" : {
"path" : "IntendedRecipient.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient",
"comment" : "This intendedRecipient MAY contain zero or one [0..1] informationRecipient (CONF:4537-5567).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IntendedRecipient.informationRecipient",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.nullFlavor",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.realmCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.nullFlavor",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.displayable",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.root",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.typeId.extension",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.templateId",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.name",
"short" : "Base for all types and resources",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"comment" : "The informationRecipient, if present, SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5568).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Person.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
]
}
],
"constraint" : [
{
"key" : "pn-no-ls",
"severity" : "error",
"human" : "No PN name part may have a qualifier of LS.",
"expression" : "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/PN"
},
{
"key" : "81-9371",
"severity" : "error",
"human" : "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"expression" : "conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
},
{
"key" : "81-9372",
"severity" : "error",
"human" : "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"expression" : "item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcDesc",
"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" : "desc"
}
],
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcDesc",
"definition" : "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcDesc",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship",
"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" : "asPatientRelationship"
}
],
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship",
"definition" : "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.nullFlavor",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.realmCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.nullFlavor",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.displayable",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.root",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.typeId.extension",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.templateId",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.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" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.classCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PRS"
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.determinerCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE"
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.code",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.informationRecipient.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization",
"comment" : "This intendedRecipient MAY contain zero or one [0..1] receivedOrganization (CONF:4537-5577).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IntendedRecipient.receivedOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.nullFlavor",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.realmCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.nullFlavor",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.displayable",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.root",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.typeId.extension",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.templateId",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.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" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ORG",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization"
}
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.id",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.name",
"comment" : "The receivedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4537-5578).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Organization.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ON"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.telecom",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.addr",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.standardIndustryClassCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.standardIndustryClassCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS"
}
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.receivedOrganization.asOrganizationPartOf",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.asOrganizationPartOf",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator",
"path" : "ClinicalDocument.legalAuthenticator",
"short" : "In a patient authored document, the legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. (Note that per the following section, there may also be one or more document authenticators.) \n\nBased on local practice, patient authored documents may be provided without legal authentication. This implies that a patient authored document that does not contain this element has not been legally authenticated.\n\nThe act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. All patient documents have the potential for legal authentication, given the appropriate legal authority.\n\nLocal policies MAY choose to delegate the function of legal authentication to a device or system that generates the document. In these cases, the legal authenticator is the person accepting responsibility for the document, not the generating device or system.\n\nNote that the legal authenticator, if present, must be a person.",
"comment" : "MAY contain zero or one [0..1] legalAuthenticator (CONF:1198-28694).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.legalAuthenticator",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/LegalAuthenticator"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.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" : "ClinicalDocument.legalAuthenticator.realmCode",
"path" : "ClinicalDocument.legalAuthenticator.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" : "ClinicalDocument.legalAuthenticator.typeId",
"path" : "ClinicalDocument.legalAuthenticator.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" : "ClinicalDocument.legalAuthenticator.typeId.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.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" : "ClinicalDocument.legalAuthenticator.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.legalAuthenticator.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" : "ClinicalDocument.legalAuthenticator.typeId.displayable",
"path" : "ClinicalDocument.legalAuthenticator.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" : "ClinicalDocument.legalAuthenticator.typeId.root",
"path" : "ClinicalDocument.legalAuthenticator.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" : "ClinicalDocument.legalAuthenticator.typeId.extension",
"path" : "ClinicalDocument.legalAuthenticator.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" : "ClinicalDocument.legalAuthenticator.templateId",
"path" : "ClinicalDocument.legalAuthenticator.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" : "ClinicalDocument.legalAuthenticator.typeCode",
"path" : "ClinicalDocument.legalAuthenticator.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "LA",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.contextControlCode",
"path" : "ClinicalDocument.legalAuthenticator.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.time",
"path" : "ClinicalDocument.legalAuthenticator.time",
"short" : "Base for all types and resources",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"comment" : "The legalAuthenticator, if present, SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5580).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.time",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
]
}
],
"constraint" : [
{
"key" : "ts-shall-day",
"severity" : "error",
"human" : "**SHALL** be precise to at least the day",
"expression" : "nullFlavor.exists() or value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
},
{
"key" : "ts-should-minute",
"severity" : "warning",
"human" : "**SHOULD** be precise to at least the minute",
"expression" : "nullFlavor.exists() or value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode",
"comment" : "The legalAuthenticator, if present, SHALL contain exactly one [1..1] signatureCode (CONF:4537-5583).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.signatureCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"constraint" : [
{
"key" : "signature",
"severity" : "warning",
"human" : "CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.",
"expression" : "code.exists() implies code != 'X'",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.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" : "ClinicalDocument.legalAuthenticator.signatureCode.code",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.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.",
"comment" : "This signatureCode SHALL contain exactly one [1..1] @code=\"S\" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:4537-5584).",
"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" : "S"
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.codeSystem",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"max" : "0",
"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"
]
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.displayName",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.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" : "0",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.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" : "ClinicalDocument.legalAuthenticator.signatureCode.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" : "ClinicalDocument.legalAuthenticator.signatureCode.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" : "ClinicalDocument.legalAuthenticator.signatureCode.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" : "ClinicalDocument.legalAuthenticator.signatureCode.originalText",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.signatureCode.qualifier",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.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" : "ClinicalDocument.legalAuthenticator.signatureCode.translation",
"path" : "ClinicalDocument.legalAuthenticator.signatureCode.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.sdtcSignatureText",
"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" : "signatureText"
}
],
"path" : "ClinicalDocument.legalAuthenticator.sdtcSignatureText",
"short" : "The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are:\n1) Electronic signature: this attribute can represent virtually any electronic signature scheme.\n2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc.\n The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall 2013.",
"definition" : "A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.",
"comment" : "The legalAuthenticator, if present, MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30810).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.sdtcSignatureText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity",
"comment" : "The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28695).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "LegalAuthenticator.assignedEntity",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.realmCode",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.typeId",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.displayable",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.root",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.typeId.extension",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.templateId",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.classCode",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.id",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.id",
"short" : "The combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.",
"comment" : "This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28696).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.assigningAuthorityName",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.displayable",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.root",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"short" : "MAY contain '2.16.840.1.113883.4.6' (NPI)",
"definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"comment" : "Such ids MAY contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-16823).",
"min" : 0,
"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"
]
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.extension",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy",
"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" : "identifiedBy"
}
],
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.code",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.code",
"comment" : "This assignedEntity MAY contain zero or one [0..1] code (CONF:1198-28697).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.code.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.code.code",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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.",
"comment" : "The code, if present, MAY contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28698).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystem",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"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"
]
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystemName",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.code.codeSystemVersion",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.code.displayName",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.code.originalText",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.code.qualifier",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.code.translation",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.addr",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.addr",
"short" : "Base for all types and resources",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"comment" : "This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5589).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
]
}
],
"constraint" : [
{
"key" : "shall-city",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"expression" : "nullFlavor.exists() or item.city.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-streetAddressLine",
"severity" : "error",
"human" : "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"expression" : "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10024",
"severity" : "error",
"human" : "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10025",
"severity" : "error",
"human" : "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-max-ad-parts",
"severity" : "error",
"human" : "SHALL have at most one of each: state, city, postalCode, and country",
"expression" : "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.telecom",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.telecom",
"comment" : "This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5595).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
],
"constraint" : [
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "url",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/url"
]
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
],
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.use",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"comment" : "Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-7999).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson",
"comment" : "This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5597).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.assignedPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.realmCode",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.displayable",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.root",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.typeId.extension",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.templateId",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.name",
"short" : "Base for all types and resources",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"comment" : "This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5598).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Person.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
]
}
],
"constraint" : [
{
"key" : "pn-no-ls",
"severity" : "error",
"human" : "No PN name part may have a qualifier of LS.",
"expression" : "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/PN"
},
{
"key" : "81-9371",
"severity" : "error",
"human" : "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"expression" : "conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
},
{
"key" : "81-9372",
"severity" : "error",
"human" : "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"expression" : "item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcDesc",
"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" : "desc"
}
],
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcDesc",
"definition" : "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcDesc",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"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" : "asPatientRelationship"
}
],
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"definition" : "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.realmCode",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PRS"
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE"
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.representedOrganization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.representedOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient",
"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" : "patient"
}
],
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.sdtcPatient",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/StructureDefinition/Base"
}
]
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient.id",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.sdtcPatient.id",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.sdtcPatient.id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.authenticator",
"path" : "ClinicalDocument.authenticator",
"short" : "The authenticator identifies a participant or participants who attest to the accuracy of the information in the document.",
"comment" : "MAY contain zero or more [0..*] authenticator (CONF:1198-28699).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.authenticator",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Authenticator"
}
]
},
{
"id" : "ClinicalDocument.authenticator.nullFlavor",
"path" : "ClinicalDocument.authenticator.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" : "ClinicalDocument.authenticator.realmCode",
"path" : "ClinicalDocument.authenticator.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" : "ClinicalDocument.authenticator.typeId",
"path" : "ClinicalDocument.authenticator.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" : "ClinicalDocument.authenticator.typeId.nullFlavor",
"path" : "ClinicalDocument.authenticator.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" : "ClinicalDocument.authenticator.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.authenticator.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" : "ClinicalDocument.authenticator.typeId.displayable",
"path" : "ClinicalDocument.authenticator.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" : "ClinicalDocument.authenticator.typeId.root",
"path" : "ClinicalDocument.authenticator.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" : "ClinicalDocument.authenticator.typeId.extension",
"path" : "ClinicalDocument.authenticator.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" : "ClinicalDocument.authenticator.templateId",
"path" : "ClinicalDocument.authenticator.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" : "ClinicalDocument.authenticator.typeCode",
"path" : "ClinicalDocument.authenticator.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Authenticator.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "AUTHEN",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id" : "ClinicalDocument.authenticator.time",
"path" : "ClinicalDocument.authenticator.time",
"short" : "Base for all types and resources",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"comment" : "SHALL contain exactly one [1..1] US Realm Date and Time (Point in Time) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.4) (CONF:4537-5608).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Authenticator.time",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
]
}
],
"constraint" : [
{
"key" : "ts-shall-day",
"severity" : "error",
"human" : "**SHALL** be precise to at least the day",
"expression" : "nullFlavor.exists() or value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
},
{
"key" : "ts-should-minute",
"severity" : "warning",
"human" : "**SHOULD** be precise to at least the minute",
"expression" : "nullFlavor.exists() or value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTime"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.authenticator.signatureCode",
"path" : "ClinicalDocument.authenticator.signatureCode",
"comment" : "SHALL contain exactly one [1..1] signatureCode (CONF:4537-5610).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Authenticator.signatureCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"constraint" : [
{
"key" : "signature",
"severity" : "warning",
"human" : "CDA Release One represented either an intended ('X') or actual ('S') authenticator. CDA Release Two only represents an actual authenticator, so has deprecated the value of 'X'.",
"expression" : "code.exists() implies code != 'X'",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDASignatureCode"
}
},
{
"id" : "ClinicalDocument.authenticator.signatureCode.nullFlavor",
"path" : "ClinicalDocument.authenticator.signatureCode.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" : "ClinicalDocument.authenticator.signatureCode.code",
"path" : "ClinicalDocument.authenticator.signatureCode.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.",
"comment" : "This signatureCode SHALL contain exactly one [1..1] @code=\"S\" (CodeSystem: HL7ParticipationSignature urn:oid:2.16.840.1.113883.5.89 STATIC) (CONF:4537-5611).",
"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" : "S"
},
{
"id" : "ClinicalDocument.authenticator.signatureCode.codeSystem",
"path" : "ClinicalDocument.authenticator.signatureCode.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"max" : "0",
"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"
]
}
]
},
{
"id" : "ClinicalDocument.authenticator.signatureCode.codeSystemName",
"path" : "ClinicalDocument.authenticator.signatureCode.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.authenticator.signatureCode.codeSystemVersion",
"path" : "ClinicalDocument.authenticator.signatureCode.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.authenticator.signatureCode.displayName",
"path" : "ClinicalDocument.authenticator.signatureCode.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" : "0",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.authenticator.signatureCode.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" : "ClinicalDocument.authenticator.signatureCode.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" : "ClinicalDocument.authenticator.signatureCode.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" : "ClinicalDocument.authenticator.signatureCode.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" : "ClinicalDocument.authenticator.signatureCode.originalText",
"path" : "ClinicalDocument.authenticator.signatureCode.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.authenticator.signatureCode.qualifier",
"path" : "ClinicalDocument.authenticator.signatureCode.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" : "ClinicalDocument.authenticator.signatureCode.translation",
"path" : "ClinicalDocument.authenticator.signatureCode.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id" : "ClinicalDocument.authenticator.sdtcSignatureText",
"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" : "signatureText"
}
],
"path" : "ClinicalDocument.authenticator.sdtcSignatureText",
"short" : "The signature can be represented either inline or by reference according to the ED data type. Typical cases for CDA are:\n1) Electronic signature: this attribute can represent virtually any electronic signature scheme.\n2) Digital signature: this attribute can represent digital signatures by reference to a signature data block that is constructed in accordance to a digital signature standard, such as XML-DSIG, PKCS#7, PGP, etc.\n The sdtc:signatureText extension provides a location in CDA for a textual or multimedia depiction of the signature by which the participant endorses and accepts responsibility for his or her participation in the Act as specified in the Participation.typeCode. Details of what goes in the field are described in the HL7 CDA Digital Signature Standard balloted in Fall of 2013.",
"definition" : "A textual or multimedia depiction of the signature by which the participant endorses his or her participation in the Act as specified in the Participation.typeCode and that he or she agrees to assume the associated accountability.",
"comment" : "MAY contain zero or one [0..1] sdtc:signatureText (CONF:4537-30811).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Authenticator.sdtcSignatureText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity",
"path" : "ClinicalDocument.authenticator.assignedEntity",
"comment" : "The authenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28700).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Authenticator.assignedEntity",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
}
],
"constraint" : [
{
"key" : "should-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.nullFlavor",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.realmCode",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.typeId",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.typeId.nullFlavor",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.typeId.displayable",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.typeId.root",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.typeId.extension",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.templateId",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.classCode",
"path" : "ClinicalDocument.authenticator.assignedEntity.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.id",
"path" : "ClinicalDocument.authenticator.assignedEntity.id",
"short" : "The combined @root and @extension attributes to record the authenticator's identity in a secure, trusted, and unique way.",
"comment" : "This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28701).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.id.nullFlavor",
"path" : "ClinicalDocument.authenticator.assignedEntity.id.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" : "ClinicalDocument.authenticator.assignedEntity.id.assigningAuthorityName",
"path" : "ClinicalDocument.authenticator.assignedEntity.id.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" : "ClinicalDocument.authenticator.assignedEntity.id.displayable",
"path" : "ClinicalDocument.authenticator.assignedEntity.id.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" : "ClinicalDocument.authenticator.assignedEntity.id.root",
"path" : "ClinicalDocument.authenticator.assignedEntity.id.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.",
"comment" : "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-16824).",
"min" : 0,
"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"
]
}
],
"constraint" : [
{
"key" : "should-npi",
"severity" : "warning",
"human" : "SHOULD be NPI",
"expression" : "$this = '2.16.840.1.113883.4.6'",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.id.extension",
"path" : "ClinicalDocument.authenticator.assignedEntity.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.sdtcIdentifiedBy",
"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" : "identifiedBy"
}
],
"path" : "ClinicalDocument.authenticator.assignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.code",
"path" : "ClinicalDocument.authenticator.assignedEntity.code",
"comment" : "This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28702).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.code.nullFlavor",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.code.code",
"path" : "ClinicalDocument.authenticator.assignedEntity.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.",
"comment" : "The code, if present, MAY contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4537-16826).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066"
}
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.code.codeSystem",
"path" : "ClinicalDocument.authenticator.assignedEntity.code.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"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"
]
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.code.codeSystemName",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.code.codeSystemVersion",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.code.displayName",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.code.originalText",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.code.qualifier",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.code.translation",
"path" : "ClinicalDocument.authenticator.assignedEntity.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" : "ClinicalDocument.authenticator.assignedEntity.addr",
"path" : "ClinicalDocument.authenticator.assignedEntity.addr",
"short" : "Base for all types and resources",
"definition" : "Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.",
"comment" : "This assignedEntity SHALL contain at least one [1..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-5616).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
]
}
],
"constraint" : [
{
"key" : "shall-city",
"severity" : "error",
"human" : "SHALL contain exactly one [1..1] city (CONF:81-7292).",
"expression" : "nullFlavor.exists() or item.city.count() = 1",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-streetAddressLine",
"severity" : "error",
"human" : "SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).",
"expression" : "nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "should-country",
"severity" : "warning",
"human" : "SHOULD contain country",
"expression" : "nullFlavor.exists() or item.country.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-7296",
"severity" : "error",
"human" : "**SHALL NOT** have mixed content except for white space (CONF:81-7296)",
"expression" : "item.xmlText.empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10024",
"severity" : "error",
"human" : "If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "81-10025",
"severity" : "error",
"human" : "If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).",
"expression" : "nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
},
{
"key" : "shall-max-ad-parts",
"severity" : "error",
"human" : "SHALL have at most one of each: state, city, postalCode, and country",
"expression" : "(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.telecom",
"path" : "ClinicalDocument.authenticator.assignedEntity.telecom",
"comment" : "This assignedEntity SHALL contain at least one [1..*] telecom (CONF:4537-5622).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
],
"constraint" : [
{
"key" : "should-use",
"severity" : "warning",
"human" : "SHOULD contain @use",
"expression" : "nullFlavor.exists() or use.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.telecom.nullFlavor",
"path" : "ClinicalDocument.authenticator.assignedEntity.telecom.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" : "ClinicalDocument.authenticator.assignedEntity.telecom.value",
"path" : "ClinicalDocument.authenticator.assignedEntity.telecom.value",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "url",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/url"
]
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.telecom.useablePeriod",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
"valueCanonical" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
],
"path" : "ClinicalDocument.authenticator.assignedEntity.telecom.useablePeriod",
"representation" : [
"typeAttr"
],
"label" : "Useable Period",
"definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TEL.useablePeriod",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
},
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.telecom.use",
"path" : "ClinicalDocument.authenticator.assignedEntity.telecom.use",
"representation" : [
"xmlAttr"
],
"label" : "Use Code",
"definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
"comment" : "Such telecoms SHOULD contain zero or one [0..1] @use, which SHALL be selected from ValueSet Telecom Use (US Realm Header) urn:oid:2.16.840.1.113883.11.20.9.20 DYNAMIC (CONF:4537-8000).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TEL.use",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.20"
}
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson",
"comment" : "This assignedEntity SHALL contain exactly one [1..1] assignedPerson (CONF:4537-5624).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.assignedPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.nullFlavor",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.realmCode",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.nullFlavor",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.displayable",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.root",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.typeId.extension",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.templateId",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.classCode",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PSN",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"
}
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.determinerCode",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.name",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.name",
"short" : "Base for all types and resources",
"definition" : "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
"comment" : "This assignedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-5625).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Person.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PN",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
]
}
],
"constraint" : [
{
"key" : "pn-no-ls",
"severity" : "error",
"human" : "No PN name part may have a qualifier of LS.",
"expression" : "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/PN"
},
{
"key" : "81-9371",
"severity" : "error",
"human" : "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"expression" : "conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
},
{
"key" : "81-9372",
"severity" : "error",
"human" : "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"expression" : "item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcDesc",
"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" : "desc"
}
],
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcDesc",
"definition" : "The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcDesc",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"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" : "asPatientRelationship"
}
],
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship",
"definition" : "Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.sdtcAsPatientRelationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.nullFlavor",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.realmCode",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.displayable",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.root",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.typeId.extension",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.templateId",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.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" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.classCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "PRS"
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.determinerCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.determinerCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "INSTANCE"
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.authenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.sdtcAsPatientRelationship.code",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.representedOrganization",
"path" : "ClinicalDocument.authenticator.assignedEntity.representedOrganization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.representedOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.sdtcPatient",
"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" : "patient"
}
],
"path" : "ClinicalDocument.authenticator.assignedEntity.sdtcPatient",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.sdtcPatient",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/StructureDefinition/Base"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.sdtcPatient.id",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.authenticator.assignedEntity.sdtcPatient.id",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.sdtcPatient.id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.participant",
"path" : "ClinicalDocument.participant",
"short" : "The participant element identifies other supporting participants, including parents, relatives, caregivers, insurance policyholders, guarantors, and other participants related in some way to the patient. \n\nA supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin)",
"comment" : "MAY contain zero or more [0..*] participant (CONF:1198-28703).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.participant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Participant1"
}
],
"constraint" : [
{
"key" : "4537-10006",
"severity" : "error",
"human" : "**SHALL** contain associatedEntity/associatedPerson *AND/OR* associatedEntity/scopingOrganization (CONF:4537-10006).",
"expression" : "associatedEntity.associatedPerson.exists() or associatedEntity.scopingOrganization.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "4537-10007",
"severity" : "warning",
"human" : "When participant/@typeCode is *IND*, associatedEntity/@classCode **SHOULD** be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes *DYNAMIC* (CONF:4537-10007).",
"expression" : "typeCode = 'IND' implies associatedEntity.classCode.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.33')",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.participant.nullFlavor",
"path" : "ClinicalDocument.participant.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" : "ClinicalDocument.participant.realmCode",
"path" : "ClinicalDocument.participant.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" : "ClinicalDocument.participant.typeId",
"path" : "ClinicalDocument.participant.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" : "ClinicalDocument.participant.typeId.nullFlavor",
"path" : "ClinicalDocument.participant.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" : "ClinicalDocument.participant.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.participant.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" : "ClinicalDocument.participant.typeId.displayable",
"path" : "ClinicalDocument.participant.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" : "ClinicalDocument.participant.typeId.root",
"path" : "ClinicalDocument.participant.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" : "ClinicalDocument.participant.typeId.extension",
"path" : "ClinicalDocument.participant.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" : "ClinicalDocument.participant.templateId",
"path" : "ClinicalDocument.participant.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" : "ClinicalDocument.participant.typeCode",
"path" : "ClinicalDocument.participant.typeCode",
"representation" : [
"xmlAttr"
],
"short" : "Unless otherwise specified by the document specific header constraints, when participant/@typeCode is IND, associatedEntity/@classCode SHALL be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes STATIC 2011-09-30",
"comment" : "The participant, if present, SHALL contain exactly one [1..1] @typeCode (CONF:1198-28704).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Participant1.typeCode",
"min" : 1,
"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/CDAParticipationType"
}
},
{
"id" : "ClinicalDocument.participant.contextControlCode",
"path" : "ClinicalDocument.participant.contextControlCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Participant1.contextControlCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "OP",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
}
},
{
"id" : "ClinicalDocument.participant.functionCode",
"path" : "ClinicalDocument.participant.functionCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Participant1.functionCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.participant.time",
"path" : "ClinicalDocument.participant.time",
"short" : "Base for all types and resources",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"comment" : "MAY contain zero or one [0..1] time (CONF:4537-10004).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Participant1.time",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
]
}
],
"constraint" : [
{
"key" : "ivl-ts-center",
"severity" : "error",
"human" : "Center cannot co-exist with low or high",
"expression" : "center.empty() or (low.empty() and high.empty())",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"key" : "ivl-value-shall",
"severity" : "error",
"human" : "If a time interval contains @value, then it shall be precise to at least the day.",
"expression" : "value.exists() implies value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
},
{
"key" : "ivl-value-should",
"severity" : "warning",
"human" : "If a time interval contains @value, then it SHOULD contain a time component.",
"expression" : "value.exists() implies value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.participant.associatedEntity",
"path" : "ClinicalDocument.participant.associatedEntity",
"comment" : "The participant, if present, SHALL contain exactly one [1..1] associatedEntity (CONF:1198-28705).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Participant1.associatedEntity",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity"
}
],
"constraint" : [
{
"key" : "should-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.participant.associatedEntity.nullFlavor",
"path" : "ClinicalDocument.participant.associatedEntity.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" : "ClinicalDocument.participant.associatedEntity.realmCode",
"path" : "ClinicalDocument.participant.associatedEntity.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" : "ClinicalDocument.participant.associatedEntity.typeId",
"path" : "ClinicalDocument.participant.associatedEntity.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" : "ClinicalDocument.participant.associatedEntity.typeId.nullFlavor",
"path" : "ClinicalDocument.participant.associatedEntity.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" : "ClinicalDocument.participant.associatedEntity.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.participant.associatedEntity.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" : "ClinicalDocument.participant.associatedEntity.typeId.displayable",
"path" : "ClinicalDocument.participant.associatedEntity.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" : "ClinicalDocument.participant.associatedEntity.typeId.root",
"path" : "ClinicalDocument.participant.associatedEntity.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" : "ClinicalDocument.participant.associatedEntity.typeId.extension",
"path" : "ClinicalDocument.participant.associatedEntity.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" : "ClinicalDocument.participant.associatedEntity.templateId",
"path" : "ClinicalDocument.participant.associatedEntity.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" : "ClinicalDocument.participant.associatedEntity.classCode",
"path" : "ClinicalDocument.participant.associatedEntity.classCode",
"representation" : [
"xmlAttr"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssociatedEntity.classCode",
"min" : 1,
"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/CDARoleClassAssociative"
}
},
{
"id" : "ClinicalDocument.participant.associatedEntity.id",
"path" : "ClinicalDocument.participant.associatedEntity.id",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssociatedEntity.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.participant.associatedEntity.sdtcIdentifiedBy",
"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" : "identifiedBy"
}
],
"path" : "ClinicalDocument.participant.associatedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssociatedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.participant.associatedEntity.code",
"path" : "ClinicalDocument.participant.associatedEntity.code",
"comment" : "This associatedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28706).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssociatedEntity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.participant.associatedEntity.addr",
"path" : "ClinicalDocument.participant.associatedEntity.addr",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssociatedEntity.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD"
}
]
},
{
"id" : "ClinicalDocument.participant.associatedEntity.telecom",
"path" : "ClinicalDocument.participant.associatedEntity.telecom",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssociatedEntity.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.participant.associatedEntity.associatedPerson",
"path" : "ClinicalDocument.participant.associatedEntity.associatedPerson",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssociatedEntity.associatedPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.participant.associatedEntity.scopingOrganization",
"path" : "ClinicalDocument.participant.associatedEntity.scopingOrganization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssociatedEntity.scopingOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.inFulfillmentOf",
"path" : "ClinicalDocument.inFulfillmentOf",
"short" : "The inFulfillmentOf element represents orders that are fulfilled by this document such as a radiologists' report of an x-ray.",
"comment" : "MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-28707).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.inFulfillmentOf",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf"
}
]
},
{
"id" : "ClinicalDocument.inFulfillmentOf.nullFlavor",
"path" : "ClinicalDocument.inFulfillmentOf.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" : "ClinicalDocument.inFulfillmentOf.realmCode",
"path" : "ClinicalDocument.inFulfillmentOf.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" : "ClinicalDocument.inFulfillmentOf.typeId",
"path" : "ClinicalDocument.inFulfillmentOf.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" : "ClinicalDocument.inFulfillmentOf.typeId.nullFlavor",
"path" : "ClinicalDocument.inFulfillmentOf.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" : "ClinicalDocument.inFulfillmentOf.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.inFulfillmentOf.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" : "ClinicalDocument.inFulfillmentOf.typeId.displayable",
"path" : "ClinicalDocument.inFulfillmentOf.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" : "ClinicalDocument.inFulfillmentOf.typeId.root",
"path" : "ClinicalDocument.inFulfillmentOf.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" : "ClinicalDocument.inFulfillmentOf.typeId.extension",
"path" : "ClinicalDocument.inFulfillmentOf.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" : "ClinicalDocument.inFulfillmentOf.templateId",
"path" : "ClinicalDocument.inFulfillmentOf.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" : "ClinicalDocument.inFulfillmentOf.typeCode",
"path" : "ClinicalDocument.inFulfillmentOf.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "InFulfillmentOf.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "FLFS",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActRelationshipFulfills|2.0.0"
}
},
{
"id" : "ClinicalDocument.inFulfillmentOf.order",
"path" : "ClinicalDocument.inFulfillmentOf.order",
"comment" : "The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-28708).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "InFulfillmentOf.order",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Order"
}
]
},
{
"id" : "ClinicalDocument.inFulfillmentOf.order.nullFlavor",
"path" : "ClinicalDocument.inFulfillmentOf.order.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" : "ClinicalDocument.inFulfillmentOf.order.realmCode",
"path" : "ClinicalDocument.inFulfillmentOf.order.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" : "ClinicalDocument.inFulfillmentOf.order.typeId",
"path" : "ClinicalDocument.inFulfillmentOf.order.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" : "ClinicalDocument.inFulfillmentOf.order.typeId.nullFlavor",
"path" : "ClinicalDocument.inFulfillmentOf.order.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" : "ClinicalDocument.inFulfillmentOf.order.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.inFulfillmentOf.order.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" : "ClinicalDocument.inFulfillmentOf.order.typeId.displayable",
"path" : "ClinicalDocument.inFulfillmentOf.order.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" : "ClinicalDocument.inFulfillmentOf.order.typeId.root",
"path" : "ClinicalDocument.inFulfillmentOf.order.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" : "ClinicalDocument.inFulfillmentOf.order.typeId.extension",
"path" : "ClinicalDocument.inFulfillmentOf.order.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" : "ClinicalDocument.inFulfillmentOf.order.templateId",
"path" : "ClinicalDocument.inFulfillmentOf.order.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" : "ClinicalDocument.inFulfillmentOf.order.classCode",
"path" : "ClinicalDocument.inFulfillmentOf.order.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Order.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode" : "ACT",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
}
},
{
"id" : "ClinicalDocument.inFulfillmentOf.order.moodCode",
"path" : "ClinicalDocument.inFulfillmentOf.order.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Order.moodCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "RQO",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent"
}
},
{
"id" : "ClinicalDocument.inFulfillmentOf.order.id",
"path" : "ClinicalDocument.inFulfillmentOf.order.id",
"short" : "A scheduled appointment or service event in a practice management system may be represented using this id element.",
"comment" : "This order SHALL contain at least one [1..*] id (CONF:1198-28709).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Order.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.inFulfillmentOf.order.code",
"path" : "ClinicalDocument.inFulfillmentOf.order.code",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Order.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-ActCode"
}
},
{
"id" : "ClinicalDocument.inFulfillmentOf.order.priorityCode",
"path" : "ClinicalDocument.inFulfillmentOf.order.priorityCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Order.priorityCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActPriority"
}
},
{
"id" : "ClinicalDocument.documentationOf",
"path" : "ClinicalDocument.documentationOf",
"comment" : "MAY contain zero or more [0..*] documentationOf (CONF:1198-28710).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.documentationOf",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/DocumentationOf"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.nullFlavor",
"path" : "ClinicalDocument.documentationOf.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" : "ClinicalDocument.documentationOf.realmCode",
"path" : "ClinicalDocument.documentationOf.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" : "ClinicalDocument.documentationOf.typeId",
"path" : "ClinicalDocument.documentationOf.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" : "ClinicalDocument.documentationOf.typeId.nullFlavor",
"path" : "ClinicalDocument.documentationOf.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" : "ClinicalDocument.documentationOf.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.documentationOf.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" : "ClinicalDocument.documentationOf.typeId.displayable",
"path" : "ClinicalDocument.documentationOf.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" : "ClinicalDocument.documentationOf.typeId.root",
"path" : "ClinicalDocument.documentationOf.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" : "ClinicalDocument.documentationOf.typeId.extension",
"path" : "ClinicalDocument.documentationOf.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" : "ClinicalDocument.documentationOf.templateId",
"path" : "ClinicalDocument.documentationOf.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" : "ClinicalDocument.documentationOf.typeCode",
"path" : "ClinicalDocument.documentationOf.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DocumentationOf.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "DOC",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent",
"path" : "ClinicalDocument.documentationOf.serviceEvent",
"short" : "A serviceEvent represents the main act being documented, such as a colonoscopy or a cardiac stress study. In a provision of healthcare serviceEvent, the care providers, PCP, or other longitudinal providers, are recorded within the serviceEvent. If the document is about a single encounter, the providers associated can be recorded in the componentOf/encompassingEncounter template.",
"comment" : "The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-28711).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DocumentationOf.serviceEvent",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent"
}
],
"constraint" : [
{
"key" : "should-us-performer",
"severity" : "warning",
"human" : "SHOULD contain performer",
"expression" : "performer.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
},
{
"key" : "should-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
},
{
"key" : "should-performer",
"severity" : "warning",
"human" : "SHOULD contain performer",
"expression" : "performer.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.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" : "ClinicalDocument.documentationOf.serviceEvent.realmCode",
"path" : "ClinicalDocument.documentationOf.serviceEvent.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" : "ClinicalDocument.documentationOf.serviceEvent.typeId",
"path" : "ClinicalDocument.documentationOf.serviceEvent.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" : "ClinicalDocument.documentationOf.serviceEvent.typeId.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.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" : "ClinicalDocument.documentationOf.serviceEvent.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.documentationOf.serviceEvent.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" : "ClinicalDocument.documentationOf.serviceEvent.typeId.displayable",
"path" : "ClinicalDocument.documentationOf.serviceEvent.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" : "ClinicalDocument.documentationOf.serviceEvent.typeId.root",
"path" : "ClinicalDocument.documentationOf.serviceEvent.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" : "ClinicalDocument.documentationOf.serviceEvent.typeId.extension",
"path" : "ClinicalDocument.documentationOf.serviceEvent.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" : "ClinicalDocument.documentationOf.serviceEvent.templateId",
"path" : "ClinicalDocument.documentationOf.serviceEvent.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" : "ClinicalDocument.documentationOf.serviceEvent.classCode",
"path" : "ClinicalDocument.documentationOf.serviceEvent.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceEvent.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode" : "ACT",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.moodCode",
"path" : "ClinicalDocument.documentationOf.serviceEvent.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceEvent.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" : "ClinicalDocument.documentationOf.serviceEvent.id",
"path" : "ClinicalDocument.documentationOf.serviceEvent.id",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceEvent.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.code",
"path" : "ClinicalDocument.documentationOf.serviceEvent.code",
"short" : "The code should be selected from a value set established by the document-level template for a specific type of Patient Generated Document.",
"definition" : "Drawn from concept domain ActCode",
"comment" : "This serviceEvent SHOULD contain zero or one [0..1] code (CONF:1198-28712).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceEvent.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime",
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime",
"short" : "Base for all types and resources",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"comment" : "This serviceEvent SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-14837).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ServiceEvent.effectiveTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
]
}
],
"constraint" : [
{
"key" : "ivl-ts-center",
"severity" : "error",
"human" : "Center cannot co-exist with low or high",
"expression" : "center.empty() or (low.empty() and high.empty())",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"key" : "ivl-value-shall",
"severity" : "error",
"human" : "If a time interval contains @value, then it shall be precise to at least the day.",
"expression" : "value.exists() implies value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
},
{
"key" : "ivl-value-should",
"severity" : "warning",
"human" : "If a time interval contains @value, then it SHOULD contain a time component.",
"expression" : "value.exists() implies value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.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" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.value",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
"valueString" : "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules",
"valueString" : "year-valid:tz-for-time"
}
],
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.value",
"representation" : [
"xmlAttr"
],
"short" : "Either @value or low/high should be present, but not both",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TS.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/ts-simple"
]
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.operator",
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.operator",
"representation" : [
"xmlAttr"
],
"definition" : "A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SXCM_TS.operator",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode" : "I",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDASetOperator"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low",
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low",
"label" : "Low Boundary",
"short" : "**MAY** be precise to at least the second",
"definition" : "This is the low limit of the interval.",
"comment" : "This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-14838).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "IVL_TS.low",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
}
],
"constraint" : [
{
"key" : "ts-shall-day",
"severity" : "error",
"human" : "**SHALL** be precise to at least the day",
"expression" : "nullFlavor.exists() or value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
},
{
"key" : "ts-should-minute",
"severity" : "warning",
"human" : "**SHOULD** be precise to at least the minute",
"expression" : "nullFlavor.exists() or value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.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" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.value",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
"valueString" : "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules",
"valueString" : "year-valid:tz-for-time"
}
],
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.value",
"representation" : [
"xmlAttr"
],
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TS.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/ts-simple"
]
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.inclusive",
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.low.inclusive",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IVXB_TS.inclusive",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"defaultValueBoolean" : true
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.center",
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.center",
"label" : "Central Value",
"definition" : "The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IVL_TS.center",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TS"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.width",
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.width",
"label" : "Width",
"definition" : "The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IVL_TS.width",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high",
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high",
"label" : "High Boundary",
"short" : "**MAY** be precise to at least the second",
"definition" : "This is the high limit of the interval.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IVL_TS.high",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
}
],
"constraint" : [
{
"key" : "ts-shall-day",
"severity" : "error",
"human" : "**SHALL** be precise to at least the day",
"expression" : "nullFlavor.exists() or value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
},
{
"key" : "ts-should-minute",
"severity" : "warning",
"human" : "**SHOULD** be precise to at least the minute",
"expression" : "nullFlavor.exists() or value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.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" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.value",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
"valueString" : "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules",
"valueString" : "year-valid:tz-for-time"
}
],
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.value",
"representation" : [
"xmlAttr"
],
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TS.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/ts-simple"
]
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.inclusive",
"path" : "ClinicalDocument.documentationOf.serviceEvent.effectiveTime.high.inclusive",
"representation" : [
"xmlAttr"
],
"definition" : "Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IVXB_TS.inclusive",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"defaultValueBoolean" : true
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer",
"short" : "The performer participant represents clinicians who actually and principally carry out the serviceEvent. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient's key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.",
"comment" : "This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-28713).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceEvent.performer",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Performer1"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.realmCode",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.typeId",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.displayable",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.root",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.typeId.extension",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.templateId",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.typeCode",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.typeCode",
"representation" : [
"xmlAttr"
],
"comment" : "The performer, if present, SHALL contain exactly one [1..1] @typeCode, which SHALL be selected from ValueSet x_ServiceEventPerformer urn:oid:2.16.840.1.113883.1.11.19601 STATIC (CONF:4537-14840).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Performer1.typeCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.19601"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode",
"short" : "When indicating the performer was the primary care physician, implementers should indicate \"PCP\" as the functionCode",
"comment" : "The performer, if present, MAY contain zero or one [0..1] functionCode (CONF:4537-16818).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Performer1.functionCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"constraint" : [
{
"key" : "should-code-attr",
"severity" : "warning",
"human" : "SHOULD contain @code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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.",
"comment" : "The functionCode, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Care Team Member Function urn:oid:2.16.840.1.113762.1.4.1099.30 DYNAMIC (CONF:4537-32889).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.10267"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"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"
]
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemName",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.codeSystemVersion",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.displayName",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.originalText",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.qualifier",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.translation",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.time",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.time",
"short" : "Base for all types and resources",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Performer1.time",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
]
}
],
"constraint" : [
{
"key" : "ivl-ts-center",
"severity" : "error",
"human" : "Center cannot co-exist with low or high",
"expression" : "center.empty() or (low.empty() and high.empty())",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"key" : "ivl-value-shall",
"severity" : "error",
"human" : "If a time interval contains @value, then it shall be precise to at least the day.",
"expression" : "value.exists() implies value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
},
{
"key" : "ivl-value-should",
"severity" : "warning",
"human" : "If a time interval contains @value, then it SHOULD contain a time component.",
"expression" : "value.exists() implies value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity",
"comment" : "The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28715).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Performer1.assignedEntity",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
}
],
"constraint" : [
{
"key" : "should-us-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.realmCode",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.displayable",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.root",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.typeId.extension",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.templateId",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ASSIGNED",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id",
"short" : "The combined @root and @extension attributes record the performer's identity in a secure, trusted, and unique way.",
"comment" : "This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28716).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "AssignedEntity.id",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.nullFlavor",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.assigningAuthorityName",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.displayable",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.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" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.root",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.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.",
"comment" : "Such ids SHOULD contain zero or one [0..1] @root=\"2.16.840.1.113883.4.6\" National Provider Identifier (CONF:4537-14847).",
"min" : 0,
"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"
]
}
],
"constraint" : [
{
"key" : "should-npi",
"severity" : "warning",
"human" : "SHOULD be NPI",
"expression" : "$this = '2.16.840.1.113883.4.6'",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy",
"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" : "identifiedBy"
}
],
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.sdtcIdentifiedBy",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code",
"short" : "If the assignedEntity is an individual, the code SHOULD be selected from value set PersonalandLegalRelationshipRoleType value set",
"comment" : "This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28718).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.addr",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.addr",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AD"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.telecom",
"min" : 0,
"max" : "*",
"base" : {
"path" : "AssignedEntity.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.assignedPerson",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.assignedPerson",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Person"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.representedOrganization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.representedOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organization"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient",
"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" : "patient"
}
],
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient",
"min" : 0,
"max" : "1",
"base" : {
"path" : "AssignedEntity.sdtcPatient",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/fhir/StructureDefinition/Base"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient.id",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
}
],
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.sdtcPatient.id",
"min" : 1,
"max" : "1",
"base" : {
"path" : "AssignedEntity.sdtcPatient.id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.relatedDocument",
"path" : "ClinicalDocument.relatedDocument",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.relatedDocument",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/RelatedDocument"
}
]
},
{
"id" : "ClinicalDocument.authorization",
"path" : "ClinicalDocument.authorization",
"short" : "The authorization element represents information about the patient's consent. The type of consent is conveyed in consent/code. Consents in the header have been finalized (consent/statusCode must equal Completed) and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of 'Privacy Consent'. The authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the CDA document.",
"comment" : "MAY contain zero or more [0..*] authorization (CONF:4537-16792) such that it",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ClinicalDocument.authorization",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Authorization"
}
]
},
{
"id" : "ClinicalDocument.authorization.nullFlavor",
"path" : "ClinicalDocument.authorization.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" : "ClinicalDocument.authorization.realmCode",
"path" : "ClinicalDocument.authorization.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" : "ClinicalDocument.authorization.typeId",
"path" : "ClinicalDocument.authorization.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" : "ClinicalDocument.authorization.typeId.nullFlavor",
"path" : "ClinicalDocument.authorization.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" : "ClinicalDocument.authorization.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.authorization.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" : "ClinicalDocument.authorization.typeId.displayable",
"path" : "ClinicalDocument.authorization.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" : "ClinicalDocument.authorization.typeId.root",
"path" : "ClinicalDocument.authorization.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" : "ClinicalDocument.authorization.typeId.extension",
"path" : "ClinicalDocument.authorization.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" : "ClinicalDocument.authorization.templateId",
"path" : "ClinicalDocument.authorization.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" : "ClinicalDocument.authorization.typeCode",
"path" : "ClinicalDocument.authorization.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Authorization.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "AUTH",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActRelationshipAuthorizedBy"
}
},
{
"id" : "ClinicalDocument.authorization.consent",
"path" : "ClinicalDocument.authorization.consent",
"comment" : "SHALL contain exactly one [1..1] consent (CONF:4537-16793).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Authorization.consent",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Consent"
}
]
},
{
"id" : "ClinicalDocument.authorization.consent.nullFlavor",
"path" : "ClinicalDocument.authorization.consent.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" : "ClinicalDocument.authorization.consent.realmCode",
"path" : "ClinicalDocument.authorization.consent.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" : "ClinicalDocument.authorization.consent.typeId",
"path" : "ClinicalDocument.authorization.consent.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" : "ClinicalDocument.authorization.consent.typeId.nullFlavor",
"path" : "ClinicalDocument.authorization.consent.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" : "ClinicalDocument.authorization.consent.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.authorization.consent.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" : "ClinicalDocument.authorization.consent.typeId.displayable",
"path" : "ClinicalDocument.authorization.consent.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" : "ClinicalDocument.authorization.consent.typeId.root",
"path" : "ClinicalDocument.authorization.consent.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" : "ClinicalDocument.authorization.consent.typeId.extension",
"path" : "ClinicalDocument.authorization.consent.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" : "ClinicalDocument.authorization.consent.templateId",
"path" : "ClinicalDocument.authorization.consent.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" : "ClinicalDocument.authorization.consent.classCode",
"path" : "ClinicalDocument.authorization.consent.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CONS",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
}
},
{
"id" : "ClinicalDocument.authorization.consent.moodCode",
"path" : "ClinicalDocument.authorization.consent.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.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" : "ClinicalDocument.authorization.consent.id",
"path" : "ClinicalDocument.authorization.consent.id",
"comment" : "This consent MAY contain zero or more [0..*] id (CONF:4537-16794).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.authorization.consent.code",
"path" : "ClinicalDocument.authorization.consent.code",
"short" : "The type of consent (e.g., a consent to perform the related serviceEvent) is conveyed in consent/code.",
"comment" : "This consent MAY contain zero or one [0..1] code (CONF:4537-16795).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.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-ActCode"
}
},
{
"id" : "ClinicalDocument.authorization.consent.statusCode",
"path" : "ClinicalDocument.authorization.consent.statusCode",
"comment" : "This consent SHALL contain exactly one [1..1] statusCode (CONF:4537-16797).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.statusCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActStatus"
}
},
{
"id" : "ClinicalDocument.authorization.consent.statusCode.nullFlavor",
"path" : "ClinicalDocument.authorization.consent.statusCode.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" : "ClinicalDocument.authorization.consent.statusCode.code",
"path" : "ClinicalDocument.authorization.consent.statusCode.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.",
"comment" : "This statusCode SHALL contain exactly one [1..1] @code=\"completed\" Completed (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4537-16798).",
"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"
]
}
],
"fixedCode" : "completed"
},
{
"id" : "ClinicalDocument.authorization.consent.statusCode.codeSystem",
"path" : "ClinicalDocument.authorization.consent.statusCode.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"max" : "0",
"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"
]
}
]
},
{
"id" : "ClinicalDocument.authorization.consent.statusCode.codeSystemName",
"path" : "ClinicalDocument.authorization.consent.statusCode.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.authorization.consent.statusCode.codeSystemVersion",
"path" : "ClinicalDocument.authorization.consent.statusCode.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.authorization.consent.statusCode.displayName",
"path" : "ClinicalDocument.authorization.consent.statusCode.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" : "0",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "ClinicalDocument.authorization.consent.statusCode.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" : "ClinicalDocument.authorization.consent.statusCode.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" : "ClinicalDocument.authorization.consent.statusCode.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" : "ClinicalDocument.authorization.consent.statusCode.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" : "ClinicalDocument.authorization.consent.statusCode.originalText",
"path" : "ClinicalDocument.authorization.consent.statusCode.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "ClinicalDocument.authorization.consent.statusCode.qualifier",
"path" : "ClinicalDocument.authorization.consent.statusCode.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" : "ClinicalDocument.authorization.consent.statusCode.translation",
"path" : "ClinicalDocument.authorization.consent.statusCode.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id" : "ClinicalDocument.componentOf",
"path" : "ClinicalDocument.componentOf",
"short" : "The encompassing encounter represents the setting of the clinical encounter during which the document act(s) or ServiceEvent(s) occurred. In order to represent providers associated with a specific encounter, they are recorded within the encompassingEncounter as participants. In a CCD, the encompassingEncounter may be used when documenting a specific encounter and its participants. All relevant encounters in a CCD may be listed in the encounters section.",
"comment" : "MAY contain zero or one [0..1] componentOf (CONF:4537-9955).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.componentOf",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ComponentOf"
}
]
},
{
"id" : "ClinicalDocument.componentOf.nullFlavor",
"path" : "ClinicalDocument.componentOf.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" : "ClinicalDocument.componentOf.realmCode",
"path" : "ClinicalDocument.componentOf.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" : "ClinicalDocument.componentOf.typeId",
"path" : "ClinicalDocument.componentOf.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" : "ClinicalDocument.componentOf.typeId.nullFlavor",
"path" : "ClinicalDocument.componentOf.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" : "ClinicalDocument.componentOf.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.componentOf.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" : "ClinicalDocument.componentOf.typeId.displayable",
"path" : "ClinicalDocument.componentOf.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" : "ClinicalDocument.componentOf.typeId.root",
"path" : "ClinicalDocument.componentOf.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" : "ClinicalDocument.componentOf.typeId.extension",
"path" : "ClinicalDocument.componentOf.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" : "ClinicalDocument.componentOf.templateId",
"path" : "ClinicalDocument.componentOf.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" : "ClinicalDocument.componentOf.typeCode",
"path" : "ClinicalDocument.componentOf.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ComponentOf.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "COMP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter",
"path" : "ClinicalDocument.componentOf.encompassingEncounter",
"comment" : "The componentOf, if present, SHALL contain exactly one [1..1] encompassingEncounter (CONF:4537-9956).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ComponentOf.encompassingEncounter",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EncompassingEncounter"
}
],
"constraint" : [
{
"key" : "should-responsibleParty",
"severity" : "warning",
"human" : "SHOULD contain responsibleParty",
"expression" : "responsibleParty.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.nullFlavor",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.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" : "ClinicalDocument.componentOf.encompassingEncounter.realmCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.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" : "ClinicalDocument.componentOf.encompassingEncounter.typeId",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.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" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.nullFlavor",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.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" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.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" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.displayable",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.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" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.root",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.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" : "ClinicalDocument.componentOf.encompassingEncounter.typeId.extension",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.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" : "ClinicalDocument.componentOf.encompassingEncounter.templateId",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.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" : "ClinicalDocument.componentOf.encompassingEncounter.classCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "ENC",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.moodCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.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" : "ClinicalDocument.componentOf.encompassingEncounter.id",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.id",
"comment" : "This encompassingEncounter SHALL contain at least one [1..*] id (CONF:4537-9959).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "EncompassingEncounter.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.code",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.code",
"comment" : "This encompassingEncounter MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Act Encounter Codes urn:oid:2.16.840.1.113762.1.4.1240.5 (CONF:1198-30873).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1240.5"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.effectiveTime",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.effectiveTime",
"short" : "Base for all types and resources",
"definition" : "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"comment" : "This encompassingEncounter SHALL contain exactly one [1..1] US Realm Date and Time (Interval) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.3) (CONF:4537-9958).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.effectiveTime",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS",
"profile" : [
🔗 "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
]
}
],
"constraint" : [
{
"key" : "ivl-ts-center",
"severity" : "error",
"human" : "Center cannot co-exist with low or high",
"expression" : "center.empty() or (low.empty() and high.empty())",
"source" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
},
{
"key" : "ivl-value-shall",
"severity" : "error",
"human" : "If a time interval contains @value, then it shall be precise to at least the day.",
"expression" : "value.exists() implies value.toString().length() >= 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
},
{
"key" : "ivl-value-should",
"severity" : "warning",
"human" : "If a time interval contains @value, then it SHOULD contain a time component.",
"expression" : "value.exists() implies value.toString().length() > 10",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode",
"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" : "admissionReferralSourceCode"
}
],
"path" : "ClinicalDocument.componentOf.encompassingEncounter.sdtcAdmissionReferralSourceCode",
"definition" : "This element is a coded concept that represents the type of referral. Its RIM source class is PatientEncounter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.sdtcAdmissionReferralSourceCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.dischargeDispositionCode",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.dischargeDispositionCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty",
"definition" : "The responsibleParty participant represents the participant having primary legal responsibility for the encounter. This differs from the legalAuthenticator participant in that the legalAuthenticator may or may not be the responsible party, and is serving a medical records function by signing off on the document, moving it into a completed state.",
"comment" : "This encompassingEncounter SHOULD contain zero or one [0..1] responsibleParty (CONF:1198-8391).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.responsibleParty",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.nullFlavor",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.realmCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.nullFlavor",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.displayable",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.root",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeId.extension",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.templateId",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.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" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.responsibleParty.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "RESP",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.responsibleParty.assignedEntity",
"comment" : "The responsibleParty, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-32904).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.responsibleParty.assignedEntity",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity"
}
],
"constraint" : [
{
"key" : "1198-32905",
"severity" : "error",
"human" : "This assignedEntity SHALL contain an assignedPerson or a representedOrganization or both (CONF:1198-32905).",
"expression" : "assignedPerson.exists() or representedOrganization.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeader"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.encounterParticipant",
"min" : 0,
"max" : "*",
"base" : {
"path" : "EncompassingEncounter.encounterParticipant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/EncounterParticipant"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location",
"definition" : "The location participant (location class) relates a healthcare facility (HealthCareFacility class) to the encounter to indicate where the encounter took place. The entity playing the role of HealthCareFacility is a place (Place class). The entity scoping the HealthCareFacility role is an organization (Organization class).\n\nThe setting of an encounter (e.g. cardiology clinic, primary care clinic, rehabilitation hospital, skilled nursing facility) can be expressed in HealthCareFacility.code. Note that setting and physical location are not the same. There is a many-to-many relationship between setting and the physical location where care is delivered. Thus, a particular room can provide the location for cardiology clinic one day, and for primary care clinic another day; and cardiology clinic today might be held in one physical location, but in another physical location tomorrow.\n\nWhen the location is an organization, this is indicated by the presence of a scoping Organization, without a playing Place.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.location",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.nullFlavor",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.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" : "ClinicalDocument.componentOf.encompassingEncounter.location.realmCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.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" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.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" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.nullFlavor",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.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" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.assigningAuthorityName",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.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" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.displayable",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.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" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.root",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.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" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeId.extension",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.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" : "ClinicalDocument.componentOf.encompassingEncounter.location.templateId",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.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" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeCode",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.location.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "LOC",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ParticipationTargetLocation"
}
},
{
"id" : "ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility",
"path" : "ClinicalDocument.componentOf.encompassingEncounter.location.healthCareFacility",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EncompassingEncounter.location.healthCareFacility",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/HealthCareFacility"
}
]
},
{
"id" : "ClinicalDocument.component",
"path" : "ClinicalDocument.component",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ClinicalDocument.component",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/Component"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "ClinicalDocument",
"path" : "ClinicalDocument"
},
{
"id" : "ClinicalDocument.templateId",
"path" : "ClinicalDocument.templateId",
"min" : 2
},
{
"id" : "ClinicalDocument.templateId:us-patient-gen-doc",
"path" : "ClinicalDocument.templateId",
"sliceName" : "us-patient-gen-doc",
"min" : 1,
"max" : "1"
},
{
"id" : "ClinicalDocument.templateId:us-patient-gen-doc.root",
"path" : "ClinicalDocument.templateId.root",
"min" : 1,
"patternString" : "2.16.840.1.113883.10.20.29.1"
},
{
"id" : "ClinicalDocument.templateId:us-patient-gen-doc.extension",
"path" : "ClinicalDocument.templateId.extension",
"min" : 1,
"patternString" : "2024-05-01"
},
{
"id" : "ClinicalDocument.recordTarget",
"path" : "ClinicalDocument.recordTarget",
"short" : "The recordTarget records the patient whose health information is described by the clinical document; each recordTarget must contain at least one patientRole element. \n\nIf the document receiver is interested in setting up a translator for the encounter with the patient, the receiver of the document will have to infer the need for a translator, based upon the language skills identified for the patient, the patient's language of preference and the predominant language used by the organization receiving the CDA.\n\nHL7 Vocabulary simply describes guardian as a relationship to a ward. This need not be a formal legal relationship. When a guardian relationship exists for the patient, it can be represented, regardless of who is present at the time the document is generated. This need not be a formal legal relationship. A child's parent can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of \"mother\" for the child's mom or \"father\" for the child's dad. An elderly person's child can be represented in the guardian role. In this case, the guardian/code element would encode the personal relationship of \"daughter\" or \"son\", or if a legal relationship existed, the relationship of \"legal guardian\" could be encoded.",
"comment" : "SHALL contain exactly one [1..1] recordTarget (CONF:1198-28460).",
"max" : "1"
},
{
"id" : "ClinicalDocument.recordTarget.patientRole",
"path" : "ClinicalDocument.recordTarget.patientRole",
"comment" : "This recordTarget SHALL contain exactly one [1..1] patientRole (CONF:1198-28461)."
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.id",
"path" : "ClinicalDocument.recordTarget.patientRole.id",
"comment" : "This patientRole SHALL contain at least one [1..*] id (CONF:1198-28462)."
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient",
"path" : "ClinicalDocument.recordTarget.patientRole.patient",
"comment" : "This patientRole SHALL contain exactly one [1..1] patient (CONF:1198-28465).",
"constraint" : [
{
"key" : "should-languageCommunication",
"severity" : "warning",
"human" : "SHOULD contain languageCommunication",
"expression" : "languageCommunication.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian",
"comment" : "This patient MAY contain zero or more [0..*] guardian (CONF:1198-28469).",
"constraint" : [
{
"key" : "should-id",
"severity" : "warning",
"human" : "SHOULD contain id",
"expression" : "id.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
},
{
"key" : "should-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.id",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.id",
"comment" : "The guardian, if present, SHOULD contain zero or more [0..*] id (CONF:1198-28470)."
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.code",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.guardian.code",
"comment" : "The guardian, if present, SHOULD contain zero or one [0..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28473)."
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication",
"comment" : "This patient SHOULD contain zero or more [0..*] languageCommunication which SHALL be selected from ValueSet AllLanguages https://www.hl7.org/fhir/valueset-all-languages.html (OID 2.16.840.1.113883.4.642.3.21) DYNAMIC (CONF:XXX)."
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.languageCode",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd",
"path" : "ClinicalDocument.recordTarget.patientRole.patient.languageCommunication.preferenceInd",
"short" : "Indicates a preference for information about care delivery and treatments be communicated (or translated if needed) into this language.\n\nIf more than one languageCommunication is present, only one languageCommunication element SHALL have a preferenceInd with a value of 1.",
"comment" : "The languageCommunication, if present, MAY contain zero or one [0..1] preferenceInd (CONF:1198-28475)."
},
{
"id" : "ClinicalDocument.recordTarget.patientRole.providerOrganization",
"path" : "ClinicalDocument.recordTarget.patientRole.providerOrganization",
"label" : "If present, this organization represents the provider organization where the person is claiming to be a patient.",
"short" : "If present, this organization represents the provider organization where the person is claiming to be a patient.",
"comment" : "This patientRole MAY contain zero or one [0..1] providerOrganization (CONF:1198-28476)."
},
{
"id" : "ClinicalDocument.author",
"path" : "ClinicalDocument.author",
"short" : "The author element represents the creator of the clinical document. The author may be a device, or a person. The person is the patient or the patient's advocate.",
"comment" : "SHALL contain at least one [1..*] author (CONF:1198-28477)."
},
{
"id" : "ClinicalDocument.author.assignedAuthor",
"path" : "ClinicalDocument.author.assignedAuthor",
"comment" : "Such authors SHALL contain exactly one [1..1] assignedAuthor (CONF:1198-28478).",
"constraint" : [
{
"key" : "should-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.author.assignedAuthor.id",
"path" : "ClinicalDocument.author.assignedAuthor.id",
"comment" : "This assignedAuthor SHALL contain at least one [1..*] id (CONF:1198-28479)."
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code",
"path" : "ClinicalDocument.author.assignedAuthor.code",
"short" : "When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient.",
"comment" : "This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:1198-28481)."
},
{
"id" : "ClinicalDocument.author.assignedAuthor.code.code",
"path" : "ClinicalDocument.author.assignedAuthor.code.code",
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.dataEnterer",
"path" : "ClinicalDocument.dataEnterer",
"short" : "The dataEnterer element represents the person who transferred the content, written or dictated by someone else, into the clinical document. The guiding rule of thumb is that an author provides the content found within the header or body of the document, subject to their own interpretation, and the dataEnterer adds that information to the electronic system. In other words, a dataEnterer transfers information from one source to another (e.g., transcription from paper form to electronic system). If the dataEnterer is missing, this role is assumed to be played by the author.",
"comment" : "MAY contain zero or one [0..1] dataEnterer (CONF:1198-28678)."
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity",
"path" : "ClinicalDocument.dataEnterer.assignedEntity",
"comment" : "The dataEnterer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28679)."
},
{
"id" : "ClinicalDocument.dataEnterer.assignedEntity.code",
"path" : "ClinicalDocument.dataEnterer.assignedEntity.code",
"comment" : "This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28680).",
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.informant:non-provider",
"path" : "ClinicalDocument.informant",
"sliceName" : "non-provider"
},
{
"id" : "ClinicalDocument.informant:non-provider.relatedEntity",
"path" : "ClinicalDocument.informant.relatedEntity",
"comment" : "SHALL contain exactly one [1..1] relatedEntity (CONF:1198-28682)."
},
{
"id" : "ClinicalDocument.informant:non-provider.relatedEntity.code",
"path" : "ClinicalDocument.informant.relatedEntity.code",
"comment" : "This relatedEntity MAY contain zero or one [0..1] code (CONF:1198-28683).",
"constraint" : [
{
"key" : "should-us-code-attr",
"severity" : "warning",
"human" : "SHOULD contain @code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.informant:non-provider.relatedEntity.code.code",
"path" : "ClinicalDocument.informant.relatedEntity.code.code",
"comment" : "The code, if present, SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28684).",
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.custodian",
"path" : "ClinicalDocument.custodian",
"short" : "The custodian element represents the organization or person that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian. The custodian participation satisfies the CDA definition of Stewardship. Because CDA is an exchange standard and may not represent the original form of the authenticated document (e.g., CDA could include scanned copy of original), the custodian represents the steward of the original source document. The custodian may be the document originator, a health information exchange, or other responsible party. Also, the custodian may be the patient or an organization acting on behalf of the patient, such as a PHR organization.",
"comment" : "SHALL contain exactly one [1..1] custodian (CONF:1198-28685)."
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian",
"path" : "ClinicalDocument.custodian.assignedCustodian",
"comment" : "This custodian SHALL contain exactly one [1..1] assignedCustodian (CONF:1198-28686)."
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization",
"short" : "The representedCustodianOrganization may be the person when the document is not maintained by an organization.",
"comment" : "This assignedCustodian SHALL contain exactly one [1..1] representedCustodianOrganization (CONF:1198-28687)."
},
{
"id" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id",
"path" : "ClinicalDocument.custodian.assignedCustodian.representedCustodianOrganization.id",
"short" : "The combined @root and @extension attributes record the custodian organization's identity in a secure, trusted, and unique way.",
"comment" : "This representedCustodianOrganization SHALL contain at least one [1..*] id (CONF:1198-28688)."
},
{
"id" : "ClinicalDocument.informationRecipient",
"path" : "ClinicalDocument.informationRecipient",
"short" : "The informationRecipient element records the intended recipient of the information at the time the document is created. For example, in cases where the intended recipient of the document is the patient's health chart, set the receivedOrganization to be the scoping organization for that chart.",
"comment" : "MAY contain zero or more [0..*] informationRecipient (CONF:1198-28690)."
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient",
"comment" : "The informationRecipient, if present, SHALL contain exactly one [1..1] intendedRecipient (CONF:1198-28691).",
"constraint" : [
{
"key" : "should-id",
"severity" : "warning",
"human" : "SHOULD contain id",
"expression" : "id.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.id",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.id",
"short" : "The combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.",
"comment" : "This intendedRecipient SHOULD contain zero or more [0..*] id (CONF:1198-28692).",
"constraint" : [
{
"key" : "should-root",
"severity" : "warning",
"human" : "SHOULD contain @root",
"expression" : "root.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.informationRecipient.intendedRecipient.id.root",
"path" : "ClinicalDocument.informationRecipient.intendedRecipient.id.root",
"short" : "For a provider, the id/@root =\"2.16.840.1.113883.4.6\" indicates the National Provider Identifier where id/@extension is the NPI number for the provider.\n\nThe ids MAY reference the id of a person or organization entity specified elsewhere in the document.",
"comment" : "The id, if present, SHOULD contain zero or one [0..1] @root (CONF:1198-28693)."
},
{
"id" : "ClinicalDocument.legalAuthenticator",
"path" : "ClinicalDocument.legalAuthenticator",
"short" : "In a patient authored document, the legalAuthenticator identifies the single person legally responsible for the document and must be present if the document has been legally authenticated. (Note that per the following section, there may also be one or more document authenticators.) \n\nBased on local practice, patient authored documents may be provided without legal authentication. This implies that a patient authored document that does not contain this element has not been legally authenticated.\n\nThe act of legal authentication requires a certain privilege be granted to the legal authenticator depending upon local policy. All patient documents have the potential for legal authentication, given the appropriate legal authority.\n\nLocal policies MAY choose to delegate the function of legal authentication to a device or system that generates the document. In these cases, the legal authenticator is the person accepting responsibility for the document, not the generating device or system.\n\nNote that the legal authenticator, if present, must be a person.",
"comment" : "MAY contain zero or one [0..1] legalAuthenticator (CONF:1198-28694)."
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity",
"comment" : "The legalAuthenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28695)."
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.id",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.id",
"short" : "The combined @root and @extension attributes to record the information recipient's identity in a secure, trusted, and unique way.",
"comment" : "This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28696)."
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.code",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.code",
"comment" : "This assignedEntity MAY contain zero or one [0..1] code (CONF:1198-28697)."
},
{
"id" : "ClinicalDocument.legalAuthenticator.assignedEntity.code.code",
"path" : "ClinicalDocument.legalAuthenticator.assignedEntity.code.code",
"comment" : "The code, if present, MAY contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28698).",
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.authenticator",
"path" : "ClinicalDocument.authenticator",
"comment" : "MAY contain zero or more [0..*] authenticator (CONF:1198-28699)."
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity",
"path" : "ClinicalDocument.authenticator.assignedEntity",
"comment" : "The authenticator, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28700).",
"constraint" : [
{
"key" : "should-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.id",
"path" : "ClinicalDocument.authenticator.assignedEntity.id",
"short" : "The combined @root and @extension attributes to record the authenticator's identity in a secure, trusted, and unique way.",
"comment" : "This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28701)."
},
{
"id" : "ClinicalDocument.authenticator.assignedEntity.code",
"path" : "ClinicalDocument.authenticator.assignedEntity.code",
"comment" : "This assignedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28702).",
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.participant",
"path" : "ClinicalDocument.participant",
"short" : "The participant element identifies other supporting participants, including parents, relatives, caregivers, insurance policyholders, guarantors, and other participants related in some way to the patient. \n\nA supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin)",
"comment" : "MAY contain zero or more [0..*] participant (CONF:1198-28703)."
},
{
"id" : "ClinicalDocument.participant.typeCode",
"path" : "ClinicalDocument.participant.typeCode",
"short" : "Unless otherwise specified by the document specific header constraints, when participant/@typeCode is IND, associatedEntity/@classCode SHALL be selected from ValueSet 2.16.840.1.113883.11.20.9.33 INDRoleclassCodes STATIC 2011-09-30",
"comment" : "The participant, if present, SHALL contain exactly one [1..1] @typeCode (CONF:1198-28704)."
},
{
"id" : "ClinicalDocument.participant.associatedEntity",
"path" : "ClinicalDocument.participant.associatedEntity",
"comment" : "The participant, if present, SHALL contain exactly one [1..1] associatedEntity (CONF:1198-28705).",
"constraint" : [
{
"key" : "should-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.participant.associatedEntity.code",
"path" : "ClinicalDocument.participant.associatedEntity.code",
"comment" : "This associatedEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28706).",
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
},
{
"id" : "ClinicalDocument.inFulfillmentOf",
"path" : "ClinicalDocument.inFulfillmentOf",
"comment" : "MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-28707)."
},
{
"id" : "ClinicalDocument.inFulfillmentOf.order",
"path" : "ClinicalDocument.inFulfillmentOf.order",
"comment" : "The inFulfillmentOf, if present, SHALL contain exactly one [1..1] order (CONF:1198-28708)."
},
{
"id" : "ClinicalDocument.inFulfillmentOf.order.id",
"path" : "ClinicalDocument.inFulfillmentOf.order.id",
"short" : "A scheduled appointment or service event in a practice management system may be represented using this id element.",
"comment" : "This order SHALL contain at least one [1..*] id (CONF:1198-28709)."
},
{
"id" : "ClinicalDocument.documentationOf",
"path" : "ClinicalDocument.documentationOf",
"comment" : "MAY contain zero or more [0..*] documentationOf (CONF:1198-28710)."
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent",
"path" : "ClinicalDocument.documentationOf.serviceEvent",
"comment" : "The documentationOf, if present, SHALL contain exactly one [1..1] serviceEvent (CONF:1198-28711).",
"constraint" : [
{
"key" : "should-code",
"severity" : "warning",
"human" : "SHOULD contain code",
"expression" : "code.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
},
{
"key" : "should-performer",
"severity" : "warning",
"human" : "SHOULD contain performer",
"expression" : "performer.exists()",
"source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmHeaderforPatientGeneratedDocument"
}
]
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.code",
"path" : "ClinicalDocument.documentationOf.serviceEvent.code",
"short" : "The code should be selected from a value set established by the document-level template for a specific type of Patient Generated Document.",
"comment" : "This serviceEvent SHOULD contain zero or one [0..1] code (CONF:1198-28712)."
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer",
"comment" : "This serviceEvent SHOULD contain zero or more [0..*] performer (CONF:1198-28713)."
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode",
"short" : "When indicating the performer was the primary care physician, implementers should indicate \"PCP\" as the functionCode"
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.functionCode.code",
"binding" : {
"strength" : "required",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.10267"
}
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity",
"comment" : "The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-28715)."
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.id",
"short" : "The combined @root and @extension attributes record the performer's identity in a secure, trusted, and unique way.",
"comment" : "This assignedEntity SHALL contain at least one [1..*] id (CONF:1198-28716)."
},
{
"id" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code",
"path" : "ClinicalDocument.documentationOf.serviceEvent.performer.assignedEntity.code",
"short" : "If the assignedEntity is an individual, the code SHOULD be selected from value set PersonalandLegalRelationshipRoleType value set",
"comment" : "This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28718).",
"binding" : {
"strength" : "preferred",
"valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.12.1"
}
}
]
}
}
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