Skip to main content


class HS.FHIRServer.Storage.Json.InteractionsStrategy extends HS.FHIRServer.API.InteractionsStrategy

Method Inventory


parameter InteractionsClass = HS.FHIRServer.Storage.Json.Interactions;
parameter ResourceSuperclass = HS.FHIRServer.Storage.Json.Resource;
parameter ResourceVersionSuperclass = HS.FHIRServer.Storage.Json.ResourceVer;
parameter StrategyDesc = All Resources stored in a single table as Json text;
parameter StrategyKey = Json;


final method %OnNew(serviceInstance As HS.FHIRServer.ServiceInstance, repoManager As HS.FHIRServer.API.RepoManager) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

method GetCapabilityConfig() as %DynamicObject
method GetCapabilityTemplate() as %DynamicObject
@API - NOTE: This method is defined in the HS.FHIRServer.Storage.Json.InteractionsStrategy class. Subclasses may override.
method GetFieldMetdata(pSearchParam As HS.FHIRServer.SearchParam) as %CacheString
@API Returns field metadata for a field corresponding to a search parameter, returns $listbuild(fieldName, isCollection,...)
method GetMetadataResource() as %DynamicObject
Return a CapabilityStatement metadata resource. The returned content is derived from a strategy-specific means of formulating a CapabilityStatement. An example use of the output might be to store the CapabilityStatement for a given Service.
This method should not be confused with the Interactions class LoadMetadata() method, which retrieves the stored CapabilityStatement for the current Service.
classmethod GetStrategyConfigInfo() as %DynamicObject
Inherited description: @API.Overrideable Returns a JSON object which defines InteractionsStrategy specific settings. This object allows settings to be modified through the FHIR configuration UI, and will also be used to set default values when a new endpoint is created. Note that additional properties can be saved in an endpoint's strategy configuration, but only settings defined here will appear in the UI and will be given a default value. The object must match the following interface: { prop_name: { # Name of the setting type: "string" | "number" | "boolean", # Datatype of the setting. Must be one of these supported JSON types default: string | number | boolean, # Default value for the property. All endpoints will use this value until changed display_name: string # (optional) Label text used to identify the setting in the config UI description: string # (optional) Description of the property. Will appear as a tooltip in the config UI }, ... } eg. { "read_write": { "type": "boolean", "default": true, "display_name": "Allow write access", "description": "If checked, this endpoint will support POSTing and PUTing resources. Otherwise, it will be read-only" }, "consent_processor": { "type": "string", "default": "MyCustom.ConsentProcessor" "display_name": "Consent processor class" } }
method MigrateFromPre2020(ByRef options) as %Integer
Inherited description: @API This method migrates existing FHIR data from a previous installation of FHIR from pre-HealthConnect 2020.1
method NewInteractionsInstance() as HS.FHIRServer.API.Interactions
@API Creates an instance of the Interactions handler object
method buildSecurity() as %DynamicObject
buildSecurity builds a CapabilityStatement security object. Input to this method is available only via the class parameters and properties of the current InteractionsStrategy object instance.
method isBitmap(pSearchParam As HS.FHIRServer.SearchParam)

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab