Practitioner
GET https://api.flexpa.com/fhir/Practitioner
Practitioner is a supporting FHIR resource about a person who is directly or indirectly involved in the provisioning of healthcare. This may be a doctor, a nurse, a social worker, or even IT personnel responsible for merging patient records. It even can be a dog (for example, a service animal such as a ward-assigned dog capable of detecting cancer in patients), which we think is pretty rad.
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 contain a referenced Practitioner resource that is the provider who rendered the service.
As a result, Practitioner 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 Practitioner resource.
Property | Value | Value Type | Data Type | Description | Required |
---|
resourceType | "Practitioner" | Fixed | string | Type of FHIR resource (fixed as "Practitioner") | Yes |
active | true | false | Enum | boolean | Whether the practitioner record is active | Yes |
gender | "male" | "female" | "other" | "unknown" | Enum | string | Administrative gender of the practitioner | Yes |
meta | | | object | Metadata about the resource | Yes |
identifier | | | object[] | Identifiers for the practitioner | Yes |
name | | | object[] | A name associated with the practitioner | Yes |
telecom | | | object[] | Contact information for the practitioner | Yes |
address | | | object[] | Physical address of the practitioner | Yes |
qualification | | | object[] | Qualifications of the practitioner | Yes |
Flexpa's Practitioner resource contains an aggregation of data from both the payer endpoint server and the official NPPES database.
Filter the top level arrays identifier
, name
, telecom
, address
, and qualification
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 names = practitioner.name.filter(filterByOfficialNPPESData);
const telecoms = practitioner.telecom.filter(filterByOfficialNPPESData);
const addresses = practitioner.address.filter(filterByOfficialNPPESData);
const qualifications = practitioner.qualification.filter(filterByOfficialNPPESData);
#Sample request
This is a sample request using curl
ACCESS_TOKEN=flexpa-link-access-token
curl "https://api.flexpa.com/fhir/Practitioner" \
-H "Authorization: Bearer $ACCESS_TOKEN"
#Sample response
This is a sample response from Humana using Flexpa API in test mode