Contact Us

Provider Directory API

Plan-Net Location

The Location resource profile provides details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated. The Location resource profile describes the physical place where healthcare services are provided, where practitioners are employed, where organizations are based, etc. Locations can range from a room in a building to a geographic region or area.

The Location structure is derived from the U.S. Core Location profile. The U.S. Core Location profile sets minimum expectations for the Location resource for recording, searching for, and fetching a location associated with a patient, provider, or organization.

This structure refers to the following:

  • Structures
    • plannet-Organization
    • plannet-Location
    • plannet-Endpoint
  • Extensions
    • newpatients
    • accessibility
    • location-boundary-geojson
    • contactpoint-availabletime
    • via-intermediary

This list includes both consumer-facing query parameters and system-level parameters (administrative, testing, and debugging). Most developers will only need common filters such as active, location, organization, service-category, specialty, or name.

  • active
  • address
  • address-city
  • address-country
  • address-postalcode
  • address-state
  • address-use
  • binary-access-read
  • binary-access-write
  • characteristic
  • _content
  • coverage-area
  • diff
  • endpoint
  • expunge
  • graphql
  • _has
  • _id
  • identifier
  • _lastUpdated
  • location
  • meta
  • meta-add
  • meta-delete
  • name
  • near
  • operational-status
  • organization
  • partof
  • _profile
  • program
  • resource-placeholder
  • _security
  • service-category
  • service-type
  • _source
  • specialty
  • status
  • _tag
  • _text
  • type
  • validate

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 Location 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 Location

Retrieve all Location resources. The Location resource describes a location associated with a patient, provider, or organization.

GET {{baseurl}}/Location

Search by Postal Code

Select locations within the specified postal (zip) code.

GET {{baseurl}}/Location?address-postalcode=[postalcode]

Search by State

Select locations within the specified state.

GET {{baseurl}}/Location?address-state=[state]

Search by Address in a City

Select locations within the specified city.

GET {{baseurl}}/Location?address-city=[city]

Examples

More Information about the Plan-Net Location profile