Skip to main content


deprecated persistent class HS.Message.FHIR.Base extends %Library.Persistent, %XML.Adaptor

SQL Table Name: HS_Message_FHIR.Base

Defines a FHIR basic message

Property Inventory

Method Inventory


property AdditionalInfo as array of HS.Types.AdditionalInfoItem;
Used for ad hoc data that is meant to travel only between config items and not between productions/systems.
Property methods: AdditionalInfoBuildValueArray(), AdditionalInfoCollectionToDisplay(), AdditionalInfoCollectionToOdbc(), AdditionalInfoDisplayToCollection(), AdditionalInfoDisplayToLogical(), AdditionalInfoGet(), AdditionalInfoGetObject(), AdditionalInfoGetObjectId(), AdditionalInfoGetStored(), AdditionalInfoGetSwizzled(), AdditionalInfoIsValid(), AdditionalInfoLogicalToDisplay(), AdditionalInfoLogicalToOdbc(), AdditionalInfoNormalize(), AdditionalInfoOdbcToCollection(), AdditionalInfoSet(), AdditionalInfoSetObject(), AdditionalInfoSetObjectId()
property BaseURL as %String (MAXLEN = 2048);
The base URL for this request
Property methods: BaseURLDisplayToLogical(), BaseURLGet(), BaseURLGetStored(), BaseURLIsValid(), BaseURLLogicalToDisplay(), BaseURLLogicalToOdbc(), BaseURLNormalize(), BaseURLSet()
property ContentType as %String (MAXLEN = 256);
For client-side request messages for write-based interactions, ContentType is populated into the HTTP Content-Type header. It indicates the ContentType of the Payload being sent to the server.
For client-side request messages for read-based interactions, ContentType is populated into the HTTP Accept header. It indicates the requested content type of the Payload that will be returned from the server.
For server-side request messages for write-based interactions, ContentType is the content type of the Payload in the request message.
For server-side request messages for read-based interactions, ContentType is the content type to use for any Payload that is returned in the response message.
For any response messages, ContentType is the content type of the response Payload.
Property methods: ContentTypeDisplayToLogical(), ContentTypeGet(), ContentTypeGetStored(), ContentTypeIsValid(), ContentTypeLogicalToDisplay(), ContentTypeLogicalToOdbc(), ContentTypeNormalize(), ContentTypeSet()
property FHIRVersion as %String (MAXLEN = 255);
FHIR Version indicator
Property methods: FHIRVersionDisplayToLogical(), FHIRVersionGet(), FHIRVersionGetStored(), FHIRVersionIsValid(), FHIRVersionLogicalToDisplay(), FHIRVersionLogicalToOdbc(), FHIRVersionNormalize(), FHIRVersionSet()
property Headers as array of %String (MAXLEN = 8192);
Message headers
Property methods: HeadersBuildValueArray(), HeadersCollectionToDisplay(), HeadersCollectionToOdbc(), HeadersDisplayToCollection(), HeadersDisplayToLogical(), HeadersGet(), HeadersGetObject(), HeadersGetObjectId(), HeadersGetStored(), HeadersGetSwizzled(), HeadersIsValid(), HeadersLogicalToDisplay(), HeadersLogicalToOdbc(), HeadersNormalize(), HeadersOdbcToCollection(), HeadersSet(), HeadersSetObject(), HeadersSetObjectId()
property Id as %String (MAXLEN = 256);
The resource ID
Property methods: IdDisplayToLogical(), IdGet(), IdGetStored(), IdIsValid(), IdLogicalToDisplay(), IdLogicalToOdbc(), IdNormalize(), IdSet()
property Payload as %Stream.GlobalCharacter;
The message payload. It can be FHIR resource content, or application/x-www-form-urlencoded request data. When that content is stored in the Payload property of this message object, it causes the standard message handling to log the Payload contents each time the message is passed between config items. For large-scale and/or complex implementations, this may not be desirable, as the logged data will quickly become voluminous and negatively affect performance. The default behavior for product FHIR components is to use QuickStreams for such content. See the QuickStream property comments for details. See also the method comments for the GetPayloadOref() instance method.
Property methods: PayloadDelete(), PayloadGet(), PayloadGetObject(), PayloadGetObjectId(), PayloadGetStored(), PayloadGetSwizzled(), PayloadIsValid(), PayloadNewObject(), PayloadOid(), PayloadOpen(), PayloadSet(), PayloadSetObject(), PayloadSetObjectId(), PayloadUnSwizzle()
property QuickStreamId as %String;
Object Id of a HS.SDA3.QuickStream object holding the message payload. The payload can be FHIR resource content, or application/x-www-form-urlencoded request data. A QuickStream is a storage alternative to the Payload property for the payload content during the life of a message session. When QuickStream is used, it maintains only a single object instance of the content, and avoids logging potentially huge payloads - which could possibly be logged multiple times - as part of the standard message handling. It is deleted at the end of each message session. If there is a need to conduct diagnostics and see a log of the payload content during new message sessions, use the TraceOperations setting of the relevant business services, processes and/or operations. See also the method comments for the GetPayloadOref() instance method.
Property methods: QuickStreamIdDisplayToLogical(), QuickStreamIdGet(), QuickStreamIdGetStored(), QuickStreamIdIsValid(), QuickStreamIdLogicalToDisplay(), QuickStreamIdLogicalToOdbc(), QuickStreamIdNormalize(), QuickStreamIdSet()
deprecated property ResourceContainer as %RegisteredObject;
DEPRECATED. Used only for DSTU2 DTL transformations. Applications should not make direct use of this property. For FHIR versions after DSTU2, use other means for making an object from FHIR stream and for making FHIR stream from object during DTL customization.
Property methods: ResourceContainerGet(), ResourceContainerGetStored(), ResourceContainerGetSwizzled(), ResourceContainerIsValid(), ResourceContainerNewObject(), ResourceContainerSet()
property TimestampUTC as %TimeStamp [ InitialExpression = $ZDT($ZTS,3) , Required ];
Time stamp of when we received this message
Property methods: TimestampUTCDisplayToLogical(), TimestampUTCGet(), TimestampUTCGetStored(), TimestampUTCIsValid(), TimestampUTCLogicalToDisplay(), TimestampUTCLogicalToXSD(), TimestampUTCNormalize(), TimestampUTCOdbcToLogical(), TimestampUTCSet(), TimestampUTCXSDToLogical()
property Type as %String (MAXLEN = 128);
The FHIR entity type on which to perform this request
Property methods: TypeDisplayToLogical(), TypeGet(), TypeGetStored(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()
property VId as %String (MAXLEN = 256);
The resource version
Property methods: VIdDisplayToLogical(), VIdGet(), VIdGetStored(), VIdIsValid(), VIdLogicalToDisplay(), VIdLogicalToOdbc(), VIdNormalize(), VIdSet()


deprecated method GetPayloadOref() as %Library.ObjectHandle
API The message payload may be held in either the Payload property or in a QuickStream. Use GetPayloadOref() to get the pointer to the object (Payload property or QuickStream) currently being used by this message instance.


index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


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


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


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



FeedbackOpens in a new tab