DaVinci PDEX Plan Net API Query Examples

This page contains short descriptions of Practitioner, PractitionerRole, Organization, and OrganizationAffiliation search queries, lists of search parameters, and sample queries.

Practitioner

We store information about practitioners in these FHIR Entities:

Practitioner queries examples:

PractitionerRole

PractitionerRole is a central entity for a practitioner. It means that this entity contains info about practitioner, network, location, organization and healthcareService. You can use PractitionerRole to search practitioners in the selected network:

  1. Get practitionerRoles by network
    https://fhir.villagecare.org/PractitionerRole?practitionerNetwork=MAP
  2. Get Practitioner Fhir ID from the PractitionerRole entity
    "practitioner": {
      "id": "920c870c-2553-4ff0-b255-b2c58504dbce",
      "resource": {
        ...
      },
      "resourceType": "Practitioner"
    }
    
  3. Get practitioner by Fhir ID
    https://fhir.villagecare.org/Practitioner?id=b061b7b9-79d6-4cf2-a758-41debb380760

Advanced PractitionerRole Queries

Also PractitionerRole entity is used to get all FHIR entities connected with a practitioner in one query. These queries can use multiple search parameters and you can include, exclude and combine them. Also you can control what entities will be returned by including and excluding entities from the _include parameter of these queries.

To add additional entities in the response, like Practitioner or Location you should use _include parameter, e.g.:

Also you can use these search parameters:

Advanced PractitionerRole queries examples:

Organization

We store information about organization in these FHIR Entities:

Organization - basic info about an organization. Contains name, address, type, specialty, identifiers like NPI and telecom info like phone and email. OrganizationAffiliation - central entity to connect organization's entities. Network - health plans an organization is connected with Location - organization's location (address) and telecom (phone, email) info HealthcareService - services provided in an organization

Organization queries examples:

OrganizationAffiliation

OrganizationAffiliation is a central entity for an organization. It means that this entity contains info about organization, network, location, and healthcareService. You can use OrganizationAffiliation to search organization in the selected network:

  1. Get OrganizationAffiliation by network
    https://fhir.villagecare.org/OrganizationAffiliation?organizationNetwork=MLTC
  2. Get Organization Fhir ID from the OrganizationAffiliation entity
    "organization": {
         "id": "22d99f7c-4dc6-46da-b5f8-1371f6ae8a53",
         "resource": {
    		...
         },
         "resourceType": "Organization"
    }
    
  3. Get Organization by Fhir ID
    https://fhir.villagecare.org/Organization?id=22d99f7c-4dc6-46da-b5f8-1371f6ae8a53

Advanced OrganizationAffiliation Queries

Also OrganizationAffiliation entity is used to get all FHIR entities connected with an organization in one query. These queries can use multiple search parameters and you can include, exclude and combine them. Also you can control what entities will be returned by including and excluding entities from the _include parameter of these queries.

To add additional entities in the response, like Organization or HealthcareService you should use _include parameter, e.g.:

Also you can use these search parameters:

Advanced OrganizationAffiliation queries examples: