1.0.2 - release Switzerland flag

KisimScheduling - Local Development build (v1.0.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

OperationDefinition: Search Appointments by Plan-Icode

Official URL: http://fhir.kisimdocs.ch/ig/KisimScheduling/OperationDefinition/appointment-query-searchByPlan Version: 1.0.2
Draft as of 2023-12-19 Computable Name: SearchAppointmentByPlan

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
    • Format: yyyy-mm-dd hh24:mi (eg. 2023-12-12 13:00)
    • It is not possible to search for appointments in the past, only appointments in the future can be searched
  • _lastUpdated date parameter as in FHIR-specification. Search for all appointments which were modified or updated in the given date range

Usage

This operation can be used to look for appointments after they were booked.

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
IN_query1..1string
(string)		BindingStrength (Required)

Extended search parameter, value has to be searchByPlan

INplanIcode1..1string
(string)		BindingStrength (Required)

Search definition inside ERP. UUID-Format

INfrom1..1string
(string)		BindingStrength (Required)

Starting time for the search. Accepted formats are: "yyyy-mm-dd hh:ii" or "yyyy-mm-dd".

INto1..1string
(string)		BindingStrength (Required)

Stopping time for the search. Accepted formats are: "yyyy-mm-dd hh:ii" or "yyyy-mm-dd".

IN_lastUpdated0..1dateBindingStrength (Required)

A bundle of appointment ressources.

OUTreturn0..1BundleBindingStrength (Required)

Notes:

Examples

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"
                    }
                ]
            }
        }
    ]
}