Skip to main content
GET
Retrieve a Task.

Authorizations

Authorization
string
header
required

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

Query Parameters

uuid
string<uuid> | null

The UUID of the task to retrieve.

external_id
string | null

The external task ID of the task to retrieve.

Maximum string length: 1024

Response

Successful Response

uuid
string<uuid>
required

A unique ID for the Task.

task_type
string
required

A Task's type. Determines what kind of processing is performed on the input data.

status
enum<string>
required

Current state of a task.

  • pending: The task is waiting to be processed.
  • processing: The task is currently being processed.
  • waiting: The task is waiting for additional input.
  • completed: The task has completed processing.
  • failed: An error occurred while the task was being processed.
  • invalid: The data uploaded does not provide any information pertaining to the task to be performed.
  • deferred: The bulk processing task has been put into a deferred state due to high load
Available options:
pending,
processing,
waiting,
completed,
failed,
invalid,
deferred
name
string
required

A user friendly name, based on information extracted from inputs.

cleared
string<date-time> | null
required

cleared can be set to a timestamp indicating when follow-ups (work external to Synthpop) related to this Task have been completed. Initialized to null upon Task creation.

created
string<date-time>
required

Timestamp indicating when this task was created.

latest_status_change
string<date-time>
required

Timestamp indicating when the latest status change for this task occurred. This indicates when a Task entered processing, waiting, completed or failed state. For pending tasks this is set to the same value as created.

category
string | null
required

Suggested task category, as determined by the medical records found.

data_items
(DataItemFile · object | DataItemJSON · object | DataItemText · object)[]
required
issues
(TaskIssueGenericLLM · object | TaskIssueGenericLogic · object | TaskIssueGenericWarning · object | TaskIssueDataMissing · object | TaskIssueMissingRecord · object | TaskIssueIncorrectDocumentSequence · object | TaskIssueInconsistentData · object | TaskIssueExpired · object | MedicalRecordIssueDataMissing · object)[]
required

Issues detected with this task or any medical records of it.

A generic task issue reported by the LLM.

external_id
string | null

An optional third party assigned ID for the task.

Maximum string length: 1024
verdicts
Verdict · object[]

List of verdicts for the task.

interceptions
Interceptions · object | null

Optional interception data including structured_data with pages-details.

verdict_summaries
VerdictSummary · object[]

Per-code referral-validation conclusion summaries.