API Reference/Providers

Providers

FHIR Practitioner

FHIR R4 Practitioner resources representing clinicians, specialists, and care team members.

The Provider Object

FieldTypeDescription
idstringFHIR logical ID for the Practitioner resource
resourceTypestringAlways "Practitioner" per FHIR R4 spec
nameHumanName[]Array of FHIR HumanName objects (family, given, prefix)
identifierIdentifier[]NPI and other professional identifiers
qualificationobject[]Credentials and licensure: MD, NP, RN, etc.
telecomContactPoint[]Office phone, fax, and email contact points
addressAddress[]Practice location addresses

Endpoints

Search FHIR Practitioner resources.

Parameters

ParameterInTypeRequiredDescription
specialtye.g. cardiologyquerystringoptionalClinical specialty code
npie.g. 1234567890querystringoptionalNational Provider Identifier

Request

curl "https://api.healthcloud.ai/v1/providers?specialty=cardiology" \
  -H "Authorization: Bearer hc_test_sk_demo_live_xxxxxx"

Response

Response200
{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 88,
  "entry": [
    {
      "resource": {
        "resourceType": "Practitioner",
        "id": "prov_chen_001",
        "name": [{ "family": "Chen", "given": ["Sarah"] }],
        "identifier": [{ "system": "http://hl7.org/fhir/sid/us-npi", "value": "1234567890" }],
        "qualification": [{ "code": { "coding": [{ "code": "MD" }] } }]
      }
    }
  ]
}

Related Resources