0.2.0 - trial-use

KisimScheduling - Local Development build (v0.2.0). See the Directory of published versions

OperationDefinition: Search Appointments by Encounter

Official URL: http://fhir.kisimdocs.ch/ig/KisimScheduling/OperationDefinition/appointment-query-searchByEncounter Version: 0.2.0
Draft as of 2022-10-05 Computable Name: SearchAppointmentByEncounter

The basic fhir specification allows the search for appointments by patient id but not by encounter. Therefore, we added this additional search algorithm.

Additional to the _query parameter we also need to include a time frame defined by the from and to parameters.

Usage

This operation might be used by systems which have the encounter id and want to display the appointments for a patient. An example would be patient entertainment systems.

SearchAppointmentByEncounter

QUERY: SearchAppointmentByEncounter

The official URL for this operation definition is: 

http://fhir.kisimdocs.ch/ig/KisimScheduling/OperationDefinition/appointment-query-searchByEncounter

Parameters

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

Extended search parameter, value has to be searchByEncounter

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

The encounter ID.

INfrom1..1dateTimehttp://hl7.org/fhir/ValueSet/binding-strength (Required)

Starting date/time for the search.

INto1..1dateTimehttp://hl7.org/fhir/ValueSet/binding-strength (Required)

Stopping date/time for the search.

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

A bundle of appointment ressources.

Notes:

Examples

Search for a time period

Search appointments for encounter:

GET [base]/Appointment?_query=searchByEncounter&encounter=12345&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"
                    }
                ]
            }
        }
    ]
}