Consolidated CDA
3.0.0-ballot - ballot
Consolidated CDA
3.0.0-ballot - ballot
This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
| Draft as of 2023-12-21 |
JSON representation of the USRealmDateTimeInterval logical model.
{
"resourceType" : "StructureDefinition",
"id" : "USRealmDateTimeInterval",
"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-USRealmDateTimeInterval-definitions.html#IVL_TS\">IVL_TS</a><a name=\"IVL_TS\"> </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 (ivl-value-shall, ivl-value-should)\">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\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/cda/stds/core/2.0.0-sd-snapshot1/StructureDefinition-IVL-TS.html\">IVL_TS</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-snapshot1/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-snapshot1/StructureDefinition-TS.html\" title=\"A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.\">@value</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd-snapshot1/StructureDefinition-SXCM-TS.html\" title=\"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.\">@operator</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd-snapshot1/StructureDefinition-IVL-TS.html\" title=\"This is the low limit of the interval.\">low</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd-snapshot1/StructureDefinition-IVL-TS.html\" title=\"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.\">center</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd-snapshot1/StructureDefinition-IVL-TS.html\" title=\"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.\">width</a>, <a href=\"http://hl7.org/cda/stds/core/2.0.0-sd-snapshot1/StructureDefinition-IVL-TS.html\" title=\"This is the high limit of the interval.\">high</a><br/><span style=\"opacity: 0.5\">Base for all types and resources</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-snapshot1/StructureDefinition-ClinicalDocument.html\">ClinicalDocument (CDA Class)</a><br/><span style=\"font-weight:bold\">ivl-value-shall: </span>If a time interval contains @value, then it shall be precise to at least the day.<br/><span style=\"font-weight:bold\">ivl-value-should: </span>If a time interval contains @value, then it SHOULD contain a time component.</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-USRealmDateTimeInterval-definitions.html#IVL_TS.value\">@value</a><a name=\"IVL_TS.value\"> </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-snapshot1/StructureDefinition-ts-simple.html\" title=\"dateTime\">ts</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Either @value or low/high should be present, but not both<br/>Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]</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-USRealmDateTimeInterval-definitions.html#IVL_TS.low\">low</a><a name=\"IVL_TS.low\"> </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 (ts-shall-day, ts-should-minute)\">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-snapshot1/StructureDefinition-IVXB-TS.html\">IVXB_TS</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">**MAY** be precise to at least the second<br/><span style=\"font-weight:bold\">ts-shall-day: </span>**SHALL** be precise to at least the day<br/><span style=\"font-weight:bold\">ts-should-minute: </span>**SHOULD** be precise to at least the minute</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_bck100.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmDateTimeInterval-definitions.html#IVL_TS.low.value\">@value</a><a name=\"IVL_TS.low.value\"> </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-snapshot1/StructureDefinition-ts-simple.html\" title=\"dateTime\">ts</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]</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-USRealmDateTimeInterval-definitions.html#IVL_TS.high\">high</a><a name=\"IVL_TS.high\"> </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 (ts-shall-day, ts-should-minute)\">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-snapshot1/StructureDefinition-IVXB-TS.html\">IVXB_TS</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">**MAY** be precise to at least the second<br/><span style=\"font-weight:bold\">ts-shall-day: </span>**SHALL** be precise to at least the day<br/><span style=\"font-weight:bold\">ts-should-minute: </span>**SHOULD** be precise to at least the minute</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_bck000.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-USRealmDateTimeInterval-definitions.html#IVL_TS.high.value\">@value</a><a name=\"IVL_TS.high.value\"> </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-snapshot1/StructureDefinition-ts-simple.html\" title=\"dateTime\">ts</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]</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/logical-container",
"valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
}
],
"url" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval",
"identifier" : [
{
"value" : "urn:oid:2.16.840.1.113883.10.20.22.5.3"
}
],
"version" : "3.0.0-ballot",
"name" : "USRealmDateTimeInterval",
"title" : "US Realm Date and Time - Interval",
"status" : "draft",
"date" : "2023-12-21T01:13:10+10:00",
"publisher" : "Health Level Seven",
"contact" : [
{
"name" : "HL7 International - Structured Documents",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"description" : "The US Realm Clinical Document Date and Time datatype flavor records date and time information. If time is provided, it must include a time zone offset.\n\nThis data type uses the same rules as US Realm Date and Time (Point in Time), but is used with elements having a datatype of IVL_TS.",
"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/IVL_TS",
"baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "IVL_TS",
"path" : "IVL_TS",
"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" : 1,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"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" : "IVL_TS.nullFlavor",
"path" : "IVL_TS.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" : "IVL_TS.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" : "IVL_TS.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" : "IVL_TS.operator",
"path" : "IVL_TS.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://terminology.hl7.org/ValueSet/v3-SetOperator"
}
},
{
"id" : "IVL_TS.low",
"path" : "IVL_TS.low",
"label" : "Low Boundary",
"short" : "**MAY** be precise to at least the second",
"definition" : "This is the low limit of the interval.",
"min" : 0,
"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" : "IVL_TS.low.nullFlavor",
"path" : "IVL_TS.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" : "IVL_TS.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" : "IVL_TS.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" : "IVL_TS.low.inclusive",
"path" : "IVL_TS.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" : "IVL_TS.center",
"path" : "IVL_TS.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" : "IVL_TS.width",
"path" : "IVL_TS.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" : "IVL_TS.high",
"path" : "IVL_TS.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" : "IVL_TS.high.nullFlavor",
"path" : "IVL_TS.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" : "IVL_TS.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" : "IVL_TS.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" : "IVL_TS.high.inclusive",
"path" : "IVL_TS.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
}
]
},
"differential" : {
"element" : [
{
"id" : "IVL_TS",
"path" : "IVL_TS",
"constraint" : [
{
"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"
}
]
},
{
"id" : "IVL_TS.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" : "IVL_TS.value",
"short" : "Either @value or low/high should be present, but not both"
},
{
"id" : "IVL_TS.low",
"path" : "IVL_TS.low",
"short" : "**MAY** be precise to at least the second",
"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" : "IVL_TS.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" : "IVL_TS.low.value"
},
{
"id" : "IVL_TS.high",
"path" : "IVL_TS.high",
"short" : "**MAY** be precise to at least the second",
"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" : "IVL_TS.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" : "IVL_TS.high.value"
}
]
}
}
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change