{ "resourceType" : "OperationDefinition", "id" : "FindAppointments", "text" : { "status" : "generated", "div" : "

Generated Narrative: OperationDefinition FindAppointments

URL: [base]/Appointment/$find

Output parameters Profile:Available Appointment Portal

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INstart1..1dateTime

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.

\n
INend1..1dateTime

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.

\n
INpractitioner0..*Reference

Restrict the search to Appointments where a specific Practitioner is the performer.

\n

Practitioner 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

This follows the IHE ITI-style parameter pattern where the parameter type remains Reference, but the logical target is carried using Reference.identifier.

\n

Reference.identifier.system: https://canonical.fhir.link/servicewell/wof-portal/identifier-system/endpoint-identifier-system-for-practitioner/{endpointId}

\n

Reference.identifier.value: source-system primary key for the practitioner

\n
INlocation0..*Reference (Location Area)

Restrict the search to Appointments at a specific location.

\n

Format: Location/{id}

\n

Example: ?location=Location/1234

\n
INorganization0..*Reference

Restrict the search to Appointments associated with a specific billing organization.

\n

BillingOrganization 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

This follows the IHE ITI -style parameter pattern where the parameter type remains Reference, but the logical target is carried using Reference.identifier.

\n

Reference.identifier.system: https://canonical.fhir.link/servicewell/wof-portal/identifier-system/endpoint-identifier-system-for-billingorganization/{endpointId}

\n

Reference.identifier.value: source-system primary key for the billing organization

\n
INvisit-type0..*string

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).

\n
INhealthcareService0..1Reference (HealthcareServicePortal)

Restrict the search to a specific HealthcareService.

\n

Format: HealthcareService/{id}

\n

Example: ?healthcareService=HealthcareService/1234

\n
INpractitionerRole0..1Reference (PractitionerRolePortal)

Restrict the search to a specific PractitionerRole.

\n

Format: PractitionerRole/{id}

\n

Example: ?practitionerRole=PractitionerRole/1234

\n
OUTreturn0..1Bundle (Portal Find Appointment response)

On success, returns a Bundle that SHALL conform to ihe-sched-avail-bundle, containing the resulting Appointment:

\n
    \n
  • status 'proposed' for available appointment opportunities (slots)
    • \n
\n

Bundels conforming to ihe-sched-avail-bundle:

\n\n
" }, "url" : "https://canonical.fhir.link/servicewell/wof-portal/OperationDefinition/FindAppointments", "version" : "1.0.0", "name" : "FindAppointments", "title" : "Find Appointments (Available Slots)", "status" : "active", "kind" : "operation", "date" : "2026-04-20T08:10:56+00:00", "publisher" : "Service Well AB", "contact" : [{ "name" : "Service Well AB", "telecom" : [{ "system" : "url", "value" : "https://servicewell.se" }, { "system" : "email", "value" : "info@servicewell.se" }] }, { "name" : "Service well", "telecom" : [{ "system" : "email", "value" : "info@servicewell.se", "use" : "work" }] }], "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://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment", "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.\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", "type" : "Reference" }, { "name" : "location", "use" : "in", "min" : 0, "max" : "*", "documentation" : "Restrict the search to Appointments at a specific location.\n\n**Format:** `Location/{id}` \n\n**Example:** `?location=Location/1234`", "type" : "Reference", "targetProfile" : ["http://portal.wof.purified.link/fhir/StructureDefinition/LocationArea"] }, { "name" : "organization", "use" : "in", "min" : 0, "max" : "*", "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", "type" : "Reference" }, { "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" : "healthcareService", "use" : "in", "min" : 0, "max" : "1", "documentation" : "Restrict the search to a specific HealthcareService.\n\n**Format:** `HealthcareService/{id}` \n\n**Example:** `?healthcareService=HealthcareService/1234`", "type" : "Reference", "targetProfile" : ["https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/healthcare-service-portal"] }, { "name" : "practitionerRole", "use" : "in", "min" : 0, "max" : "1", "documentation" : "Restrict the search to a specific PractitionerRole.\n\n**Format:** `PractitionerRole/{id}` \n\n**Example:** `?practitionerRole=PractitionerRole/1234`", "type" : "Reference", "targetProfile" : ["https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/practitioner-role-portal"] }, { "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\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.", "type" : "Bundle", "targetProfile" : ["https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-find-appointment-bundle"] }] }