0.1.0 - ci-build
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
| Active as of 2025-01-25 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="healthcareService-provider-find"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition healthcareService-provider-find</b></p><a name="healthcareService-provider-find"> </a><a name="hchealthcareService-provider-find"> </a><a name="healthcareService-provider-find-en-US"> </a><p>URL: [base]/HealthcareService/$findHSP</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>healthcareService-reference</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/resource.html">Resource</a> (<a href="StructureDefinition-at-scheduling-healthcareservice.html" title="http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/at-scheduling-healthcareservice">HL7® AT Scheduling HealthcareService Profile</a>)</td><td/><td><div><p>The full HealthcareService resource can be provided for this operation. The HealthcareService SHALL have be active (HealthcareService.active=true).</p>
</div></td></tr><tr><td>IN</td><td>healthcareService-category</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R5/search.html#token">token</a>)</td><td/><td><div><p>The code of the category of the healthcare service. Each parameter value SHALL contain <em>both</em> the system property and the code property for a code using the general syntax <code>healthcareService-category=[system]|[code]</code>. See the examples below for how this is implemented.</p>
</div></td></tr><tr><td>IN</td><td>healthcareService-type</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R5/search.html#token">token</a>)</td><td/><td><div><p>The code of the type of the healthcare service. Each parameter value SHALL contain <em>both</em> the system property and the code property for a code using the general syntax <code>healthcareService-type=[system]|[code]</code>. See the examples below for how this is implemented.</p>
</div></td></tr><tr><td>IN</td><td>healthcareService-specialty</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R5/search.html#token">token</a>)</td><td/><td><div><p>The code of the specialty of the healthcare service. Each parameter value SHALL contain <em>both</em> the system property and the code property for a code using the general syntax <code>healthcareService-specialty=[system]|[code]</code>. See the examples below for how this is implemented.</p>
</div></td></tr><tr><td>IN</td><td>healthcareService-location</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R5/references.html#Reference">Reference</a> (<a href="http://hl7.org/fhir/R5/location.html" title="http://hl7.org/fhir/StructureDefinition/Location">Location</a>)</td><td/><td><div><p>The (physical) location where a healthcare service should be provided can be used as a search parameter.</p>
</div></td></tr><tr><td>IN</td><td>healthcareService-zipCodeArea</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R5/search.html#string">string</a>)</td><td/><td><div><p>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.</p>
</div></td></tr><tr><td>IN</td><td>healthcareService-availability</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R5/metadatatypes.html#Availability">Availability</a></td><td/><td><div><p>The desired availabilities for the healthcare service.</p>
</div></td></tr><tr><td>OUT</td><td>result</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/bundle.html">Bundle</a></td><td/><td><div><p>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.</p>
</div></td></tr></table></div>
</text>
<url
value="http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/OperationDefinition/healthcareService-provider-find"/>
<version value="0.1.0"/>
<name value="Find_HealthcareService_Provider"/>
<status value="active"/>
<kind value="query"/>
<date value="2025-01-25T14:51:21+00:00"/>
<publisher value="HL7® Austria, TC FHIR®"/>
<description
value="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 value="false"/>
<code value="findHSP"/>
<resource value="HealthcareService"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<parameter>
<name value="healthcareService-reference"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The full HealthcareService resource can be provided for this operation. The HealthcareService SHALL have be active (HealthcareService.active=true). "/>
<type value="Resource"/>
<targetProfile
value="http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/at-scheduling-healthcareservice"/>
</parameter>
<parameter>
<name value="healthcareService-category"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="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 value="string"/>
<searchType value="token"/>
</parameter>
<parameter>
<name value="healthcareService-type"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="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 value="string"/>
<searchType value="token"/>
</parameter>
<parameter>
<name value="healthcareService-specialty"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="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 value="string"/>
<searchType value="token"/>
</parameter>
<parameter>
<name value="healthcareService-location"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="The (physical) location where a healthcare service should be provided can be used as a search parameter."/>
<type value="Reference"/>
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Location"/>
</parameter>
<parameter>
<name value="healthcareService-zipCodeArea"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="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 value="string"/>
<searchType value="string"/>
</parameter>
<parameter>
<name value="healthcareService-availability"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="The desired availabilities for the healthcare service. "/>
<type value="Availability"/>
</parameter>
<parameter>
<name value="result"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="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 value="Bundle"/>
</parameter>
</OperationDefinition>