Contact Us

Provider Directory API

Plan-Net HealthcareService

The HealthcareService resource profile describes services offered by an organization and/or practitioner at a specific location. The profile may be used to encompass a variety of services covering the entire healthcare spectrum. These services can include: promotion, prevention, diagnostics, pharmacy, hospital and ambulatory care, home care, long-term care, and other health-related and community services.

The HealthcareService structure is derived from the FHIR R4 HealthcareService resource. The HealthcareService resource is used to describe a single healthcare service or category of services that are provided by an organization at a location.

This structure refers to the following:

  • Structures
    • plannet-Organization
    • plannet-Location
    • plannet-Endpoint
  • Extensions
    • newpatients
    • delivery-method
    • 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 HealthcareService 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 for a HealthcareService

Retrieve all HealthcareService resources. The HealthcareService resource is used to describe a single healthcare service or category of services that are provided by an organization at a location. The location of the services could be virtual, as with telemedicine services.

GET {{baseurl}}/HealthcareService

Search by Service Category

Select HealthcareServices providing the specified category of services.

GET {{baseurl}}/HealthcareService?service-category=[service-category]

Search by Location

Select HealthcareServices with the specified location.

GET {{baseurl}}/HealthcareService?location=location/[location]

Search by Name

Select HealthcareServices with the specified name.

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

Examples

More Information about the Plan-Net HealthcareService profile