Search for an active plan, return member_id and payer_id if found

post/v1/discover

Request

  • Base URL
    https://coverage-api.meetnirvana.com
  • URL
    https://coverage-api.meetnirvana.com/v1/discover
  • Auth
    none declared

Request body

gender'M' | 'F'
member_dobstring date required

Member’s date of birth provided in yyyy-mm-dd format

member_first_namestring required

Member’s first name; as printed on the insurance card

member_last_namestring required

Member’s last name; as printed on the insurance card

next_appointmentstring date

Patient's next appointment date in yyyy-mm-dd format

office_idstring

An identifier for the office or location being visited.

patient_idstring

Patient's id

patient_type'PROSPECT' | 'NEW_PATIENT' | 'EXISTING_PATIENT'
payer_idstring required

Unique external payer ID associated with the insurer. Use BCBS when the member's Blue Cross Blue Shield plan is unknown: it is routed to the BCBS payer for the provided zip code

provider_npistring required

Service Provider’s 10-character NPI

zipstring required

Zip code

Example request

{
  "member_first_name": "NAME",
  "member_last_name": "SURNAME",
  "payer_id": "87726",
  "zip": "10001"
}

Response

Successful Response

bluecard_eligibleboolean

Indicates if the policy belongs to a Bluecard member

group_idstring

The group id of the member's insurance plan

group_namestring

The group name of the member’s insurance plan

insurance_type'HMO' | 'PPO' | 'EPO' | 'POS'
payer_idstring required

Payer ID used to verify benefits

payer_namestring

Payer name

plan_begin_datestring date

The date the member’s plan was activated

plan_end_datestring date

The date the member’s plan expires

plan_namestring

The name of the member’s insurance plan

plan_status'UNKNOWN' | 'INACTIVE' | 'ACTIVE' | 'ACTIVE_AT_RISK'
plan_type'UNKNOWN' | 'ORIGINAL_MEDICAID' | 'MANAGED_MEDICAID' | 'MEDICARE_ADVANTAGE' | 'ORIGINAL_MEDICARE' | 'DUAL' | 'MARKETPLACE' | 'GOVERNMENT' | 'COMMERCIAL' | 'SUPPLEMENTAL_MEDICARE'
qmb_statusboolean

Indicates if the member has Qualified Medicare Beneficiary (QMB) status

relationship_to_subscriberstring

The member’s relation to the subscriber of the plan (e.g. self, spouse, child, etc.)

Example response

{
  "plan_begin_date": "2021-01-01",
  "plan_end_date": "2022-01-01"
}

Changes

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new ORIGINAL_MEDICARE enum value to the / response property for the response status

    • warning

      added the new SUPPLEMENTAL_MEDICARE enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added to the response body anyOf list for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response's property default value {"code":"UNABLE_TO_FIND_ACTIVE_COVERAGE","message":"Unable to find active coverage for this member"} was removed for the status

    • info

      the response's property default value {"code":"UNABLE_TO_FIND_ACTIVE_COVERAGE","message":"Unable to find active coverage for this member"} was removed for the status

    • info

      the response's property default value {"code":"UNABLE_TO_FIND_ACTIVE_COVERAGE","message":"Unable to find active coverage for this member"} was removed for the status

    • info

      the response's property default value {"code":"UNABLE_TO_FIND_ACTIVE_COVERAGE","message":"Unable to find active coverage for this member"} was removed for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status