API reference

Clinical cases

Report progress, message the patient, resolve.

Confirm processing, report clinical progress, send patient-visible messages, and explicitly resolve escalated cases.

Read current external-care progress

GET/v1/clinical-cases/{caseId}/progress

Use this endpoint to reconcile sequence conflicts and confirm the next accepted sequence. Transport delivery and provider processing are intentionally separate fields.

API key. Authorization: Bearer nzh_sb_… in sandbox, nzh_prod_… in production: Authentication.

Parameters

Field	Type	Description
`caseId`Required	path · string (uuid)	The canonical UUID from the clinical_case.opened webhook. This is not the patient-facing NC-XXXXXXXX reference.

cURL

curl "https://api.nezercare.com/v1/clinical-cases/CASE_ID/progress" \
  --request GET \
  --header "Authorization: Bearer $NEZER_API_KEY"

Responses

Status	Meaning
`200`	Current progress.
`400`	The request is malformed or violates the operation contract.
`401`	The API credential is missing, invalid, expired, or revoked.
`403`	The organization hasn't signed its BAA, so patient features (and API keys) are off. An owner or administrator signs it in Settings; it takes effect at once.
`404`	The resource is not accessible in this credential's environment.
`409`	The idempotency identifier was reused with different content, or an update is out of sequence.

200 body

Field	Type	Description
`caseId`Required	string (uuid)
`status`Required	string
`sequence`Required	integer	At least 0.
`nextSequence`Required	integer	At least 1.
`confirmationOverdue`Required	boolean
`confirmationDueAt`	string (date-time) or null
`transportDelivered`Required	boolean
`scheduledFor`	string (date-time) or null
`updatedAt`	string (date-time)
`externalReference`	string or null

200 response

{
  "caseId": "150d31aa-c9ed-4624-b516-8f7f354f0848",
  "status": "awaiting_processing",
  "sequence": 0,
  "nextSequence": 1,
  "confirmationOverdue": false,
  "transportDelivered": true,
  "externalReference": null
}

401 response

{
  "code": "INVALID_API_CREDENTIAL",
  "message": "API credential is invalid."
}

403 response

{
  "code": "BAA_REQUIRED",
  "message": "Sign your BAA to turn on patient features. An owner or administrator can sign it in Settings."
}

Report provider-workflow progress

POST/v1/clinical-cases/{caseId}/updates

The first update must be processed at sequence 1. Later updates may report scheduling, clinician response, patient contact, or final resolution. Use the same updateId and identical body when retrying.

API key. Authorization: Bearer nzh_sb_… in sandbox, nzh_prod_… in production: Authentication.

Parameters

Field	Type	Description
`caseId`Required	path · string (uuid)	The canonical UUID from the clinical_case.opened webhook. This is not the patient-facing NC-XXXXXXXX reference.

Request body

Field	Type	Description
`updateId`Required	string (uuid)
`sequence`Required	integer	1 to 1000000.
`status`Required	string	One of `processed`, `scheduled`, `clinician_responded`, `patient_contacted`, `resolved`.
`externalReference`Required	string	1–200 characters.
`scheduledFor`	string (date-time)
`resolutionOutcome`	string	One of `patient_contacted`, `provider_follow_up`, `medication_adjusted`, `emergency_referral`, `no_further_action`, `other`.
`resolutionNote`	string	10–2000 characters.

cURL

curl "https://api.nezercare.com/v1/clinical-cases/CASE_ID/updates" \
  --request POST \
  --header "Authorization: Bearer $NEZER_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "updateId": "d574b886-f658-43dc-a62a-6c66ef74682d",
    "sequence": 1,
    "status": "processed",
    "externalReference": "provider-conversation-001"
  }'

Appointment scheduled

{
  "updateId": "8bb876eb-c77e-4686-b8f0-e4f76333670a",
  "sequence": 2,
  "status": "scheduled",
  "externalReference": "appointment-456",
  "scheduledFor": "2026-09-08T14:30:00-04:00"
}

Case resolved

{
  "updateId": "947ea6c9-cdb3-48d7-874b-bfcd59b54e99",
  "sequence": 3,
  "status": "resolved",
  "externalReference": "provider-conversation-001",
  "resolutionOutcome": "provider_follow_up",
  "resolutionNote": "Clinician reviewed the concern and provided follow-up guidance."
}

Responses

Status	Meaning
`200`	Progress recorded or an identical retry recognized.
`400`	The request is malformed or violates the operation contract.
`401`	The API credential is missing, invalid, expired, or revoked.
`403`	The organization hasn't signed its BAA, so patient features (and API keys) are off. An owner or administrator signs it in Settings; it takes effect at once.
`404`	The resource is not accessible in this credential's environment.
`409`	The idempotency identifier was reused with different content, or an update is out of sequence.

200 body

Field	Type	Description
`caseId`Required	string (uuid)
`updateId`Required	string (uuid)
`sequence`Required	integer
`status`Required	string
`duplicate`Required	boolean

401 response

{
  "code": "INVALID_API_CREDENTIAL",
  "message": "API credential is invalid."
}

403 response

{
  "code": "BAA_REQUIRED",
  "message": "Sign your BAA to turn on patient features. An owner or administrator can sign it in Settings."
}

Send a message to the patient

POST/v1/clinical-cases/{caseId}/messages

The encrypted message appears in the patient's secure case conversation. Do not put internal clinical notes in this patient-visible field. The patient receives a privacy-safe email without the message body.

API key. Authorization: Bearer nzh_sb_… in sandbox, nzh_prod_… in production: Authentication.

Parameters

Field	Type	Description
`caseId`Required	path · string (uuid)	The canonical UUID from the clinical_case.opened webhook. This is not the patient-facing NC-XXXXXXXX reference.

Request body

Field	Type	Description
`messageId`Required	string (uuid)
`message`Required	string	1–4000 characters.
`externalReference`Required	string	1–200 characters.

cURL

curl "https://api.nezercare.com/v1/clinical-cases/CASE_ID/messages" \
  --request POST \
  --header "Authorization: Bearer $NEZER_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "messageId": "a321530a-f9fe-4435-8593-38eb75174854",
    "message": "A clinician reviewed your concern. Have your symptoms changed today?",
    "externalReference": "provider-message-456"
  }'

Responses

Status	Meaning
`200`	Message created or an identical retry recognized.
`400`	The request is malformed or violates the operation contract.
`401`	The API credential is missing, invalid, expired, or revoked.
`403`	The organization hasn't signed its BAA, so patient features (and API keys) are off. An owner or administrator signs it in Settings; it takes effect at once.
`404`	The resource is not accessible in this credential's environment.
`409`	The idempotency identifier was reused with different content, or an update is out of sequence.

200 body

Field	Type	Description
`caseId`Required	string (uuid)
`messageId`Required	string (uuid)
`duplicate`Required	boolean
`createdAt`	string (date-time)

401 response

{
  "code": "INVALID_API_CREDENTIAL",
  "message": "API credential is invalid."
}

403 response

{
  "code": "BAA_REQUIRED",
  "message": "Sign your BAA to turn on patient features. An owner or administrator can sign it in Settings."
}