0.1.0 - ci-build

WofPortalIG, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-portal/ and changes regularly. See the Directory of published versions

: $getOffersContext — Booking Content Context - XML Representation

Active as of 2026-02-05

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="get-offers-context"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition get-offers-context</b></p><a name="get-offers-context"> </a><a name="hcget-offers-context"> </a><p>URL: [base]/$getOffersContext</p><p>URL: [base]/ActivityDefinition/$getOffersContext</p><p>URL: [base]/ActivityDefinition/[id]/$getOffersContext</p><p>URL: [base]/HealthcareService/$getOffersContext</p><p>URL: [base]/HealthcareService/[id]/$getOffersContext</p><p>URL: [base]/PractitionerRole/$getOffersContext</p><p>URL: [base]/PractitionerRole/[id]/$getOffersContext</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>includeActivityDefinitionPortal</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>If true, the response Bundle SHALL include ActivityDefinitionPortal resources.
If omitted or false, ActivityDefinitionPortal resources are not included.</p>
</div></td></tr><tr><td>IN</td><td>includeHealthcareServicePortal</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>If true, the response Bundle SHALL include HealthcareServicePortal resources.
If omitted or false, HealthcareServicePortal resources are not included.</p>
</div></td></tr><tr><td>IN</td><td>includePractitionerRolePortal</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>If true, the response Bundle SHALL include PractitionerRolePortal resources.
If omitted or false, PractitionerRolePortal resources are not included.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a> (<a href="StructureDefinition-BundleOffersContextPortal.html" title="https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/BundleOffersContextPortal">Bundle (Offers Context) — WOF Portal</a>)</td><td/><td><div><p>A profiled Bundle containing offers context resources.</p>
</div></td></tr></table></div>
  </text>
  <url
       value="https://canonical.fhir.link/servicewell/wof-portal/OperationDefinition/get-offers-context"/>
  <version value="0.1.0"/>
  <name value="GetOffersContext"/>
  <title value="$getOffersContext — Booking Content Context"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2026-02-05T11:52:45+00:00"/>
  <publisher value="Service Well AB"/>
  <contact>
    <name value="Service Well AB"/>
    <telecom>
      <system value="url"/>
      <value value="https://servicewell.se"/>
    </telecom>
  </contact>
  <description
               value="Read-oriented operation returning an enriched, profiled Bundle for fast content rendering.
It may include ActivityDefinitionPortal, HealthcareServicePortal, PractitionerRolePortal and OfferPortal.
It MUST NOT include Schedule, Slot, or bookable time slots."/>
  <code value="getOffersContext"/>
  <resource value="ActivityDefinition"/>
  <resource value="HealthcareService"/>
  <resource value="PractitionerRole"/>
  <system value="true"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="includeActivityDefinitionPortal"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="If true, the response Bundle SHALL include ActivityDefinitionPortal resources.
If omitted or false, ActivityDefinitionPortal resources are not included."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="includeHealthcareServicePortal"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="If true, the response Bundle SHALL include HealthcareServicePortal resources.
If omitted or false, HealthcareServicePortal resources are not included."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="includePractitionerRolePortal"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="If true, the response Bundle SHALL include PractitionerRolePortal resources.
If omitted or false, PractitionerRolePortal resources are not included."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="A profiled Bundle containing offers context resources."/>
    <type value="Bundle"/>
    <targetProfile
                   value="https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/BundleOffersContextPortal"/>
  </parameter>
</OperationDefinition>