FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageservicewell.fhir.wof-connect
Resource TypeOperationDefinition
IdOperationDefinition-FindAppointments.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/servicewell/servicewell.fhir.wof-connect/OperationDefinition-FindAppointments.html
URLhttp://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/FindAppointments
Version0.1.1
Statusactive
Date2026-02-11T12:21:17+00:00
NameFindAppointments
TitleFind Appointments (Available Slots)
DescriptionFinds 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.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
WofConnectCapabilityStatementWOF Connect Capability Statement

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition FindAppointments

URL: [base]/Appointment/$find

Output parameters Profile:IHE ITI Scheduling Bundle Profile

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INstart1..1dateTime

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.

INend1..1dateTime

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.

INpractitioner0..*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.

INorganization0..*Reference (Wof Connect Economy Organization)

Restrict the search to Appointments associated with a specific Organization (e.g., business/clinic owner).

INvisit-type0..*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).

OUTreturn0..1Bundle

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.


Source1

{
  "resourceType": "OperationDefinition",
  "id": "FindAppointments",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/FindAppointments",
  "version": "0.1.1",
  "name": "FindAppointments",
  "title": "Find Appointments (Available Slots)",
  "status": "active",
  "kind": "operation",
  "date": "2026-02-11T12:21:17+00:00",
  "publisher": "Service Well AB",
  "contact": [
    {
      "name": "Service Well AB",
      "telecom": [
        {
          "system": "url",
          "value": "https://servicewell.se"
        },
        {
          "system": "email",
          "value": "info@servicewell.se"
        }
      ]
    }
  ],
  "description": "Finds available appointment opportunities (slots) and returns them as proposed Appointments.\n\nThis operation corresponds to the IHE ITI Scheduling $find operation and returns\na Bundle of Appointment resources conforming to the IHE Scheduled Availability Bundle profile.",
  "affectsState": false,
  "code": "find",
  "base": "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-find",
  "resource": [
    "Appointment"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "outputProfile": "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle",
  "parameter": [
    {
      "name": "start",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Start of the requested time window for which available appointment opportunities (slots) should be returned.\nThis parameter is mandatory as per IHE ITI Scheduling $find.",
      "type": "dateTime"
    },
    {
      "name": "end",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "End of the requested time window for which available appointment opportunities (slots) should be returned.\nThis parameter is mandatory as per IHE ITI Scheduling $find.",
      "type": "dateTime"
    },
    {
      "name": "practitioner",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Restrict the search to Appointments where a specific Practitioner is the performer.\nIf multiple values are supplied, the server MAY treat them as an OR or AND filter as documented by the implementation.",
      "type": "Reference",
      "targetProfile": [
        "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitioner"
      ]
    },
    {
      "name": "organization",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Restrict the search to Appointments associated with a specific Organization (e.g., business/clinic owner).",
      "type": "Reference",
      "targetProfile": [
        "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-economyorganization"
      ]
    },
    {
      "name": "visit-type",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Restrict the search to a specific visit type (service type). In this implementation, visit-type\ntypically carries a WOF Connect service-type identifier (e.g., [system]|[code] where code maps to treatmentId).",
      "type": "string"
    },
    {
      "name": "return",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "On success, returns a Bundle that SHALL conform to ihe-sched-avail-bundle, containing the resulting Appointment:\n- status 'proposed' for available appointment opportunities (slots)\n\nIf the operation fails, an OperationOutcome is returned instead of this parameter.",
      "type": "Bundle"
    }
  ]
}