Recommendation | Candid | API Reference

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

1 [ 2 { 3 "deactivated": true, 4 "id": "id", 5 "organization_id": "organization_id", 6 "patient": { 7 "id": "id", 8 "mrn": "mrn", 9 "organization_id": "organization_id", 10 "last_name": "last_name", 11 "first_name": "first_name", 12 "date_of_birth": "2023-01-15", 13 "member_id": "member_id" 14 }, 15 "recommendation": { 16 "type": "MEDICARE_ADVANTAGE", 17 "payload": { 18 "ma_benefit": { 19 "key": "value" 20 }, 21 "payer_id": "payer_id", 22 "payer_name": "payer_name", 23 "member_id": "member_id" 24 } 25 }, 26 "updated_at": "2024-01-15T09:30:00Z", 27 "updating_user_id": "updating_user_id", 28 "version": 1 29 }, 30 { 31 "deactivated": true, 32 "id": "id", 33 "organization_id": "organization_id", 34 "patient": { 35 "id": "id", 36 "mrn": "mrn", 37 "organization_id": "organization_id", 38 "last_name": "last_name", 39 "first_name": "first_name", 40 "date_of_birth": "2023-01-15", 41 "member_id": "member_id" 42 }, 43 "recommendation": { 44 "type": "MEDICARE_ADVANTAGE", 45 "payload": { 46 "ma_benefit": { 47 "key": "value" 48 }, 49 "payer_id": "payer_id", 50 "payer_name": "payer_name", 51 "member_id": "member_id" 52 } 53 }, 54 "updated_at": "2024-01-15T09:30:00Z", 55 "updating_user_id": "updating_user_id", 56 "version": 1 57 } 58 ]

Gets recommendation for eligibility checks based on the request.

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’. ieq is a case-insensitive equality operator. 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.

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.

Headers

Query parameters

Response