Register unstructured document

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.

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}$

Query Parameters

wait?|

Block up to this many ms for the execution to reach terminal status. 0 or omitted = return immediately with current status.

Range0 <= value <= 30000

Request Body

application/json

Document registration payload containing the file name and optional MIME type.

TypeScript Definitions

Use the request body type in TypeScript.

Registration payload for an unstructured document.

name*string

File name of the document, including extension. Used as the source label in the ingest status and execution history.

Length1 <= length

mimeType?string

MIME type of the document (e.g., application/pdf, text/plain). Used to determine how the document is stored and referenced.

Response Body

`application/json`

curl -X POST "https://example.com/v1/patients/string/ingest/document" \  -H "Content-Type: application/json" \  -d '{    "name": "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"  }}