Clinia
API ReferenceREST API

Get patient

GET
/v1/patients/{patientId}

Returns demographic metadata and pipeline stats for a patient identified by its registry key.

Path Parameters

patientId*string

Registry key of the patient, as assigned by the caller when the first ingest was submitted.

Match^[A-Za-z0-9._-]{1,128}$

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/patients/patient-123"
{
  "id": "string",
  "name": "string",
  "birthDate": "string",
  "gender": "string",
  "stats": {
    "entities": 0,
    "events": 0,
    "relationships": 0,
    "warnings": 0,
    "loadMs": 0
  }
}
{
  "code": 1,
  "type": "ALREADY_EXISTS",
  "message": "string"
}

List patients GET

Returns all patients currently loaded in the registry. An empty array is returned if no patients have been ingested yet.

Upsert patient PUT

Creates the patient registry entry if it does not yet exist, or returns the existing record unchanged. Fully idempotent — safe to call before or after the first ingest.