Batch ingest
Submits FHIR bundles, CDA documents, and unstructured document registrations in a single request. Each source type is processed independently; the graph is rebuilt once after all sources are loaded.
Authorization
Bearer writeEach operation lists the OAuth scope (read or write) it requires.
In: header
Scope: write
Path Parameters
ID of the patient
^[A-Za-z0-9._-]{1,128}$Query Parameters
Block up to this many ms for the execution to reach terminal status. 0 or omitted = return immediately with current status.
0 <= value <= 30000Request Body
application/json
Batch payload containing any combination of FHIR bundles, CDA documents, and document registrations. At least one of fhir, cda, or documents must be non-empty.
TypeScript Definitions
Use the request body type in TypeScript.
Mixed batch of FHIR bundles, CDA documents, and unstructured document registrations to process in a single ingest request.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/patients/string/ingest" \ -H "Content-Type: application/json" \ -d '{}'{ "executionId": "string", "status": "pending", "sourceLabel": "fhir", "deltas": { "entitiesAdded": 0, "eventsAdded": 0, "relsAdded": 0 }, "warningsCount": 0, "error": { "code": "string", "message": "string" }, "skippedReason": "string", "patient": { "id": "string", "name": "string" }, "links": { "self": "string", "patient": "string" }}Register unstructured document POST
Registers an unstructured document by name and MIME type. Used for documents that cannot be parsed as FHIR or CDA (e.g., PDFs). The document is tracked as an ingest source but does not contribute extracted clinical entities.
Get ingest status GET
Returns whether the patient graph is ready to query, per-source extraction stats, aggregate load stats, and extraction warnings that did not halt ingestion. Poll this endpoint after a fire-and-forget ingest call.