# OnboardPatientPayload

Model ID: `OnboardPatientPayload`

No description.

Type: `object`

## Fields

| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `address` | [`Address`](./Address.md) | No |  |  |  | Yes | Mutually exclusive with addresses. |
| `addresses` | `array|null` | No |  |  |  | Yes | Mutually exclusive with address. |
| `attributes` | [`OnboardPatientAttributes`](./OnboardPatientAttributes.md) | No |  |  |  | No | Arbitrary JSON-compatible metadata stored on the initial FHIR Patient resource. |
| `date_of_birth` | `string` | Yes |  |  |  | No | ISO 8601 date (YYYY-MM-DD) |
| `email` | `string` | Yes |  |  |  | No | Patient's email; used as the Cognito login username. |
| `first_name` | `string` | Yes |  |  |  | No | Patient's given name. |
| `flags` | [`OnboardPatientFlags`](./OnboardPatientFlags.md) | No |  |  |  | No | Boolean registration flags, matching ordinary Patient registration. |
| `last_name` | `string` | Yes |  |  |  | No | Patient's family name. |
| `password` | `string|null` | No |  |  |  | Yes | Auto-generated server-side and not returned if omitted. |
| `phone` | `string|null` | No |  |  |  | Yes | E.164 phone number, optional. |
| `race` | [`Race`](./Race.md) | No |  |  |  | Yes | One race value, or a list of them. |
| `sex_at_birth` | [`SexAtBirth`](./SexAtBirth.md) | No |  |  |  | Yes | Sex assigned at birth, optional. |

## Example

None declared in canonical OpenAPI.