Encounters
FHIR EncounterFHIR R4 Encounter resources representing patient visits, admissions, telehealth sessions, and care events.
The Encounter Object
| Field | Type | Description |
|---|---|---|
| id | string | FHIR logical ID for the Encounter resource |
| resourceType | string | Always "Encounter" per FHIR R4 spec |
| status | string | FHIR status: planned | arrived | triaged | in-progress | finished | cancelled |
| class | Coding | Encounter class code: AMB (ambulatory), IMP (inpatient), VR (virtual) |
| type | CodeableConcept[] | Type of encounter (e.g. office visit, telehealth, emergency) |
| subject | Reference | Reference to the Patient resource |
| participant | object[] | Practitioners who participated in the encounter |
| period | Period | Start and end datetime of the encounter |
| reasonCode | CodeableConcept[] | Coded reason for the encounter (ICD-10/SNOMED) |
Endpoints
Returns FHIR Encounter resources for a patient.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| patiente.g. Patient/pat_demo_001 | query | string | required | Patient ID |
| datee.g. ge2026-01-01 | query | string | optional | Date range filter |
| statuse.g. finished | query | string | optional | FHIR status |
Request
curl "https://api.healthcloud.ai/v1/encounters?patient=Patient/pat_demo_001" \ -H "Authorization: Bearer hc_test_sk_demo_live_xxxxxx"
Response
Response200
{ "resourceType": "Bundle", "type": "searchset", "total": 12, "entry": [ { "resource": { "resourceType": "Encounter", "id": "enc_001", "status": "finished", "class": { "code": "AMB" }, "subject": { "reference": "Patient/pat_demo_001" }, "period": { "start": "2026-02-14T09:00:00Z", "end": "2026-02-14T09:30:00Z" } } } ] }