JOjoincandidhealth
v1

Recommendation

Changed on

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.

get/eligibility-checks/v1/recommendation

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/eligibility-checks/v1/recommendation
  • Auth
    HTTP bearer

Query parameters

filtersstring

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', 'notIn'. 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'). notIn excludes values that match any item in a semicolon-separated list (e.g., 'appointment.locationResourceId|notIn|foo;bar'); rows with no value for that field are still returned. Path values are camelCase.

Response

Response with status 200

organization_idstring required

The unique identifier for an Organization in the database

deactivatedboolean required

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

versioninteger required

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

updated_atstring date-time required
updating_user_idstring required

The unique identifier for a User in the database

idstring required

The unique UUID identifier for an EligibilityRecommendation.

eligibility_check_idstring required
coverage_idstring uuid

The unique identifier for a Coverage in the database

Changes

  • 24b2d80d577aRevision changes
    • breaking

      the response's property type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      for the query request parameter filters, the type was generalized from no type to string

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id recommendation removed and replaced with v1_recommendation