Organization
GET https://api.flexpa.com/fhir/Organization
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.
Property | Value | Value Type | Data Type | Description | Required |
---|
resourceType | "Organization" | Fixed | string | Type of FHIR resource (fixed as "Organization") | Yes |
active | true | false | Enum | boolean | Whether the organization record is active | Yes |
name | "SUNSHINE HEALTH" | Variable | string | A name associated with the organization | Yes |
alias | ["SUNSHINE HEALTH LLC"] | Variable | string[] | Alternative names for the organization | No |
meta | | | object | Metadata about the resource | Yes |
identifier | | | object[] | Identifiers for the organization | Yes |
telecom | | | object[] | Contact information for the organization | Yes |
address | | | object[] | Physical address of the organization | Yes |
contact | | | object[] | Contact information for authorized official | Yes |
type | | | object[] | The type of organization | Yes |
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