# Get the patient sidebar summary

Operation ID: `patient.getPatientSidebarPatientSidebar`

Return a compact patient summary (demographics + recent encounters) for rendering the app sidebar. Requires a Bearer JWT (any authenticated pool type).

## Public method

`getPatientSidebar`

Signature: `patient.getPatientSidebar()`

Return type: `Promise<JsonValue>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`GET /patient/sidebar`

## Path parameters

None.

## Query parameters

None.

## Body parameters

None.

Request model: None.

## Request example

None declared in canonical OpenAPI.

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`GetPatientSidebarPatientSidebarResponse`](../models/GetPatientSidebarPatientSidebarResponse.md) | application/json | Patient sidebar |

## Success response examples

### 200

```json
{
  "asOf": "string",
  "ok": true,
  "sidebar": {
    "patient": {
      "active": true,
      "addresses": [],
      "athena_patient_id": "string",
      "athena_practice_id": "string",
      "attributes": {},
      "communications": [
        {
          "language": "string",
          "preferred": false
        }
      ],
      "created_by": "self",
      "created_date": "2026-01-01T09:00:00Z",
      "date_of_birth": "2026-01-01",
      "deceased": false,
      "deceased_cause": "string",
      "deceased_date": "2026-01-01",
      "drivers_license": {
        "expiration_date": "2026-01-01",
        "number": "string",
        "state": "st"
      },
      "email": "user@example.com",
      "emergency_contacts": [],
      "ethnicity": "hispanic_or_latino",
      "fhir_id": "string",
      "flags": {},
      "gender": "male",
      "gender_identity": "man",
      "insurance": [
        {
          "copay": 0,
          "deductible": 0,
          "effective_date": "2026-01-01",
          "group_number": "string",
          "member_id": "string",
          "payer_id": "string",
          "payer_name": "string",
          "plan_name": "string",
          "plan_type": "string",
          "priority": "primary",
          "subscriber_date_of_birth": "2026-01-01",
          "subscriber_first_name": "string",
          "subscriber_id": "string",
          "subscriber_last_name": "string",
          "subscriber_relationship": "self",
          "termination_date": "2026-01-01"
        }
      ],
      "links": [
        {
          "other_patient_fhir_id": "string",
          "type": "seealso"
        }
      ],
      "managing_organization_id": "string",
      "marital_status": "single",
      "mrn": "string",
      "name": {
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "preferred_name": "string",
        "prefix": "string",
        "suffix": "string",
        "use": "official"
      },
      "nationality": "st",
      "openloop_dietitian_id": "string",
      "openloop_patient_id": "string",
      "patient_id": "00000000-0000-0000-0000-000000000000",
      "phones": [],
      "photo_binary_id": "string",
      "preferred_language": "en",
      "preferred_pharmacy": {
        "address_city": "string",
        "address_state": "string",
        "address_street1": "string",
        "address_street2": "string",
        "address_zip": "string",
        "fax": "string",
        "is_mail_order": false,
        "name": "string",
        "ncpdp_id": "string",
        "notes": "string",
        "npi": "string",
        "pharmacy_id": "string",
        "phone": "string"
      },
      "race": [
        "american_indian_or_alaska_native"
      ],
      "sex_at_birth": "male",
      "steadymd_patient_guid": "string",
      "steadymd_program_guid": "string"
    },
    "recent_encounters": [
      {
        "appointment_id": "string",
        "athena_appointment_id": "string",
        "athena_encounter_id": "string",
        "created_by": "self",
        "created_date": "2026-01-01T09:00:00Z",
        "diagnoses": [
          {
            "condition_display": "string",
            "condition_id": "string",
            "rank": 1,
            "use_code": "CC"
          }
        ],
        "encounter_class": "AMB",
        "encounter_id": "00000000-0000-0000-0000-000000000000",
        "fhir_id": "string",
        "hospitalization": {
          "admit_source_code": "string",
          "destination_id": "string",
          "discharge_disposition": "home",
          "origin_id": "string",
          "pre_admission_id": "string",
          "re_admission_code": "string"
        },
        "length_minutes": 0,
        "locations": [
          {
            "location_display": "string",
            "location_id": "string",
            "period_end": "2026-01-01T09:00:00Z",
            "period_start": "2026-01-01T09:00:00Z",
            "status": "active"
          }
        ],
        "notes": "string",
        "openloop_appointment_id": "string",
        "openloop_encounter_id": "string",
        "participants": [
          {
            "participant_type": "PPRF",
            "period_end": "2026-01-01T09:00:00Z",
            "period_start": "2026-01-01T09:00:00Z",
            "practitioner_display": "string",
            "practitioner_id": "string"
          }
        ],
        "patient_id": "string",
        "period_end": "2026-01-01T09:00:00Z",
        "period_start": "2026-01-01T09:00:00Z",
        "priority_code": "string",
        "priority_display": "string",
        "reason_code": "string",
        "reason_display": "string",
        "service_provider_display": "string",
        "service_provider_id": "string",
        "service_type_code": "string",
        "service_type_display": "string",
        "status": "planned",
        "steadymd_consult_guid": "string",
        "steadymd_episode_guid": "string",
        "type_code": "string",
        "type_display": "string"
      }
    ]
  }
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
| `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | No FHIR patient record could be resolved for the caller |
| `500` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Internal server error |

## Error examples

### 401 — Missing or invalid access token

```json
{
  "error": "Authorization required"
}
```

### 404 — Patient not found

```json
{
  "error": "Patient not found"
}
```

### 500 — Unexpected service failure (sanitized example)

```json
{
  "error": "Internal server error"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
```

```ts
const result = await patient.getPatientSidebar();
```

## cURL

```bash
curl -X GET \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  'https://dev-api-patient.health.cloud/patient/sidebar'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.