Ingest CDA
Submits a CDA/C-CDA XML document for ingestion. Body must be text/plain. Returns an IngestExecutionEnvelope immediately; use ?wait=<ms> to block until terminal status.
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
text/plain
CDA/C-CDA XML document to ingest. Must be a non-empty XML string.
TypeScript Definitions
Use the request body type in TypeScript.
CDA/C-CDA XML document
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/patients/string/ingest/cda" \ -H "Content-Type: text/plain" \ -d 'string'{ "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" }}Ingest FHIR R4 POST
Submits a FHIR R4 Bundle or single resource for ingestion. Returns an `IngestExecutionEnvelope` immediately with status `pending` or `running`. Pass `?wait=<ms>` (max 30 000) to block until the execution reaches a terminal status. Multiple ingest calls for the same registry key accumulate sources; entity resolution re-runs after each call.
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.