# OnboardPatientResponse

Model ID: `OnboardPatientResponse`

Per-step result. No cross-service transaction exists across these FHIR/
Cognito writes, so each step's outcome — and the id it produced, if any —
is reported independently rather than claiming all-or-nothing success.
This is the 'completed' shape (HTTP 201) — every requested step
succeeded. See the 207 response for the 'partial' shape.

Type: `object`

## Fields

| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `encounter` | [`OnboardEncounterStepResult`](./OnboardEncounterStepResult.md) | Yes |  |  |  | No | Result of the optional encounter-creation step. |
| `overall_status` | `string` | Yes |  |  |  | No | 'completed', 'partial', or 'failed' |
| `patient` | [`OnboardPatientStepResult`](./OnboardPatientStepResult.md) | Yes |  |  |  | No | Result of the patient-registration step. Always attempted; never 'skipped'. |
| `questionnaire_response` | [`OnboardQuestionnaireStepResult`](./OnboardQuestionnaireStepResult.md) | Yes |  |  |  | No | Result of the optional questionnaire-response step. |
| `vitals` | [`OnboardVitalsStepResult`](./OnboardVitalsStepResult.md) | Yes |  |  |  | No | Result of the optional vitals-submission step. |

## Example

None declared in canonical OpenAPI.