# OnboardEncounterPayload

Model ID: `OnboardEncounterPayload`

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, optional. |
| `created_date` | `string|null` | No |  |  |  | Yes | ISO 8601 datetime |
| `diagnoses` | array of [`fieldagent.EncounterDiagnosis`](./fieldagent.EncounterDiagnosis.md) | No |  |  |  | No | Diagnoses associated with the encounter. |
| `encounter_class` | [`EncounterClass`](./EncounterClass.md) | No |  |  | `"AMB"` | No | FHIR encounter class, e.g. ambulatory. |
| `encounter_id` | `string|null` | No |  |  |  | Yes | UUID; server-generated if omitted. |
| `fhir_id` | `string|null` | No |  |  |  | Yes | FHIR id; server-generated on create, so normally omitted here. |
| `hospitalization` | [`fieldagent.EncounterHospitalization`](./fieldagent.EncounterHospitalization.md) | No |  |  |  | Yes | Hospitalization details, when applicable. |
| `length_minutes` | `integer|null` | No |  |  |  | Yes | Encounter duration in minutes, optional. |
| `locations` | array of [`fieldagent.EncounterLocation`](./fieldagent.EncounterLocation.md) | No |  |  |  | No | Locations where the encounter took place. |
| `participants` | array of [`fieldagent.EncounterParticipant`](./fieldagent.EncounterParticipant.md) | No |  |  |  | No | Practitioners or other participants involved in the encounter. |
| `period_end` | `string|null` | No |  |  |  | Yes | ISO 8601 datetime |
| `period_start` | `string|null` | No |  |  |  | Yes | ISO 8601 datetime |
| `priority_code` | `string|null` | No |  |  |  | Yes | Coded encounter priority, optional. |
| `priority_display` | `string|null` | No |  |  |  | Yes | Display text for priority_code, optional. |
| `reason_code` | `string|null` | No |  |  |  | Yes | Coded reason for the encounter, optional. |
| `reason_display` | `string|null` | No |  |  |  | Yes | Display text for reason_code, optional. |
| `service_provider_display` | `string|null` | No |  |  |  | Yes | Display text for service_provider_id, optional. |
| `service_provider_id` | `string|null` | No |  |  |  | Yes | FHIR Organization id of the servicing provider, optional. |
| `service_type_code` | `string|null` | No |  |  |  | Yes | Coded clinical service type, optional. |
| `service_type_display` | `string|null` | No |  |  |  | Yes | Display text for service_type_code, optional. |
| `status` | [`EncounterStatus`](./EncounterStatus.md) | No |  |  | `"planned"` | No | Encounter lifecycle status. |
| `type_code` | `string|null` | No |  |  |  | Yes | Coded encounter type, optional. |
| `type_display` | `string|null` | No |  |  |  | Yes | Display text for type_code, optional. |

## Example

None declared in canonical OpenAPI.