This website provides API documentation for the careMESH National Provider Directory (Branded SEARCH). The documentation and the API responses are unique to the FHIR server defined below. Different FHIR servers may include different data sources and/or FHIR extensions.

The careMESH directory is a comprehensive, nationwide directory of US based healthcare providers and organizations. It is built from the ground up, based on the following standards:

• Fast Healthcare Interoperability Resources
• DaVinci PDEX Plan Net (STU1)

The directory is built based on regular updates from over 500 sources. These include:

• Medicare and Medicaid data sets
• State medical board information
• Hospital directory data
• Individual provider updates of their own data
• Payor directory data

The data sources that are included in this FHIR server are: All CMS Data Sources (e.g. NPPES, Medicare Care Compare, Hospital Compare...) NOTE: THIS APPLICATION IS FOR DEMO PURPOSES. IT IS CAPACITY AND RATE LIMITED AND THEREFORE CERTAIN TRANSACTIONS MAY BE SLOW OR TIME OUT.

There are two basic ways in which to access the directory. careMESH provides an interactive, user facing interface and through our FHIR based API. These are available at the following URLs for this server:

Because the careMESH Directory is a standard FHIR service, you can use any client software supporting the FHIR standard to acess it. Since FHIR is a relatively simple REST-based standard, you can also access it easily using any HTTP client library.

For most resource types, you will find interactive examples and sample code for searching and reading that resource type. These are by no means comprehensive, and in most cases you will need to supplement the code with additional authentication information before they will work. In other words, they are demonstrations of how you might implement client code for the given operation, but should not be considered ready for production.

Authentication Overview

careMESH Directory supports a variety of configurable authentication mechanisms. This document will document the specific authentication mechanisms supported for this instance of careMESH directory. That said, almost any form of authentication can be supported. Currently active supported forms include:

• Authentication using an API key (JWT)
• Authentication against Google accounts
• Authentication against Microsoft Azure Active Directory
• Authentication using SAML
• SMART on FHIR Authentication

The following sections describe authentication strategies enabled for this directory instance:

Open

Search Parameters

AuditEvent resources can be searched for using an HTTP GET request to the endpoint (i.e. /AuditEvent).

Search Parameters

Endpoint resources can be searched for using an HTTP GET request to the endpoint (i.e. /Endpoint).

Description

The HealthcareService resource is used by careMESH to describe what services are offered by an organization at a location. The services offered may be unknown, in which case the service <code>type</code> and <code>specialty</code> lists will be empty. This should be interpreted to mean that the organization provides services at the address but the nature of the services is unknown.

Search Parameters

HealthcareService resources can be searched for using an HTTP GET request to the endpoint (i.e. /HealthcareService).

Description

The Location resource represents a physical location at which service is provided. careMESH validates the vast majority of Locations against the USPS address database, therefore each location should represent a valid address. careMESH does not currently use the per-location contact information, so any contact information provided is purely for informational purposes and will not be used for careMESH delivery of messages. This resource is based on the FHIR R4 resource type, linked below.

Search Parameters

Location resources can be searched for using an HTTP GET request to the endpoint (i.e. /Location).

Description

The Media resource type is used by careMESH directory to provide a photograph of a practitioner where one is available. No other media types are supported. The resource is based on the FHIR R4 Media resource type, linked below.

Search Parameters

Media resources can be searched for using an HTTP GET request to the endpoint (i.e. /Media).

Description

A careMESH directory Organization describes an organization that provides patient care, directly or indirectly. Some typical examples would include hospitals and provider practice groups. It is based on the FHIR Organization resource type, linked below.

Examples

Fetch an organization by id

This query gets an organization by resource ID

Click "Try it!" to see results!

Search Parameters

Organization resources can be searched for using an HTTP GET request to the endpoint (i.e. /Organization).

Description

A careMESH Practitioner is any healthcare worker. This includes the obvious (doctors and nurses), but also administrative support personnel. It is based on the FHIR Practitioner resource type, linked below.

Examples

Read

Retrieve Dr. Sanjay Gupta by ID

Click "Try it!" to see results!

Simple search

Find Dr. Sanjay Gupta by first & last name

Click "Try it!" to see results!

Find doctors by location

Find all the doctors with last name "walker" in New York city

Click "Try it!" to see results!

search by role (type) code for practitionerRoles that reference this one

Click "Try it!" to see results!

Search Parameters

Practitioner resources can be searched for using an HTTP GET request to the endpoint (i.e. /Practitioner).

Description

The PractitionerRole resource describes the link between a practitioner and an organization, a location, or both. In many cases, there will be contact information for the practitioner when they are working for at this combination of organization & location. This contact information should be preferred over contact information from other sources, as it is more specific. For more detail, refer to the FHIR PractitionerRole definitions linked below.

Examples

Find a physician's roles

Search for all PractitionerRoles associated with Dr. Sanjay Gupta, by ID

Click "Try it!" to see results!

Find all doctors at a hospital

Return a list of the first 10 doctors who are employed by Tampa General Hospital

Click "Try it!" to see results!

Search Parameters

PractitionerRole resources can be searched for using an HTTP GET request to the endpoint (i.e. /PractitionerRole).

Description

A SearchParameter resource specifies a search parameter that may be used on the RESTful API to search or filter on a resource. The SearchParameter resource declares: * how to refer to the search parameter from a client * how the search parameter is to be understood by the server * where in the source resource the parameter matches The search parameter resources present in the implementation guide (at each parameter's canonical URL) should be preferred over those provided by the server.

Search Parameters

SearchParameter resources can be searched for using an HTTP GET request to the endpoint (i.e. /SearchParameter).