0.2.0 - trial-use
KisimScheduling - Local Development build (v0.2.0). See the Directory of published versions
| Draft as of 2022-10-05 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="slot-query-searchByPlan"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><h2>SearchSlotByPlan</h2><p>QUERY: SearchSlotByPlan</p><p>The official URL for this operation definition is: </p><pre>http://fhir.kisimdocs.ch/ig/KisimScheduling/OperationDefinition/slot-query-searchByPlan</pre><p>Parameters</p><table class="grid"><tr><td><b>Use</b></td><td><b>Name</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>_query</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#string">string</a>)</td><td><a href="http://hl7.org/fhir/R4/valueset-binding-strength.html">http://hl7.org/fhir/ValueSet/binding-strength</a> (Required)</td><td><div><p>Extended search parameter as defined by the fhir-specification. Value has to be "searchByPlan"</p>
</div></td></tr><tr><td>IN</td><td>planIcode</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#string">string</a>)</td><td><a href="http://hl7.org/fhir/R4/valueset-binding-strength.html">http://hl7.org/fhir/ValueSet/binding-strength</a> (Required)</td><td><div><p>Search definition which is created in KISIM. The identifier is a UUID.</p>
</div></td></tr><tr><td>IN</td><td>start</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#string">string</a>)</td><td><a href="http://hl7.org/fhir/R4/valueset-binding-strength.html">http://hl7.org/fhir/ValueSet/binding-strength</a> (Required)</td><td><div><p>Starting time for the search. Accepted formats are: "yyyy-mm-dd hh:ii" or "yyyy-mm-dd". If the parameter is not set the search starts now.</p>
</div></td></tr><tr><td>IN</td><td>maxDays</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#string">string</a>)</td><td><a href="http://hl7.org/fhir/R4/valueset-binding-strength.html">http://hl7.org/fhir/ValueSet/binding-strength</a> (Required)</td><td><div><p>Defines the number of days from "start" during which empty slots are searched. Value of 1 equals 24 hours. Max Value=10</p>
</div></td></tr><tr><td>IN</td><td>splitSlots</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#string">string</a>)</td><td><a href="http://hl7.org/fhir/R4/valueset-binding-strength.html">http://hl7.org/fhir/ValueSet/binding-strength</a> (Required)</td><td><div><p>Value of either 0 or 1. If the parameter is set to 1, the slots are split into a KISIM-defined length from the search plan or the durationMinutes parameter.</p>
</div></td></tr><tr><td>IN</td><td>durationMinutes</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#string">string</a>)</td><td><a href="http://hl7.org/fhir/R4/valueset-binding-strength.html">http://hl7.org/fhir/ValueSet/binding-strength</a> (Required)</td><td><div><p>Number of minutes to split the slots into. If nothing is set, the default value from KISIM as defined in the search plan is used.</p>
</div></td></tr><tr><td>IN</td><td>resourceFilter</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a><br/>(<a href="http://hl7.org/fhir/R4/search.html#string">string</a>)</td><td><a href="http://hl7.org/fhir/R4/valueset-binding-strength.html">http://hl7.org/fhir/ValueSet/binding-strength</a> (Required)</td><td><div><p>Filter the slots by location. Those values equal the values inside KISIM. The balue can be either "USER" for practitioners or "KONS" for locations(rooms)</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td><a href="http://hl7.org/fhir/R4/valueset-binding-strength.html">http://hl7.org/fhir/ValueSet/binding-strength</a> (Required)</td><td><div><p>A bundle of slot resources. The ID is dynamic. Found slots will be cached for a time on the server. After that time, the slot will no longer be accessible.</p>
</div></td></tr></table></div>
</text>
<url
value="http://fhir.kisimdocs.ch/ig/KisimScheduling/OperationDefinition/slot-query-searchByPlan"/>
<version value="0.2.0"/>
<name value="SearchSlotByPlan"/>
<status value="draft"/>
<kind value="query"/>
<date value="2022-10-05T16:49:12+02:00"/>
<publisher value="Cistec AG"/>
<contact>
<name value="Cistec AG"/>
<telecom>
<system value="url"/>
<value value="https://www.cistec.com"/>
</telecom>
<telecom>
<system value="email"/>
<value value="robert.birri@cistec.com"/>
</telecom>
</contact>
<code value="searchByPlan"/>
<resource value="Slot"/>
<system value="false"/>
<type value="false"/>
<instance value="false"/>
<parameter>
<name value="_query"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Extended search parameter as defined by the fhir-specification. Value has to be "searchByPlan""/>
<type value="string"/>
<searchType value="string"/>
<binding>
<strength value="required"/>
<valueSet value="http://hl7.org/fhir/ValueSet/binding-strength"/>
</binding>
</parameter>
<parameter>
<name value="planIcode"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Search definition which is created in KISIM. The identifier is a UUID."/>
<type value="string"/>
<searchType value="string"/>
<binding>
<strength value="required"/>
<valueSet value="http://hl7.org/fhir/ValueSet/binding-strength"/>
</binding>
</parameter>
<parameter>
<name value="start"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Starting time for the search. Accepted formats are: "yyyy-mm-dd hh:ii" or "yyyy-mm-dd". If the parameter is not set the search starts now."/>
<type value="string"/>
<searchType value="string"/>
<binding>
<strength value="required"/>
<valueSet value="http://hl7.org/fhir/ValueSet/binding-strength"/>
</binding>
</parameter>
<parameter>
<name value="maxDays"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Defines the number of days from "start" during which empty slots are searched. Value of 1 equals 24 hours. Max Value=10"/>
<type value="string"/>
<searchType value="string"/>
<binding>
<strength value="required"/>
<valueSet value="http://hl7.org/fhir/ValueSet/binding-strength"/>
</binding>
</parameter>
<parameter>
<name value="splitSlots"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Value of either 0 or 1. If the parameter is set to 1, the slots are split into a KISIM-defined length from the search plan or the durationMinutes parameter."/>
<type value="string"/>
<searchType value="string"/>
<binding>
<strength value="required"/>
<valueSet value="http://hl7.org/fhir/ValueSet/binding-strength"/>
</binding>
</parameter>
<parameter>
<name value="durationMinutes"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Number of minutes to split the slots into. If nothing is set, the default value from KISIM as defined in the search plan is used."/>
<type value="string"/>
<searchType value="string"/>
<binding>
<strength value="required"/>
<valueSet value="http://hl7.org/fhir/ValueSet/binding-strength"/>
</binding>
</parameter>
<parameter>
<name value="resourceFilter"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Filter the slots by location. Those values equal the values inside KISIM. The balue can be either "USER" for practitioners or "KONS" for locations(rooms)"/>
<type value="string"/>
<searchType value="string"/>
<binding>
<strength value="required"/>
<valueSet value="http://hl7.org/fhir/ValueSet/binding-strength"/>
</binding>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation
value="A bundle of slot resources. The ID is dynamic. Found slots will be cached for a time on the server. After that time, the slot will no longer be accessible."/>
<type value="Bundle"/>
<binding>
<strength value="required"/>
<valueSet value="http://hl7.org/fhir/ValueSet/binding-strength"/>
</binding>
</parameter>
</OperationDefinition>