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

Goal

 

Goal

Describes the intended behavioral health objective(s) for a member. 

HL7 FHIR interactions

Read Interaction:

GET [base]/Goal/[id]

Search-Type Interaction:

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

ParameterConformanceSample SearchNotes
 MAY[base]/GoalBundle all goal resources for member in
JWT id token
_idMAY[base]/Goal?_id=[id] 
identifier – member numberMAY[base]/Goal?identifier=<member number>member number - internal member
number
lifecyclestatusMAY[base]/Goal?lifecycleStatus=[goal status]goal status values: http://hl7.org/fhir/R4/valueset-goal-status.html
target-dateMAY[base]/Goal?target-date=eq[Goal.target.due] 
patientMAY[base]/Goal?_patient=[patient id]Patient id in JWT id token

 

URLs

Sandbox

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

Production

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

 

Headers

ACCEPT: application/json
AUTHORIZATION: Bearer {ACCESS_TOKEN}

 

Sample Request

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

 

Sample Response

Coming soon!