low level details for the care connect patient 'id' element
Tweet Me
Deceased Implementation Guide
Use case
This specification describes a single use case.
Element Usage
The deceased element provides an implementer a choice of data types to represent whether the patient is deceased. Only one of the two choices can be used to make this representation.
Deceased
| Type | name | Data Type | Description |
|---|---|---|---|
| Choice | deceased | boolean or dateTime | Element used to determine if the patient is deceased using a true/false value or a date and time value. |
- Boolean or dateTime value MUST be used with this element
- A time and timezone value may be used as part of the value
Example of Correct Usage
| Usage | Element | examples | Comments |
 |
deceased |
1957-01-01 | Correct format for a birth time, comprising of date only. |
|
1988-11-11T11:45+00:00 | Correct format for a birth time, comprising of date, time with seconds zero filled, and a timezone | |
|
true | Boolean value used to indicate patient is deceased. |
Example of Incorrect Usage
| Usage | Element | examples | Comments |
 |
deceased |
1987-01-23T21:33:00 | The timezone is missing |
|
1987-02-30 | The date is invalid | |
|
FALSE | The boolean value is in uppercase rather than the required lowercase. |
On the wire example in XML
<deceasedBoolean value="false"/>
<deceasedDateTime value="1973-12-10"/>
On the wire example in JSON
{
"deceasedBoolean": { "value": "true" }
}
{
"deceasedDateTime": { "value": "1957-01-01" }
}
Error Handling
The provider system SHALL return an error if:
- The dateTime value is not a valid format
- The boolean value is not true or false or is missing.