# Check in an encounter via the tenant's connected EHR

Operation ID: `patient.checkInEncounter`

Check in an encounter via the tenant's connected EHR

## Public method

`checkInEncounter`

Signature: `patient.checkInEncounter(encounterId, request)`

Return type: `Promise<CheckInEncounterResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /encounters/{encounter_id}/check-in`

## Path parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `encounter_id` | `string` | Yes |  |  |  | No |  |

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`CheckInEncounterRequest`](../models/CheckInEncounterRequest.md) | Yes |  |  |  | No |  |

Request model: [`CheckInEncounterRequest`](../models/CheckInEncounterRequest.md)

## Request example

```json
{
  "appointment_id": "string"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`CheckInEncounterResponse`](../models/CheckInEncounterResponse.md) | application/json | Encounter checked in and linked to the EHR encounter, plus athena_patient_id |

## Success response examples

### 200

```json
{
  "appointment_id": "string",
  "athena_appointment_id": "string",
  "athena_encounter_id": "string",
  "athena_patient_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",
  "openloop_encounter_status": "linked",
  "openloop_patient_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

None declared in canonical OpenAPI.

## Error examples

None declared in canonical OpenAPI.

## NodeJS / TypeScript implementation

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

```ts
const encounterId = "<ENCOUNTER_ID>";

const request = {
  "appointment_id": "string"
};

const result = await patient.checkInEncounter(encounterId, request);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"appointment_id":"string"}' \
  'https://dev-api-patient.health.cloud/encounters/%3CENCOUNTER_ID%3E/check-in'
```

## 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.