OperationDefinition-slot-prefetch

Sourcefhir.argonaut.scheduling#1.0.0:Argonaut Scheduling Implementation Guide (v3.0.1)
resourceTypeOperationDefinition
idslot-prefetch
canonicalhttp://fhir.org/guides/argonaut-scheduling/OperationDefinition/slot-prefetch
version1.0.0
statusactive
nameAvailability_Prefetch_Operation
date2018-02-12T19:00:00+11:00
descriptionThis operation fetches available free slots for the 'initial load', update and reconciliation steps in the [Prefetch Use Case](patient-scheduling.html#use-case-3-prefetching-open-slots). The server determines which open slots to expose to the application for use in creating new appointments. If neither a start or end date is given then the maximum period as defined by local business rules and starting from when the operation was transacted SHALL be used. The actors practitioner, organization and location further refine the search.
jurisdictionsus
codefind
systemfalse
typetrue
instancefalse
resourcesSlot
Usages

URL: [base]/Slot/$find

Parameters

Use Name Scope Cardinality Type Binding Documentation
IN start 1..1 dateTime

The period of time that should be checked for free slots. If no start date is provided, all available slots prior to the end date are in scope (subject to limits imposed by local business rules).
IN end 1..1 dateTime

The period of time that should be checked for appointment availability. If no end date is provided, all available slots after the start date are in scope (subject to limits imposed by local business rules).
IN practitioner 0..* uri

The Practitioner reference when performing a provider based query. This is a reference to a FHIR Practitioner resource, e.g. 'Practitioner/123'.
IN organization 0..* uri

The Organization reference when performing a provider based query. This is a reference to a FHIR Organization resource, e.g. 'Organization/abc'.
IN location-string 0..* string
( string )

A (part of the) address of the location of interest. (e.g., zip codes, city or state). This string parameter is interpreted as a String search parameter and covers the string type elements in the Address datatype .

IN location-reference 0..* uri

A Location reference when performing an operation where the Location resource id is known.

OUT return 0..1 Bundle

An Argonaut Slot Bundle Profile of type searchset with entries of proposed Slot resources and may also contain an OperationOutcome with errors, warnings or information as a result of processing the operation - e.g., an informational notice that the returned slots are not within the requested start and end times. An empty bundle means no available slots based on inputs

Note that all input parameters are simple types allowing either the 'GET' or the 'POST' syntax to be used to initiate the interaction. Examples of both are shown below.

Produced 06 Apr 2023