Create an incident
/v1/incidentsCreates an incident and returns it. Send an Idempotency-Key header to make the request safe to retry. Available to keys belonging to office staff and caregivers. With a caregiver's or patient's key, a saved record that key cannot read back is answered with only object and id. Requires a key with write scope.
Headers
A unique value (a UUID works well) that makes this request safe to retry for 24 hours. A retry with the same key and body returns the first result; the same key with a different body is refused with idempotency_conflict.
Request body
application/jsonShort summary.
What happened.
When the incident happened.
Kind of incident.
FallMedicationBehavioralInjuryEquipmentAttendanceConductOthernullHow serious it was.
LowMediumHighCriticalnullWhere follow-up stands. New incidents start Open. Only keys belonging to office staff can set this.
OpenMonitoringAwaitingFollowUpResolvedClosednullThe patient involved.
The caregiver involved.
The visit during which it happened.
What was done at the time.
Body part injured, if any.
Witness, if any.
Whether 911 or other emergency services were called.
Whether the patient went to hospital.
Hospital, if transported.
Whether the patient's physician was told.
Whether family was told.
Whether the incident must be reported to a regulator.
Whether follow-up is needed.
When follow-up is due. Only keys belonging to office staff can set this.
Follow-up notes.
Whether the incident is resolved. Only keys belonging to office staff can set this.
How it was resolved. Only keys belonging to office staff can set this.
Whether only administrators can see it. Only keys belonging to office staff can set this.
Response
201The new incident.
String representing the object's type. Always incident.
Unique identifier of the incident.
Short summary.
What happened.
When the incident happened.
Kind of incident.
FallMedicationBehavioralInjuryEquipmentAttendanceConductOthernullHow serious it was.
LowMediumHighCriticalnullWhere follow-up stands. New incidents start Open.
OpenMonitoringAwaitingFollowUpResolvedClosednullThe patient involved.
The caregiver involved.
The visit during which it happened.
What was done at the time.
Body part injured, if any.
Witness, if any.
Whether 911 or other emergency services were called.
Whether the patient went to hospital.
Hospital, if transported.
Whether the patient's physician was told.
Whether family was told.
Whether the incident must be reported to a regulator.
Whether follow-up is needed.
When follow-up is due.
Follow-up notes.
Whether the incident is resolved.
How it was resolved.
Whether only administrators can see it.
Who reported it.
When it was reported.
When it was resolved.
When the incident was created.
When the incident was last changed.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Idempotent-ReplayedstringPresent and true when this response is the stored result of an earlier request with the same Idempotency-Key.Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 409 | n/a | The Idempotency-Key was already used with a different request, or that request is still running (idempotency_conflict). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.