Skip to main content

HS.FHIR.vSTU3.Model.Resource.MessageDefinition.AllowedResponse

deprecated class HS.FHIR.vSTU3.Model.Resource.MessageDefinition.AllowedResponse extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = MessageDefinition.AllowedResponse;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = MessageDefinition.AllowedResponse;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property message as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "message", XMLPROJECTION = "ELEMENT") [ Required ];
A reference to the message definition that must be adhered to by this supported response.
Property methods: messageGet(), messageGetSwizzled(), messageIsValid(), messageNewObject(), messageSet()
property situation as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "situation", XMLPROJECTION = "ELEMENT");
Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).
Property methods: situationGet(), situationGetSwizzled(), situationIsValid(), situationNewObject(), situationSet()

Methods

deprecated method SetMessage(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "message" property.
deprecated method SetSituation(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "situation" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab