Ingest FHIR R4

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.

Authorization

Bearer write

AuthorizationBearer <token>

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

In: header

Scope: write

Path Parameters

patientId*string

ID of the patient

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

Request Body

application/json

FHIR R4 Bundle or single resource to ingest.

TypeScript Definitions

Use the request body type in TypeScript.

A FHIR Bundle or a single FHIR resource.

resourceType*string

The FHIR resource type — Bundle for a collection, otherwise the resource's.

Length1 <= length

entry?array<unknown>

A Bundle's entries. Absent when the body is a single resource.

[key: string]?unknown

Response Body

`application/json`

curl -X POST "https://example.com/v1/patients/string/ingestions/fhir/r4" \  -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,    "messages": 0  },  "intake": [    {      "unit": "resource",      "received": 0,      "entries": [        {          "kind": "string",          "label": "string",          "count": 1,          "outcome": "structured",          "reason": "unsupported"        }      ],      "sessionId": "string"    }  ],  "startedAt": "string",  "completedAt": "string",  "failure": {    "code": "string",    "message": "string"  }}

Authorization

Path Parameters

Request Body

Response Body

202application/json

400application/json

404application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`