Recommendation

GET

/eligibility-checks/v1/recommendation

GET

/eligibility-checks/v1/recommendation

curl https://pre-api.joincandidhealth.com/eligibility-checks/v1/recommendation \
     -H "Authorization: Bearer <token>"

200Retrieved

[
  {
    "deactivated": true,
    "eligibility_check_id": "eligibility_check_id",
    "id": "id",
    "organization_id": "organization_id",
    "patient": {
      "id": "id",
      "mrn": "mrn",
      "organization_id": "organization_id",
      "last_name": "last_name",
      "first_name": "first_name",
      "date_of_birth": "2023-01-15",
      "member_id": "member_id"
    },
    "recommendation": {
      "type": "MEDICARE_ADVANTAGE",
      "payload": {
        "ma_benefit": {
          "key": "value"
        },
        "payer_id": "payer_id",
        "payer_name": "payer_name",
        "member_id": "member_id"
      }
    },
    "updated_at": "2024-01-15T09:30:00Z",
    "updating_user_id": "updating_user_id",
    "version": 1,
    "coverage_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "votes": [
      {
        "user_id": "user_id",
        "value": "UPVOTE"
      },
      {
        "user_id": "user_id",
        "value": "UPVOTE"
      }
    ]
  },
  {
    "deactivated": true,
    "eligibility_check_id": "eligibility_check_id",
    "id": "id",
    "organization_id": "organization_id",
    "patient": {
      "id": "id",
      "mrn": "mrn",
      "organization_id": "organization_id",
      "last_name": "last_name",
      "first_name": "first_name",
      "date_of_birth": "2023-01-15",
      "member_id": "member_id"
    },
    "recommendation": {
      "type": "MEDICARE_ADVANTAGE",
      "payload": {
        "ma_benefit": {
          "key": "value"
        },
        "payer_id": "payer_id",
        "payer_name": "payer_name",
        "member_id": "member_id"
      }
    },
    "updated_at": "2024-01-15T09:30:00Z",
    "updating_user_id": "updating_user_id",
    "version": 1,
    "coverage_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "votes": [
      {
        "user_id": "user_id",
        "value": "UPVOTE"
      },
      {
        "user_id": "user_id",
        "value": "UPVOTE"
      }
    ]
  }
]

Gets recommendation for eligibility checks based on filters. This endpoint will retrieve all the latest eligibility recommendations for each eligibility recommendation type for the given filters. If you want to get a specific recommendation type, you can use the type query parameter.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

filtersstringOptional

A serialized list of filters separated by commas indicating filters to apply. Each filter is of the form ‘path:operator:value’. Example: ‘patient.mrn|eq|12345’. Filters are separated by commas. Example: ‘patient.mrn|eq|12345,appointment.startDate|gt|67890’. All filters are ANDed together. Valid operators are ‘eq’, ‘gt’, ‘lt’, ‘contains’, ‘ieq’, ‘in’. ieq is a case-insensitive equality operator. in allows searching for values that match any item in a semicolon-separated list (e.g., ‘patient.id|in|foo;bar;baz’). Path values are camelCase.

Response

This endpoint returns a list of objects.

deactivatedboolean

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

eligibility_check_idstring

idstring

The unique UUID identifier for an EligibilityRecommendation.

organization_idstring

The organization that owns this object.

patientobject

An object representing patient information for an eligibility recommendation. This is used to find recommendations. Each field helps us find the right corresponding eligibility recommendation for the patient.

recommendationobject

updated_atdatetime

updating_user_idstring

The user ID of the user who last updated the object.

versioninteger

The version of the object. Any update to any property of an object object will create a new version.

coverage_idUUIDOptional

The unique identifier for a Coverage in the database

voteslist of objectsOptional

Array of votes for this recommendation