# patient_connection.created

A Patient was created for or connected to an Organization.

## Payload schema

- `object`
  - `api_version` (`any`)
  - `context` (`object`) - Present only when `source` is `api`. Identifies the acting project and API key.
    - `developer_platform_api_key_id` (`string | null`) - format: `uuid`
    - `developer_platform_project_id` (`string | null`) - format: `uuid`
  - `created_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.
  - `data` (`object`)
    - `object` (`object`)
      - `clinician_id` (`string | null`) - format: `uuid`; The Clinician associated with this registration, when one is assigned.
      - `created_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.
      - `gp_status` (`string | null`) - enum: `none_or_omitted`, `has_gp`, `no_gp_required`, `null`; Whether this Organization has recorded a GP for the Patient. `has_gp` means a GP PatientConnection is expected. `no_gp_required` means the Patient does not need a GP. `none_or_omitted` means no GP has been recorded.
      - `id` (`string`) - format: `uuid`; The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
      - `is_active` (`boolean`) - Whether the Patient registration is active.
      - `links` (`object`) - URLs to related resources.
        - `patient` (`string`) - format: `uri`; The full URL of a related resource.
        - `payor` (`string | null`) - format: `uri`; The full URL of a related resource.
      - `object` (`any`) - Discriminator value emitted at `object`.
      - `organization` (`object`)
        - `address_line_1` (`string | null`) - The primary address line of the organization.
        - `address_line_2` (`string | null`) - The secondary address line of the organization.
        - `city` (`string | null`) - The city in the organization's postal address.
        - `country_code` (`string | null`) - The ISO 3166-1 alpha-2 country code for the postal address, such as `GB` for the United Kingdom.
        - `county` (`string | null`) - The county or region in the organization's postal address.
        - `created_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.
        - `currency` (`string | null`) - The ISO 4217 currency code used by the organization. Must be one of `chf`, `eur`, `gbp`, or `usd`. Null when this Organization is returned from `GET /v1/organizations` or nested on a PatientConnection.
        - `email` (`string | null`) - format: `email`; The contact email address of the organization. Null when this Organization is returned from `GET /v1/organizations` or nested on a PatientConnection.
        - `formatted_address` (`string | null`) - The single-line address of the organization, formatted for display.
        - `id` (`string`) - format: `uuid`; The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
        - `name` (`string`) - The display name of the organization, for example `Acme Healthcare`.
        - `object` (`any`) - Discriminator value emitted at `object`.
        - `organization_type` (`string | null`) - enum: `consultant`, `gp_practice`, `hospital`, `laboratory`, `legal`, `other`, `pharmacy`, `private_practice`, `null`; The kind of organization. Use `gp_practice` when attaching a GP.
        - `phone` (`string | null`) - The formatted contact phone number of the organization. Null when this Organization is returned from `GET /v1/organizations` or nested on a PatientConnection.
        - `postcode` (`string | null`) - The postal code in the organization's postal address.
        - `subdomain` (`string | null`) - The URL-safe subdomain that identifies the organization. Null when this Organization is returned from `GET /v1/organizations` or nested on a PatientConnection.
        - `time_zone` (`string | null`) - The IANA time zone used to interpret scheduling dates and display appointment times. Always `Europe/London` when present. Null when this Organization is returned from `GET /v1/organizations` or nested on a PatientConnection.
        - `updated_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.
      - `organization_id` (`string`) - format: `uuid`; The Organization with which the Patient was registered.
      - `patient` (`object`)
        - `address_line_1` (`string | null`) - The primary address line of the Patient.
        - `address_line_2` (`string | null`) - The secondary address line of the Patient.
        - `city` (`string | null`) - The city in the Patient's postal address.
        - `country_code` (`string | null`) - The ISO 3166-1 alpha-2 country code for the postal address, such as `GB` for the United Kingdom.
        - `county` (`string | null`) - The county or region in the Patient's postal address.
        - `created_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.
        - `creation_source` (`string | null`) - How the Patient was created. `api` means the record was created through the Developer Platform. Read-only.
        - `date_of_birth` (`string | null`) - format: `date`; The date of birth of the patient, in ISO 8601 format (YYYY-MM-DD).
        - `display_name` (`string | null`) - The formatted display name of the patient, including their title when recorded.
        - `email` (`string | null`) - format: `email`; The email address of the patient, when recorded.
        - `first_name` (`string | null`) - The first name of the patient.
        - `id` (`string`) - format: `uuid`; The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
        - `is_opted_out_of_sms` (`boolean`) - Whether the Patient has opted out of SMS messages.
        - `last_name` (`string | null`) - The last name of the patient.
        - `mobile` (`string | null`) - The national mobile number without its country calling code.
        - `mobile_country_dial_code` (`string | null`) - The ISO 3166-1 alpha-2 country code used to derive the mobile calling code.
        - `nhs_number` (`string | null`) - The 10-digit NHS number of the patient, without formatting.
        - `object` (`any`) - Discriminator value emitted at `object`.
        - `phone` (`string | null`) - The national phone number without its country calling code.
        - `phone_country_dial_code` (`string | null`) - The ISO 3166-1 alpha-2 country code used to derive the phone calling code.
        - `phone_number` (`string | null`) - The Patient's preferred contact number, formatted for display and compatible with E.164.
        - `postcode` (`string | null`) - The postal code of the Patient.
        - `sex` (`string | null`) - enum: `female`, `male`, `other`, `null`; The Patient's recorded sex.
        - `title` (`string | null`) - The personal title of the patient, when recorded.
        - `updated_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.
      - `payor_id` (`string | null`) - format: `uuid`; The Payor this Organization uses as the default billing party for the Patient.
      - `updated_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.
  - `developer_platform_project_id` (`string | null`) - format: `uuid`; The project ID whose credential caused the change. Null for `dashboard` events.
  - `id` (`string`) - Event identifier prefixed with `evt_`.
  - `livemode` (`boolean`) - `false` for test-event deliveries.
  - `object` (`any`)
  - `source` (`string`) - enum: `api`, `dashboard`; Origin of the change. `api` means a Developer Platform mutation; `dashboard` means a Carebit-initiated change.
  - `type` (`any`)

### Example payload

```json
{
  "id": "evt_00000000-0000-4000-8000-000000000012",
  "object": "event",
  "api_version": "v1",
  "created_at": "2026-01-01T09:00:00Z",
  "data": {
    "object": {
      "id": "00000000-0000-4000-8000-000000000017",
      "object": "patient_connection",
      "clinician_id": "00000000-0000-4000-8000-000000000002",
      "created_at": "2026-01-01T09:00:00Z",
      "gp_status": "has_gp",
      "is_active": true,
      "links": {
        "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004",
        "payor": null
      },
      "organization": {
        "id": "00000000-0000-4000-8000-000000000018",
        "object": "organization",
        "address_line_1": "1 Test Street",
        "address_line_2": null,
        "city": "Test City",
        "country_code": "GB",
        "county": "Testshire",
        "created_at": "2026-01-01T09:00:00Z",
        "currency": null,
        "email": null,
        "formatted_address": "1 Test Street, Test City, GB, TE1 1ST",
        "name": "High Street Surgery",
        "organization_type": "gp_practice",
        "phone": null,
        "postcode": "TE1 1ST",
        "subdomain": null,
        "time_zone": null,
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "organization_id": "00000000-0000-4000-8000-000000000018",
      "patient": {
        "id": "00000000-0000-4000-8000-000000000004",
        "object": "patient",
        "address_line_1": "1 Test Street",
        "address_line_2": null,
        "city": "Test City",
        "country_code": "GB",
        "county": "Testshire",
        "created_at": "2026-01-01T09:00:00Z",
        "creation_source": "api",
        "date_of_birth": "1970-01-01",
        "display_name": "Ms Test Patient",
        "email": "test.patient@example.invalid",
        "first_name": "Test",
        "is_opted_out_of_sms": false,
        "last_name": "Patient",
        "mobile": "7700900123",
        "mobile_country_dial_code": "GB",
        "nhs_number": "9990000000",
        "phone": "1234567890",
        "phone_country_dial_code": "GB",
        "phone_number": "+441234567890",
        "postcode": "TE1 1ST",
        "sex": "female",
        "title": "Ms",
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "payor_id": null,
      "updated_at": "2026-01-01T09:00:00Z"
    }
  },
  "developer_platform_project_id": null,
  "livemode": false,
  "source": "dashboard",
  "type": "patient_connection.created"
}
```