cca-fhir-providerdirectory-exp-api icon


(0 reviews)
Power up your workflow by quickly identifying individual providers and provider organizations



The Provider Directory API asset is a component of MuleSoft Accelerator for Healthcare.

MuleSoft Accelerator for Healthcare enables healthcare providers to unlock critical patient data to build a patient 360 within Salesforce Health Cloud, faster and easier than ever before. The solution includes pre-built APIs, connectors, integration templates, and a prescriptive end-to-end reference architecture to bring patient demographics information and COVID-19 test results from any EHR into Health Cloud using HL7 V2 or FHIR standards.

The solution also provides a library of United States Core Data for Interoperability (USCDI) and FHIR R4 resources to help healthcare developers adhere to interoperability needs and jumpstart the development of healthcare digital transformation initiatives.

This asset provides the API specification for the Provider Directory API needed to meet CMS interoperability requirements, and is built according to the Da Vinci PDEX Plan Net implementation guide. See the implementation template for more information.

Use case

See the use case page for more information on how to use these assets.

What is Da Vinci?
Da Vinci is a private sector initiative that addresses the needs of the Value Based Care Community by leveraging the HL7 FHIR platform. You can find out more details about the Da Vinci project here.

The Center for Medicare and Medicaid Services (CMS) recommends the Da Vinci implementation guide to satisfy the data requirements for this API.

Conformance Language

This specification uses the conformance verbs SHALL, SHOULD and MAY:

SHALL: An absolute requirement for all implementations. The FHIR server must return this data.
SHOULD: A best practice or recommendation for the implementation. The FHIR server is recommended to return this data.
MAY: An optional inclusion for the implementation; not a requirement. The FHIR server may return the data, but there is no requirement to do so.


Commonwealth Care Alliance Provider Directory FHIR server does not maintain any records that can be associated with a consumer. Therefore, the Provider Directory API does not require third-party applications to send consumer identifying information, and does not require authentication.

FHIR RESTful API Capabilities

Implements RESTful behaviors according to the FHIR specification.
Returns the following http status codes:


Note: For more information about the FHIR RESTful API, please refer to the HL7® FHIR® RESTful API topics.

Search Syntax

To search resource interactions, use the following syntax:

GET [base]/[Resource-type]?[parameter1]{:m1|m2|...}={c1|c2|...}[value1{,value2,...}]{&[parameter2]{:m1|m2|...}={c1|c2|...}[value1{,value2,...}]&....}

GET: the HTTP verb used to fetch the resource
Variables surrounded by " " are mandatory for the client to supply, and will be replaced by the string literal identified.
Variables surrounded by "{ }" are optional for the client to supply, and will be replaced by the string literal identified.
base: The Service Root URL
Resource-type: The name of a resource type (e.g "Patient")
parameter: The search parameters as defined for the particular interaction (e.g. "?patient=Patient/123")
value: the search parameter value for a particular search
Note: For values of type Token, the syntax {system|}[code] means that the system value is optional for the client to supply.

{:m1|m2|...}: The list of supported search parameter modifiers
{c1|c2|...}: The list of supported search parameter comparators
{,value2,...}: Optional multiple "OR" values
{&parameter2={:m1 m2 ...}={c1 c2 ...}[value1{,value2,...}&...}: Optional multiple "AND" search parameters
In the simplest case, a search is executed by performing a GET operation in the RESTful framework:

GET [base]/[Resource-type]?name=value&...

For this RESTful search, the parameters are a series of name=[value] pairs encoded in the URL. The search parameter names are defined for each resource. For example, the Observation resource the name "code" for search on the LOINC code.

Note: For more information about how the search resource interactions are handled, refer to the HL7® FHIR® Search topic.

Search Parameters


Base URI

Query parameters