Flexpa
Developer PortalFeedbackContact usOnboard

Guides

  • Home
  • Quickstart
  • Financial Data

Network

  • Network guide
  • Directory
  • Updates

Consent

  • Link SDK
  • Patient access

Records

  • FHIR API
  • Node SDK
  • FHIR Introduction
  • Usage
  • Terminology
    • AllergyIntolerance
    • Bundle
    • CarePlan
    • CareTeam
    • Condition
    • Coverage
    • Device
    • DiagnosticReport
    • DocumentReference
    • Encounter
    • ExplanationOfBenefit
    • Goal
    • Immunization
    • Location
    • Medication
    • MedicationDispense
    • MedicationRequest
    • Observation
    • OperationOutcome
    • Organization
    • Patient
    • Practitioner
    • PractitionerRole
    • Procedure
    • Provenance

Misc

  • Changelog
  • Support
  • Flexpa OS
  • We're hiring

Organization

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

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

Organization is a supporting FHIR resource that is used to represent a payer, provider, or other organization.

In contrast to many of the other resources in the Flexpa that are patient-specific, it serves as a foundational resource that supports the clinical and financial resources in the API. For instance, an ExplanationOfBenefit may have been issued by a particular payer Organization.

As a result, Organization is most often used as part of an include parameter in a search request to retrieve the related resources or is accessed via a read with a specific FHIR resource ID obtained from a financial or clinical resource.

#Schema

This is Flexpa's supported FHIR schema for the Organization resource.

PropertyValueValue TypeData TypeDescriptionRequired
resourceType"Organization"FixedstringType of FHIR resource (fixed as "Organization")Yes
activetrue | falseEnumbooleanWhether the organization record is activeYes
name"SUNSHINE HEALTH"VariablestringA name associated with the organizationYes
alias["SUNSHINE HEALTH LLC"]Variablestring[]Alternative names for the organizationNo
metaobjectMetadata about the resourceYes
identifierobject[]Identifiers for the organizationYes
telecomobject[]Contact information for the organizationYes
addressobject[]Physical address of the organizationYes
contactobject[]Contact information for authorized officialYes
typeobject[]The type of organizationYes

Flexpa's Organization resource contains an aggregation of data from both the payer endpoint server and the official NPPES database.

Filter the top level arrays identifier, telecom, address, contact,and type with the following function to include only NPPES data points:

function filterByOfficialNPPESData(element: Element) {
  return element.extension.some(
    (extension) => extension.extension.some(
      (extension) => extension.valueReference?.reference.startsWith('https://npiregistry.cms.hhs.gov')
    )
  );
}

const identifiers = practitioner.identifier.filter(filterByOfficialNPPESData);
const telecoms = practitioner.telecom.filter(filterByOfficialNPPESData);
const addresses = practitioner.address.filter(filterByOfficialNPPESData);
const contacts = practitioner.contact.filter(filterByOfficialNPPESData);
const types = practitioner.type.filter(filterByOfficialNPPESData);

#Sample request

This is a sample request using curl

ACCESS_TOKEN=flexpa-link-access-token

curl "https://api.flexpa.com/fhir/Organization" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

#Sample response

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

Status TwitterGitHub

© 2025 Flexpa. All rights reserved.

On this page
  • Schema
  • Sample request
  • Sample response