Checklists

Create a Checklist Evaluation Job

Start a job that evaluates the checklist for each patient. You may read its status and retrieve the results by using the jobId it returns.

post/checklists/{checklistId}/evaluation-jobs

Request

  • Base URL: https://api.xcures.com/v3
  • URL: https://api.xcures.com/v3/checklists/{checklistId}/evaluation-jobs
  • Auth: HTTP bearer

Path parameters

checklistIdstring uuid required

The checklist's id.

Headers

ProjectIdstring required

The project the request acts in; one of the projects your credential spans.

Request body

jobNamestring

A name of your choosing for the job; a default naming the checklist and the patient count when absent.

Response

The job, queued.

jobIdstring uuid required

The job's id; read its status and results with it.

checklistIdstring uuid required

The checklist the job evaluates.

jobNamestring required

The job's name.

status'queued' | 'running' | 'cancelling' | 'completed' | 'partially_completed' | 'failed' | 'cancelled' required

Where the job is; completed, partially_completed, failed and cancelled are terminal.

patientCountinteger required

The number of patients the job evaluates.

succeededCountinteger required

The number of patients whose evaluation succeeded so far.

failedCountinteger required

The number of patients whose evaluation failed so far.

submittedAtstring date-time required

When the job was started.

startedAtstring date-time

When evaluation began; absent before it has.

completedAtstring date-time

When the job reached a terminal status; absent before it has.

resultsExpiresAtstring date-time

Until when the job's results can be read; absent before the job completes.

Changes

No recorded changes to this operation across all 1 revision of this API.