Flexpa
Developer PortalContact us

Flexpa overview

  • Introduction
  • Patient access
  • Use cases
  • What we don't do
  • Pricing

Getting started

  • Quickstart
  • Test mode
  • Going live
  • Changelog
  • FAQ

Network

  • Payers
  • Endpoints

Tools

  • Flexpa Link
  • Flexpa API
  • Data analytics
  • Connections
  • MyFlexpa
  • Portal
  • Scan

FHIR Overview

  • Introduction
  • Reading resources
  • Searching resources
  • Code systems
    • AllergyIntolerance
    • Bundle
    • CapabilityStatement
    • CarePlan
    • CareTeam
    • Condition
    • Coverage
    • Device
    • DiagnosticReport
    • DocumentReference
    • Encounter
    • ExplanationOfBenefit
    • Goal
    • Immunization
    • Location
    • Medication
    • MedicationDispense
    • MedicationRequest
    • Observation
    • OperationOutcome
    • Organization
    • Patient
    • Practitioner
    • PractitionerRole
    • Procedure
    • Provenance

Patient Guides

  • Steps to connect
  • Troubleshooting tips

About Flexpa

  • Flexpa OS
  • Brand kit
  • Join us
  • Support

Goal

GET https://api.flexpa.com/fhir/Goal

  • Goal is a base FHIR Resource ( JSON example)
  • Commonly available via US Core Goal Profile

Goal is a clinical FHIR Resource that describes the intended objective for a patient, such as weight loss or restoring an activity of daily living.

While a few payers may make this information available, almost all do not have this data unless it is submitted to the payer by providers for quality measures or other provider/payer data exchange programs, as it is not included with or derived from core claims generation.

#Search parameters

The full list of search parameters can be found here. Some of the most important are:

Parameters

patient
string

The ID of the patient who has the goal. We recommend using this search parameter along with the $PATIENT_ID wildcard

#Sample request

While some servers may support a resource-level search without any parameters, not all do. We recommend using the format below with the patient ID via the $PATIENT_ID wildcard as a search parameter.

This is a sample request using curl

ACCESS_TOKEN=flexpa-link-access-token

curl "https://api.flexpa.com/fhir/Goal?patient=$PATIENT_ID" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

#Sample response

This is a sample response from Humana using Flexpa API in test mode

Status TwitterGitHub

© 2023 Flexpa. All rights reserved.

On this page
  • Search parameters
  • Sample request
  • Sample response