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

## Logical Model: USRealmDateandTimeDTMUSFIELDED - JSON Profile

Draft as of 2023-09-29

JSON representation of the USRealmDateandTimeDTMUSFIELDED logical model.

Raw json | Download

    {
      "resourceType" : "StructureDefinition",
      "id" : "USRealmDateandTimeDTMUSFIELDED",
      "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 &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=\"data:image/png;base64, \" 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-USRealmDateandTimeDTMUSFIELDED-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/R5/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=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//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=\"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><br/><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>\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, \" 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/StructureDefinition/elementdefinition-namespace",
          "valueUri" : "urn:hl7-org:v3"
        }
      ],
      "url" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTMUSFIELDED",
      "identifier" : [
        {
          "value" : "urn:oid:2.16.840.1.113883.10.20.22.5.4"
        }
      ],
      "version" : "2.1",
      "name" : "USRealmDateandTimeDTMUSFIELDED",
      "title" : "US Realm Date and Time (DTM.US.FIELDED)",
      "status" : "draft",
      "date" : "2023-09-29T16:20:44+00: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 no time zone offset is provided, you can make no assumption about time, unless you have made a local exchange agreement.\n\nThis 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" : "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/TS",
      "baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/TS",
      "derivation" : "constraint",
      "snapshot" : {
        "element" : [
          {
            "id" : "TS",
            "path" : "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" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "81-10127",
                "severity" : "error",
                "human" : "**SHALL** be precise to the day (CONF:81-10127).",
                "source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTMUSFIELDED"
              },
              {
                "key" : "81-10128",
                "severity" : "warning",
                "human" : "**SHOULD** be precise to the minute (CONF:81-10128).",
                "source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTMUSFIELDED"
              },
              {
                "key" : "81-10129",
                "severity" : "warning",
                "human" : "**MAY** be precise to the second (CONF:81-10129).",
                "source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTMUSFIELDED"
              },
              {
                "key" : "81-10130",
                "severity" : "warning",
                "human" : "If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130).",
                "source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTMUSFIELDED"
              }
            ],
            "isModifier" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              }
            ]
          },
          {
            "id" : "TS.nullFlavor",
            "path" : "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://terminology.hl7.org/ValueSet/v3-NullFlavor"
            }
          },
          {
            "id" : "TS.value",
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
                "valueString" : "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
              }
            ],
            "path" : "TS.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" : "string",
                "profile" : [
                  "http://hl7.org/cda/stds/core/StructureDefinition/ts-simple"
                ]
              }
            ]
          }
        ]
      },
      "differential" : {
        "element" : [
          {
            "id" : "TS",
            "path" : "TS",
            "constraint" : [
              {
                "key" : "81-10127",
                "severity" : "error",
                "human" : "**SHALL** be precise to the day (CONF:81-10127).",
                "source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTMUSFIELDED"
              },
              {
                "key" : "81-10128",
                "severity" : "warning",
                "human" : "**SHOULD** be precise to the minute (CONF:81-10128).",
                "source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTMUSFIELDED"
              },
              {
                "key" : "81-10129",
                "severity" : "warning",
                "human" : "**MAY** be precise to the second (CONF:81-10129).",
                "source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTMUSFIELDED"
              },
              {
                "key" : "81-10130",
                "severity" : "warning",
                "human" : "If more precise than day, **SHOULD** include time-zone offset (CONF:81-10130).",
                "source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateandTimeDTMUSFIELDED"
              }
            ]
          }
        ]
      }
    }