Return to our FHIR API Lists:      
FHIR - Patient Resources      
FHIR - Drug Formulary Resources      
FHIR - Provider Resources

List

 

List

The List API (using the CoveragePlan profile) will retrieve the active benefit plans and their cost share tiering data for the query parameters in the API request. The CoveragePlan resource represents a health plan and contains links to administrative information, a list of formulary drugs covered under that plan, and a definition of drug tiers and their associated cost-sharing models. The DaVinci PDEX US Drug Formulary Implementation Guide provides more details regarding the CoveragePlan profile for this List Resource.

HL7 FHIR interactions

Read Interaction:

GET [base]/List/[id]

Search-Type Interaction:

GET [base]/List?[parameter=value]

ParameterConformanceSample SearchNotes
 MAY[base]/ListBundle all list resources
identifier - plan identifierMAY[base]/List?identifier=[plan identifier]plan identifier- internal rxplan identifier from FHIR Coverage
Resource

 

URLs

Sandbox

https://apipreprod.arkbluecross.com/blueware/V1/FHIR/List

Production

https://api.arkbluecross.com/blueware/V1/FHIR/List

 

Headers

ACCEPT: application/json
AUTHORIZATION: Bearer {ACCESS_TOKEN}

 

Sample Request

curl -X GET \https://apipreprod.arkbluecross.com/blueware/V1/FHIR/List \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {your access token}' \

 

Sample Response

Coming soon!