WOF Connect📍
0.1.1 - ci-build [WIP]
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
| Active as of 2026-02-11 |
{
"resourceType" : "OperationDefinition",
"id" : "FindAppointments",
"text" : {
"status" : "generated",
"div" : "<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.\nThis parameter is mandatory as per IHE ITI Scheduling $find.</p>\n</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.\nThis parameter is mandatory as per IHE ITI Scheduling $find.</p>\n</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.\nIf multiple values are supplied, the server MAY treat them as an OR or AND filter as documented by the implementation.</p>\n</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>\n</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\ntypically carries a WOF Connect service-type identifier (e.g., [system]|[code] where code maps to treatmentId).</p>\n</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>\n<ul>\n<li>status 'proposed' for available appointment opportunities (slots)</li>\n</ul>\n<p>If the operation fails, an OperationOutcome is returned instead of this parameter.</p>\n</div></td></tr></table></div>"
},
"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"
}
]
}