Skip to main content

HS.FHIRServer.API.Data.RestClient.Response

serial class HS.FHIRServer.API.Data.RestClient.Response extends %Library.SerialObject, %XML.Adaptor

Message class for response to client-side (outgoing) FHIR REST API request.

Property Inventory

Properties

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(), AdditionalInfoGetSwizzled(), AdditionalInfoIsValid(), AdditionalInfoLogicalToDisplay(), AdditionalInfoLogicalToOdbc(), AdditionalInfoNormalize(), AdditionalInfoOdbcToCollection(), AdditionalInfoSet(), AdditionalInfoSetObject(), AdditionalInfoSetObjectId()
property ETag as %String (MAXLEN = 128);
Property methods: ETagDisplayToLogical(), ETagGet(), ETagIsValid(), ETagLogicalToDisplay(), ETagLogicalToOdbc(), ETagNormalize(), ETagSet()
property Id as %String);
Length restriction will be enforced elsewhere by schema-based validation on id data type.
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdLogicalToOdbc(), IdNormalize(), IdSet()
property IsPrettyOut as %Boolean;
True if output is to be formatted (_pretty=true)
Property methods: IsPrettyOutDisplayToLogical(), IsPrettyOutGet(), IsPrettyOutIsValid(), IsPrettyOutLogicalToDisplay(), IsPrettyOutLogicalToXSD(), IsPrettyOutNormalize(), IsPrettyOutSet(), IsPrettyOutXSDToLogical()
property Json;
JSON Response object Note: This is not typed as a %DynamicObject because IRIS automatically creates an empty one which we do not want.
Property methods: JsonDisplayToLogical(), JsonGet(), JsonIsValid(), JsonLogicalToDisplay(), JsonLogicalToOdbc(), JsonNormalize(), JsonSet()
property LastModified as %String (MAXLEN = 128);
Property methods: LastModifiedDisplayToLogical(), LastModifiedGet(), LastModifiedIsValid(), LastModifiedLogicalToDisplay(), LastModifiedLogicalToOdbc(), LastModifiedNormalize(), LastModifiedSet()
property Location as %String);
Property methods: LocationDisplayToLogical(), LocationGet(), LocationIsValid(), LocationLogicalToDisplay(), LocationLogicalToOdbc(), LocationNormalize(), LocationSet()
property OtherHeaders as array of %String (MAXLEN = 8192);
Message headers not already covered by explicit response properties.
Property methods: OtherHeadersBuildValueArray(), OtherHeadersCollectionToDisplay(), OtherHeadersCollectionToOdbc(), OtherHeadersDisplayToCollection(), OtherHeadersDisplayToLogical(), OtherHeadersGet(), OtherHeadersGetObject(), OtherHeadersGetObjectId(), OtherHeadersGetSwizzled(), OtherHeadersIsValid(), OtherHeadersLogicalToDisplay(), OtherHeadersLogicalToOdbc(), OtherHeadersNormalize(), OtherHeadersOdbcToCollection(), OtherHeadersSet(), OtherHeadersSetObject(), OtherHeadersSetObjectId()
property Payload as %Stream.Object;
Stream representation of the request or response payload, as a property of this class.
Property methods: PayloadDelete(), PayloadGet(), PayloadGetObject(), PayloadGetObjectId(), PayloadGetSwizzled(), PayloadIsValid(), PayloadNewObject(), PayloadOid(), PayloadOpen(), PayloadSet(), PayloadSetObject(), PayloadSetObjectId(), PayloadUnSwizzle()
property ResponseFormat as %String (MAXLEN = 8192);
Mime type of the response payload. May simply be a mime type (e.g., "application/fhir+json"), or the contents of an HTTP Content-Type header (e.g. "application/fhir+json; charset-utf8"), depending on the use case.
Property methods: ResponseFormatDisplayToLogical(), ResponseFormatGet(), ResponseFormatIsValid(), ResponseFormatLogicalToDisplay(), ResponseFormatLogicalToOdbc(), ResponseFormatNormalize(), ResponseFormatSet()
property Status as %String (MAXLEN = 256);
HTTP Status code
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
property VId as %String;
Property methods: VIdDisplayToLogical(), VIdGet(), VIdIsValid(), VIdLogicalToDisplay(), VIdLogicalToOdbc(), VIdNormalize(), VIdSet()

Inherited Members

Inherited Methods

FeedbackOpens in a new tab