Queries

Get a Query

Read one query, to see how far the retrieval of the patient's clinical documents has reached.

get/queries/{queryId}

Request

  • Base URL: https://api.xcures.com/v3
  • URL: https://api.xcures.com/v3/queries/{queryId}
  • Auth: HTTP bearer

Path parameters

queryIdstring uuid required

The query's id.

Headers

ProjectIdstring required

The project the query's patient belongs to.

Response

The query.

idstring uuid required

The query's id.

patientIdstring uuid required

The patient the query retrieves records for.

createdAtstring date-time required

When the query was created.

status'delayed' | 'initiated' | 'pending' | 'inProgress' | 'completed' | 'exhausted' | 'error' required

How far the retrieval of the patient's clinical documents has reached. completed, exhausted and error are terminal; the others mean the query is still running or waiting to run.

Changes

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