Skip to main content

HS.Message.FHIR.Request

deprecated persistent class HS.Message.FHIR.Request extends HS.Message.FHIR.Base, HS.Util.EnsRequest

SQL Table Name: HS_Message_FHIR.Request

THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
A FHIR request message. Typically represents the inbound REST request

Property Inventory

Method Inventory

Parameters

parameter RESPONSECLASSNAME = HS.Message.FHIR.Response;

Properties

property Accept as %String (MAXLEN = 255);
For client-side request messages, Accept is not used.
For server-side request messages, Accept is populated with a value derived from the first found of the either the request URL _format parameter or the HTTP Accept header value.
Property methods: AcceptDisplayToLogical(), AcceptGet(), AcceptGetStored(), AcceptIsValid(), AcceptLogicalToDisplay(), AcceptLogicalToOdbc(), AcceptNormalize(), AcceptSet()
property Compartment as %String (MAXLEN = 255);
Compartment
Property methods: CompartmentDisplayToLogical(), CompartmentGet(), CompartmentGetStored(), CompartmentIsValid(), CompartmentLogicalToDisplay(), CompartmentLogicalToOdbc(), CompartmentNormalize(), CompartmentSet()
property FormatFHIROutput as %Boolean [ InitialExpression = 0 ];
Add formatting indents and lines feeds to returned FHIR payload
Property methods: FormatFHIROutputDisplayToLogical(), FormatFHIROutputGet(), FormatFHIROutputGetStored(), FormatFHIROutputIsValid(), FormatFHIROutputLogicalToDisplay(), FormatFHIROutputLogicalToXSD(), FormatFHIROutputNormalize(), FormatFHIROutputSet(), FormatFHIROutputXSDToLogical()
property Interaction as %String [ Required ];
The FHIR interaction
Property methods: InteractionDisplayToLogical(), InteractionGet(), InteractionGetStored(), InteractionIsValid(), InteractionLogicalToDisplay(), InteractionLogicalToOdbc(), InteractionNormalize(), InteractionSet()
property Parameters as array of %List;
Query Parameters
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetStored(), ParametersGetSwizzled(), ParametersIsValid(), ParametersLogicalToOdbc(), ParametersLogicalToXSD(), ParametersOdbcToCollection(), ParametersOdbcToLogical(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId(), ParametersXSDToLogical()
property SessionApplication as %String (MAXLEN = 255);
Property methods: SessionApplicationDisplayToLogical(), SessionApplicationGet(), SessionApplicationGetStored(), SessionApplicationIsValid(), SessionApplicationLogicalToDisplay(), SessionApplicationLogicalToOdbc(), SessionApplicationNormalize(), SessionApplicationSet()
property SessionId as %String (MAXLEN = 255);
Property methods: SessionIdDisplayToLogical(), SessionIdGet(), SessionIdGetStored(), SessionIdIsValid(), SessionIdLogicalToDisplay(), SessionIdLogicalToOdbc(), SessionIdNormalize(), SessionIdSet()

Methods

deprecated method GetParameterCount(pParamName As %String) as %Integer
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
GetParameterCount returns the number of instances of a given parameter. This method assumes that all instances of a given parameter include a modifier OR all instances do NOT include a modifier. Parameter modifier in FHIR is expressed as a colon-delimited suffix on the parameter name (not value), for example family:exact=jones.
deprecated method GetParameterValue(pParamName As %String, pPosition As %Integer = 1, ByRef pModifier As %String) as %String
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
GetParameter returns the value of a specified parameter instance, plus any parameter modifier. This method assumes that all instances of a given parameter include a modifier OR all instances do NOT include a modifier. Parameter modifier in FHIR is expressed as a colon-delimited suffix on the parameter name (not value), for example family:exact=jones.
deprecated method SetParameter(pParamName As %String = "", pParamValue As %String = "", pModifier As %String = "") as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
SetParameter adds the specified parameter, modifier, and value to the request message Parameters collection.

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (HS.Message.FHIR.Base)

^HS.Message.FHIR.BaseD(ID,"AdditionalInfo",n)
=
AdditionalInfo(n)

Storage Model: Storage (HS.Message.FHIR.Base)

^HS.Message.FHIR.BaseD(ID)
=
%%CLASSNAME
TimestampUTC
BaseURL
Type
Id
VId
ContentType
Payload
FHIRVersion
ResourceContainer
QuickStreamId

Storage Model: Storage (HS.Message.FHIR.Base)

^HS.Message.FHIR.BaseD(ID,"Headers",n)
=
Headers(n)

Storage Model: Storage (HS.Message.FHIR.Request)

^HS.Message.FHIR.BaseD(ID,"HS.Message.FHIR.Request.Parameters",n)
=
Parameters(n)

Storage Model: Storage (HS.Message.FHIR.Request)

^HS.Message.FHIR.BaseD(ID,"Request")
=
Interaction
Compartment
HSMinVersion
HSCoreVersion
FormatFHIROutput
SessionApplication
SessionId
%ClearFields
Accept
FeedbackOpens in a new tab