PackagesCanonicalsLogsProblems
    Packages
    servicewell.fhir.wof-portal@1.0.0
    https://canonical.fhir.link/servicewell/wof-portal/OperationDefinition/get-offers-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.  \\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",
  "_filename": "OperationDefinition-get-offers-context.json",
  "package_name": "servicewell.fhir.wof-portal",
  "date": "2026-04-20T11:19:47+00:00",
  "system": true,
  "publisher": "Service Well AB",
  "instance": true,
  "name": "GetOffersContext",
  "type": "false",
  "experimental": null,
  "resourceType": "OperationDefinition",
  "title": "$getOffersContext — Booking Content Context",
  "package_version": "1.0.0",
  "status": "active",
  "id": "99185fa8-41f5-429e-8586-2a8eb3a1ab38",
  "resource": [ "ActivityDefinition", "HealthcareService", "PractitionerRole" ],
  "kind": "operation",
  "url": "https://canonical.fhir.link/servicewell/wof-portal/OperationDefinition/get-offers-context",
  "code": "get-offers-context",
  "version": "1.0.0",
  "contact": [ {
    "name": "Service Well AB",
    "telecom": [ {
      "value": "https://servicewell.se",
      "system": "url"
    }, {
      "value": "info@servicewell.se",
      "system": "email"
    } ]
  }, {
    "name": "Service well",
    "telecom": [ {
      "use": "work",
      "value": "info@servicewell.se",
      "system": "email"
    } ]
  } ],
  "parameter": [ {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "includeActivityDefinitionPortal",
    "type": "boolean",
    "documentation": "If true, the response Bundle SHALL include ActivityDefinitionPortal resources.\nIf omitted or false, ActivityDefinitionPortal resources are not included."
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "includeHealthcareServicePortal",
    "type": "boolean",
    "documentation": "If true, the response Bundle SHALL include HealthcareServicePortal resources.\nIf omitted or false, HealthcareServicePortal resources are not included."
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "includePractitionerRolePortal",
    "type": "boolean",
    "documentation": "If true, the response Bundle SHALL include PractitionerRolePortal resources.\nIf omitted or false, PractitionerRolePortal resources are not included."
  }, {
    "max": "1",
    "min": 1,
    "use": "out",
    "name": "return",
    "type": "Bundle",
    "documentation": "A profiled Bundle containing offers context resources.",
    "targetProfile": [ "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/BundleOffersContextPortal" ]
  } ]
}