PractitionerRole Search

get

https://api.getconvergent.io/plannet/v1/fhir/{resource}

Returns all practitionerRole records that match parameters sent in the query string

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

resource

string

required

Defaults to practitionerrole

Query Params

practitioner.name

string

full name, first name, last name. Supports fuzzy search

practitioner.email

string

Search provider by email address. Exact search and case sensitive.

practitioner.communication

string

The Language(s) the provider is proficient in. Must search using Language code or display value..

practitioner.identifier

string

Exact search for provider's NPI. Example npi|1234567890

location.address

string

full address, street address. Supports Fuzzy Search.

location.address.city

string

city. Fuzzy Search

location.address.state

string

state. Exact search on Full Name and abbreviation.

location.address.postalcode

int32

zip code. 5 digits search. Exact search on first 5 digits of zipcode

location.phone

int32

Exact search on 10-digit telephone number

location.email

string

Search provider by location email. Exact Search

location.url

string

Website. Search provider location website. Exact Search and Case Sensitive

location.accessibility-code

string

Codes for documenting general categories of accessibilities available. (adacomp;cultcomp;handiaccess))

specialty:text

string

Search provider by specialty. Supports Fuzzy Search on the specialty display value

code

string

Search provider by provider type display value. Supports Fuzzy Search.

acceptingpatients

string

Whether a Provider is accepting new patients or not. Exact search on code. newpt;nopt

_page

int32

Number of pages - searching with page only will return 25 records per page

_count

int32

Number of records - maximum = 100. Note that searching with count only will return 1 page of records

active

boolean

Search for active providers only

Responses

Language

Loading…

Response

Choose an example:

application/json

200200

400400

404404