# CreateEncounterRequest

Model ID: `CreateEncounterRequest`

Request body for POST /encounters.

Type: `object`

## Fields

| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `appointment_id` | `string|null` | No |  |  | `null` | Yes | FHIR Appointment id this encounter fulfills, when linked. |
| `created_by` | `string|null` | No |  |  | `null` | Yes | Person FHIR resource ID of the creating field agent, or 'self'. |
| `created_date` | `string|null` | No |  |  | `null` | Yes | UTC datetime when the encounter was created. |
| `diagnoses` | `array|null` | No |  |  | `null` | Yes | Diagnoses recorded for this encounter, ranked by rank. |
| `encounter_class` | `string|null` | No |  |  | `null` | Yes | Encounter class: AMB, EMER, FLD, HH, ACUTE, NONAC, OBSENC, PRENC, SS, or VR. |
| `encounter_id` | `string|null` | No |  |  | `null` | Yes | HealthCloud encounter identifier (UUID), when supplied. |
| `fhir_id` | `string|null` | No |  |  | `null` | Yes | FHIR Encounter resource id, when updating an existing encounter. |
| `hospitalization` | [`_CreateEncounterHospitalizationRequest`](./_CreateEncounterHospitalizationRequest.md) | No |  |  | `null` | Yes | Hospitalization details for inpatient encounters. |
| `length_minutes` | `integer|null` | No |  |  | `null` | Yes | Duration of the encounter in minutes. |
| `locations` | `array|null` | No |  |  | `null` | Yes | Locations where the encounter takes place. |
| `participants` | `array|null` | No |  |  | `null` | Yes | 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 |  |  | `null` | Yes | When the encounter ended (ISO dateTime). |
| `period_start` | `string|null` | No |  |  | `null` | Yes | When the encounter started (ISO dateTime). |
| `priority_code` | `string|null` | No |  |  | `null` | Yes | Code for the encounter priority. |
| `priority_display` | `string|null` | No |  |  | `null` | Yes | Display text for the encounter priority. |
| `reason_code` | `string|null` | No |  |  | `null` | Yes | SNOMED CT code for the reason for the encounter. |
| `reason_display` | `string|null` | No |  |  | `null` | Yes | Display text for the reason for the encounter. |
| `service_provider_display` | `string|null` | No |  |  | `null` | Yes | Display name of the service provider organization. |
| `service_provider_id` | `string|null` | No |  |  | `null` | Yes | FHIR Organization id of the service provider. |
| `service_type_code` | `string|null` | No |  |  | `null` | Yes | SNOMED CT code for the service type. |
| `service_type_display` | `string|null` | No |  |  | `null` | Yes | Display text for the service type. |
| `status` | `string|null` | No |  |  | `null` | Yes | Encounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled, entered-in-error, or unknown. |
| `type_code` | `string|null` | No |  |  | `null` | Yes | SNOMED CT code for the encounter type. |
| `type_display` | `string|null` | No |  |  | `null` | Yes | Display text for the encounter type. |

## Example

None declared in canonical OpenAPI.