Production documentation for public provider directory discovery APIs. This reference documents supported resource routes, common search parameters, paging behavior, and response contracts.
| Item | Value |
|---|---|
| FHIR URL | Configured at runtime |
| Base path | /pd |
| Authentication | Not required (public endpoint) |
| Content type | application/fhir+json |
| Pagination | _count with Bundle next links |
| Resource model | FHIR Bundle + resource entries |
| Method | Path | Access | Success Response |
|---|---|---|---|
| GET | /pd/Organization | Public | 200 Bundle(Organization) |
| GET | /pd/Organization/{id} | Public | 200 Organization |
| GET | /pd/Practitioner | Public | 200 Bundle(Practitioner) |
| GET | /pd/Practitioner/{id} | Public | 200 Practitioner |
| GET | /pd/PractitionerRole | Public | 200 Bundle(PractitionerRole) |
| GET | /pd/PractitionerRole/{id} | Public | 200 PractitionerRole |
| GET | /pd/Location | Public | 200 Bundle(Location) |
| GET | /pd/Location/{id} | Public | 200 Location |
| GET | /pd/InsurancePlan | Public | 200 Bundle(InsurancePlan) |
| GET | /pd/InsurancePlan/{id} | Public | 200 InsurancePlan |
| GET | /pd/HealthcareService | Public | 200 Bundle(HealthcareService) |
| GET | /pd/HealthcareService/{id} | Public | 200 HealthcareService |
| GET | /pd/OrganizationAffiliation | Public | 200 Bundle(OrganizationAffiliation) |
| GET | /pd/OrganizationAffiliation/{id} | Public | 200 OrganizationAffiliation |
| Parameter | Description |
|---|---|
name | Name fragment matching for organization/practitioner. |
identifier | System and value identifier search. |
organization | Filter roles/services by organization reference. |
practitioner | Filter roles by practitioner reference. |
address-city | City-level location/organization filtering. |
specialty | Specialty/service capability filtering. |
_count | Page size (server-enforced maximum). |
| Status | Meaning |
|---|---|
| 200 | Resource or Bundle returned successfully. |
| 400 | Unsupported parameter or malformed search value. |
| 404 | Resource id not found. |
| 429 | Rate limited; retry with backoff. |
| 5xx | Server-side issue; retry per client policy. |
Errors are returned as FHIR OperationOutcome payloads.