Home > Class Reference > HSLIB namespace > HS.FHIR.REST.Operation


class HS.FHIR.REST.Operation extends Ens.BusinessOperation

FHIR REST client business operation

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter INVOCATION = Queue;
Inherited description: 2 modes: Queue, InProc
parameter SETTINGS = ServiceName:Basic:selector?Select=1&context={HS.Util.ContextSearch/ServiceNameItemsByParam?Type=HTTP},-Validate,MetadataClass:Basic,FHIRVersion:Basic;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties (Including Private)

property Adapter as Ens.OutboundAdapter;
Inherited description: The adapter instance
Property methods: AdapterGet(), AdapterGetSwizzled(), AdapterIsValid(), AdapterName(), AdapterNewObject(), AdapterSet()
property FHIRVersion as %String (MAXLEN = 255);
FHIR Version indicator (if specified)
Property methods: FHIRVersionDisplayToLogical(), FHIRVersionGet(), FHIRVersionIsValid(), FHIRVersionLogicalToDisplay(), FHIRVersionLogicalToOdbc(), FHIRVersionNormalize(), FHIRVersionSet()
property MetadataCache as array of HS.FHIR.InteractionMetadata [ Transient ];
Cache of interaction metadata keyed by interaction name
Property methods: MetadataCacheBuildValueArray(), MetadataCacheCollectionToDisplay(), MetadataCacheCollectionToOdbc(), MetadataCacheDisplayToCollection(), MetadataCacheGet(), MetadataCacheGetObject(), MetadataCacheGetObjectId(), MetadataCacheGetSwizzled(), MetadataCacheIsValid(), MetadataCacheOdbcToCollection(), MetadataCacheSet(), MetadataCacheSetObject(), MetadataCacheSetObjectId()
property MetadataClass as Ens.DataType.Class [ InitialExpression = "HS.FHIR.InteractionMetadata" , Required ];
Interaction Metadata class to use
Property methods: MetadataClassDisplayToLogical(), MetadataClassGet(), MetadataClassIsValid(), MetadataClassLogicalToDisplay(), MetadataClassLogicalToOdbc(), MetadataClassNormalize(), MetadataClassSet()
property ServiceName as %String (MAXLEN = 255);
HTTP Service Registry entry for the target server. This value may be overridden on a per-message basis by specifying the ServiceName in the request message.
Property methods: ServiceNameDisplayToLogical(), ServiceNameGet(), ServiceNameIsValid(), ServiceNameLogicalToDisplay(), ServiceNameLogicalToOdbc(), ServiceNameNormalize(), ServiceNameSet()
property Validate as %Boolean [ InitialExpression = 0 , Required ];
Attempt to validate the interaction, specifically the status codes & content type
Property methods: ValidateDisplayToLogical(), ValidateGet(), ValidateIsValid(), ValidateLogicalToDisplay(), ValidateNormalize(), ValidateSet()

Methods (Including Private)

method AddOAuth2Header(pRequest As HS.Message.FHIR.Request) as %Status [ Language = objectscript ]
Add the OAuth2 access token to the HTTP request headers, if applicable.
method FHIRRequest(pRequest As HS.Message.FHIR.Request, pResponse As HS.Message.FHIR.Response) as %Status [ Language = objectscript ]
Process a client-side FHIR request to the specified remote server
method GetByURL(pRequest As HS.Message.FHIR.Request, pResponse As HS.Message.FHIR.Response) [ Language = objectscript ]
Handle an HTTP GET on a specified full URL, as opposed to a URL whose pieces and parts reside throughout the HS FHIR request message. The URL does not necessarily need to be a FHIR request.
method GetInteractionMetadata(pInteraction As %String, ByRef pMetadata As HS.FHIR.InteractionMetadata) as %Status [ Language = objectscript ]
Helper method for getting interaction metadata. This first consults the local metadata cache before calling out to the metadata class to get the metadata. NOTE: Restarting this production element will flush the cache.
method OnInit() as %Status [ Language = objectscript ]
This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method OnMessage(pRequest As %Library.Persistent, Output pResponse As %Library.Persistent) as %Status [ Language = objectscript ]
Inherited description: This is the default message handler. All request types not declared in the message map are delivered here
method OnTearDown() as %Status [ Language = objectscript ]
This user callback method is called from %OnClose()

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)


FeedbackOpens in a new window