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

FHIR IG analytics

Packageservicewell.fhir.wof-connect
Resource TypeOperationDefinition
IdOperationDefinition-GetScheduleContext.json
FHIR VersionR4
Sourcehttp://canonical.fhir.link/servicewell/wof-connect/0.1.3/OperationDefinition-GetScheduleContext.html
URLhttp://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/GetScheduleContext
Version0.1.3
Statusactive
Date2026-04-02T09:20:58+00:00
NameGetScheduleContext
TitleGet Schedule Context
DescriptionReturns a Bundle containing Schedule resources together with related actors and activity definitions for a given period. Only resources that are actually scheduled are included.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
servicewell.fhir.wof-connect#0.1.3WofConnectCapabilityStatementWOF 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

UseNameScopeCardinalityTypeBindingDocumentation
INperiod-start0..1dateTime

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

INperiod-end0..1dateTime

End of the requested time period.

INhealthcare-service0..*Reference (Wof Connect HealthcareService)

Restrict the query to specific HealthcareService resources.

INactor0..*Reference (Wof Connect PractitionerRole, Wof Connect Practitioner, Wof Connect Economy Organization)

Filter on specific actors referenced by Schedule.actor.

OUTreturn1..1Bundle

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.3",
  "name": "GetScheduleContext",
  "title": "Get Schedule Context",
  "status": "active",
  "kind": "operation",
  "date": "2026-04-02T09:20:58+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-billing-organization"
      ]
    },
    {
      "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"
    }
  ]
}