Ingest FHIR R5
Submits a FHIR R5 Bundle or a single resource. The response is a receipt: ingestion continues after it is returned, so poll the ingestion to follow it. The version is part of the path because a Bundle does not state which FHIR release it is written against.
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}$Request Body
application/json
FHIR R5 Bundle or single resource to ingest.
TypeScript Definitions
Use the request body type in TypeScript.
A FHIR Bundle or a single FHIR resource.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/patients/string/ingestions/fhir/r5" \ -H "Content-Type: application/json" \ -d '{ "resourceType": "string", "property1": null, "property2": null }'{ "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" }}Ingest FHIR R4 POST
Submits a FHIR R4 Bundle or a single resource. The response is a receipt: extraction continues after it is returned, so poll the ingestion to follow it. The version is part of the path because a Bundle does not state which FHIR release it is written against.
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.