Getting Started with Provider Directory API
The CareConnect Provider Directory API provides public access to payer network information including healthcare providers, organizations, locations, and insurance plans. This guide will help you get started quickly.
What is the Provider Directory API?
The Provider Directory API is a FHIR R4-based service that allows applications to:
- Discover healthcare providers in insurance networks
- Find provider locations and contact information
- Access insurance plan details and coverage areas
- Verify provider-organization relationships
- Locate healthcare services by specialty or geography
Key Features:
- No Authentication Required - Publicly accessible endpoints
- FHIR R4 Compliant - Standard healthcare data format
- Real-time Data - Current provider network information
- Geographic Search - Location-based provider discovery
Before You Start
Prerequisites
- Basic understanding of REST APIs
- Familiarity with JSON data format
- Knowledge of FHIR concepts (helpful but not required)
What You'll Need
- Provider Directory Base URL - Discover available endpoints using the Service Base URL documentation
- API Testing Tool - We recommend Postman or curl
- FHIR Resource Knowledge - Review the resource documentation for data structures
Quick Start Workflow
Step 1: Discover Available APIs
- Production
- Preview
curl -X GET https://fhir.netsmartcloud.com/brand/brands.json
curl -X GET https://fhirtest.netsmartcloud.com/brand/brands.json
Look for endpoints containing /payer/provider-directory/ in the response. Only payer tenants will have Provider Directory endpoints available.
Step 2: Check Server Capabilities
- Production
- Preview
curl -X GET https://fhir.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/metadata \
-H "Accept: application/fhir+json"
curl -X GET https://fhirtest.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/metadata \
-H "Accept: application/fhir+json"
This returns a CapabilityStatement showing supported resources and operations.
Step 3: Search for Organizations
- Production
- Preview
curl -X GET "https://fhir.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/Organization?_count=5" \
-H "Accept: application/fhir+json"
curl -X GET "https://fhirtest.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/Organization?_count=5" \
-H "Accept: application/fhir+json"
Step 4: Get Specific Organization Details
- Production
- Preview
curl -X GET https://fhir.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/Organization/{organization-id} \
-H "Accept: application/fhir+json"
curl -X GET https://fhirtest.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/Organization/{organization-id} \
-H "Accept: application/fhir+json"
Common Use Case Examples
Find Providers by Specialty
Search for cardiologists in California:
- Production
- Preview
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-www-form-urlencoded" \
-d "specialty=207RC0000X&address-state=CA&_count=10"
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-www-form-urlencoded" \
-d "specialty=207RC0000X&address-state=CA&_count=10"
Find Locations by City
Search for provider locations in Sacramento:
- Production
- Preview
curl -X GET "https://fhir.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/Location?address-city=Sacramento&_count=10" \
-H "Accept: application/fhir+json"
curl -X GET "https://fhirtest.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/Location?address-city=Sacramento&_count=10" \
-H "Accept: application/fhir+json"
Find Healthcare Services
Search for mental health services:
- Production
- Preview
curl -X POST https://fhir.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/HealthcareService/_search \
-H "Accept: application/fhir+json" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "service-category=394913002&_count=10"
curl -X POST https://fhirtest.netsmartcloud.com/payer/provider-directory/v2/{tenant-id}/HealthcareService/_search \
-H "Accept: application/fhir+json" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "service-category=394913002&_count=10"
Understanding the Response
All successful requests return FHIR Bundle resources containing:
{
"resourceType": "Bundle",
"type": "searchset",
"total": 25,
"entry": [
{
"resource": {
"resourceType": "Organization",
"id": "org-123",
"name": "Example Healthcare System",
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/organization-type",
"code": "prov",
"display": "Healthcare Provider"
}
]
}
]
}
}
]
}
Next Steps
Interactive Testing
- Postman Tutorial - Step-by-step guide for testing with Postman
Explore Resources
- Organization - Healthcare organizations and payers
- Practitioner - Individual healthcare providers
- Location - Physical service locations
- HealthcareService - Available services
Advanced Topics
- Search Parameters - Detailed search capabilities
- Error Handling - Troubleshooting common issues
- Performance Guidelines - Optimization best practices
Need Help?
- Documentation: Review the complete API documentation
- Support: Contact Netsmart for technical assistance
- FHIR Resources: Consult the FHIR R4 specification for detailed resource information