FHIRsmith: OperationDefinition/OperationDefinition-GetScheduleContext.json

FHIR IG analytics

Package	servicewell.fhir.wof-connect
Resource Type	OperationDefinition
Id	OperationDefinition-GetScheduleContext.json
FHIR Version	R4
Source	https://build.fhir.org/ig/servicewell/servicewell.fhir.wof-connect/OperationDefinition-GetScheduleContext.html
URL	http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/GetScheduleContext
Version	0.1.1
Status	active
Date	2026-02-11T12:21:17+00:00
Name	GetScheduleContext
Title	Get Schedule Context
Description	Returns a Bundle containing Schedule resources together with related actors and activity definitions for a given period. Only resources that are actually scheduled are included.
Type	true
Kind	operation

Resources that use this resource

CapabilityStatement
WofConnectCapabilityStatement	WOF 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 GetScheduleContext

URL: [base]/Schedule/$get-schedule-context

Output parameters Profile:WOF Connect GetScheduleContext Operation Response

Parameters

Use

Name

Scope

Cardinality

Type

Binding

Documentation

period-start

0..1

dateTime

Start of the requested time period (used for Slots and filtering scheduled context).

period-end

0..1

dateTime

End of the requested time period.

healthcare-service

0..*

Reference (Wof Connect HealthcareService)

Restrict the query to specific HealthcareService resources.

actor

0..*

Reference (Wof Connect PractitionerRole, Wof Connect Practitioner, Wof Connect Economy Organization)

Filter on specific actors referenced by Schedule.actor.

OUT

return

1..1

Bundle

A Bundle containing Schedule, Slot, Actor, and ActivityDefinition resources that are actually scheduled within the requested period. The Bundle SHALL conform to the WofConnectScheduleContextOperationResponse profile.

Source1

{
  "resourceType": "OperationDefinition",
  "id": "GetScheduleContext",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/GetScheduleContext",
  "version": "0.1.1",
  "name": "GetScheduleContext",
  "title": "Get Schedule Context",
  "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": "Returns a Bundle containing Schedule resources together with related actors and activity definitions for a given period. Only resources that are actually scheduled are included.",
  "affectsState": false,
  "code": "get-schedule-context",
  "resource": [
    "Schedule"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "outputProfile": "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-schedule-context-operation-response",
  "parameter": [
    {
      "name": "period-start",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Start of the requested time period (used for Slots and filtering scheduled context).",
      "type": "dateTime"
    },
    {
      "name": "period-end",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "End of the requested time period.",
      "type": "dateTime"
    },
    {
      "name": "healthcare-service",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Restrict the query to specific HealthcareService resources.",
      "type": "Reference",
      "targetProfile": [
        "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-healthcareservice"
      ]
    },
    {
      "name": "actor",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Filter on specific actors referenced by Schedule.actor.",
      "type": "Reference",
      "targetProfile": [
        "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitionerrole",
        "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitioner",
        "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-economyorganization"
      ]
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "A Bundle containing Schedule, Slot, Actor, and ActivityDefinition resources that are actually scheduled within the requested period.\nThe Bundle SHALL conform to the WofConnectScheduleContextOperationResponse profile.",
      "type": "Bundle"
    }
  ]
}