API ReferenceIngestion

Get case status

Preview

Retrieve the ingestion status of a single case by the caseId you submitted. Resolved within your organization (the caseId need only be unique to you). Cases are retained for at least 24 hours after creation.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

caseIdstringRequired
The case identifier you submitted in the ingestion row.

Headers

Orchestra-VersionstringOptional

Optional date-based API version (e.g. 2026-07-13). When omitted, the version pinned to your client at onboarding is used.

Response

The case.
caseIdstring

The case identifier — the value you submitted, and the case’s canonical id. Reconciles to the underlying surgery; no separate surgery id is exposed.

jobIdstringformat: "uuid"
The batch this case was submitted in.
statusenum

Per-case lifecycle state. created (accepted/queued), processing (being reconciled), completed (successfully ingested), failed (errored — see error).

createdAtdatetime
updatedAtdatetime
surgeryTypestringOptional
serviceLinestringOptional
dateOfServicedateOptional
surgeonNamestringOptional
facilityobjectOptional

Public projection of the Orchestra Facility model.

workflowenumOptional
The workflow Orchestra assigned to the surgery.
recommendedCareSettingenumOptional
archivedbooleanOptional
patientobjectOptional

The resolved patient record. Present once status is completed.

errorobjectOptional

Present only when status is failed. RFC 9457 problem shape.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error