0.1.0 - ci-build

TCFHIRAGSchedulingR5 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

OperationDefinition: healthcareService-provider-find

Official URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/OperationDefinition/healthcareService-provider-find Version: 0.1.0
Active as of 2025-02-07 Responsible: HL7® Austria, TC FHIR® Computable Name: Find_HealthcareService_Provider

A query operation that allows to search for healthcare service providers that offer a specific healthcare service. The general information about the HealthcareService identification itself is already available in advance, either as resource or via codes.

Generated Narrative: OperationDefinition healthcareService-provider-find

URL: [base]/HealthcareService/$findHSP

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INhealthcareService-reference0..1Resource (HL7® AT Scheduling HealthcareService Profile)

The full HealthcareService resource can be provided for this operation. The HealthcareService SHALL have be active (HealthcareService.active=true).

INhealthcareService-category0..1string
(token)

The code of the category of the healthcare service. Each parameter value SHALL contain both the system property and the code property for a code using the general syntax healthcareService-category=[system]|[code]. See the examples below for how this is implemented.

INhealthcareService-type0..1string
(token)

The code of the type of the healthcare service. Each parameter value SHALL contain both the system property and the code property for a code using the general syntax healthcareService-type=[system]|[code]. See the examples below for how this is implemented.

INhealthcareService-specialty0..1string
(token)

The code of the specialty of the healthcare service. Each parameter value SHALL contain both the system property and the code property for a code using the general syntax healthcareService-specialty=[system]|[code]. See the examples below for how this is implemented.

INhealthcareService-location0..*Reference (Location)

The (physical) location where a healthcare service should be provided can be used as a search parameter.

INhealthcareService-zipCodeArea0..*string
(string)

The aera in which a healthcare service should be offered can be provided as search parameter. For that purpose the zip code(s) shall be used.

INhealthcareService-availability0..*Availability

The desired availabilities for the healthcare service.

OUTresult1..1Bundle

The response will be a Bundle consisting of the HealthcareService resource and a list of healthcare service providers (Organization, Practitioner, PractitionerRole) that offer the requested service and an OperationOutcome with errors, warnings or information as a result of processing the operation.

Notes:

  • For input parameters that are codes, the simple FHIR token search parameter type is used instead of the complex CodeableConcept datatype. This allows either the 'GET' or the 'POST' syntax to be used to initiate the interaction in many cases. The Reference datatype is used for resources references, which allows the requester to use either a reference to existing resource, or an identifier (logical reference).
  • To set the upper limit on the total number of available appointment options to return use the standard _count search parameter.

For the Scheduling Client

This query operation is used by the Scheduling Client to find healthcare service providers that offer a specific healthcare service. This can be achieved by:

  • using a HealthcareService instance (as full resource) as search input
  • identifying the healthcare service via a code (HealthcareService.category, HealthcareService.type or HealthcareService.specialty)

In addition to that a Scheduling Client can provide further filter criteria in its search like:

  • a region where a healthcare service should ideally be offered with either a Location reference or a zip code
  • the desired availablity time of a healthcare service
Pre-Conditions

The following pre-conditions must be fullfilled for the $findHSP operation to be successful:

  • The general information about the HealthcareService identification itself is already available in advance
  • This means that either the client has already searched for the healthcare service and has fetched the corresponding HealthcareService resource instance or the client is aware of the codes for category, type or specialty of it.

If a healthcare service information is not provided by the client in this query operation, the Scheduling Server SHALL reject the operation and provide a corresponding explanation in the OperationOutcome.

For the Scheduling Server

Based on the search input the Scheduling Server has to look up the corresponding healthcare service as well as the healthcare service providers that offer it. Depending on the implementation and the supported scenarios for the scheduling workflow, the server has to do this internally and/or with its connected systems. It SHALL respond to the client with a Bundle containing the HealthcareService resource and a list of healthcare service providers (Organization, Practitioner, PractitionerRole) that offer the requested service. Furthermore it SHALL contain an OperationOutcome with errors, warnings or information as a result of processing the operation.

Examples

ToDo