{ "resourceType": "OperationDefinition", "id": "slot-query-searchByPlan", "text": { "status": "extensions", "div": "

SearchSlotByPlan

QUERY: SearchSlotByPlan

The official URL for this operation definition is: 

http://fhir.kisimdocs.ch/ig/KisimScheduling/OperationDefinition/slot-query-searchByPlan

Parameters

UseNameCardinalityTypeBindingDocumentation
IN_query1..1string
(string)		http://hl7.org/fhir/ValueSet/binding-strength (Required)

Extended search parameter as defined by the fhir-specification. Value has to be "searchByPlan"

\n
INplanIcode1..1string
(string)		http://hl7.org/fhir/ValueSet/binding-strength (Required)

Search definition which is created in KISIM. The identifier is a UUID.

\n
INstart0..1string
(string)		http://hl7.org/fhir/ValueSet/binding-strength (Required)

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.

\n
INmaxDays1..1string
(string)		http://hl7.org/fhir/ValueSet/binding-strength (Required)

Defines the number of days from "start" during which empty slots are searched. Value of 1 equals 24 hours. Max Value=10

\n
INsplitSlots0..1string
(string)		http://hl7.org/fhir/ValueSet/binding-strength (Required)

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.

\n
INdurationMinutes0..1string
(string)		http://hl7.org/fhir/ValueSet/binding-strength (Required)

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.

\n
INresourceFilter0..1string
(string)		http://hl7.org/fhir/ValueSet/binding-strength (Required)

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)

\n
OUTreturn0..1Bundlehttp://hl7.org/fhir/ValueSet/binding-strength (Required)

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.

\n
" }, "url": "http://fhir.kisimdocs.ch/ig/KisimScheduling/OperationDefinition/slot-query-searchByPlan", "version": "0.1.0", "name": "SearchSlotByPlan", "status": "draft", "kind": "query", "date": "2022-09-05T14:14:42+02:00", "publisher": "Cistec AG", "contact": [ { "name": "Cistec AG", "telecom": [ { "system": "url", "value": "https://www.cistec.com" }, { "system": "email", "value": "robert.birri@cistec.com" } ] } ], "code": "searchByPlan", "resource": [ "Slot" ], "system": false, "type": false, "instance": false, "parameter": [ { "name": "_query", "use": "in", "min": 1, "max": "1", "documentation": "Extended search parameter as defined by the fhir-specification. Value has to be \"searchByPlan\"", "type": "string", "searchType": "string", "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/binding-strength" } }, { "name": "planIcode", "use": "in", "min": 1, "max": "1", "documentation": "Search definition which is created in KISIM. The identifier is a UUID.", "type": "string", "searchType": "string", "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/binding-strength" } }, { "name": "start", "use": "in", "min": 0, "max": "1", "documentation": "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": "string", "searchType": "string", "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/binding-strength" } }, { "name": "maxDays", "use": "in", "min": 1, "max": "1", "documentation": "Defines the number of days from \"start\" during which empty slots are searched. Value of 1 equals 24 hours. Max Value=10", "type": "string", "searchType": "string", "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/binding-strength" } }, { "name": "splitSlots", "use": "in", "min": 0, "max": "1", "documentation": "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": "string", "searchType": "string", "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/binding-strength" } }, { "name": "durationMinutes", "use": "in", "min": 0, "max": "1", "documentation": "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": "string", "searchType": "string", "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/binding-strength" } }, { "name": "resourceFilter", "use": "in", "min": 0, "max": "1", "documentation": "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": "string", "searchType": "string", "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/binding-strength" } }, { "name": "return", "use": "out", "min": 0, "max": "1", "documentation": "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": "Bundle", "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/binding-strength" } } ] }