Practitioner

Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare.

Get 100 practitioners (by default):

GET [base]/fhir/Practitioner

Get practitioner by name:

GET [base]/fhir/Practitioner?name=SMITH%20JOHN

Get practitioners by language:

GET [base]/fhir/Practitioner?communication=es

Get practitioners by specialty:

GET [base]/fhir/Practitioner?qualificationName=PHYSICAL%20THERAPY

Get practitioner by identifier:

GET [base]/fhir/Practitioner?identifier=1861919391

Get practitioners by language AND specialty:

GET [base]/fhir/Practitioner?communication=es&qualificationName=PHYSICAL%20THERAPY

Get practitioner by resource id:

GET [base]/fhir/Practitioner/[id]

The full list of FHIR search parameters for Practitioner is found below. Aidbox also offers a selection of query parameters to further refine search results. This includes pagination, full-text search, sorting etc. Refer to the FHIR API Search docs for information.

The search results are returned in Bundles by default. Alternatively, you can specify a _result parameter with value array to receive resources in a JSON array.

Example response:

Bundle

GET [base]/fhir/Practitioner?ilike=joh+smit

{
   "resourceType":"Bundle",
   "type":"searchset",
   "meta":{
      "versionId":"0"
   },
   "total":2,
   "link":[
      {
         "relation":"first",
         "url":"/fhir/Practitioner?ilike=joh+smit&page=1"
      },
      {
         "relation":"self",
         "url":"/fhir/Practitioner?ilike=joh+smit&page=1"
      }
   ],
   "entry":[
      {
         "resource":{
            "name":[
               {
                  "given":[
                     "John"
                  ],
                  "family":"Smith"
               }
            ],
            "birthDate":"1983-03-27",
            "resourceType":"Practitioner",
            "active":false,
            "id":"0399387c-74d9-4b9f-b52f-eff2778775e8",
            "gender":"male"
         },
         "search":{
            "mode":"match"
         }
      },
      {
         "resource":{
            "name":[
               {
                  "given":[
                     "John"
                  ],
                  "family":"Smith"
               }
            ],
            "birthDate":"1983-03-27",
            "resourceType":"Practitioner",
            "active":true,
            "id":"24f0943f-93d4-430b-848a-3bb21c27440c",
            "gender":"male"
         },
         "search":{
            "mode":"match"
         }
      }
   ]
}

JSON array

GET [base]/fhir/Practitioner?ilike=joh+smit&_result=array

[
   {
      "meta":{
         "versionId":"15043688"
      },
      "name":[
         {
            "given":[
               "John"
            ],
            "family":"Smith"
         }
      ],
      "birthDate":"1983-03-27",
      "resourceType":"Practitioner",
      "active":false,
      "id":"0399387c-74d9-4b9f-b52f-eff2778775e8",
      "gender":"male"
   },
   {
      "meta":{
         "versionId":"27083967"
      },
      "name":[
         {
            "given":[
               "John"
            ],
            "family":"Smith"
         }
      ],
      "birthDate":"1983-03-27",
      "resourceType":"Practitioner",
      "active":true,
      "id":"24f0943f-93d4-430b-848a-3bb21c27440c",
      "gender":"male"
   }
]

Bulk API

The following bulk operations on Practitioner are available.

$dump

Aidbox will respond with Chunked Transfer Encoding ndjson stream, optionally you can get the output in FHIR format or GZIPped.

This is a memory-efficient operation. Aidbox just streams the database cursor to a socket. If your HTTP Client supports processing of Chunked Encoding, you can process resources in stream one by one without waiting for the end of the response. See full docs here.

Request

GET [base]/Practitioner/$dump

Response

HTTP/1.1 200 OK
Content-Type: application/ndjson
Transfer-Encoding: chunked

{"resourceType": "Practitioner", "id": .............}
{"resourceType": "Practitioner", "id": .............}
{"resourceType": "Practitioner", "id": .............}
{"resourceType": "Practitioner", "id": .............}
.........

$dump-csv

Dump Practitioner resources in CSV format.

This operation dumps resource data in Aidbox format as CSV (RFC4180). In this format, columns are paths to JSON values and Rows are values. It includes the header.

Neither the specific order of columns nor the order of rows is guaranteed. See full docs here.

GET [base]/Practitioner/$dump-csv

Parameters

Parameter	Description
Practitioner.active	true/false
Practitioner.address	address
Practitioner.address-city	city
Practitioner.address-country	country
Practitioner.address-postalcode	postal code
Practitioner.address-state	state
Practitioner.address-use	the use of an address
Practitioner.boardCertifiedCode	certification code of a practitioner in ABMS
Practitioner.boardCertifiedValue	certification value of a practitioner in ABMS
Practitioner.communication	spoken language of a practitioner
Practitioner.email	email
Practitioner.family	family name
Practitioner.gender	gender
Practitioner.given	given name
Practitioner.identifier	identifier in a system
Practitioner.name	full name
Practitioner.phone	phone
Practitioner.phonetic	part of a family or given name using a phonetic matching algorithm
Practitioner.qualification	qualification
Practitioner.qualificationCode	qualification code
Practitioner.qualificationName	qualification name
Practitioner.telecom	telecom