WOF Connect📍
0.1.1 - ci-build [WIP]

WOF Connect📍, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 0.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-connect/ and changes regularly. See the Directory of published versions

: Find Appointments (Available Slots) - XML Representation

Active as of 2026-02-11

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="FindAppointments"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition FindAppointments</b></p><a name="FindAppointments"> </a><a name="hcFindAppointments"> </a><p>URL: [base]/Appointment/$find</p><p>Output parameters Profile:<a href="https://profiles.ihe.net/ITI/Scheduling/1.0.0/StructureDefinition-ihe-sched-avail-bundle.html">IHE ITI Scheduling Bundle Profile</a></p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</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/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></td><td/><td><div><p>Start of the requested time window for which available appointment opportunities (slots) should be returned.
This parameter is mandatory as per IHE ITI Scheduling $find.</p>
</div></td></tr><tr><td>IN</td><td>end</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></td><td/><td><div><p>End of the requested time window for which available appointment opportunities (slots) should be returned.
This parameter is mandatory as per IHE ITI Scheduling $find.</p>
</div></td></tr><tr><td>IN</td><td>practitioner</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-wof-connect-practitioner.html" title="http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitioner">Wof Connect Practitioner</a>)</td><td/><td><div><p>Restrict the search to Appointments where a specific Practitioner is the performer.
If multiple values are supplied, the server MAY treat them as an OR or AND filter as documented by the implementation.</p>
</div></td></tr><tr><td>IN</td><td>organization</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a> (<a href="StructureDefinition-wof-connect-economyorganization.html" title="http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-economyorganization">Wof Connect Economy Organization</a>)</td><td/><td><div><p>Restrict the search to Appointments associated with a specific Organization (e.g., business/clinic owner).</p>
</div></td></tr><tr><td>IN</td><td>visit-type</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Restrict the search to a specific visit type (service type). In this implementation, visit-type
typically carries a WOF Connect service-type identifier (e.g., [system]|[code] where code maps to treatmentId).</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>On success, returns a Bundle that SHALL conform to ihe-sched-avail-bundle, containing the resulting Appointment:</p>
<ul>
<li>status 'proposed' for available appointment opportunities (slots)</li>
</ul>
<p>If the operation fails, an OperationOutcome is returned instead of this parameter.</p>
</div></td></tr></table></div>
  </text>
  <url
       value="http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/FindAppointments"/>
  <version value="0.1.1"/>
  <name value="FindAppointments"/>
  <title value="Find Appointments (Available Slots)"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2026-02-11T12:21:17+00:00"/>
  <publisher value="Service Well AB"/>
  <contact>
    <name value="Service Well AB"/>
    <telecom>
      <system value="url"/>
      <value value="https://servicewell.se"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="info@servicewell.se"/>
    </telecom>
  </contact>
  <description
               value="Finds available appointment opportunities (slots) and returns them as proposed Appointments.

This operation corresponds to the IHE ITI Scheduling $find operation and returns
a Bundle of Appointment resources conforming to the IHE Scheduled Availability Bundle profile."/>
  <affectsState value="false"/>
  <code value="find"/>
  <base
        value="https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-find"/>
  <resource value="Appointment"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <outputProfile
                 value="https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle"/>
  <parameter>
    <name value="start"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Start of the requested time window for which available appointment opportunities (slots) should be returned.
This parameter is mandatory as per IHE ITI Scheduling $find."/>
    <type value="dateTime"/>
  </parameter>
  <parameter>
    <name value="end"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="End of the requested time window for which available appointment opportunities (slots) should be returned.
This parameter is mandatory as per IHE ITI Scheduling $find."/>
    <type value="dateTime"/>
  </parameter>
  <parameter>
    <name value="practitioner"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="Restrict the search to Appointments where a specific Practitioner is the performer.
If multiple values are supplied, the server MAY treat them as an OR or AND filter as documented by the implementation."/>
    <type value="Reference"/>
    <targetProfile
                   value="http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitioner"/>
  </parameter>
  <parameter>
    <name value="organization"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="Restrict the search to Appointments associated with a specific Organization (e.g., business/clinic owner)."/>
    <type value="Reference"/>
    <targetProfile
                   value="http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-economyorganization"/>
  </parameter>
  <parameter>
    <name value="visit-type"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="Restrict the search to a specific visit type (service type). In this implementation, visit-type
typically carries a WOF Connect service-type identifier (e.g., [system]|[code] where code maps to treatmentId)."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="On success, returns a Bundle that SHALL conform to ihe-sched-avail-bundle, containing the resulting Appointment:
- status 'proposed' for available appointment opportunities (slots)

If the operation fails, an OperationOutcome is returned instead of this parameter."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>