Package | hl7.at.fhir.tc.wg.scheduling.r5 |
Resource Type | OperationDefinition |
Id | healthcareService-provider-find |
FHIR Version | R5 |
Source | http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/https://build.fhir.org/ig/HL7Austria/TC-FHIR-AG-Scheduling-R5/OperationDefinition-healthcareService-provider-find.html |
URL | http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/OperationDefinition/healthcareService-provider-find |
Version | 0.2.0 |
Status | active |
Date | 2025-05-23T10:55:12+00:00 |
Name | Find_HealthcareService_Provider |
Authority | hl7 |
Description | 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. |
Type | true |
Kind | operation |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition healthcareService-provider-find
URL: [base]/HealthcareService/$findHSP
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | healthcareService-reference | 0..1 | Reference (HL7® AT Scheduling HealthcareService Profile) | The full HealthcareService resource can be provided for this operation. The HealthcareService SHALL have be active (HealthcareService.active=true). | ||
IN | healthcareService-category | 0..1 | string (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 | ||
IN | healthcareService-type | 0..1 | string (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 | ||
IN | healthcareService-specialty | 0..1 | string (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 | ||
IN | healthcareService-location | 0..* | Reference (Location) | The (physical) location where a healthcare service should be provided can be used as a search parameter. | ||
IN | healthcareService-zipCodeArea | 0..* | 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. | ||
IN | healthcareService-availability | 0..* | Availability | The desired availabilities for the healthcare service. | ||
OUT | result | 1..1 | Bundle | 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. |
{ "resourceType": "OperationDefinition", "id": "healthcareService-provider-find", "text": { "status": "generated", "div": "<!-- snip (see above) -->" }, "url": "http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/OperationDefinition/healthcareService-provider-find", "version": "0.2.0", "name": "Find_HealthcareService_Provider", "status": "active", "kind": "operation", "date": "2025-05-23T10:55:12+00:00", "publisher": "HL7® Austria, TC FHIR®", "description": "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. ", "affectsState": false, "code": "findHSP", "resource": [ "HealthcareService" ], "system": false, "type": true, "instance": false, "parameter": [ { "name": "healthcareService-reference", "use": "in", "min": 0, "max": "1", "documentation": "The full HealthcareService resource can be provided for this operation. The HealthcareService SHALL have be active (HealthcareService.active=true). ", "type": "Reference", "targetProfile": [ "http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/at-scheduling-healthcareservice" ] }, { "name": "healthcareService-category", "use": "in", "min": 0, "max": "1", "documentation": "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.", "type": "string", "searchType": "token" }, { "name": "healthcareService-type", "use": "in", "min": 0, "max": "1", "documentation": "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.", "type": "string", "searchType": "token" }, { "name": "healthcareService-specialty", "use": "in", "min": 0, "max": "1", "documentation": "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.", "type": "string", "searchType": "token" }, { "name": "healthcareService-location", "use": "in", "min": 0, "max": "*", "documentation": "The (physical) location where a healthcare service should be provided can be used as a search parameter.", "type": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ] }, { "name": "healthcareService-zipCodeArea", "use": "in", "min": 0, "max": "*", "documentation": "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.", "type": "string", "searchType": "string" }, { "name": "healthcareService-availability", "use": "in", "min": 0, "max": "*", "documentation": "The desired availabilities for the healthcare service. ", "type": "Availability" }, { "name": "result", "use": "out", "min": 1, "max": "1", "documentation": "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.", "type": "Bundle" } ] }