Resources

The Provider Directory API supports 9 HL7 FHIR R4 resources that work together to provide comprehensive provider network information. This page covers shared concepts and patterns used across all resources.

Supported Resources

Resource	Description	Primary Use Cases
CapabilityStatement	API capabilities and supported operations	Discover API features and limitations (read-only)
Endpoint	Technical endpoints for data exchange	Integration and connectivity information
HealthcareService	Services offered by organizations	Discover available medical services
InsurancePlan	Insurance plans and coverage details	Find accepted insurance plans
Location	Physical locations where services are provided	Find clinic addresses, service locations
Organization	Healthcare organizations, facilities, and networks	Find provider organizations, health systems
OrganizationAffiliation	Relationships between organizations	Understand organizational networks
Practitioner	Individual healthcare providers	Search for doctors, nurses, specialists
PractitionerRole	Roles practitioners have at organizations	Link providers to their practice locations

Supported Headers

Header	Direction	Description
Accept	Request	Preferred format of response payload.
Content-Type	Response	The format of response payload. Default: application/fhir+json;charset=UTF-8
X-Correlation-Id	Response	Used to provide the requester's transaction ID back in the response when it is not accepted as the transaction ID for Netsmart logging.
X-Request-ID	Request & Response	Unique transaction ID for logging purposes. Typically, a UUID. If this header is passed in the request Netsmart will either accept it as the transaction ID or return it in the response X-Correlation-Id header.

Content-Type

This API supports accepting and returning resources as XML and JSON. You can specify your preference by using the Accept header.

JSON	XML	Turtle
application/fhir+json	application/fhir+xml	application/x-turtle
json	xml	ttl

Operations

Resources on this endpoint will support one or more of the following operations. This section describes how to implement each operation. Please consult the resource-specific documentation to determine which operations are supported.

Read

Production

curl -X GET https://fhir.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/{Resource}/{id} \
    -H "Accept: application/fhir+json"

Preview

curl -X GET https://fhirtest.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/{Resource}/{id} \
    -H "Accept: application/fhir+json"

Search

Common Parameters

Name	Type	Description
_count	special	Integer. Number of result to return per page. Default: 100. Max: 500
_offset	special	Integer. Page offset (zero-based). Default: 0
_sort	special	SortSpec. Sort option.

Via POST (recommended)

The POST method is recommended as it keeps health information out of the URL.

Production

curl -X POST https://fhir.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/{Resource}/_search \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "parameter=value%20parameter=value"

Preview

curl -X POST https://fhirtest.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/{Resource}/_search \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "parameter=value%20parameter=value"

Via GET

Production

curl -X GET "https://fhir.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/{Resource}?parameter=value&parameter=value" \
    -H "Accept: application/fhir+json"

Preview

curl -X GET https://fhirtest.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/{Resource}/{id} \
    -H "Accept: application/fhir+json"

Search Example

The following example illustrates using the common search parameters with the Practitioner resource. The API will return the second set of 5 matching results for Practitioners with the family name like "Baker".

Production

Example: Practitioner Search by Family Name

curl -X POST https://fhir.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/Practitioner/_search \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "family=Baker&_offset=5&_count=5"

Preview

curl -X POST https://fhirtest.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/Practitioner/_search \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "family=Baker&_offset=5&_count=5"

Resource Relationships

Provider Directory resources are interconnected to provide comprehensive provider network information:

Key Relationships:

• PractitionerRole links Practitioners to Organizations and Locations
• HealthcareService describes services offered by Organizations at Locations
• OrganizationAffiliation shows relationships between Organizations
• InsurancePlan indicates which plans are accepted by Organizations
• Endpoint provides technical connectivity information for Organizations and Locations

For detailed information about each resource, including specific search parameters, examples, and integration patterns, see the individual resource documentation linked in the table above.

Error Handling

All Provider Directory API errors follow FHIR OperationOutcome format. For comprehensive error documentation, troubleshooting guidance, and examples, see the dedicated Common Errors page.

Quick Reference:

• 400 Bad Request: Invalid search parameters or malformed requests
• 403 Forbidden: Invalid URL path or unsupported endpoint
• 404 Not Found: Resource doesn't exist or unsupported resource type
• 429 Too Many Requests: Rate limit exceeded
• 500 Internal Server Error: Server-side errors