Ensure canvas patient Canvas Patient

{
  "id": "id",
  "createdAt": "2024-01-15T09:30:00Z",
  "coverage": [
    {
      "id": "id",
      "rank": 1,
      "policyId": "policyId"
    },
    {
      "id": "id",
      "rank": 1,
      "policyId": "policyId"
    }
  ],
  "firstName": "firstName",
  "lastName": "lastName",
  "dateOfBirth": "2024-01-15T09:30:00Z",
  "email": "email",
  "patientToken": "patientToken",
  "externalId": "externalId",
  "phone": "phone",
  "address": {
    "state": "AL",
    "line1": "line1",
    "line2": "line2",
    "city": "city",
    "postalCode": "postalCode",
    "country": "US"
  },
  "metadata": {
    "exampleKey": "exampleKey"
  },
  "account": {
    "status": "CURRENT",
    "balance": 1
  }
}

Resolves or syncs a Bridge Patient for a Canvas Patient ID. Returns the same shape as Patient create, including a fresh patient token.

Authentication

X-API-Keystring

API Key authentication via header

Request

This endpoint expects an object.

canvasPatientIdstringRequired

Response

This endpoint returns an object.

idstring

createdAtdatetime

coveragelist of objects

firstNamestring

lastNamestring

dateOfBirthdatetime

emailstring

patientTokenstringOptional

externalIdstringOptional

phonestringOptional

addressobjectOptional

metadataobjectOptional

Customizable object of string to string key-value data

accountobjectOptional