OperationDefinition-appointment-find

Sourcefhir.argonaut.scheduling#1.0.0:Argonaut Scheduling Implementation Guide (v3.0.1)
resourceTypeOperationDefinition
idappointment-find
canonicalhttp://fhir.org/guides/argonaut-scheduling/OperationDefinition/appointment-find
version1.0.0
statusactive
nameAppointment_Availability_Operation
date2017-10-31T18:00:00+11:00
descriptionSearches for availability for a future appointment(s) within a time period of defined by date range input parameters. 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 will be used. Other input parameter further refine the search and include practitioner references, specialties, visit type, locations, and patient information. From these criteria, a system determines which schedulable resources ( e.g., people, rooms, equiibment) are needed for the visit, and provides time slots where all required resources are available.
jurisdictionsus
codefind
systemfalse
typetrue
instancefalse
resourcesAppointment
Usages

URL: [base]/Appointment/$find

Parameters

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

The period of time that should be checked for appointment availability.- e.g., look for all available appointments in a certain date range. If no start date is provided, all available appointments 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.- e.g., look for all available appointments in a certain date range. If no end date is provided, all available appointments after the start date are in scope (subject to limits imposed by local business rules).

IN specialty 0..* string
( token )
Argonaut Scheduling Specialties (Extensible)

The code for which specialty is requested for the appointment. ( e.g., 'Dermatology'). If multiple codes are listed, the order of the codes will interpreted as the order of preference. The response will contain appointments with any of these actors (i.e. this does not drive joint appointment with multiple actors). Each parameter value SHALL contain both the system property and the code property for a code using the general syntax specialty=[system]|[code] . See the examples below for how this is implemented.

IN visit-type 0..* string
( token )
Argonaut Visit Types (Extensible)

The code for one of the common appointment visit types for scheduling. ( e.g.,'Echocardiography' or 'Well child visit' ). This list of visit types is extensible and implementers may choose to add there own codes. If multiple codes are listed, the order of the codes will interpreted as the order of preference. The response will contain appointments with any of these services (i.e. this does not drive joint appointment with multiple services). Each parameter value SHALL contain both the system property and the code property for a code using the general syntax service-type=[system]|[code] . See the examples below for how this is implemented.

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'. If multiple practitioner references are listed, the order will interpreted as the order of preference. The response will contain appointments with any of these actors (i.e. this does not drive joint appointment with multiple actors).

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'. If multiple organization references are listed, the order will interpreted as the order of preference. The response will contain appointments with any of these actors (i.e. this does not drive joint appointment with multiple actors).

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 . If multiple locations are listed, the order will interpreted as the order of preference. The response will contain appointments with any of these actors (i.e. this does not drive joint appointment with multiple locations)

IN location-reference 0..* uri

A Location reference when performing an operation where the Location resource id is known. If multiple location references are listed, the order will interpreted as the order of preference. The response will contain appointments with any of these actors (i.e. this does not drive joint appointment with multiple locations)

IN patient-reference 0..* uri

A Patient reference when performing an operation where the Patient resource id is known. Patient resources include demographics and patient preferences that may be important for availaiblilty searches. If multiple patient references are listed, the response will contain appointments which is joint match for all patients - i.e., a group appointment.

IN patient-resource 0..* Patient

This parameter uses the Patient resource type instead of a simple reference because the patient record may not exist when performing availablity searches. (If the Patient resource id is known, use the patient-reference parameter instead.) It based on the US Core Patient Profile and includes demographics and patient preferences that may be important for availaiblilty searches. If the appointment is for a new patient, the patient record should not be created until just before booking an appointment. If multiple patient resources are listed, the response will contain appointments which is joint match for all patients - i.e., a group appointment.

IN coverage 0..* Coverage

This parameter uses the Coverage type and is constrained to the the Argonaut Coverage Profile . It provides insurance information for scheduling an appointment and or registering a patient. Do not transmit Coverage resource elements that require the Patient resource id if it is not known. If multiple coverage resources are listed, the response will contain appointments which is joint match for all coverages and patients - i.e., a group appointment.

IN reason 0..* string
( token )
Condition/Problem/Diagnosis Codes (Preferred)

A clinical sign, symptom, diagnosis or health concern that this appointment is intended to treat. This may is used in conjunction with the specialty to determine which schedulable resources are needed for the visit. For example, for an orthopedics appointment, the reason may drive whether a hip specialist or knee specialist is preferred. Each parameter value SHALL contain both the system property and the code property for a code using the general syntax specialty=[system]|[code] . See the examples below for how this is implemented.

OUT return 0..1 Bundle

An Argonaut Appointment Bundle Profile of type searchset with entries of proposed Appointment 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 appointments are not within the requested start and end times. An empty bundle means no available appointments based on inputs


Produced 06 Apr 2023