{
"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.",
"_filename": "OperationDefinition-FindAppointments.json",
"package_name": "servicewell.fhir.wof-portal",
"date": "2026-04-20T11:19:47+00:00",
"system": false,
"publisher": "Service Well AB",
"instance": false,
"name": "FindAppointments",
"type": "true",
"experimental": null,
"outputProfile": "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment",
"resourceType": "OperationDefinition",
"title": "Find Appointments (Available Slots)",
"package_version": "1.0.0",
"status": "active",
"id": "039a402b-4cfa-4b07-8249-35569c19e17f",
"resource": [ "Appointment" ],
"affectsState": false,
"kind": "operation",
"url": "https://canonical.fhir.link/servicewell/wof-portal/OperationDefinition/FindAppointments",
"code": "find",
"base": "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-find",
"version": "1.0.0",
"contact": [ {
"name": "Service Well AB",
"telecom": [ {
"value": "https://servicewell.se",
"system": "url"
}, {
"value": "info@servicewell.se",
"system": "email"
} ]
}, {
"name": "Service well",
"telecom": [ {
"use": "work",
"value": "info@servicewell.se",
"system": "email"
} ]
} ],
"parameter": [ {
"max": "1",
"min": 1,
"use": "in",
"name": "start",
"type": "dateTime",
"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."
}, {
"max": "1",
"min": 1,
"use": "in",
"name": "end",
"type": "dateTime",
"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."
}, {
"max": "*",
"min": 0,
"use": "in",
"name": "practitioner",
"type": "Reference",
"documentation": "Restrict the search to Appointments where a specific Practitioner is the performer.\n\nPractitioner is not exposed as a standalone API resource in WOF Portal. This parameter therefore uses a `Reference` with `identifier` populated for the logical Practitioner concept, instead of a resolvable FHIR resource reference.\n\nThis follows the IHE ITI-style parameter pattern where the parameter type remains `Reference`, but the logical target is carried using `Reference.identifier`.\n\n**Reference.identifier.system:** `https://canonical.fhir.link/servicewell/wof-portal/identifier-system/endpoint-identifier-system-for-practitioner/{endpointId}`\n\n**Reference.identifier.value:** source-system primary key for the practitioner"
}, {
"max": "*",
"min": 0,
"use": "in",
"name": "location",
"type": "Reference",
"documentation": "Restrict the search to Appointments at a specific location.\n\n**Format:** `Location/{id}` \n\n**Example:** `?location=Location/1234`",
"targetProfile": [ "http://portal.wof.purified.link/fhir/StructureDefinition/LocationArea" ]
}, {
"max": "*",
"min": 0,
"use": "in",
"name": "organization",
"type": "Reference",
"documentation": "Restrict the search to Appointments associated with a specific billing organization.\n\nBillingOrganization is not exposed as a standalone API resource in WOF Portal. This parameter therefore uses a `Reference` with `identifier` populated for the logical BillingOrganization concept, instead of a resolvable FHIR resource reference.\n\nThis follows the IHE ITI -style parameter pattern where the parameter type remains `Reference`, but the logical target is carried using `Reference.identifier`.\n\n**Reference.identifier.system:** `https://canonical.fhir.link/servicewell/wof-portal/identifier-system/endpoint-identifier-system-for-billingorganization/{endpointId}`\n\n**Reference.identifier.value:** source-system primary key for the billing organization"
}, {
"max": "*",
"min": 0,
"use": "in",
"name": "visit-type",
"type": "string",
"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)."
}, {
"max": "1",
"min": 0,
"use": "in",
"name": "healthcareService",
"type": "Reference",
"documentation": "Restrict the search to a specific HealthcareService.\n\n**Format:** `HealthcareService/{id}` \n\n**Example:** `?healthcareService=HealthcareService/1234`",
"targetProfile": [ "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/healthcare-service-portal" ]
}, {
"max": "1",
"min": 0,
"use": "in",
"name": "practitionerRole",
"type": "Reference",
"documentation": "Restrict the search to a specific PractitionerRole.\n\n**Format:** `PractitionerRole/{id}` \n\n**Example:** `?practitionerRole=PractitionerRole/1234`",
"targetProfile": [ "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/practitioner-role-portal" ]
}, {
"max": "1",
"min": 0,
"use": "out",
"name": "return",
"type": "Bundle",
"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\nBundels conforming to ihe-sched-avail-bundle:\n- [portal-find-appointment-bundle](./StructureDefinition-portal-find-appointment-bundle.html) \nIf the operation fails, an OperationOutcome is returned instead of this parameter.",
"targetProfile": [ "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-find-appointment-bundle" ]
} ]
}