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
| Official URL: http://fhir.kisimdocs.ch/ig/KisimScheduling/OperationDefinition/appointment-query-searchByPlan | Version: 1.0.3 | |||
| Draft as of 2025-07-25 | Computable Name: SearchAppointmentByPlan | |||
Search appointments which were created on the locations or practitioners of a specific plan.
Search for a bundle of appointments which were created on the locations or practitioners defined in the search plan.
Appointments can be searched in a time window. There are two different time windows which are supported, at least one of them needs to be used for the query.
from and to parameters: All appointments which are taking place between the from and to parameters
_lastUpdated date parameter as in FHIR-specification. Search for all appointments which were modified or updated in the given date rangeThis operation can be used to look for appointments after they were booked.
Generated Narrative: OperationDefinition appointment-query-searchByPlan
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | _query | 1..1 | string (string) | BindingStrength (Required) | Extended search parameter, value has to be searchByPlan | |
| IN | planIcode | 1..1 | string (string) | BindingStrength (Required) | Search definition inside ERP. UUID-Format | |
| IN | from | 1..1 | string (string) | BindingStrength (Required) | Starting time for the search. Accepted formats are: "yyyy-mm-dd hh:ii" or "yyyy-mm-dd". | |
| IN | to | 1..1 | string (string) | BindingStrength (Required) | Stopping time for the search. Accepted formats are: "yyyy-mm-dd hh:ii" or "yyyy-mm-dd". | |
| IN | _lastUpdated | 0..1 | date | BindingStrength (Required) | A bundle of appointment ressources. | |
| OUT | return | 0..1 | Bundle | BindingStrength (Required) |
Search for appointments which are taking place during the time window
Search appointments for a plan definition:
GET [base]/Appointment?_query=searchByPlan&planIcode=[UUID]&from=2020-11-10 12:00&to=2020-11-30 17:00
Response
HTTP/1.1 200 OK
[other headers]
Response Body
The response for the different searches will always be a bundle with 0…n entries.
{
"resourceType": "Bundle",
"id": "05163c62-bdb8-4b21-924a-04719932f55b",
"meta": {
"lastUpdated": "2021-03-10T13:56:59.410+01:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "/fhir/r4/*/Appointment?_query=searchByPlan&from=2021-03-07%2012%3A00&planIcode=3bb783e0-f9d8-4d9e-9cfa-d5d9e399ba61&to=2021-03-31%2017%3A00"
}
],
"entry": [
{
"fullUrl": "/fhir/r4/*/Appointment/22839",
"resource": {
"resourceType": "Appointment",
"id": "22839",
"identifier": [
{
"system": "http://cistec.com",
"value": "22839"
}
],
"status": "pending",
"serviceCategory": [
{
"coding": [
{
"system": "http://hl7.org/fhir/ValueSet/service-category",
"code": "35",
"display": "Hospital"
}
]
}
],
"start": "2021-03-11T08:00:00.000+01:00",
"end": "2021-03-11T08:10:00.000+01:00",
"participant": [
{
"actor": {
"reference": "Practitioner/PRACTITIONER",
"display": "Test Practitioner"
},
"status": "accepted"
}
]
}
}
]
}