Track asynchronous operations

Availability: proposed. This resource is new public API behavior over service-owned jobs.

Account-erasure, export and stored-document processing initiators return an Operation receipt with an ID. Save that ID so the integration can recover if it misses a webhook.

GET /operations/{operationId}
Authorization: Bearer <backend-access-token>

The initiating integration needs operations:read and the operation-specific authority. A guessed ID or broad scope does not authorize access. Erasure status requires independently authorized access after the patient identity disappears.

States

State Meaning
queued Accepted and awaiting execution.
running An owner is carrying out work.
succeeded The documented live-data operation completed.
failed The operation failed; inspect its safe failure code.
blocked A hold or prerequisite prevents completion.
cancelled The supported cancellation policy ended the operation.

This enum does not promise a public cancel endpoint. Use POST /documents/{documentId}/processing-runs for authorised processing/reprocessing; operator controls remain private.

Results and retained copies

An export result is retrieved through an authorized API reference once ready. Recheck access to every exported category; health:read alone must not reveal restricted transcripts or documents.

Erasure completion describes the specified live-data cleanup. Retained backups, explicit holds and minimal audit evidence are tracked separately. Unknown retention expiry remains explicit. Account unlinking is distinct from erasing a patient's full ENO account.

For document-processing operations, the receipt identifies the accepted documentId, attempt and effective scrubPII policy. document_processing means first-time extraction of a stored document; reprocessing means a subsequent run. Success applies to that specific attempt. A queued receipt reports the selected policy, not completed scrubbing. When scrubbing is newly enabled, it must finish before downstream processing. A later attempt in processing-status cannot establish that an earlier operation succeeded.

Resource availability

For a document's extraction/publication/Atlas readiness, use the processing-status resource. Do not overload operation state with a claim that every downstream snapshot is already available.

Partner API 0.1.0-draft.3 · Draft contract · Sandbox and SDK availability require confirmation.