XML Format: OperationDefinition-appointment-find
Raw xml
<OperationDefinition xmlns="http://hl7.org/fhir"> <id value="appointment-find"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <h2>Appointment Availability Operation</h2> <p>OPERATION: Appointment Availability Operation</p> <p>The official URL for this operation definition is: </p> <pre>http://fhir.org/guides/argonaut-scheduling/OperationDefinition/appointment-find</pre> <div> <p>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 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.</p> </div> <p>URL: [base]/Appointment/$find</p> <p>Parameters</p> <table class="grid"> <tr> <td> <b>Use</b> </td> <td> <b>Name</b> </td> <td> <b>Cardinality</b> </td> <td> <b>Type</b> </td> <td> <b>Binding</b> </td> <td> <b>Documentation</b> </td> </tr> <tr> <td>IN</td> <td>start</td> <td>1..1</td> <td>dateTime</td> <td/> <td> <div> <p>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).</p> </div> </td> </tr> <tr> <td>IN</td> <td>end</td> <td>1..1</td> <td>dateTime</td> <td/> <td> <div> <p>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).</p> </div> </td> </tr> <tr> <td>IN</td> <td>specialty</td> <td>0..*</td> <td>string (<a href="http://hl7.org/fhir/STU3/search.html#token">token</a>)</td> <td> <a href="ValueSet-specialty.html">http://fhir.org/guides/argonaut-scheduling/ValueSet/specialty</a> (Extensible)</td> <td> <div> <p>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 <em>both</em> the system property and the code property for a code using the general syntax <code>specialty=[system]|[code]</code>. See the examples below for how this is implemented.</p> </div> </td> </tr> <tr> <td>IN</td> <td>visit-type</td> <td>0..*</td> <td>string (<a href="http://hl7.org/fhir/STU3/search.html#token">token</a>)</td> <td> <a href="ValueSet-visit-type.html">http://fhir.org/guides/argonaut-scheduling/ValueSet/visit-type</a> (Extensible)</td> <td> <div> <p>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 <em>both</em> the system property and the code property for a code using the general syntax <code>service-type=[system]|[code]</code>. See the examples below for how this is implemented.</p> </div> </td> </tr> <tr> <td>IN</td> <td>practitioner</td> <td>0..*</td> <td>uri</td> <td/> <td> <div> <p>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).</p> </div> </td> </tr> <tr> <td>IN</td> <td>organization</td> <td>0..*</td> <td>uri</td> <td/> <td> <div> <p>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).</p> </div> </td> </tr> <tr> <td>IN</td> <td>location-string</td> <td>0..*</td> <td>string (<a href="http://hl7.org/fhir/STU3/search.html#string">string</a>)</td> <td/> <td> <div> <p>A (part of the) address of the location of interest. (e.g., zip codes, city or state). This string parameter is interpreted as a <a href="http://build.fhir.org/search.html#string">String search parameter</a> and covers the <code>string</code> type elements in the <a href="http://build.fhir.org/datatypes.html#Address">Address datatype</a>. 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)</p> </div> </td> </tr> <tr> <td>IN</td> <td>location-reference</td> <td>0..*</td> <td>uri</td> <td/> <td> <div> <p>A Location reference when performing an operation where the Location resource <code>id</code> 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)</p> </div> </td> </tr> <tr> <td>IN</td> <td>patient-reference</td> <td>0..*</td> <td>uri</td> <td/> <td> <div> <p>A Patient reference when performing an operation where the Patient resource <code>id</code> 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.</p> </div> </td> </tr> <tr> <td>IN</td> <td>patient-resource</td> <td>0..*</td> <td>Patient (<a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient">US Core Patient Profile</a>)</td> <td/> <td> <div> <p>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 <code>patient-reference</code> parameter instead.) It based on the <a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient">US Core Patient Profile</a> 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.</p> </div> </td> </tr> <tr> <td>IN</td> <td>coverage</td> <td>0..*</td> <td>Coverage (<a href="http://fhir.org/guides/argonaut-scheduling/StructureDefinition/argo-coverage">Argonaut Coverage Profile</a>)</td> <td/> <td> <div> <p>This parameter uses the Coverage type and is constrained to the the <a href="http://fhir.org/guides/argonaut-scheduling/StructureDefinition/argo-coverage">Argonaut Coverage Profile</a>. 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.</p> </div> </td> </tr> <tr> <td>IN</td> <td>reason</td> <td>0..*</td> <td>string (<a href="http://hl7.org/fhir/STU3/search.html#token">token</a>)</td> <td> <a href="http://hl7.org/fhir/STU3/valueset-condition-code.html">http://hl7.org/fhir/ValueSet/condition-code</a> (Preferred)</td> <td> <div> <p>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 <code>specialty=[system]|[code]</code>. See the examples below for how this is implemented.</p> </div> </td> </tr> <tr> <td>OUT</td> <td>return</td> <td>0..1</td> <td>Bundle (<a href="StructureDefinition-avail-bundle.html">Argonaut Appointment Bundle Profile</a>)</td> <td/> <td> <div> <p>An <a href="StructureDefinition-avail-bundle.html">Argonaut Appointment Bundle Profile</a> of type <code>searchset</code> with entries of proposed <a href="http://build.fhir.org/appointment.html">Appointment</a> resources and may also contain an <a href="http://build.fhir.org/operationoutcome.html">OperationOutcome</a> 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</p> </div> </td> </tr> </table> <div> <ul> <li>For input parameters that are codes, the simple FHIR <a href="http://build.fhir.org/search.html#token">token</a> search parameter type is used instead of the complex <code>Coding</code> datatype. Also, the simple <code>uri</code> datatype is used instead of the complex <code>Reference</code> datatype for resources references. This allows either the 'GET' or the 'POST' syntax to be used to initiate the interaction in many cases. Examples of both are shown below.</li> <li>If more than one actor type is present, the response SHOULD contain appointments with <em>all</em> of these actors (i.e, this is a logical 'AND'). If an actor type is repeated the response SHOULD contain appointments with <em>any</em> of these actors and SHOULD be interpreted as the order of preference (i.e. this is a logical 'OR' and does not drive a joint appointment with multiple practitioners. locations or organizations). Ultimately the server is responsible for determining the first/best available appointment options to return.</li> <li>References can be to an absolute URL, but servers only perform operations on their own resources.</li> <li>To set the upper limit on the total number of available appointment options to return use the standard <a href="http://build.fhir.org/search.html#count"> <code>_count</code> </a> search parameter. See the examples below for how this is implemented.</li> </ul> </div> </div> </text> <url value="http://fhir.org/guides/argonaut-scheduling/OperationDefinition/appointment-find"/> <version value="1.0.1"/> <name value="Appointment_Availability_Operation"/> <status value="active"/> <kind value="operation"/> <date value="2017-10-31T00:00:00-07:00"/> <description value="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 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."/> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166"/> <code value="US"/> <display value="United States of America"/> </coding> </jurisdiction> <code value="find"/> <comment value="- For input parameters that are codes, the simple FHIR [token](http://build.fhir.org/search.html#token) search parameter type is used instead of the complex `Coding` datatype. Also, the simple `uri` datatype is used instead of the complex `Reference` datatype for resources references. This allows either the 'GET' or the 'POST' syntax to be used to initiate the interaction in many cases. Examples of both are shown below. - If more than one actor type is present, the response SHOULD contain appointments with *all* of these actors (i.e, this is a logical 'AND'). If an actor type is repeated, the response SHOULD contain appointments with *any* of these actors and SHOULD be interpreted as the order of preference (i.e. this is a logical 'OR' and does not drive a joint appointment with multiple practitioners. locations or organizations) Ultimately the server is responsible for determining the first/best available appointment options to return.. - References can be to an absolute URL, but servers only perform operations on their own resources. - To set the upper limit on the total number of available appointment options to return use the standard [`_count`](http://build.fhir.org/search.html#count) search parameter. See the examples below for how this is implemented."/> <resource value="Appointment"/> <system value="false"/> <type value="true"/> <instance value="false"/> <parameter> <name value="start"/> <use value="in"/> <min value="1"/> <max value="1"/> <documentation value="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)."/> <type value="dateTime"/> </parameter> <parameter> <name value="end"/> <use value="in"/> <min value="1"/> <max value="1"/> <documentation value="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)."/> <type value="dateTime"/> </parameter> <parameter> <name value="specialty"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="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."/> <type value="string"/> <searchType value="token"/> <binding> <strength value="extensible"/> <valueSetUri value="http://fhir.org/guides/argonaut-scheduling/ValueSet/specialty"/> </binding> </parameter> <parameter> <name value="visit-type"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="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."/> <type value="string"/> <searchType value="token"/> <binding> <strength value="extensible"/> <valueSetUri value="http://fhir.org/guides/argonaut-scheduling/ValueSet/visit-type"/> </binding> </parameter> <parameter> <name value="practitioner"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="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)."/> <type value="uri"/> </parameter> <parameter> <name value="organization"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="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)."/> <type value="uri"/> </parameter> <parameter> <name value="location-string"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="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](http://build.fhir.org/search.html#string) and covers the `string` type elements in the [Address datatype](http://build.fhir.org/datatypes.html#Address). 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)"/> <type value="string"/> <searchType value="string"/> </parameter> <parameter> <name value="location-reference"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="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)"/> <type value="uri"/> </parameter> <parameter> <name value="patient-reference"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="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."/> <type value="uri"/> </parameter> <parameter> <name value="patient-resource"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="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](http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient) 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."/> <type value="Patient"/> <profile> <reference value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/> </profile> </parameter> <parameter> <name value="coverage"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="This parameter uses the Coverage type and is constrained to the the [Argonaut Coverage Profile](http://fhir.org/guides/argonaut-scheduling/StructureDefinition/argo-coverage). 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."/> <type value="Coverage"/> <profile> <reference value="http://fhir.org/guides/argonaut-scheduling/StructureDefinition/argo-coverage"/> </profile> </parameter> <parameter> <name value="reason"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="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."/> <type value="string"/> <searchType value="token"/> <binding> <strength value="preferred"/> <valueSetUri value="http://hl7.org/fhir/ValueSet/condition-code"/> </binding> </parameter> <parameter> <name value="return"/> <use value="out"/> <min value="0"/> <max value="1"/> <documentation value="An [Argonaut Appointment Bundle Profile](StructureDefinition-avail-bundle.html) of type `searchset` with entries of proposed [Appointment](http://build.fhir.org/appointment.html) resources and may also contain an [OperationOutcome](http://build.fhir.org/operationoutcome.html) 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"/> <type value="Bundle"/> <profile> <reference value="http://fhir.org/guides/argonaut-scheduling/StructureDefinition/avail-bundle"/> </profile> </parameter> </OperationDefinition>
