SIMPLIFIER.NET - FHIRPath Playground

FHIRPath

If you Log in or sign up, you can edit this script yourself.

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="alpha-slot-find" />
  <text>
    <status value="additional" />
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Find available Slots</h2>
      <p>This operation queries for available free slots with optional parameters, such as date/time
        range, and specialty. 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 will be used. </p>
      <h2>Operation functionality in terms of FHIR</h2>
      <p> Search for all Slots within the request time period in combination with the parameters as
        supplied. Filter for any limitations that may exist in terms of the type of slots that may be booked by a specific client. </p>
    </div>
  </text>
  <url value="http://hl7.alp/OperationDefinition/alpha-slot-find" />
  <version value="1.0.0" />
  <name value="Find Slots" />
  <status value="active" />
  <kind value="operation" />
  <publisher value="Alpha NHIT Centre" />
  <contact>
    <name value="Alpha NHIT Centre" />
    <telecom>
      <system value="email" />
      <value value="info@nhitcentre.alp" />
      <use value="work" />
    </telecom>
  </contact>
  <description value="This operation queries for available free slots with optional parameters, such as date/time range, and specialty.  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 will be used. &#xA;&#xA; 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. " />
  <code value="find" />
  <comment value="The _count parameter may be used to specify the upper limit of slots to be returned by the operation.  &#xA;&#xA; Note that is operation is intended to be used by patient-facing Apps." />
  <resource value="Slot" />
  <system value="false" />
  <type value="true" />
  <instance value="false" />
  <parameter>
    <name value="start" />
    <use value="in" />
    <min value="0" />
    <max value="1" />
    <documentation value="The start date/time of the period of time that should be checked for free slots. This parameter searched on the start time of the Slots (```Slot.start```). 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)." />
    <type value="dateTime" />
  </parameter>
  <parameter>
    <name value="end" />
    <use value="in" />
    <min value="0" />
    <max value="1" />
    <documentation value="The end date/time of time that should be checked for appointment availability. This parameter searched on the start time of the Slots (```Slot.start```). If no end date is provided, all available slots after the start date are in scope (subject to limits imposed by local business rules)." />
    <type value="dateTime" />
  </parameter>
  <parameter>
    <name value="practitioner" />
    <use value="in" />
    <min value="0" />
    <max value="*" />
    <documentation value="Reference to one or more practitioners. This may be implicit in some authorization contexts." />
    <type value="string" />
    <searchType value="reference" />
  </parameter>
  <parameter>
    <name value="patient" />
    <use value="in" />
    <min value="0" />
    <max value="1" />
    <documentation value="Reference to one patient. This may be implicit in some authorization contexts." />
    <type value="string" />
    <searchType value="reference" />
  </parameter>
  <parameter>
    <name value="service-type" />
    <use value="in" />
    <min value="0" />
    <max value="*" />
    <documentation value="Code for a certain type of appointment." />
    <type value="CodeableConcept" />
  </parameter>
  <parameter>
    <name value="return" />
    <use value="out" />
    <min value="0" />
    <max value="1" />
    <documentation value="An Bundle of type `searchset` with entries of proposed Slot resources and may also contain an [OperationOutcome] (http://hl7.org/fhir/R4/operationoutcome.html) 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" />
    <type value="Bundle" />
  </parameter>
</OperationDefinition>

name : Find Slots

{

}