Patient Vault — 1health

Deceased

/v3/patient/{patientId}/deceased endpoint reference.

URL: https://demo.1health.io/api/v3/patient/{patientId}/deceased

APIs for marking a patient deceased and managing the structured death record (date, time, cause, manner, place of death, certifier). Reversal is expressed via DELETE; corrections via PUT/PATCH.

Endpoints

Endpoint	Method	Description
/v3/patient/{patientId}/deceased	GET	Get a patient's deceased record
/v3/patient/{patientId}/deceased	POST	Mark a patient deceased
/v3/patient/{patientId}/deceased	PUT	Fully update a patient's deceased record
/v3/patient/{patientId}/deceased	PATCH	Partially update a patient's deceased record
/v3/patient/{patientId}/deceased	DELETE	Reverse a patient's deceased record

GET/v3/patient/{patientId}/deceased

Get a patient's deceased record

Overview

Returns the patient's deceased record.

Authorization

Bearer JWT required. See the authentication guide.

Path Parameters

Parameter	Type	Required	Description
patientId	Long	Yes	The ID of the patient.

Responses

200 OK

Deceased record found.

DTO: PatientDeceasedResponseDTO

{
  "id": 1001,
  "patientId": 1001,
  "deceasedDate": "example-value",
  "deceasedTime": "example-value",
  "cause": "example-value",
  "manner": "example-value",
  "placeOfDeath": "example-value",
  "certifierId": "example-value",
  "notes": "example-value",
  "createdAt": "example-value"
}

Field	Type	Nullable	Description
id	Long	No	Deceased record ID.
patientId	Long	No	ID of the patient this record is for.
deceasedDate	string	No	Date of death (YYYY-MM-DD).
deceasedTime	string	Yes	Time of death (HH:MM, 24-hour UTC).
cause	string	Yes	Cause of death — ICD-10 code or freeform text.
manner	string	Yes	Manner of death.
placeOfDeath	string	Yes	Facility name or location description.
certifierId	string	Yes	NPI of the certifying provider.
notes	string	Yes	Additional narrative notes.
createdAt	string	No	When the record was created (UTC).

401 Unauthorized

Not authenticated — valid session required.

404 Not Found

Patient not found, or patient is not marked deceased.

Example

curl -X GET "https://demo.1health.io/api/v3/patient/1001/deceased" \
  -H "Authorization: Bearer $TOKEN"

POST/v3/patient/{patientId}/deceased

Mark a patient deceased

Overview

Creates the patient's deceased record and sets the deceased flag that blocks new appointments and orders. Returns a server-assigned id.

Authorization

Bearer JWT required. See the authentication guide.

Path Parameters

Parameter	Type	Required	Description
patientId	Long	Yes	The ID of the patient.

Request Body

Content-Type: application/json · DTO: PatientDeceasedRequestDTO

{
  "deceasedDate": "example-value",
  "deceasedTime": "example-value",
  "cause": "example-value",
  "manner": "example-value",
  "placeOfDeath": "example-value",
  "certifierId": "example-value",
  "notes": "example-value"
}

Field	Type	Required	Constraints	Description
deceasedDate	string	Yes	format: date	Date of death (YYYY-MM-DD).
deceasedTime	string	No		Time of death (HH:MM, 24-hour UTC).
cause	string	No		Cause of death — ICD-10 code or freeform text.
manner	string	No	one of: Natural, Accident, Homicide, Suicide, Undetermined, Pending	Manner of death — one of: Natural, Accident, Homicide, Suicide, Undetermined, Pending.
placeOfDeath	string	No		Facility name or location description.
certifierId	string	No		NPI of the certifying provider.
notes	string	No		Additional narrative notes.

Responses

201 Created

Deceased record created successfully.

DTO: PatientDeceasedResponseDTO

{
  "id": 1001,
  "patientId": 1001,
  "deceasedDate": "example-value",
  "deceasedTime": "example-value",
  "cause": "example-value",
  "manner": "example-value",
  "placeOfDeath": "example-value",
  "certifierId": "example-value",
  "notes": "example-value",
  "createdAt": "example-value"
}

Field	Type	Nullable	Description
id	Long	No	Deceased record ID.
patientId	Long	No	ID of the patient this record is for.
deceasedDate	string	No	Date of death (YYYY-MM-DD).
deceasedTime	string	Yes	Time of death (HH:MM, 24-hour UTC).
cause	string	Yes	Cause of death — ICD-10 code or freeform text.
manner	string	Yes	Manner of death.
placeOfDeath	string	Yes	Facility name or location description.
certifierId	string	Yes	NPI of the certifying provider.
notes	string	Yes	Additional narrative notes.
createdAt	string	No	When the record was created (UTC).

400 Bad Request

Invalid request. Possible causes: • Missing required field (deceasedDate) • Invalid deceasedDate format, in the future, or before date of birth • Invalid manner • Invalid deceasedTime format (expected HH:MM, 24-hour)

401 Unauthorized

Not authenticated — valid session required.

404 Not Found

Patient not found.

409 Conflict

Patient is already marked deceased.

Example

curl -X POST "https://demo.1health.io/api/v3/patient/1001/deceased" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" -d '{"deceasedDate": "example-value", "deceasedTime": "example-value", "cause": "example-value", "manner": "example-value", "placeOfDeath": "example-value", "certifierId": "example-value", "notes": "example-value"}'

PUT/v3/patient/{patientId}/deceased

Fully update a patient's deceased record

Overview

Replaces the deceased record. Use when correcting multiple fields at once.

Authorization

Bearer JWT required. See the authentication guide.

Path Parameters

Parameter	Type	Required	Description
patientId	Long	Yes	The ID of the patient.

Request Body

Content-Type: application/json · DTO: PatientDeceasedRequestDTO

{
  "deceasedDate": "example-value",
  "deceasedTime": "example-value",
  "cause": "example-value",
  "manner": "example-value",
  "placeOfDeath": "example-value",
  "certifierId": "example-value",
  "notes": "example-value"
}

Field	Type	Required	Constraints	Description
deceasedDate	string	Yes	format: date	Date of death (YYYY-MM-DD).
deceasedTime	string	No		Time of death (HH:MM, 24-hour UTC).
cause	string	No		Cause of death — ICD-10 code or freeform text.
manner	string	No	one of: Natural, Accident, Homicide, Suicide, Undetermined, Pending	Manner of death — one of: Natural, Accident, Homicide, Suicide, Undetermined, Pending.
placeOfDeath	string	No		Facility name or location description.
certifierId	string	No		NPI of the certifying provider.
notes	string	No		Additional narrative notes.

Responses

200 OK

Deceased record updated successfully.

DTO: PatientDeceasedResponseDTO

{
  "id": 1001,
  "patientId": 1001,
  "deceasedDate": "example-value",
  "deceasedTime": "example-value",
  "cause": "example-value",
  "manner": "example-value",
  "placeOfDeath": "example-value",
  "certifierId": "example-value",
  "notes": "example-value",
  "createdAt": "example-value"
}

Field	Type	Nullable	Description
id	Long	No	Deceased record ID.
patientId	Long	No	ID of the patient this record is for.
deceasedDate	string	No	Date of death (YYYY-MM-DD).
deceasedTime	string	Yes	Time of death (HH:MM, 24-hour UTC).
cause	string	Yes	Cause of death — ICD-10 code or freeform text.
manner	string	Yes	Manner of death.
placeOfDeath	string	Yes	Facility name or location description.
certifierId	string	Yes	NPI of the certifying provider.
notes	string	Yes	Additional narrative notes.
createdAt	string	No	When the record was created (UTC).

400 Bad Request

401 Unauthorized

Not authenticated — valid session required.

404 Not Found

Patient not found, or patient is not marked deceased.

Example

curl -X PUT "https://demo.1health.io/api/v3/patient/1001/deceased" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" -d '{"deceasedDate": "example-value", "deceasedTime": "example-value", "cause": "example-value", "manner": "example-value", "placeOfDeath": "example-value", "certifierId": "example-value", "notes": "example-value"}'

PATCH/v3/patient/{patientId}/deceased

Partially update a patient's deceased record

Overview

Updates only the fields provided in the request body. Use to correct a wrong date or other specific fields without reversing the record.

Authorization

Bearer JWT required. See the authentication guide.

Path Parameters

Parameter	Type	Required	Description
patientId	Long	Yes	The ID of the patient.

Request Body

Content-Type: application/json · DTO: PatientDeceasedRequestDTO

{
  "deceasedDate": "example-value",
  "deceasedTime": "example-value",
  "cause": "example-value",
  "manner": "example-value",
  "placeOfDeath": "example-value",
  "certifierId": "example-value",
  "notes": "example-value"
}

Field	Type	Required	Constraints	Description
deceasedDate	string	Yes	format: date	Date of death (YYYY-MM-DD).
deceasedTime	string	No		Time of death (HH:MM, 24-hour UTC).
cause	string	No		Cause of death — ICD-10 code or freeform text.
manner	string	No	one of: Natural, Accident, Homicide, Suicide, Undetermined, Pending	Manner of death — one of: Natural, Accident, Homicide, Suicide, Undetermined, Pending.
placeOfDeath	string	No		Facility name or location description.
certifierId	string	No		NPI of the certifying provider.
notes	string	No		Additional narrative notes.

Responses

200 OK

Deceased record partially updated successfully.

DTO: PatientDeceasedResponseDTO

{
  "id": 1001,
  "patientId": 1001,
  "deceasedDate": "example-value",
  "deceasedTime": "example-value",
  "cause": "example-value",
  "manner": "example-value",
  "placeOfDeath": "example-value",
  "certifierId": "example-value",
  "notes": "example-value",
  "createdAt": "example-value"
}

Field	Type	Nullable	Description
id	Long	No	Deceased record ID.
patientId	Long	No	ID of the patient this record is for.
deceasedDate	string	No	Date of death (YYYY-MM-DD).
deceasedTime	string	Yes	Time of death (HH:MM, 24-hour UTC).
cause	string	Yes	Cause of death — ICD-10 code or freeform text.
manner	string	Yes	Manner of death.
placeOfDeath	string	Yes	Facility name or location description.
certifierId	string	Yes	NPI of the certifying provider.
notes	string	Yes	Additional narrative notes.
createdAt	string	No	When the record was created (UTC).

400 Bad Request

Invalid request. Possible causes: • Invalid deceasedDate format, in the future, or before date of birth • Invalid manner • Invalid deceasedTime format (expected HH:MM, 24-hour)

401 Unauthorized

Not authenticated — valid session required.

404 Not Found

Patient not found, or patient is not marked deceased.

Example

curl -X PATCH "https://demo.1health.io/api/v3/patient/1001/deceased" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" -d '{"deceasedDate": "example-value", "deceasedTime": "example-value", "cause": "example-value", "manner": "example-value", "placeOfDeath": "example-value", "certifierId": "example-value", "notes": "example-value"}'

DELETE/v3/patient/{patientId}/deceased

Reverse a patient's deceased record

Overview

Reverses the record: the patient is no longer marked deceased. The original deceased record and this reversal are preserved in History (the record is soft-deleted, not removed).

Authorization

Bearer JWT required. See the authentication guide.

Path Parameters

Parameter	Type	Required	Description
patientId	Long	Yes	The ID of the patient.

Responses

200 OK

Deceased record reversed successfully.

DTO: PatientDeceasedDeleteResponseDTO

{
  "id": 1001,
  "reversed": true,
  "reversedAt": "example-value"
}

Field	Type	Nullable	Description
id	Long	Yes	ID of the reversed deceased record. Omitted when the patient was not marked deceased.
reversed	boolean	No	Always true — the patient is no longer marked deceased.
reversedAt	string	No	When the reversal happened (UTC).

401 Unauthorized

Not authenticated — valid session required.

404 Not Found

Patient not found.

Example

curl -X DELETE "https://demo.1health.io/api/v3/patient/1001/deceased" \
  -H "Authorization: Bearer $TOKEN"

Parent: https://agents.1health.io/public/demo/api/v3/patient/_patientId_/agents.md · Site guide: https://agents.1health.io/public/demo/api/agents.md

Deceased

Endpoints

GET/v3/patient/{patientId}/deceased

Overview

Authorization

Path Parameters

Responses

200 OK

401 Unauthorized

404 Not Found

Example

POST/v3/patient/{patientId}/deceased

Overview

Authorization

Path Parameters

Request Body

Responses

201 Created

400 Bad Request

401 Unauthorized

404 Not Found

409 Conflict

Example

PUT/v3/patient/{patientId}/deceased

Overview

Authorization

Path Parameters

Request Body

Responses

200 OK

400 Bad Request

401 Unauthorized

404 Not Found

Example

PATCH/v3/patient/{patientId}/deceased

Overview

Authorization

Path Parameters

Request Body

Responses

200 OK

400 Bad Request

401 Unauthorized

404 Not Found

Example

DELETE/v3/patient/{patientId}/deceased

Overview

Authorization

Path Parameters

Responses

200 OK

401 Unauthorized

404 Not Found

Example

Navigation