Vital Records Common Library (VRCL) STU2-ballot
2.0.0 - trial-use United States of America flag

Vital Records Common Library (VRCL) STU2-ballot, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/vr-common-library/ and changes regularly. See the Directory of published versions

Extension: Partial Date Vital Records

Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr Version: 2.0.0
Active as of 2024-03-21 Computable Name: ExtensionPartialDateVitalRecords

Provides values of a partial date for cases beyond what FHIR date can support directly.

Context of Use

This extension may be used on the following element(s):

  • Element ID date

If a component is missing, it is assumed unknown.

  • This extension SHOULD NOT be used when the value can be expressed as a date, specifically YYYY, YYYY-MM, YYYY-MM-DD, or a full date.
  • This extension SHOULD NOT be used to express that the date in its entirety is missing/unknown. In this case a simple dataAbsent reason extension should be used on the date.
  • This extension SHOULD be used to express missing components of date including XXXX-XX-DD, YYYY-XX-DD, YYYY-MM-XX, but one or more components of the date is unknown.
  • If a component is missing, the interpretation should be equivalent to it being present, with a data absent reason of ‘unknown’. If the data absent reason is other than ‘unknown’, the component may be included wih a data absent reason.

When the known components of the date can be expressed as a valid dateTime, the value SHALL be present. So, for example 2022-12-XX, the dateTime value should be "2022-12".

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Complex Extension: Provides values of a partial date for cases beyond what FHIR date can support directly.

  • year: unsignedInt: The year portion (YYYY) of the partial date (0-9998).
  • month: unsignedInt: The month portion (MM) of the partial date (1-12).
  • day: unsignedInt: The day portion (DD) of the partial date (1-31).

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPartial Date
... extension:year 0..1ExtensionDate year (0-9998)
.... extension 0..0
.... url 1..1uri"year"
.... value[x] 1..1unsignedIntValue of extension
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataabsent 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... extension:month 0..1ExtensionDate month (1-12)
.... extension 0..0
.... url 1..1uri"month"
.... value[x] 1..1unsignedIntValue of extension
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataabsent 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... extension:day 0..1ExtensionDate day (1-31)
.... extension 0..0
.... url 1..1uri"day"
.... value[x] 1..1unsignedIntValue of extension
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataabsent 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPartial Date
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:year 0..1ExtensionDate year (0-9998)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"year"
.... value[x] 1..1unsignedIntValue of extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataabsent 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... value 0..1stringPrimitive value for unsignedInt
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"month"
.... value[x] 1..1unsignedIntValue of extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataabsent 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... value 0..1stringPrimitive value for unsignedInt
... extension:day 0..1ExtensionDate day (1-31)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"day"
.... value[x] 1..1unsignedIntValue of extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataabsent 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... value 0..1stringPrimitive value for unsignedInt
... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Provides values of a partial date for cases beyond what FHIR date can support directly.

  • year: unsignedInt: The year portion (YYYY) of the partial date (0-9998).
  • month: unsignedInt: The month portion (MM) of the partial date (1-12).
  • day: unsignedInt: The day portion (DD) of the partial date (1-31).

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPartial Date
... extension:year 0..1ExtensionDate year (0-9998)
.... extension 0..0
.... url 1..1uri"year"
.... value[x] 1..1unsignedIntValue of extension
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataabsent 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... extension:month 0..1ExtensionDate month (1-12)
.... extension 0..0
.... url 1..1uri"month"
.... value[x] 1..1unsignedIntValue of extension
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataabsent 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... extension:day 0..1ExtensionDate day (1-31)
.... extension 0..0
.... url 1..1uri"day"
.... value[x] 1..1unsignedIntValue of extension
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataabsent 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPartial Date
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:year 0..1ExtensionDate year (0-9998)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"year"
.... value[x] 1..1unsignedIntValue of extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataabsent 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... value 0..1stringPrimitive value for unsignedInt
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"month"
.... value[x] 1..1unsignedIntValue of extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataabsent 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... value 0..1stringPrimitive value for unsignedInt
... extension:day 0..1ExtensionDate day (1-31)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"day"
.... value[x] 1..1unsignedIntValue of extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... dataabsent 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


..... value 0..1stringPrimitive value for unsignedInt
... url 1..1uri"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-vr"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron