FindAppointments
type: OperationDefinition
node role: treeRoot
id:
  v: FindAppointments
text:
  status:
    v: generated
  div:
    v: Generated Narrative: OperationDefinition FindAppointments URL: [base]/Appointment/$find Output parameters Profile:IHE ITI Scheduling Bundle Profile Parameters Use Name Scope Cardinality Type Binding Documentation IN start 1..1 dateTime 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. IN end 1..1 dateTime 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. IN practitioner 0..* Reference (Wof Connect Practitioner) 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. IN organization 0..* Reference (Wof Connect Economy Organization) Restrict the search to Appointments associated with a specific Organization (e.g., business/clinic owner). IN visit-type 0..* string 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). OUT return 0..1 Bundle 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.
url:
  v: http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/FindAppointments
  l: FindAppointments
version:
  v: 0.1.1
name:
  v: FindAppointments
title:
  v: Find Appointments (Available Slots)
status:
  v: active
kind:
  v: operation
date:
  v: 2026-03-20T09:13:30+00:00
publisher:
  v: Service Well AB
contact:
  name:
    v: Service Well AB
  telecom:
    system:
      v: url
    value:
      v: https://servicewell.se
  telecom:
    system:
      v: email
description:
  v: 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.
affects state:
  v: false
code:
  v: find
base:
  v: https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-find
  l: appointment-find
resource:
  v: Appointment
system:
  v: false
type:
  v: true
instance:
  v: false
output profile:
  v: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle
  l: ihe-sched-avail-bundle
parameter:
  name:
    v: start
  use:
    v: in
  min:
    v: 1
  max:
    v: 1
  documentation:
    v: 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:
    v: dateTime
parameter:
  name:
    v: end
  use:
    v: in
  min:
    v: 1
  max:
    v: 1
  documentation:
    v: 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:
    v: dateTime
parameter:
  name:
    v: practitioner
  use:
    v: in
  min:
    v: 0
  max:
    v: *
  documentation:
    v: 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:
    v: Reference
  target profile:
    v: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitioner
    l: wof-connect-practitioner
parameter:
  name:
    v: organization
  use:
    v: in
  min:
    v: 0
  max:
    v: *
  documentation:
    v: Restrict the search to Appointments associated with a specific Organization (e.g., business/clinic owner).
  type:
    v: Reference
  target profile:
    v: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-billing-organization
    l: wof-connect-billing-organization
parameter:
  name:
    v: visit-type
  use:
    v: in
  min:
    v: 0
  max:
    v: *
  documentation:
    v: 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:
    v: string
parameter:
  name:
    v: return
  use:
    v: out
  min:
    v: 0
  max:
    v: 1
  documentation:
    v: 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:
    v: Bundle