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

FHIR IG analytics

Packageservicewell.fhir.wof-portal
Resource TypeOperationDefinition
IdOperationDefinition-get-offers-context.json
FHIR VersionR4
Sourcefile:///azp/_work/1/s/output/OperationDefinition-get-offers-context.html
URLhttps://canonical.fhir.link/servicewell/wof-portal/OperationDefinition/get-offers-context
Version1.0.0
Statusactive
Date2026-04-20T11:19:47+00:00
NameGetOffersContext
Title$getOffersContext — Booking Content Context
Description`$get-offers-context` is a **read-oriented** FHIR operation designed to let a frontend **quickly populate booking content** so a patient can choose *what* to book and *with whom/where* — without needing multiple round-trips. It may include ActivityDefinitionPortal, HealthcareServicePortal, PractitionerRolePortal and OfferPortal. It MUST NOT include Schedule, Slot, or bookable time slots. This operation returns a **profiled Bundle** that may include: - `ActivityDefinitionPortal` (what is being offered) - `HealthcareServicePortal` (where / which clinic service offers it) - `PractitionerRolePortal` (who can perform it) - **Offer** resources (a lightweight “relation + settings” object) The response is intentionally shaped for **fast content rendering**, not for scheduling.
Typefalse
Kindoperation

Resources that use this resource

CapabilityStatement
servicewell.fhir.wof-portal#1.0.0WOFPortalCapabilityStatementWOF Portal Capability Statement

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition get-offers-context

URL: [base]/$get-offers-context

URL: [base]/ActivityDefinition/[id]/$get-offers-context

URL: [base]/HealthcareService/[id]/$get-offers-context

URL: [base]/PractitionerRole/[id]/$get-offers-context

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INincludeActivityDefinitionPortal0..1boolean

If true, the response Bundle SHALL include ActivityDefinitionPortal resources. If omitted or false, ActivityDefinitionPortal resources are not included.

INincludeHealthcareServicePortal0..1boolean

If true, the response Bundle SHALL include HealthcareServicePortal resources. If omitted or false, HealthcareServicePortal resources are not included.

INincludePractitionerRolePortal0..1boolean

If true, the response Bundle SHALL include PractitionerRolePortal resources. If omitted or false, PractitionerRolePortal resources are not included.

OUTreturn1..1Bundle (Bundle (Offers Context) — WOF Portal)

A profiled Bundle containing offers context resources.


Source1

{
  "resourceType": "OperationDefinition",
  "id": "get-offers-context",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://canonical.fhir.link/servicewell/wof-portal/OperationDefinition/get-offers-context",
  "version": "1.0.0",
  "name": "GetOffersContext",
  "title": "$getOffersContext — Booking Content Context",
  "status": "active",
  "kind": "operation",
  "date": "2026-04-20T11:19:47+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": "`$get-offers-context` is a **read-oriented** FHIR operation designed to let a frontend **quickly populate booking content** so a patient can choose *what* to book and *with whom/where* — without needing multiple round-trips.  \nIt may include ActivityDefinitionPortal, HealthcareServicePortal, PractitionerRolePortal and OfferPortal.  \nIt MUST NOT include Schedule, Slot, or bookable time slots.  \n\nThis operation returns a **profiled Bundle** that may include:\n\n- `ActivityDefinitionPortal` (what is being offered)\n- `HealthcareServicePortal` (where / which clinic service offers it)\n- `PractitionerRolePortal` (who can perform it)\n- **Offer** resources (a lightweight “relation + settings” object)\n\nThe response is intentionally shaped for **fast content rendering**, not for scheduling.\n",
  "code": "get-offers-context",
  "resource": [
    "ActivityDefinition",
    "HealthcareService",
    "PractitionerRole"
  ],
  "system": true,
  "type": false,
  "instance": true,
  "parameter": [
    {
      "name": "includeActivityDefinitionPortal",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "If true, the response Bundle SHALL include ActivityDefinitionPortal resources.\nIf omitted or false, ActivityDefinitionPortal resources are not included.",
      "type": "boolean"
    },
    {
      "name": "includeHealthcareServicePortal",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "If true, the response Bundle SHALL include HealthcareServicePortal resources.\nIf omitted or false, HealthcareServicePortal resources are not included.",
      "type": "boolean"
    },
    {
      "name": "includePractitionerRolePortal",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "If true, the response Bundle SHALL include PractitionerRolePortal resources.\nIf omitted or false, PractitionerRolePortal resources are not included.",
      "type": "boolean"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "A profiled Bundle containing offers context resources.",
      "type": "Bundle",
      "targetProfile": [
        "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/BundleOffersContextPortal"
      ]
    }
  ]
}