SSO Eligibility

This endpoint should ONLY be used if your patients are authenticating via SAML SSO or the Mobile SDK. Patient records can be created or updated. After the patient authenticates for the first time, only specific fields can be updated. See the mutation strategy table below. Patient attribute updates occur by passing an exisiting external_user_id in the request body.

CirrusMD will provide you the external_plan_id. This must be passed to create the patient under the correct plan. The external_user_id is the unique identifier provided by you. Passing this id in subsequent requests allows the patient record to be updated.

NOTE

Replace <base_url> from the examples below with one of the following:

Environment	Base URL
Production	https://api.cirrusmd.com
Sandbox	https://api-sandbox.cirrusmd.com

---

Request URL

POST <base_url>/v2/sso/eligibility

Example Request Body

{
  "allergies": "gluten",
  "city": "Milwaukee",
  "county": "Milwaukee",
  "dob": "1990-01-01",
  "email": "email@example.com",
  "external_plan_id": "provided_external_plan_id",
  "external_user_id": "4b0877f1-ada7-4084-8c47-2d8a7ce8a701",
  "first_name": "First",
  "last_name": "Last",
  "medical_eligibility": "TRUE or FALSE",
  "medical_enrollment": "TRUE or FALSE",
  "medical_plan_description": "BCBS PPO Gold",
  "medications": "ibuprofen",
  "member_id": "294ea4ab-537d-404a-8b41-3362ab2a8bb4",
  "metadata": {
    "key": "value"
  },
  "middle_name": "Middle",
  "payor_name": "BCBS",
  "payor_plan_name": "BCBS PPO Gold",
  "phone": "9999999999",
  "relationship_code": "Primary",
  "relationship_code_hipaa": "18",
  "sex": "female",
  "state": "WI",
  "subscriber_relationship": "Primary or Dependent",
  "zipcode": "12345"
}

Minimum Required Request Body for Patient Creation

{
  "dob": "1990-01-01",
  "email": "email@example.com",
  "external_user_id": "4b0877f1-ada7-4084-8c47-2d8a7ce8a701",
  "external_plan_id": "provided_external_plan_id",
  "first_name": "First",
  "last_name": "Last",
  "sex": "female"
}

Example Response

{
  "id": 162,
  "allergies": "gluten",
  "dob": "1990-01-01",
  "email": "email@example.com",
  "external_user_id": "4b0877f1-ada7-4084-8c47-2d8a7ce8a701",
  "first_name": "First",
  "last_name": "Last",
  "medical_history": null,
  "medications": "ibuprofen",
  "member_id": "294ea4ab-537d-404a-8b41-3362ab2a8bb4",
  "metadata": {
    "key": "value"
  },
  "middle_name": "Middle",
  "phone": "9999999999",
  "sex": "female",
  "type": "patients",
  "zipcode": "12345"
}

Attribute Mutation Strategy

Only specific patient attributes are mutable via the customer API after a patient sign in. Please reference the table below to determine if/when a patient attribute is mutable.

Attribute	Mutable Before Sign In	Mutable After Sign In
allergies	Yes	No
dob	Yes	No
email	Yes	No
external_user_id	No	No
first_name	Yes	No
last_name	Yes	No
medical_history	Yes	No
medications	Yes	No
member_id	Yes	Yes
middle_name	Yes	No
metadata	Yes	No
phone	Yes	No
sex	Yes	No
zipcode	Yes	No