Encounter Eligibility

Beta

GET

/eligibility-checks/v1/encounter_eligibility

GET

/eligibility-checks/v1/encounter_eligibility

curl -G https://pre-api.joincandidhealth.com/eligibility-checks/v1/encounter_eligibility \
     -H "Authorization: Bearer <token>" \
     -d encounter_id=encounter_id

200Retrieved

{
  "items": [
    {
      "id": "id",
      "source": "STEDI",
      "dateOfService": "2024-01-15T09:30:00Z",
      "payerId": "payerId",
      "providerNPI": "providerNPI",
      "status": "ACTIVE",
      "errors": [
        {
          "source": "CANDID",
          "errorDetails": {
            "field?": "field?",
            "description?": "description?",
            "location?": "location?",
            "possibleResolutions?": "possibleResolutions?",
            "code?": "code?",
            "followupAction?": "followupAction?"
          }
        },
        {
          "source": "CANDID",
          "errorDetails": {
            "field?": "field?",
            "description?": "description?",
            "location?": "location?",
            "possibleResolutions?": "possibleResolutions?",
            "code?": "code?",
            "followupAction?": "followupAction?"
          }
        }
      ],
      "dependent": {
        "name": "name"
      }
    },
    {
      "id": "id",
      "source": "STEDI",
      "dateOfService": "2024-01-15T09:30:00Z",
      "payerId": "payerId",
      "providerNPI": "providerNPI",
      "status": "ACTIVE",
      "errors": [
        {
          "source": "CANDID",
          "errorDetails": {
            "field?": "field?",
            "description?": "description?",
            "location?": "location?",
            "possibleResolutions?": "possibleResolutions?",
            "code?": "code?",
            "followupAction?": "followupAction?"
          }
        },
        {
          "source": "CANDID",
          "errorDetails": {
            "field?": "field?",
            "description?": "description?",
            "location?": "location?",
            "possibleResolutions?": "possibleResolutions?",
            "code?": "code?",
            "followupAction?": "followupAction?"
          }
        }
      ],
      "dependent": {
        "name": "name"
      }
    }
  ]
}

Returns patient eligibility data regardless of clearinghouse. Uses the encounter id to get needed patient, date of service, etc data.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

encounter_idstringRequired

Response

This endpoint returns an object.

itemslist of objects