# Encounter

Model ID: `fieldagent.Encounter`

No description.

Type: `object`

## Fields

| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `appointment_id` | `string|null` | No |  |  |  | Yes | FHIR Appointment id this encounter fulfills, when linked. |
| `athena_appointment_id` | `string|null` | No |  |  |  | Yes | Athena Health appointment id this encounter was checked in from, when checked in via Athena. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
| `athena_encounter_id` | `string|null` | No |  |  |  | Yes | Athena Health encounter id this encounter is linked to, when checked in via Athena. |
| `created_by` | `string` | No |  |  | `"self"` | No | Person FHIR resource ID of the creating field agent, or 'self' |
| `created_date` | `string|null` | No |  |  |  | Yes | UTC datetime when the encounter was created |
| `diagnoses` | array of [`fieldagent.EncounterDiagnosis`](./fieldagent.EncounterDiagnosis.md) | No |  |  |  | No | Diagnoses recorded for this encounter, ranked by rank. |
| `encounter_class` | [`EncounterClass`](./EncounterClass.md) | No |  |  | `"AMB"` | No | Encounter class: AMB (ambulatory), EMER (emergency), FLD (field), HH (home health), ACUTE, NONAC, OBSENC, PRENC, SS, or VR (virtual). |
| `encounter_id` | `string` | No | uuid |  |  | No | HealthCloud encounter identifier (UUID). |
| `fhir_id` | `string|null` | No |  |  |  | Yes | FHIR Encounter resource id, when stored. |
| `hospitalization` | [`fieldagent.EncounterHospitalization`](./fieldagent.EncounterHospitalization.md) | No |  |  |  | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
| `length_minutes` | `integer|null` | No |  |  |  | Yes | Duration of the encounter in minutes, when known. |
| `locations` | array of [`fieldagent.EncounterLocation`](./fieldagent.EncounterLocation.md) | No |  |  |  | No | Locations where the encounter takes place, with status and period. |
| `notes` | `string|null` | No |  |  |  | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
| `openloop_appointment_id` | `string|null` | No |  |  |  | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
| `openloop_encounter_id` | `string|null` | No |  |  |  | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
| `participants` | array of [`fieldagent.EncounterParticipant`](./fieldagent.EncounterParticipant.md) | No |  |  |  | No | Practitioners participating in the encounter, with their roles. |
| `patient_id` | `string` | Yes |  |  |  | No | FHIR Patient id who is the subject of the encounter. |
| `period_end` | `string|null` | No |  |  |  | Yes | When the encounter ended, when recorded. |
| `period_start` | `string|null` | No |  |  |  | Yes | When the encounter started, when recorded. |
| `priority_code` | `string|null` | No |  |  |  | Yes | Code for the encounter priority (e.g. routine, urgent, emergent), when coded. |
| `priority_display` | `string|null` | No |  |  |  | Yes | Display text for the encounter priority, when available. |
| `reason_code` | `string|null` | No |  |  |  | Yes | SNOMED CT code for the reason for the encounter, when coded. |
| `reason_display` | `string|null` | No |  |  |  | Yes | Display text for the reason for the encounter, when available. |
| `service_provider_display` | `string|null` | No |  |  |  | Yes | Display name of the service provider organization, when available. |
| `service_provider_id` | `string|null` | No |  |  |  | Yes | FHIR Organization id of the service provider, when linked. |
| `service_type_code` | `string|null` | No |  |  |  | Yes | SNOMED CT code for the service type, when coded. |
| `service_type_display` | `string|null` | No |  |  |  | Yes | Display text for the service type, when available. |
| `status` | [`EncounterStatus`](./EncounterStatus.md) | No |  |  | `"planned"` | No | Encounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled, entered-in-error, or unknown. |
| `steadymd_consult_guid` | `string|null` | No |  |  |  | Yes | SteadyMD consult guid this encounter was checked in from, when checked in via SteadyMD. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
| `steadymd_episode_guid` | `string|null` | No |  |  |  | Yes | SteadyMD episode guid this encounter is linked to, when checked in via SteadyMD. |
| `type_code` | `string|null` | No |  |  |  | Yes | SNOMED CT code for the encounter type (e.g. office visit, follow-up), when coded. |
| `type_display` | `string|null` | No |  |  |  | Yes | Display text for the encounter type, when available. |

## Example

None declared in canonical OpenAPI.