Queries

Create a Query

Start a query across the health information networks for the patient's records. The query is queued and runs asynchronously; read it with getQuery to see how far it has reached. A person signed in needs a role code on file to start one.

post/patients/{patientId}/queries

Request

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

Path parameters

patientIdstring uuid required

The patient to retrieve records for.

Headers

ProjectIdstring required

The project the patient belongs to.

Response

The query, as queued.

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.