low level details for the care connect patient 'birthTime' extension
Tweet Me
Birth Time Implementation Guide
Use case
This specification describes a single use case.
birthTime
| Type | name | Data Type | Description |
|---|---|---|---|
| Extension | birthTime | dateTime | The time of day that the patient was born. This includes the date to ensure that the time zone information can be communicated effectively. |
An optional extension that may be used to capture to time of a patients birth.
Extension Usage
The data type of dateTime requires the implantation to follow the following guidelines:
- Time must contain a date in addition to the time.
- The time must use a 24hr format
- The time must be present, with seconds being optional. The time 24:00 is not valid.
- A timezone must be used.
The extension url is:
http://hl7.org/fhir/StructureDefinition/patient-birthTime
Important: The extension is not an extension of birthDate, but an extension of the CareConnect-Patient-1 profile. Its location in the XML structure must be correct
Example of Correct Usage
| Usage | Element | examples | Comments |
 |
birthDate |
1957-01-01T08:39:16+00:00 | Correct format for a birth time, comprising of date, time (including seconds) and a timezone |
|
birthDate |
1988-11-11T11:45+00:00 | Correct format for a birth time, comprising of date, time with seconds zero filled, and a timezone |
Example of Incorrect Usage
| Usage | Element | examples | Comments |
 |
1973-04-01 | The time is not present. | |
|
1987-01-23T24:00:00+00:00 | The time 24:00 is not a valid time | |
|
1987/01/23T21:33:00+00:00 | The date separator uses / which is not valid |
On the wire XML example
<extension url="http://hl7.org/fhir/StructureDefinition/patient-birthTime">
<valueDateTime value="2016-01-02T08:39:00+00:00"/>
</extension>
On the wire example in JSON
{
"extension": {
"-url": "http://hl7.org/fhir/StructureDefinition/patient-birthTime",
"valueDateTime": { "-value": "2016-01-02T08:39:16+00:00" }
}
}
Error Handling
The provider system SHALL return an error if:
-
birthTimeis missing a time -
birthTimeis missing a timezone -
birthTimedate part does not match with the value inbirthDate