Transactional API
Workflow
The Workflow section of the Transactional API covers operational filing scenarios: actions a clinical system takes after a clinician has reviewed and acted on a result, not just reading or creating data.
All Workflow endpoints share the same authentication and error model as the rest of the Transactional API.
Investigation report filing
Four endpoints support the investigation report filing workflow:
| Endpoint | Method | Purpose |
|---|---|---|
| List Unfiled Investigation Reports | GET | Returns all PENDING reports that can be filed via the API (excludes free-text results). |
| Get Investigation Report | GET | Returns full detail for a single PENDING report, including groups, results, and existing filing comments. |
| List Unfulfilled Investigation Requests | GET | Returns outstanding investigation request items for a patient, so they can be offered as options to mark fulfilled on filing. |
| File Investigation Report | POST | Files the report, optionally attaching comments to groups or results, and marking request items as fulfilled. |
A typical integration follows this order:
- List Unfiled Investigation Reports: find all reports awaiting action.
- Get Investigation Report: fetch the full detail of a chosen report to display to the user.
- List Unfulfilled Investigation Requests (optional): if your integration offers the option to mark investigation request items as fulfilled on filing, call this to retrieve the outstanding requests for the patient, then present them for the user to select.
- File Investigation Report: file the report, passing any filing comments and fulfilled request item IDs.