diagnos

REST API

GET /v1/patients

List patients

Published from commit 4eb9d27
GET /v1/patients

One page of patients; rows are anonymous unless summary=true.

Query parameters #

  • security_group string

    Only this security group (default: every group this process may list).

  • include_deleted boolean

    Include documents in the trash.

  • limit integer

    Page size, 1–200.

  • cursor string

    The `next_cursor` of the previous page.

  • summary boolean

    Include each row's decrypted summary (names/tags, or title/modality/date).

Responses #

  • 200 Successful Response

    • items object[] required
    • next_cursor object

  • 400 The vault refused the request as invalid.

    • error object required

      The body of every non-2xx response: what went wrong, for a program and for a person.

  • 401 No client certificate, or the SDK session was rejected or expired (`session_expired`).

    • error object required

      The body of every non-2xx response: what went wrong, for a program and for a person.

  • 402 The workspace has no credit for this.

    • error object required

      The body of every non-2xx response: what went wrong, for a program and for a person.

  • 403 CN not allowed, permission denied, or no key for the data's security group (`group_key_unavailable`).

    • error object required

      The body of every non-2xx response: what went wrong, for a program and for a person.

  • 404 Not found — also a node read under a group it does not belong to.

    • error object required

      The body of every non-2xx response: what went wrong, for a program and for a person.

  • 409 A pending or newer version, a replay, or an upload that never reached storage.

    • error object required

      The body of every non-2xx response: what went wrong, for a program and for a person.

  • 422 The body or query failed validation (`invalid_request`).

    • error object required

      The body of every non-2xx response: what went wrong, for a program and for a person.

  • 429 Rate limited, after the SDK's own backoff gave up.

    • error object required

      The body of every non-2xx response: what went wrong, for a program and for a person.

  • 500 An envelope did not open (`crypto_error`, no detail on purpose).

    • error object required

      The body of every non-2xx response: what went wrong, for a program and for a person.

  • 502 The vault failed, or answered outside the protocol (`protocol_error`).

    • error object required

      The body of every non-2xx response: what went wrong, for a program and for a person.

curl --cert client.crt --key client.key \
  -X GET "https://api.imgexam.com/v1/patients?security_group=<string>&include_deleted=<boolean>&limit=<integer>&cursor=<string>&summary=<boolean>" \
  -H "Content-Type: application/json"
 
{
  "items": [
    {
      "index": {
        "document_id": "string",
        "workspace_id": "string",
        "resource": "patients",
        "security_group_id": "string",
        "encrypted_keys": {},
        "encrypted_index": {},
        "streams": {},
        "meta": {},
        "created_at": "string",
        "created_by": "string",
        "updated_at": "string",
        "updated_by": {},
        "is_archived": false,
        "is_deleted": false
      },
      "summary": {}
    }
  ],
  "next_cursor": {}
}