| Package | hl7.cda.us.ccda |
| Type | StructureDefinition |
| Id | USRealmDateTimeInterval |
| FHIR Version | R5 |
| Source | http://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda/StructureDefinition-USRealmDateTimeInterval.html |
| URL | http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval |
| Version | 4.0.0 |
| Status | draft |
| Date | 2025-06-26T21:09:45+00:00 |
| Name | USRealmDateTimeInterval |
| Title | US Realm Date and Time - Interval |
| Realm | us |
| Authority | hl7 |
| 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. This 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. |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL_TS |
| Kind | logical |
| StructureDefinition | |
| NoteActivity | Note Activity |
| ProcedureActivityProcedure | Procedure Activity Procedure |
| USRealmHeader | US Realm Header |
| StructureDefinition | |
| IVL-TS | IVL_TS: Interval (V3 Data Type) |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition USRealmDateTimeInterval
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  IVL_TS | C | 1..* | IVL_TS | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @value, @operator, low, center, width, high Base for all types and resources Logical Container: ClinicalDocument (CDA Class) Constraints: ivl-value-shall, ivl-value-should |
 @value | 0..1 | ts | Either @value or low/high should be present, but not both Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| low | C | 0..1 | IVXB_TS | **MAY** be precise to at least the second Constraints: ts-shall-day, ts-should-minute |
  @value | 0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| high | C | 0..1 | IVXB_TS | **MAY** be precise to at least the second Constraints: ts-shall-day, ts-should-minute |
 @value | 0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "USRealmDateTimeInterval",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"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": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.10.20.22.5.3"
}
],
"version": "4.0.0",
"name": "USRealmDateTimeInterval",
"title": "US Realm Date and Time - Interval",
"status": "draft",
"date": "2025-06-26T21:09:45+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 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": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "2.0.1-sd"
}
],
"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://hl7.org/cda/stds/core/ValueSet/CDASetOperator"
}
},
{
"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"
}
]
}
}