Skip to main content
GET
/
v1
/
claims
/
{id}
/
payer-policy
GET /v1/claims/{id}/payer-policy
curl --request GET \
  --url https://have-foresight.app/api/v1/v1/claims/{id}/payer-policy \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "data": {
    "claimId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "retrievalMode": "policy_graph",
    "claimType": "<string>",
    "specialty": "<string>",
    "evaluatedAt": "2023-11-07T05:31:56Z",
    "reason": "<string>",
    "recommendations": [
      {
        "id": "<string>",
        "policyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "policyVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "policyTitle": "<string>",
        "payerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "payerSlug": "<string>",
        "payerName": "<string>",
        "relationshipType": "<string>",
        "ruleFamily": "<string>",
        "subjectCodeSystem": "<string>",
        "subjectCode": "<string>",
        "targetCode": "<string>",
        "targetCodeSystem": "<string>",
        "targetModifier": "<string>",
        "targetPlaceOfService": "<string>",
        "targetDiagnosisCodes": [
          "<string>"
        ],
        "status": "eligible_auto_apply",
        "confidenceLevel": 1,
        "safetyClass": "<string>",
        "releaseStatus": "<string>",
        "releaseGateStatus": "<string>",
        "autoApplyDefault": true,
        "compiledRuleId": "<string>",
        "reason": "<string>",
        "citation": {}
      }
    ],
    "candidates": [
      {}
    ],
    "compiledRules": [
      {}
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.have-foresight.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-Key
string
header
required

Foresight API key, prefixed fsk_live_ or fsk_test_.

Path Parameters

id
string
required

Claim ID.

Response

Policy explanation returned.

success
boolean
data
object