Spenser - a developer's companion
1.0.0 - STU1 International flag

Spenser - a developer's companion, published by Zeora. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/costateixeira/spenser/tree/master and changes regularly. See the Directory of published versions
Built from commit 1fbb0f74.

CapabilityStatement: SpenserFHIRCapabilityStatement

Official URL: http://costateixeira.github.io/spenser/CapabilityStatement/SpenserFHIRCapabilityStatement Version: 1.0.0
Active as of 2025-04-18 Computable Name:

Raw OpenAPI-Swagger Definition file | Download

  • Implementation Guide Version: 1.0.0
  • FHIR Version: 5.0.0
  • Supported Formats: json
  • Published on: 2025-04-18
  • Published by: Zeora

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

REST Configuration: 1

Mode: server

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
MedicationRequest y
MedicationDispense y
InventoryReport yy
Core FHIR Resource
MedicationRequest
Reference Policy
Interaction summary
  • Supports create.

Core FHIR Resource
MedicationDispense
Reference Policy
Interaction summary
  • Supports read.

Core FHIR Resource
InventoryReport
Reference Policy
Interaction summary
  • Supports read, create.

REST Configuration: 2

Mode: client

Spenser also acts as a client: it polls a server for orders it should fulfil. Following the COW guidance on actionable orders, an order is only dispensed when the MedicationRequest carries the 'actionable' tag, or when a Task asks for it to be fulfilled.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
MedicationRequest yy_tag, status, intent
Task yystatusTask:focus
MedicationDispense y
Core FHIR Resource
MedicationRequest
Reference Policy
Interaction summary
  • Supports search-type, update.

Documentation

Searched for orders tagged as actionable. Set to 'completed' after dispensing, when no Task is coordinating the work.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_tagtoken

Selects orders tagged http://terminology.hl7.org/CodeSystem/common-tags#actionable

SHALLstatustoken
SHALLintenttoken
 
Core FHIR Resource
Task
Reference Policy
Interaction summary
  • Supports search-type, update.

Documentation

Coordination Task pointing at the order in Task.focus. Set to 'completed' with the dispense in Task.output; the status of the request itself is left to the placer.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLstatustoken
 
Core FHIR Resource
MedicationDispense
Reference Policy
Interaction summary
  • Supports create.

Documentation

Created on the server once an order has been dispensed, referring to the order in authorizingPrescription.