Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) generated with FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: USRealmDateandTimeDTMUSFIELDED - XML Profile

Active as of 2023-01-16

XML representation of the 2.16.840.1.113883.10.20.22.5.4 resource profile.

Raw xml | Download



<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="2.16.840.1.113883.10.20.22.5.4"/>
  <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 &amp; 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="http://build.fhir.org/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-2.16.840.1.113883.10.20.22.5.4-definitions.html#TS">TS</a><a name="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/5.0.0-snapshot3/conformance-rules.html#constraints" title="This element has or is affected by constraints (81-10127, 81-10128, 81-10129, 81-10130)">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/draft1/StructureDefinition-TS.html">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="opacity: 0.5">Base for all types and resources</span><br/><span style="font-weight:bold">81-10127: </span>**SHALL** be precise to the day (CONF:81-10127).<br/><span style="font-weight:bold">81-10128: </span>**SHOULD** be precise to the minute (CONF:81-10128).<br/><span style="font-weight:bold">81-10129: </span>**MAY** be precise to the second (CONF:81-10129).<br/><span style="font-weight:bold">81-10130: </span>If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130).</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="http://build.fhir.org/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
  </text>
  <url
       value="http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.4"/>
  <identifier>
    <value value="urn:oid:2.16.840.1.113883.10.20.22.5.4"/>
  </identifier>
  <version value="2.1.0-draft1"/>
  <name value="USRealmDateandTimeDTMUSFIELDED"/>
  <title value="US Realm Date and Time (DTM.US.FIELDED)"/>
  <status value="active"/>
  <date value="2023-01-16T21:46:29+11: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 (DT.US.FIELDED), but is used with elements having a datatype of TS."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <fhirVersion value="5.0.0-snapshot3"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="resource"/>
  <abstract value="false"/>
  <type value="TS"/>
  <baseDefinition value="http://hl7.org/fhir/cda/StructureDefinition/TS"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="TS">
      <path value="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() &gt; id.count())"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
      </constraint>
      <constraint>
        <key value="81-10127"/>
        <severity value="error"/>
        <human value="**SHALL** be precise to the day (CONF:81-10127)."/>
      </constraint>
      <constraint>
        <key value="81-10128"/>
        <severity value="warning"/>
        <human value="**SHOULD** be precise to the minute (CONF:81-10128)."/>
      </constraint>
      <constraint>
        <key value="81-10129"/>
        <severity value="warning"/>
        <human value="**MAY** be precise to the second (CONF:81-10129)."/>
      </constraint>
      <constraint>
        <key value="81-10130"/>
        <severity value="warning"/>
        <human
               value="If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130)."/>
      </constraint>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="TS.nullFlavor">
      <path value="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"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-NullFlavor"/>
      </binding>
    </element>
    <element id="TS.value">
      <extension
                 url="http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format">
        <valueCode value="YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"/>
      </extension>
      <path value="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="dateTime"/>
      </type>
    </element>
    <element id="TS.inclusive">
      <path value="TS.inclusive"/>
      <representation value="xmlAttr"/>
      <definition
                  value="Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open)."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="TS.inclusive"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="boolean"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="TS">
      <path value="TS"/>
      <constraint>
        <key value="81-10127"/>
        <severity value="error"/>
        <human value="**SHALL** be precise to the day (CONF:81-10127)."/>
      </constraint>
      <constraint>
        <key value="81-10128"/>
        <severity value="warning"/>
        <human value="**SHOULD** be precise to the minute (CONF:81-10128)."/>
      </constraint>
      <constraint>
        <key value="81-10129"/>
        <severity value="warning"/>
        <human value="**MAY** be precise to the second (CONF:81-10129)."/>
      </constraint>
      <constraint>
        <key value="81-10130"/>
        <severity value="warning"/>
        <human
               value="If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130)."/>
      </constraint>
    </element>
  </differential>
</StructureDefinition>