1.0.3 - release
CH
KisimScheduling - Local Development build (v1.0.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2025-07-25 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:OperationDefinition ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "slot-query-searchByAppointment"] ; #
fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition slot-query-searchByAppointment</b></p><a name=\"slot-query-searchByAppointment\"> </a><a name=\"hcslot-query-searchByAppointment\"> </a><a name=\"slot-query-searchByAppointment-en-US\"> </a><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>_query</td><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\">BindingStrength</a> (Required)</td><td><div><p>Extended search parameter as defined by the fhir-specification. Value has to be "searchByAppointment"</p>\n</div></td></tr><tr><td>IN</td><td>TERMNR</td><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\">BindingStrength</a> (Required)</td><td><div><p>ID of existing Appointment</p>\n</div></td></tr><tr><td>IN</td><td>start</td><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\">BindingStrength</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>\n</div></td></tr><tr><td>IN</td><td>maxDays</td><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\">BindingStrength</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>\n</div></td></tr><tr><td>IN</td><td>splitSlots</td><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\">BindingStrength</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>\n</div></td></tr><tr><td>IN</td><td>durationMinutes</td><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\">BindingStrength</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>\n</div></td></tr><tr><td>IN</td><td>resourceFilter</td><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\">BindingStrength</a> (Required)</td><td><div><p>Filter the slots by location or practitioner. Those values equal the values inside KISIM. The value can be either "USER" for practitioners or "KONS" for locations(rooms)</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><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\">BindingStrength</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>\n</div></td></tr></table></div>"^^rdf:XMLLiteral
] ; #
fhir:url [ fhir:v "http://fhir.kisimdocs.ch/ig/KisimScheduling/OperationDefinition/slot-query-searchByAppointment"^^xsd:anyURI] ; #
fhir:version [ fhir:v "1.0.3"] ; #
fhir:name [ fhir:v "SearchSlotByAppointment"] ; #
fhir:title [ fhir:v "Search Slots by Appointment"] ; #
fhir:status [ fhir:v "draft"] ; #
fhir:kind [ fhir:v "query"] ; #
fhir:date [ fhir:v "2025-07-25T15:46:04+02:00"^^xsd:dateTime] ; #
fhir:publisher [ fhir:v "Cistec AG"] ; #
fhir:contact ( [
fhir:name [ fhir:v "Cistec AG" ] ;
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "https://www.cistec.com" ] ] [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "robert.birri@cistec.com" ] ] )
] ) ; #
fhir:description [ fhir:v "Search free slots in a time period for an already existing appointment"] ; #
fhir:jurisdiction ( [
( fhir:coding [
fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
fhir:code [ fhir:v "CH" ] ] )
] ) ; #
fhir:code [ fhir:v "searchByAppointment"] ; #
fhir:resource ( [ fhir:v "Slot"] ) ; #
fhir:system [ fhir:v false] ; #
fhir:type [ fhir:v false] ; #
fhir:instance [ fhir:v false] ; #
fhir:parameter ( [
fhir:name [ fhir:v "_query" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Extended search parameter as defined by the fhir-specification. Value has to be \"searchByAppointment\"" ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "string" ] ;
fhir:binding [
fhir:strength [ fhir:v "required" ] ;
fhir:valueSet [
fhir:v "http://hl7.org/fhir/ValueSet/binding-strength"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/ValueSet/binding-strength> ] ]
] [
fhir:name [ fhir:v "TERMNR" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "ID of existing Appointment" ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "string" ] ;
fhir:binding [
fhir:strength [ fhir:v "required" ] ;
fhir:valueSet [
fhir:v "http://hl7.org/fhir/ValueSet/binding-strength"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/ValueSet/binding-strength> ] ]
] [
fhir:name [ fhir:v "start" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "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." ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "string" ] ;
fhir:binding [
fhir:strength [ fhir:v "required" ] ;
fhir:valueSet [
fhir:v "http://hl7.org/fhir/ValueSet/binding-strength"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/ValueSet/binding-strength> ] ]
] [
fhir:name [ fhir:v "maxDays" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Defines the number of days from \"start\" during which empty slots are searched. Value of 1 equals 24 hours. Max Value=10" ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "string" ] ;
fhir:binding [
fhir:strength [ fhir:v "required" ] ;
fhir:valueSet [
fhir:v "http://hl7.org/fhir/ValueSet/binding-strength"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/ValueSet/binding-strength> ] ]
] [
fhir:name [ fhir:v "splitSlots" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "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." ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "string" ] ;
fhir:binding [
fhir:strength [ fhir:v "required" ] ;
fhir:valueSet [
fhir:v "http://hl7.org/fhir/ValueSet/binding-strength"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/ValueSet/binding-strength> ] ]
] [
fhir:name [ fhir:v "durationMinutes" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "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." ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "string" ] ;
fhir:binding [
fhir:strength [ fhir:v "required" ] ;
fhir:valueSet [
fhir:v "http://hl7.org/fhir/ValueSet/binding-strength"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/ValueSet/binding-strength> ] ]
] [
fhir:name [ fhir:v "resourceFilter" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Filter the slots by location or practitioner. Those values equal the values inside KISIM. The value can be either \"USER\" for practitioners or \"KONS\" for locations(rooms)" ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "string" ] ;
fhir:binding [
fhir:strength [ fhir:v "required" ] ;
fhir:valueSet [
fhir:v "http://hl7.org/fhir/ValueSet/binding-strength"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/ValueSet/binding-strength> ] ]
] [
fhir:name [ fhir:v "return" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "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." ] ;
fhir:type [ fhir:v "Bundle" ] ;
fhir:binding [
fhir:strength [ fhir:v "required" ] ;
fhir:valueSet [
fhir:v "http://hl7.org/fhir/ValueSet/binding-strength"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/ValueSet/binding-strength> ] ]
] ) . #
IG © 2022+ Cistec AG. Package hl7.fhir.ch.kisimscheduling#1.0.3 based on FHIR 4.0.1. Generated 2025-07-25
Links: Table of Contents |
QA Report