Scheduling
1.0.0 - Trial-Implementation
This page is part of the IHE ITI Scheduling (v1.0.0: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-find | Version: 1.0.0 | |||
Active as of 2024-12-12 | Computable Name: Find_Appointments_Operation |
Searches 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 parameters further refine the search and include practitioner references, specialties, visit type, locations, patient and referral information. From these criteria, a system determines which schedulable resources ( e.g., people, rooms, equipment) are needed for the visit, and provides proposed appointments for the time slots where all required resources are available.
Generated Narrative: OperationDefinition appointment-find
URL: [base]/Appointment/$find
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) | https://profiles.ihe.net/ITI/SCHED/ValueSet/specialty (Example) | 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 | |
IN | visit-type | 0..* | string (token) | https://profiles.ihe.net/ITI/SCHED/ValueSet/visit-type (Example) | 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 | |
IN | practitioner | 0..* | Reference (Practitioner) | 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..* | Reference (Organization) | 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 | ||
IN | location-reference | 0..* | Reference (Location) | A Location reference when performing an operation where the Location resource | ||
IN | patient-reference | 0..* | Reference (Patient) | A Patient reference when performing an operation where the Patient resource | ||
IN | patient-resource | 0..* | Patient (Patient) | This parameter uses the Patient resource type instead of a simple reference because it is possible for the patient record to not exist when performing availability searches. (If the Patient resource id is known, use the | ||
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 could 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 | |
IN | referral-identifier | 0..1 | Identifier | When an appointment needs to be made as part of a referral, this parameter can contain the ServiceRequest identifier for the referral. | ||
IN | timing | 0..1 | Timing | Provides information about the preferred times for the appointment | ||
IN | insurance-reference | 0..* | Reference (InsurancePlan) | Reference to the insurance information for the patient for whom the potential appointment is about to be made. | ||
OUT | return | 0..1 | Bundle (IHE ITI Scheduling Bundle Profile) | An IHE Appointment Bundle Profile of type |
Coding
datatype. This allows either the 'GET' or the 'POST' syntax to be used to initiate the interaction in many cases. The Reference
datatype is used for resources references, which allows the requester to use either a reference to existing resource, or an identifier (logical reference). Examples of both are shown below._count
search parameter. See the examples below for how this is implemented.$hold
operation, and for which the holding period had not expired) in the list of potential appointments.