The Context Engine Studio is now open source.  View on GitHub →
Clinia
API ReferenceREST API

List ingestions

GET
/v1/patients/{patientId}/ingestions

This patient's submissions, newest arrival last. status is derived per submission from the work it started, so filtering on it is also how to ask what is outstanding: ?status=pending,processing returns everything still to settle, and its meta.total is the count — zero means this patient's data has settled.

Authorization

Bearer read
AuthorizationBearer <token>

Each operation lists the OAuth scope (read or write) it requires.

In: header

Scope: read

Path Parameters

patientId*string

ID of the patient

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

Query Parameters

page?|

Zero-indexed page of submissions to return. Defaults to 0.

Range0 <= value
Default0
perPage?integer

Number of submissions per page. Defaults to 100; maximum is 1000.

Range1 <= value <= 1000
Default100
sort?"receivedAt"

Field to sort by. One of: receivedAt. Defaults to receivedAt.

Default"receivedAt"

Value in

  • "receivedAt"
order?string

Sort direction. Defaults to desc.

Default"desc"

Value in

  • "asc"
  • "desc"
status?array<>

Only return submissions in these states. Repeat the parameter or separate with commas.

Items1 <= items

Response Body

application/json

curl -X GET "https://example.com/v1/patients/string/ingestions"
{  "data": [    {      "ingestionId": "string",      "source": "fhir/r4",      "mimeType": "string",      "receivedAt": "string",      "status": "pending",      "staged": {        "facts": 0,        "events": 0,        "narratives": 0      },      "intake": [        {          "unit": "resource",          "received": 0,          "entries": [            {              "kind": "string",              "label": "string",              "count": 1,              "outcome": "structured",              "reason": "unsupported"            }          ]        }      ],      "startedAt": "string",      "completedAt": "string",      "failure": {        "code": "string",        "message": "string"      }    }  ],  "meta": {    "total": 0,    "page": 0,    "perPage": 0  }}

Ingest CDA R2 POST

Submits CDA R2 documents as XML. Post one document as the request body with `Content-Type: application/cda+xml`, or several as `multipart/form-data` with one `documents` part per document. The response is a receipt: ingestion continues after it is returned, so poll the ingestion to follow it. `intake` comes back index-aligned with the documents you sent, so it stays clear which document held what — and if any document cannot be parsed the whole request is rejected and nothing is stored.

Get an ingestion GET

One submission and where its work stands. `status` is derived from the work the submission started, so this is the handle to poll after submitting — it stays valid for the life of that work.