---
title: "Look up a patient"
description: "SIIPS's record of the patient with that document number, and, when history asks for it, the patient's agenda (each appointment with the reference visoft.appointments.cancel takes) and admissions. found:false is an answer, not a failure. The record is cached for five minutes (refresh reads SIIPS again); the agenda is read for every call.\n\n- **Scopes:** any one of `visoft:appointments:read`, `visoft:appointments:write`\n- **Credentials:** an API key, a client-credentials token or a person's access token\n- **Effect:** read-only; safe to retry\n- **Limits:** request body up to 64 KB, response up to 1 MB\n- **CLI:** `arbol visoft patients lookup` · **MCP tool:** `visoft_patients_lookup`"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.getarbol.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Visoft API › Patients

`POST /v1/visoft/patients/lookup`

SIIPS's record of the patient with that document number, and, when history asks for it, the patient's agenda (each appointment with the reference visoft.appointments.cancel takes) and admissions. found:false is an answer, not a failure. The record is cached for five minutes (refresh reads SIIPS again); the agenda is read for every call.

- **Scopes:** any one of `visoft:appointments:read`, `visoft:appointments:write`
- **Credentials:** an API key, a client-credentials token or a person's access token
- **Effect:** read-only; safe to retry
- **Limits:** request body up to 64 KB, response up to 1 MB
- **CLI:** `arbol visoft patients lookup` · **MCP tool:** `visoft_patients_lookup`

## Authentication

Requires one of the following:

- `arbolHuman`, oauth2, scopes: `visoft:appointments:read`
- `arbolHuman`, oauth2, scopes: `visoft:appointments:write`
- `arbolMachine`, oauth2, scopes: `visoft:appointments:read`
- `arbolMachine`, oauth2, scopes: `visoft:appointments:write`
- `arbolApiKey`, http, header `Authorization`

## Request body

_Required._

- `documentNumber` (`visoft.patients.lookup.documentNumber`; string, required) — The patient's document number: letters and digits only, without dots, spaces or hyphens.
  - pattern `^[A-Za-z0-9]{1,20}$`
- `connectionId` (`visoft.patients.lookup.connectionId`; string, optional) — The connection to run on. Optional when the organization has one Visoft connection; required when it has several. Another organization's connection is CONNECTION_NOT_FOUND.
  - minLength 5; maxLength 68; pattern `^con_[0-9A-Za-z]+$`
- `history` (`visoft.patients.lookup.history`; string, optional) — none (the default): the record alone. current: also the patient's current agenda and admissions. all: past appointments too.
  - one of `"none"`, `"current"`, `"all"`
- `refresh` (`visoft.patients.lookup.refresh`; boolean, optional) — Read SIIPS again instead of the connection's cache (contracts 12 h, services 6 h, professionals 1 h, a patient 5 min).

## Example request

```json
{
  "connectionId": "string",
  "documentNumber": "string",
  "history": "none",
  "refresh": true
}
```

## Code samples

### cURL

```bash
curl https://api.getarbol.com/v1/visoft/patients/lookup \
  --request POST \
  --header "Authorization: Bearer $ARBOL_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "documentNumber": "<documentNumber>"
}'
```

### TypeScript

```typescript
import { createClient } from "@arbol-ai/sdk";

const arbol = createClient({
  baseUrl: "https://api.getarbol.com",
  token: process.env.ARBOL_API_KEY!,
});

const { data } = await arbol.visoft.patients.lookup({
  documentNumber: "<documentNumber>",
});
```

### Rust

```rust
use arbol_sdk::{types, Client, Credential};

let arbol = Client::new(Credential::ApiKey(std::env::var("ARBOL_API_KEY")?))?;

let data = arbol
    .visoft()
    .patients()
    .lookup(&types::VisoftPatientsLookupInput {
        document_number: "<documentNumber>".into(),
        connection_id: None,
        history: None,
        refresh: None,
    })
    .await?;
```

### CLI

```bash
arbol visoft patients lookup --document-number '<documentNumber>'
```

### MCP

```json
{
  "name": "visoft_patients_lookup",
  "arguments": {
    "documentNumber": "<documentNumber>"
  }
}
```

## Responses

### 200

Successful operation.

#### Example

```json
{
  "success": true,
  "data": {
    "found": true,
    "patient": {
      "documentType": "string",
      "documentNumber": "string",
      "firstName1": "string",
      "firstName2": "string",
      "lastName1": "string",
      "lastName2": "string",
      "fullName": "string",
      "birthDate": "string",
      "sex": "string",
      "genderIdentity": "string",
      "sexualOrientation": "string",
      "maritalStatus": "string",
      "phoneMobile": "string",
      "phoneOffice": "string",
      "email": "string",
      "address": "string",
      "zone": "string",
      "country": "string",
      "departmentCode": "string",
      "departmentName": "string",
      "municipalityCode": "string",
      "cityName": "string",
      "neighborhoodCode": "string",
      "affiliateType": "string",
      "stratum": "string",
      "status": "string",
      "populationCode": "string",
      "populationGroupCode": "string",
      "professionCode": "string",
      "educationCode": "string",
      "occupation": "string",
      "ethnicity": "string",
      "disabilityPhysical": "string",
      "disabilityMental": "string",
      "disabilityPsychiatric": "string",
      "chronicHypertension": "string",
      "chronicHypertensionSince": "string",
      "chronicDiabetes": "string",
      "chronicDiabetesSince": "string",
      "chronicRenal": "string",
      "chronicRenalSince": "string",
      "latitude": "string",
      "longitude": "string",
      "providerMessage": "string"
    },
    "history": {
      "appointments": [
        {
          "reference": "string",
          "scheduleId": "string",
          "agencyCode": "string",
          "contractCode": "string",
          "specialty": "string",
          "service": "string",
          "professionalId": "string",
          "professionalName": "string",
          "visitType": "string",
          "startsAt": "2019-08-24T14:15:22Z",
          "admissionNumber": "string",
          "attended": "string",
          "purpose": "string",
          "resource": "string",
          "subCostCenter": "string",
          "tag": "string",
          "web": "string",
          "phone": "string",
          "patientSummary": "string"
        }
      ],
      "admissions": [
        {
          "admissionNumber": "string",
          "agencyCode": "string",
          "date": "string",
          "professionalId": "string",
          "specialty": "string",
          "status": "string"
        }
      ]
    }
  },
  "error": null,
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.200.success`; boolean, required)
  - one of `true`
- `data` (`visoft.patients.lookup.response.200.data`; object, required)
  - `found` (`visoft.patients.lookup.response.200.data.found`; boolean, required) — Whether SIIPS has a patient with that document.
  - `patient` (`visoft.patients.lookup.response.200.data.patient`; any of, required) — The record; null when not found.
    - any of: `VisoftPatient`, `null`
  - `history` (`visoft.patients.lookup.response.200.data.history`; any of, required) — The agenda and admissions, when history asked for them and the patient was found.
    - any of: `VisoftPatientHistory`, `null`
- `error` (`visoft.patients.lookup.response.200.error`; unknown, required)
- `metadata` (`visoft.patients.lookup.response.200.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.200.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 400

`INVALID_INPUT`: The request does not match the published schema.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INVALID_INPUT",
    "message": "string",
    "retryable": false,
    "data": {
      "issues": [
        {
          "path": "string",
          "message": "string"
        }
      ]
    }
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.400.success`; boolean, required)
  - one of `false`
- `data` (`visoft.patients.lookup.response.400.data`; unknown, required)
- `error` (`visoft.patients.lookup.response.400.error`; object, required) — The request does not match the published schema.
  - `code` (`visoft.patients.lookup.response.400.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INVALID_INPUT"`
  - `message` (`visoft.patients.lookup.response.400.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.patients.lookup.response.400.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.patients.lookup.response.400.error.data`; object, required)
    - `issues` (`visoft.patients.lookup.response.400.error.data.issues`; array<object>, optional)
      - `path` (`visoft.patients.lookup.response.400.error.data.issues.path`; string, required) — RFC 6901 JSON Pointer to the refused field; empty for the whole input.
        - maxLength 256
      - `message` (`visoft.patients.lookup.response.400.error.data.issues.message`; string, required)
        - maxLength 256
- `metadata` (`visoft.patients.lookup.response.400.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.400.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 401

`UNAUTHORIZED`: A valid access token is required.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.401.success`; boolean, required)
  - one of `false`
- `data` (`visoft.patients.lookup.response.401.data`; unknown, required)
- `error` (`visoft.patients.lookup.response.401.error`; object, required) — A valid access token is required.
  - `code` (`visoft.patients.lookup.response.401.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNAUTHORIZED"`
  - `message` (`visoft.patients.lookup.response.401.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.patients.lookup.response.401.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.patients.lookup.response.401.error.data`; object, required) — No fields.
- `metadata` (`visoft.patients.lookup.response.401.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.401.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 403

`FORBIDDEN`: The token does not authorize this operation.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "FORBIDDEN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.403.success`; boolean, required)
  - one of `false`
- `data` (`visoft.patients.lookup.response.403.data`; unknown, required)
- `error` (`visoft.patients.lookup.response.403.error`; object, required) — The token does not authorize this operation.
  - `code` (`visoft.patients.lookup.response.403.error.code`; string, required) — The failure code, stable across releases.
    - one of `"FORBIDDEN"`
  - `message` (`visoft.patients.lookup.response.403.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.patients.lookup.response.403.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.patients.lookup.response.403.error.data`; object, required) — No fields.
- `metadata` (`visoft.patients.lookup.response.403.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.403.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 404

`CONNECTION_NOT_FOUND`: The organization has no such connection.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "CONNECTION_NOT_FOUND",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.404.success`; boolean, required)
  - one of `false`
- `data` (`visoft.patients.lookup.response.404.data`; unknown, required)
- `error` (`visoft.patients.lookup.response.404.error`; object, required) — The organization has no such connection.
  - `code` (`visoft.patients.lookup.response.404.error.code`; string, required) — The failure code, stable across releases.
    - one of `"CONNECTION_NOT_FOUND"`
  - `message` (`visoft.patients.lookup.response.404.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.patients.lookup.response.404.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.patients.lookup.response.404.error.data`; object, required) — No fields.
- `metadata` (`visoft.patients.lookup.response.404.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.404.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 409

`CONNECTION_NOT_CONFIGURED`: The organization has no active Visoft connection for this call; an administrator connects Visoft in Account.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "CONNECTION_NOT_CONFIGURED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.409.success`; boolean, required)
  - one of `false`
- `data` (`visoft.patients.lookup.response.409.data`; unknown, required)
- `error` (`visoft.patients.lookup.response.409.error`; object, required) — The organization has no active Visoft connection for this call; an administrator connects Visoft in Account.
  - `code` (`visoft.patients.lookup.response.409.error.code`; string, required) — The failure code, stable across releases.
    - one of `"CONNECTION_NOT_CONFIGURED"`
  - `message` (`visoft.patients.lookup.response.409.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.patients.lookup.response.409.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.patients.lookup.response.409.error.data`; object, required) — No fields.
- `metadata` (`visoft.patients.lookup.response.409.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.409.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 413

`REQUEST_TOO_LARGE`: The request exceeds the allowed size.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "REQUEST_TOO_LARGE",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.413.success`; boolean, required)
  - one of `false`
- `data` (`visoft.patients.lookup.response.413.data`; unknown, required)
- `error` (`visoft.patients.lookup.response.413.error`; object, required) — The request exceeds the allowed size.
  - `code` (`visoft.patients.lookup.response.413.error.code`; string, required) — The failure code, stable across releases.
    - one of `"REQUEST_TOO_LARGE"`
  - `message` (`visoft.patients.lookup.response.413.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.patients.lookup.response.413.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.patients.lookup.response.413.error.data`; object, required) — No fields.
- `metadata` (`visoft.patients.lookup.response.413.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.413.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 415

`UNSUPPORTED_MEDIA_TYPE`: The request content type is not supported.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.415.success`; boolean, required)
  - one of `false`
- `data` (`visoft.patients.lookup.response.415.data`; unknown, required)
- `error` (`visoft.patients.lookup.response.415.error`; object, required) — The request content type is not supported.
  - `code` (`visoft.patients.lookup.response.415.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNSUPPORTED_MEDIA_TYPE"`
  - `message` (`visoft.patients.lookup.response.415.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.patients.lookup.response.415.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.patients.lookup.response.415.error.data`; object, required) — No fields.
- `metadata` (`visoft.patients.lookup.response.415.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.415.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 422

`CREDENTIALS_REJECTED`: The organization's connection to this integration couldn't complete the request. Don't retry it automatically; if it keeps happening, contact your Arbol team.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "CREDENTIALS_REJECTED",
    "message": "string",
    "retryable": false
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.422.success`; boolean, required)
  - one of `false`
- `data` (`visoft.patients.lookup.response.422.data`; unknown, required)
- `error` (`visoft.patients.lookup.response.422.error`; object, required) — The organization's connection to this integration couldn't complete the request. Don't retry it automatically; if it keeps happening, contact your Arbol team.
  - `code` (`visoft.patients.lookup.response.422.error.code`; string, required) — The failure code, stable across releases.
    - one of `"CREDENTIALS_REJECTED"`
  - `message` (`visoft.patients.lookup.response.422.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.patients.lookup.response.422.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
- `metadata` (`visoft.patients.lookup.response.422.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.422.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 429

`RATE_LIMITED`: The request rate limit was exceeded. Try again later.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RATE_LIMITED",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.429.success`; boolean, required)
  - one of `false`
- `data` (`visoft.patients.lookup.response.429.data`; unknown, required)
- `error` (`visoft.patients.lookup.response.429.error`; object, required) — The request rate limit was exceeded. Try again later.
  - `code` (`visoft.patients.lookup.response.429.error.code`; string, required) — The failure code, stable across releases.
    - one of `"RATE_LIMITED"`
  - `message` (`visoft.patients.lookup.response.429.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.patients.lookup.response.429.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`visoft.patients.lookup.response.429.error.data`; object, required) — No fields.
- `metadata` (`visoft.patients.lookup.response.429.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.429.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 500

`INTERNAL_ERROR`: The service could not complete the operation.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.500.success`; boolean, required)
  - one of `false`
- `data` (`visoft.patients.lookup.response.500.data`; unknown, required)
- `error` (`visoft.patients.lookup.response.500.error`; object, required) — The service could not complete the operation.
  - `code` (`visoft.patients.lookup.response.500.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INTERNAL_ERROR"`
  - `message` (`visoft.patients.lookup.response.500.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.patients.lookup.response.500.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.patients.lookup.response.500.error.data`; object, required) — No fields.
- `metadata` (`visoft.patients.lookup.response.500.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.500.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 502

- `OUTCOME_UNKNOWN`: The operation may have been applied; check its result before repeating it.
- `PROVIDER_UNAVAILABLE`: The clinical system did not answer or could not complete the request.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "OUTCOME_UNKNOWN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.502.success`; boolean, required)
  - one of `false`
- `data` (`visoft.patients.lookup.response.502.data`; unknown, required)
- `error` (`visoft.patients.lookup.response.502.error`; one of, required)
  - one of: `OutcomeUnknownFailure`, `VisoftProviderUnavailableFailure`
  - discriminator: `code`
- `metadata` (`visoft.patients.lookup.response.502.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.502.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 503

`UPSTREAM_UNAVAILABLE`: The upstream service could not complete the request.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_UNAVAILABLE",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.503.success`; boolean, required)
  - one of `false`
- `data` (`visoft.patients.lookup.response.503.data`; unknown, required)
- `error` (`visoft.patients.lookup.response.503.error`; object, required) — The upstream service could not complete the request.
  - `code` (`visoft.patients.lookup.response.503.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UPSTREAM_UNAVAILABLE"`
  - `message` (`visoft.patients.lookup.response.503.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.patients.lookup.response.503.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`visoft.patients.lookup.response.503.error.data`; object, required) — No fields.
- `metadata` (`visoft.patients.lookup.response.503.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.503.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 504

`UPSTREAM_TIMEOUT`: The upstream service did not respond before its deadline.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_TIMEOUT",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.patients.lookup.response.504.success`; boolean, required)
  - one of `false`
- `data` (`visoft.patients.lookup.response.504.data`; unknown, required)
- `error` (`visoft.patients.lookup.response.504.error`; object, required) — The upstream service did not respond before its deadline.
  - `code` (`visoft.patients.lookup.response.504.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UPSTREAM_TIMEOUT"`
  - `message` (`visoft.patients.lookup.response.504.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.patients.lookup.response.504.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`visoft.patients.lookup.response.504.error.data`; object, required) — No fields.
- `metadata` (`visoft.patients.lookup.response.504.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.patients.lookup.response.504.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.


Source: https://docs.getarbol.com/api/visoft/patients/lookup/index.md