Skip to main content

HS.FHIR.vSTU3.Model.Resource.MessageHeader

deprecated class HS.FHIR.vSTU3.Model.Resource.MessageHeader extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
If the element is present, it must have either a @value, an @id, or extensions

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 XMLNAME = MessageHeader;
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.

Properties

property author as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "author", XMLPROJECTION = "ELEMENT");
The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
Property methods: authorGet(), authorGetSwizzled(), authorIsValid(), authorNewObject(), authorSet()
property destination as list of HS.FHIR.vSTU3.Model.Resource.MessageHeader.Destination (XMLNAME = "destination", XMLPROJECTION = "ELEMENT");
The destination application which the message is intended for.
Property methods: destinationBuildValueArray(), destinationCollectionToDisplay(), destinationCollectionToOdbc(), destinationDisplayToCollection(), destinationGet(), destinationGetObject(), destinationGetObjectId(), destinationGetSwizzled(), destinationIsValid(), destinationOdbcToCollection(), destinationSet(), destinationSetObject(), destinationSetObjectId()
property enterer as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "enterer", XMLPROJECTION = "ELEMENT");
The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.
Property methods: entererGet(), entererGetSwizzled(), entererIsValid(), entererNewObject(), entererSet()
property event as HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "event", XMLPROJECTION = "ELEMENT") [ Required ];
Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://hl7.org/fhir/message-events".
Property methods: eventGet(), eventGetSwizzled(), eventIsValid(), eventNewObject(), eventSet()
property focus as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "focus", XMLPROJECTION = "ELEMENT");
The actual data of the message - a reference to the root/focus class of the event.
Property methods: focusBuildValueArray(), focusCollectionToDisplay(), focusCollectionToOdbc(), focusDisplayToCollection(), focusGet(), focusGetObject(), focusGetObjectId(), focusGetSwizzled(), focusIsValid(), focusOdbcToCollection(), focusSet(), focusSetObject(), focusSetObjectId()
property reason as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
Property methods: reasonGet(), reasonGetSwizzled(), reasonIsValid(), reasonNewObject(), reasonSet()
property receiver as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "receiver", XMLPROJECTION = "ELEMENT");
Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
Property methods: receiverGet(), receiverGetSwizzled(), receiverIsValid(), receiverNewObject(), receiverSet()
property response as HS.FHIR.vSTU3.Model.Resource.MessageHeader.Response (XMLNAME = "response", XMLPROJECTION = "ELEMENT");
Information about the message that this message is a response to. Only present if this message is a response.
Property methods: responseGet(), responseGetSwizzled(), responseIsValid(), responseNewObject(), responseSet()
property responsible as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "responsible", XMLPROJECTION = "ELEMENT");
The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.
Property methods: responsibleGet(), responsibleGetSwizzled(), responsibleIsValid(), responsibleNewObject(), responsibleSet()
property sender as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "sender", XMLPROJECTION = "ELEMENT");
Identifies the sending system to allow the use of a trust relationship.
Property methods: senderGet(), senderGetSwizzled(), senderIsValid(), senderNewObject(), senderSet()
property source as HS.FHIR.vSTU3.Model.Resource.MessageHeader.Source (XMLNAME = "source", XMLPROJECTION = "ELEMENT") [ Required ];
The source application from which this message originated.
Property methods: sourceGet(), sourceGetSwizzled(), sourceIsValid(), sourceNewObject(), sourceSet()
property timestamp as HS.FHIR.vSTU3.Model.Datatype.Instant (XMLNAME = "timestamp", XMLPROJECTION = "ELEMENT") [ Required ];
The time that the message was sent.
Property methods: timestampGet(), timestampGetSwizzled(), timestampIsValid(), timestampNewObject(), timestampSet()

Methods

deprecated method SetAuthor(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 "author" property.
deprecated method SetEnterer(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 "enterer" property.
deprecated method SetEvent(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "event" property.
deprecated method SetFocus(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "focus" property.
deprecated method SetReason(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "reason" property.
deprecated method SetReceiver(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 "receiver" property.
deprecated method SetResponsible(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 "responsible" property.
deprecated method SetSender(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 "sender" property.
deprecated method SetTimestamp(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 "timestamp" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab