Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
| Draft as of 2023-09-29 |
XML representation of the USRealmDateandTimeDTUSFIELDED logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="USRealmDateandTimeDTUSFIELDED"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmDateandTimeDTUSFIELDED-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 (81-10078, 81-10079, 81-10080, 81-10081)">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="https://build.fhir.org/ig/HL7/CDA-core-2.0//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="https://build.fhir.org/ig/HL7/CDA-core-2.0//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="https://build.fhir.org/ig/HL7/CDA-core-2.0//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="https://build.fhir.org/ig/HL7/CDA-core-2.0//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="https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-IVL-TS.html" title="This is the low limit of the interval.">low</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-2.0//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="https://build.fhir.org/ig/HL7/CDA-core-2.0//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="https://build.fhir.org/ig/HL7/CDA-core-2.0//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">81-10078: </span>**SHALL** be precise to the day (CONF:81-10078).<br/><span style="font-weight:bold">81-10079: </span>**SHOULD** be precise to the minute (CONF:81-10079).<br/><span style="font-weight:bold">81-10080: </span>**MAY** be precise to the second (CONF:81-10080).<br/><span style="font-weight:bold">81-10081: </span>If more precise than day, **SHOULD** include time-zone offset (CONF:81-10081).</td></tr>
<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>
</text>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/logical-target">
<valueBoolean>
<extension
url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
<valueCode value="not-applicable"/>
</extension>
</valueBoolean>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:v3"/>
</extension>
<url
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTUSFIELDED"/>
<identifier>
<value value="urn:oid:2.16.840.1.113883.10.20.22.5.3"/>
</identifier>
<version value="2.1"/>
<name value="USRealmDateandTimeDTUSFIELDED"/>
<title value="US Realm Date and Time (DT.US.FIELDED)"/>
<status value="draft"/>
<date value="2023-09-29T16:20:44+00:00"/>
<publisher value="Health Level Seven"/>
<contact>
<name value="HL7 International - Structured Documents"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/structure"/>
</telecom>
</contact>
<description
value="The US Realm Clinical Document Date and Time datatype flavor records date and time information. If no time zone offset is provided, you can make no assumption about time, unless you have made a local exchange agreement.
This data type uses the same rules as US Realm Date and Time (DTM.US.FIELDED), but is used with elements having a datatype of IVL_TS."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<fhirVersion value="5.0.0"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type value="http://hl7.org/cda/stds/core/StructureDefinition/IVL_TS"/>
<baseDefinition
value="http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"/>
<derivation value="constraint"/>
<snapshot>
<element id="IVL_TS">
<path value="IVL_TS"/>
<short value="Base for all types and resources"/>
<definition
value="A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression."/>
<min value="1"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ivl-ts-center"/>
<severity value="error"/>
<human value="Center cannot co-exist with low or high"/>
<expression value="center.empty() or (low.empty() and high.empty())"/>
<source
value="http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"/>
</constraint>
<constraint>
<key value="81-10078"/>
<severity value="error"/>
<human value="**SHALL** be precise to the day (CONF:81-10078)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTUSFIELDED"/>
</constraint>
<constraint>
<key value="81-10079"/>
<severity value="warning"/>
<human value="**SHOULD** be precise to the minute (CONF:81-10079)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTUSFIELDED"/>
</constraint>
<constraint>
<key value="81-10080"/>
<severity value="warning"/>
<human value="**MAY** be precise to the second (CONF:81-10080)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTUSFIELDED"/>
</constraint>
<constraint>
<key value="81-10081"/>
<severity value="warning"/>
<human
value="If more precise than day, **SHOULD** include time-zone offset (CONF:81-10081)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTUSFIELDED"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="IVL_TS.nullFlavor">
<path value="IVL_TS.nullFlavor"/>
<representation value="xmlAttr"/>
<label value="Exceptional Value Detail"/>
<definition
value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ANY.nullFlavor"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-NullFlavor"/>
</binding>
</element>
<element id="IVL_TS.value">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format">
<valueString value="YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"/>
</extension>
<path value="IVL_TS.value"/>
<representation value="xmlAttr"/>
<definition
value="A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="TS.value"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/ts-simple"/>
</type>
</element>
<element id="IVL_TS.operator">
<path value="IVL_TS.operator"/>
<representation value="xmlAttr"/>
<definition
value="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 value="0"/>
<max value="1"/>
<base>
<path value="SXCM_TS.operator"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<defaultValueCode value="I"/>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-SetOperator"/>
</binding>
</element>
<element id="IVL_TS.low">
<path value="IVL_TS.low"/>
<label value="Low Boundary"/>
<definition value="This is the low limit of the interval."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="IVL_TS.low"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"/>
</type>
</element>
<element id="IVL_TS.center">
<path value="IVL_TS.center"/>
<label value="Central Value"/>
<definition
value="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 value="0"/>
<max value="1"/>
<base>
<path value="IVL_TS.center"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/TS"/>
</type>
</element>
<element id="IVL_TS.width">
<path value="IVL_TS.width"/>
<label value="Width"/>
<definition
value="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 value="0"/>
<max value="1"/>
<base>
<path value="IVL_TS.width"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/PQ"/>
</type>
</element>
<element id="IVL_TS.high">
<path value="IVL_TS.high"/>
<label value="High Boundary"/>
<definition value="This is the high limit of the interval."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="IVL_TS.high"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"/>
</type>
</element>
</snapshot>
<differential>
<element id="IVL_TS">
<path value="IVL_TS"/>
<constraint>
<key value="81-10078"/>
<severity value="error"/>
<human value="**SHALL** be precise to the day (CONF:81-10078)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTUSFIELDED"/>
</constraint>
<constraint>
<key value="81-10079"/>
<severity value="warning"/>
<human value="**SHOULD** be precise to the minute (CONF:81-10079)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTUSFIELDED"/>
</constraint>
<constraint>
<key value="81-10080"/>
<severity value="warning"/>
<human value="**MAY** be precise to the second (CONF:81-10080)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTUSFIELDED"/>
</constraint>
<constraint>
<key value="81-10081"/>
<severity value="warning"/>
<human
value="If more precise than day, **SHOULD** include time-zone offset (CONF:81-10081)."/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTUSFIELDED"/>
</constraint>
</element>
</differential>
</StructureDefinition>
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change