US Realm Date and Time - Interval - Consolidated CDA (C-CDA) v4.0.0-ballot

Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: US Realm Date and Time - Interval

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmDateTimeInterval				Version: 4.0.0-ballot
Draft as of 2024-11-21				Computable Name: USRealmDateTimeInterval
Other Identifiers: urn:oid:2.16.840.1.113883.10.20.22.5.3

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.

Usage:

Use this Logical Model: Note Activity, Procedure Activity Procedure and US Realm Header

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

This structure is derived from IVL_TS

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) ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component.
@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 ts-shall-day: SHALL be precise to at least the day ts-should-minute: SHOULD be precise to at least the minute
@value		0..1	ts	Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
high	C	0..1	IVXB_TS	MAY be precise to at least the second ts-shall-day: SHALL be precise to at least the day ts-should-minute: SHOULD be precise to at least the minute
@value		0..1	ts	Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ivl-value-shall	error	IVL_TS	If a time interval contains @value, then it shall be precise to at least the day. : value.exists() implies value.toString().length() >= 10
ivl-value-should	warning	IVL_TS	If a time interval contains @value, then it SHOULD contain a time component. : value.exists() implies value.toString().length() > 10
ts-shall-day	error	IVL_TS.low, IVL_TS.high	SHALL be precise to at least the day : nullFlavor.exists() or value.toString().length() >= 10
ts-should-minute	warning	IVL_TS.low, IVL_TS.high	SHOULD be precise to at least the minute : nullFlavor.exists() or value.toString().length() > 10

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) ivl-ts-center: Center cannot co-exist with low or high ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component.
@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 ts-shall-day: SHALL be precise to at least the day ts-should-minute: SHOULD be precise to at least the minute
@value		0..1	ts	Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
high	C	0..1	IVXB_TS	MAY be precise to at least the second ts-shall-day: SHALL be precise to at least the day ts-should-minute: SHOULD be precise to at least the minute
@value		0..1	ts	Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ivl-ts-center	error	IVL_TS	Center cannot co-exist with low or high : center.empty() or (low.empty() and high.empty())
ivl-value-shall	error	IVL_TS	If a time interval contains @value, then it shall be precise to at least the day. : value.exists() implies value.toString().length() >= 10
ivl-value-should	warning	IVL_TS	If a time interval contains @value, then it SHOULD contain a time component. : value.exists() implies value.toString().length() > 10
ts-shall-day	error	IVL_TS.low, IVL_TS.high	SHALL be precise to at least the day : nullFlavor.exists() or value.toString().length() >= 10
ts-should-minute	warning	IVL_TS.low, IVL_TS.high	SHOULD be precise to at least the minute : nullFlavor.exists() or value.toString().length() > 10

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) ivl-ts-center: Center cannot co-exist with low or high ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@value		0..1	ts	Either @value or low/high should be present, but not both Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
@operator		0..1	cs	Binding: CDASetOperator (required)
low	C	0..1	IVXB_TS	MAY be precise to at least the second ts-shall-day: SHALL be precise to at least the day ts-should-minute: SHOULD be precise to at least the minute
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@value		0..1	ts	Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
@inclusive		0..1	bl
center		0..1	TS
width		0..1	PQ
high	C	0..1	IVXB_TS	MAY be precise to at least the second ts-shall-day: SHALL be precise to at least the day ts-should-minute: SHOULD be precise to at least the minute
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@value		0..1	ts	Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
@inclusive		0..1	bl
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IVL_TS.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
IVL_TS.operator	required	CDASetOperator `http://hl7.org/cda/stds/core/ValueSet/CDASetOperator`
IVL_TS.low.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
IVL_TS.high.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`

Constraints

Id	Grade	Path(s)	Details	Requirements
ivl-ts-center	error	IVL_TS	Center cannot co-exist with low or high : center.empty() or (low.empty() and high.empty())
ivl-value-shall	error	IVL_TS	If a time interval contains @value, then it shall be precise to at least the day. : value.exists() implies value.toString().length() >= 10
ivl-value-should	warning	IVL_TS	If a time interval contains @value, then it SHOULD contain a time component. : value.exists() implies value.toString().length() > 10
ts-shall-day	error	IVL_TS.low, IVL_TS.high	SHALL be precise to at least the day : nullFlavor.exists() or value.toString().length() >= 10
ts-should-minute	warning	IVL_TS.low, IVL_TS.high	SHOULD be precise to at least the minute : nullFlavor.exists() or value.toString().length() > 10

This structure is derived from IVL_TS

Summary

Differential View

This structure is derived from IVL_TS

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) ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component.
@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 ts-shall-day: SHALL be precise to at least the day ts-should-minute: SHOULD be precise to at least the minute
@value		0..1	ts	Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
high	C	0..1	IVXB_TS	MAY be precise to at least the second ts-shall-day: SHALL be precise to at least the day ts-should-minute: SHOULD be precise to at least the minute
@value		0..1	ts	Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ivl-value-shall	error	IVL_TS	If a time interval contains @value, then it shall be precise to at least the day. : value.exists() implies value.toString().length() >= 10
ivl-value-should	warning	IVL_TS	If a time interval contains @value, then it SHOULD contain a time component. : value.exists() implies value.toString().length() > 10
ts-shall-day	error	IVL_TS.low, IVL_TS.high	SHALL be precise to at least the day : nullFlavor.exists() or value.toString().length() >= 10
ts-should-minute	warning	IVL_TS.low, IVL_TS.high	SHOULD be precise to at least the minute : nullFlavor.exists() or value.toString().length() > 10

Key Elements View

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) ivl-ts-center: Center cannot co-exist with low or high ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component.
@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 ts-shall-day: SHALL be precise to at least the day ts-should-minute: SHOULD be precise to at least the minute
@value		0..1	ts	Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
high	C	0..1	IVXB_TS	MAY be precise to at least the second ts-shall-day: SHALL be precise to at least the day ts-should-minute: SHOULD be precise to at least the minute
@value		0..1	ts	Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ivl-ts-center	error	IVL_TS	Center cannot co-exist with low or high : center.empty() or (low.empty() and high.empty())
ivl-value-shall	error	IVL_TS	If a time interval contains @value, then it shall be precise to at least the day. : value.exists() implies value.toString().length() >= 10
ivl-value-should	warning	IVL_TS	If a time interval contains @value, then it SHOULD contain a time component. : value.exists() implies value.toString().length() > 10
ts-shall-day	error	IVL_TS.low, IVL_TS.high	SHALL be precise to at least the day : nullFlavor.exists() or value.toString().length() >= 10
ts-should-minute	warning	IVL_TS.low, IVL_TS.high	SHOULD be precise to at least the minute : nullFlavor.exists() or value.toString().length() > 10

Snapshot View

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) ivl-ts-center: Center cannot co-exist with low or high ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@value		0..1	ts	Either @value or low/high should be present, but not both Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
@operator		0..1	cs	Binding: CDASetOperator (required)
low	C	0..1	IVXB_TS	MAY be precise to at least the second ts-shall-day: SHALL be precise to at least the day ts-should-minute: SHOULD be precise to at least the minute
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@value		0..1	ts	Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
@inclusive		0..1	bl
center		0..1	TS
width		0..1	PQ
high	C	0..1	IVXB_TS	MAY be precise to at least the second ts-shall-day: SHALL be precise to at least the day ts-should-minute: SHOULD be precise to at least the minute
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@value		0..1	ts	Date Format: YYYYMMDDHHMMSS.UUUU[+\|-ZZzz]
@inclusive		0..1	bl
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IVL_TS.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
IVL_TS.operator	required	CDASetOperator `http://hl7.org/cda/stds/core/ValueSet/CDASetOperator`
IVL_TS.low.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`
IVL_TS.high.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`

Constraints

Id	Grade	Path(s)	Details	Requirements
ivl-ts-center	error	IVL_TS	Center cannot co-exist with low or high : center.empty() or (low.empty() and high.empty())
ivl-value-shall	error	IVL_TS	If a time interval contains @value, then it shall be precise to at least the day. : value.exists() implies value.toString().length() >= 10
ivl-value-should	warning	IVL_TS	If a time interval contains @value, then it SHOULD contain a time component. : value.exists() implies value.toString().length() > 10
ts-shall-day	error	IVL_TS.low, IVL_TS.high	SHALL be precise to at least the day : nullFlavor.exists() or value.toString().length() >= 10
ts-should-minute	warning	IVL_TS.low, IVL_TS.high	SHOULD be precise to at least the minute : nullFlavor.exists() or value.toString().length() > 10

This structure is derived from IVL_TS

Summary

Other representations of profile: CSV, Excel

IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#4.0.0-ballot based on FHIR 5.0.0. Generated 2024-11-21
Links: Table of Contents | QA Report | Version History external | | Propose a change