Overview

The Patient Benefits API is used for managing patient benefits and enabling benefit checks during prescribe. See this guide for Benefit Checks.

⚠️
Note that the Patient Benefits API URL host name and sandbox below are not the same as our main Clinical API.

Env	URL
neutron (staging)	https://clinical-api.neutron.health/graphql
photon (production)	https://clinical-api.photon.health/graphql

Sandbox

The links above also function as API sandbox links. In the sandbox, you can interact with the latest version of the Patient Benefit APIs.

To make requests in the sandbox, you must set the HTTP headers below. You can get test tokens from the Developers tab in the web application at https://app.neutron.health/settings/developers.

# required sandbox headers
x-photon-auth-token: paste_from_dev_settings
x-photon-auth-token-type: auth0

Integration

Integration examples are similar to the Clinical API examples documented here. The main difference is the API hostname.

Create Benefit Mutation

mutation CreateBenefit($input: BenefitInput!) {
  createBenefit(input: $input) {
    id
    bin
    groupId
    memberId
    pcn
  }
}

input BenefitInput {
  bin: String!
  groupId: String
  memberId: String!
  pcn: String
  patientId: ID!
}

Example GraphQL request variable for above createBenefit mutation:

{
  "input": {
    "bin": "test1",
    "groupId": "test-groupId-1",
    "memberId": "test-memberId-1",
    "pcn": "test-pcn-1",
    "patientId": "pat_testId1234"
  }
}

You can verify the patient’s benefit by querying for it on the Patient object:

query Patients($filter: PatientsFilter!) {
  patients(filter: $filter) {
    benefits {
      id
    }
  }
}