Practitioner
Use the Practitioner resource to obtain information about healthcare providers managed by Health Gorilla.
FHIR Resource: Practitioner https://www.hl7.org/fhir/practitioner.html
Supported Attributes
Field Name | Comments |
---|---|
identifier | NPI UID |
active | |
birthDate | |
name | |
telecom | |
address |
https://api.healthgorilla.com/fhir/Practitioner
FHIR Operations
The following operations are currently supported:
1. Read
HTTP Request | Method | Action |
---|---|---|
/Practitioner/{ID} | GET | Retrieve provider by ID |
2. Search
HTTP Request | Method | Action |
---|---|---|
/Practitioner?[parameter={value}] | GET | Retrieve providers by the specified search criteria |
Search Parameters:
Name | Type | Description |
---|---|---|
Identifier | Token | A practitioner's Identifier. |
name | String | |
role | Token | The only value supported: doctor (Required) |
specialty | Token | |
near | Token | The coordinates expressed as [latitude]:[longitude] (using the WGS84 datum, see notes) to find locations near to. |
near-distance | Quantity | Miles (Required) |
address-state | String | |
address-city | String | |
address-postalcode | String | |
_offset | Number | |
_count | Number | Page size |
_include | Use to include related PractitionerRole into result Bundle. https://www.hl7.org/fhir/STU3/search.html#include |
Available values for include directive:
Include | Criteria | Resource |
---|---|---|
_revinclude | PractitionerRole:practitioner | PractitionerRole |
Examples
2.1 Search practitioner by NPI number:
https://api.healthgorilla.com/fhir/Practitioner?identifier=http://hl7.org/fhir/sid/us-npi|1234567893
2.2 Search practitioner by Health Gorilla assigned identifier:
https://api.healthgorilla.com/fhir/Practitioner?identifier=https://www.healthgorilla.com|f3c88f5b53910aba83b224f4
2.3 Search cardiologists by name within 10 miles around Sunnyvale, CA. PractitionerRole entries that refer to Practitioner records are also included into result bundle:
https://api.healthgorilla.com/fhir/Practitioner?
name=Gregory House
&role=doctor
&speciality=Cardiologist
&address-city=Sunnyvale
&address-state=CA
&near-distance=10
&_revinclude=PractitionerRole:practitioner
&_count=20
2.4 Search providers by name within 1000 miles in CA:
https://api.healthgorilla.com/fhir/Practitioner?
name=Gregory House
&role=doctor
&address-state=CA
&near-distance=1000
2.5 Search providers by name within 5 miles around the specified point:
https://api.healthgorilla.com/fhir/Practitioner?
name=Gregory House
&role=doctor
&near=37.3910024:-122.0765676
&near-distance=5
Updated 10 months ago