Contact Us

Provider Directory API

Plan-Net Organization

The Organization resource profile describes a formal or informal grouping of people or organizations with a common purpose (e.g., company, institution, corporation, community group, healthcare practice).

Note: When the contact is a department rather than a human (e.g., patient help line), add the department name in contact.name.text and include blank family and given name fields.

The Organization profile is based on the U.S. Core Organization profile. Both the Plan-Net Network and Organization profiles are based on this Organization profile. To selectively query only Network profiles, search for type = ntwk. To selectively query only Organization profiles, search for type = fac,bus,prvgrp,payer,atyprv.

This structure refers to the following:

  • Structure
    • plannet-Organization
  • Extensions
    • qualification
    • org-description
    • location-reference
    • contactpoint-availabletime
    • via-intermediary
    • geolocation

Since the Plan-Net Network and Organization profiles are both based on the Organization profile, you must distinguish which of these you want to search for if you want to narrow your search. To selectively query only Network profiles, search for type = ntwk. To selectively query only Organization profiles, search for type = fac,bus,prvgrp,payer,atyprv.

Note: Unlike Plan-Net, CARIN for Blue Button® does not have a separate Network resource profile; all Network parameters are handled by the Organization resource in C4BB.

References

Many of the defined elements in a resource are references to other resources. Using these references, the resources combine to build a web of information about healthcare. The Organization profile references these resources:

Note: Not all resources may be available for all provider directories.

Anticipated Queries

Use Postman to test Opala’s Provider Directory API by querying the API and returning the results. Opala’s Collection is a group of API requests that are already saved in the Postman app and arranged in folders. Within each folder are pre-defined requests that you can run as-is or modify to fit your own needs.

Contact us to request a copy of the Postman collection for the Provider Directory API.

Search Organization

Retrieve all Organization resources. An organization can be a company, institution, corporation, community group, or healthcare practice.

Guidance: When the contact is a department name, rather than a human (e.g., patient help line), include a blank family and given name, and provide the department name in contact.name.text

GET {{baseurl}}/Organization

Search by Name

Select an Organization with a specific name.

GET {{baseurl}}/Organization?name=[name]

Search by Type

Select Organizations that are part of the specified organization.

GET {{baseurl}}/Organization?partof=[partof]

GET {{baseurl}}/Organization?type=[type]

Search by Address 

Select Organizations that are at a specified location.

GET {{baseurl}}/Organization?address-use=[address-use]

GET {{baseurl}}/Organization?address=[organization-address]

Examples

More Information about the Plan-Net Organization profile