For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
        • Mocking Eligibility Checks
          • POSTPost
          • POSTBatch
          • GETPoll Batch
          • GETPayer Search
          • GETRecommendation
          • POSTCreate Recommendation
          • PUTVote Recommendation
          • GETGet Multi
Contact Sales
LogoLogo
API ReferencePre EncounterEligibility ChecksV1

Vote Recommendation

GA
PUT
/eligibility-checks/v1/recommendation/:recommendation_id/:version/vote
PUT
/eligibility-checks/v1/recommendation/:recommendation_id/:version/vote
$curl -X PUT https://pre-api.joincandidhealth.com/eligibility-checks/v1/recommendation/recommendation_id/version/vote \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "user_id": "user_id",
>  "value": "UPVOTE"
>}'
1{
2  "deactivated": true,
3  "eligibility_check_id": "eligibility_check_id",
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  "coverage_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
30  "votes": [
31    {
32      "user_id": "user_id",
33      "value": "UPVOTE"
34    },
35    {
36      "user_id": "user_id",
37      "value": "UPVOTE"
38    }
39  ]
40}

Submit user feedback on an eligibility recommendation. The path must contain the next version number to prevent race conditions. For example, if the current version of the recommendation is n, you will need to send a request to this endpoint with /{recommendation_id}/{n+1}/vote to update the vote.

Was this page helpful?
Previous

Get Multi

Next
Built with

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

recommendation_idstringRequired
versionstringRequired

Request

This endpoint expects an object.
user_idstringRequired
The user who voted
valueenumRequired
The vote value
Allowed values:

Response

This endpoint returns an object.
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_idUUID
The unique identifier for a Coverage in the database
voteslist of objects
Array of votes for this recommendation

Errors

404
Not Found Error
409
Version Conflict Error