1.0.0 - release
1.0.0 - release
KisimScheduling - Local Development build (v1.0.0). See the Directory of published versions
| Draft as of 2023-08-02 |
{
"resourceType" : "OperationDefinition",
"id" : "slot-query-searchByPlan",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>Parameters</p><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 "searchByPlan"</p>\n</div></td></tr><tr><td>IN</td><td>planIcode</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>Search definition which is created in KISIM. The identifier is a UUID.</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. Those values equal the values inside KISIM. The balue 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>"
},
"url" : "http://fhir.kisimdocs.ch/ig/KisimScheduling/OperationDefinition/slot-query-searchByPlan",
"version" : "1.0.0",
"name" : "SearchSlotByPlan",
"status" : "draft",
"kind" : "query",
"date" : "2023-08-02T14:48:38+02:00",
"publisher" : "Cistec AG",
"contact" : [
{
"name" : "Cistec AG",
"telecom" : [
{
"system" : "url",
"value" : "https://www.cistec.com"
},
{
"system" : "email",
"value" : "robert.birri@cistec.com"
}
]
}
],
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "CH"
}
]
}
],
"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"
}
}
]
}
IG © 2022+ Cistec AG. Package hl7.fhir.ch.kisimscheduling#1.0.0 based on FHIR 4.0.1. Generated 2023-08-02
Links: Table of Contents |
QA Report