The Opala Provider Directory API Setting Up Postman
Plan-Net Resource Profiles

© 2021-2022 Opala. All Rights Reserved.

Version 1.1.0.0

Contact Opala's
Documentation Team

Plan-Net Location (7.56.1)

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:

  • 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:

Anticipated Queries

Use Postman to test Opala's Provider Directory API by querying the API and returning the results. The Opala 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.

See the Setting Up Postman topic in this documentation set for information on how to import the Opala Collection into your local copy of Postman.

You can view Opala's Capability Statement at https://api.opalahealth.io:45000/pdir/premera/v1/fhir/r4/metadata for a description of the Provider Directory API to assist you in making your queries.

Search Location

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

GET {{base_url}}/Location

Search by Postal Code

Select locations within the specified postal (zip) code.

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

Note: When searching by Zip code, Opala recommends not including the +4 in the Zip+4 format. Doing this will give you a larger result set. Limiting the search to a single Zip+4 location will return fewer (perhaps no) results.

Search by State

Select locations within the specified state.

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

Search by Address in a City

Select locations within the specified city.

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

Examples

More Information about the plannetLocation profile

Top