Skip to main content


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

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.

Property Inventory


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


property author as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "author", XMLPROJECTION = "ELEMENT");

The source of the decision.


Property methods: authorGet(), authorGetSwizzled(), authorIsValid(), authorNewObject(), authorSet()
property destination as list of HS.FHIR.DTL.vSTU3.Model.Element.MessageHeader.destination (XMLNAME = "destination", XMLPROJECTION = "ELEMENT");

Message destination application(s)

Property methods: destinationBuildValueArray(), destinationCollectionToDisplay(), destinationCollectionToOdbc(), destinationDisplayToCollection(), destinationGet(), destinationGetObject(), destinationGetObjectId(), destinationGetSwizzled(), destinationIsValid(), destinationOdbcToCollection(), destinationSet(), destinationSetObject(), destinationSetObjectId()
property enterer as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "enterer", XMLPROJECTION = "ELEMENT");

The source of the data entry.


Property methods: entererGet(), entererGetSwizzled(), entererIsValid(), entererNewObject(), entererSet()
property event as HS.FHIR.DTL.vSTU3.Model.Datatype.Coding (XMLNAME = "event", XMLPROJECTION = "ELEMENT") [ Required ];

Code for the event this message represents.

any FHIR3 code may be used; message-events shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: eventGet(), eventGetSwizzled(), eventIsValid(), eventNewObject(), eventSet()
property focus as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "focus", XMLPROJECTION = "ELEMENT");

The actual content of the message.

Any FHIR3 Resource may be indicated by this Reference

Property methods: focusBuildValueArray(), focusCollectionToDisplay(), focusCollectionToOdbc(), focusDisplayToCollection(), focusGet(), focusGetObject(), focusGetObjectId(), focusGetSwizzled(), focusIsValid(), focusOdbcToCollection(), focusSet(), focusSetObject(), focusSetObjectId()
property reason as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");

Cause of event.

any FHIR3 code may be used; message-reason-encounter shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reasonGet(), reasonGetSwizzled(), reasonIsValid(), reasonNewObject(), reasonSet()
property receiver as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "receiver", XMLPROJECTION = "ELEMENT");

Intended "real-world" recipient for the data.

Practitioner | Organization

Property methods: receiverGet(), receiverGetSwizzled(), receiverIsValid(), receiverNewObject(), receiverSet()
property response as HS.FHIR.DTL.vSTU3.Model.Element.MessageHeader.response (XMLNAME = "response", XMLPROJECTION = "ELEMENT");

If this is a reply to prior message.

Property methods: responseGet(), responseGetSwizzled(), responseIsValid(), responseNewObject(), responseSet()
property responsible as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "responsible", XMLPROJECTION = "ELEMENT");

Final responsibility for event.

Practitioner | Organization

Property methods: responsibleGet(), responsibleGetSwizzled(), responsibleIsValid(), responsibleNewObject(), responsibleSet()
property sender as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "sender", XMLPROJECTION = "ELEMENT");

Real world sender of the message.

Practitioner | Organization

Property methods: senderGet(), senderGetSwizzled(), senderIsValid(), senderNewObject(), senderSet()
property source as HS.FHIR.DTL.vSTU3.Model.Element.MessageHeader.source (XMLNAME = "source", XMLPROJECTION = "ELEMENT") [ Required ];

Message source application.

Property methods: sourceGet(), sourceGetSwizzled(), sourceIsValid(), sourceNewObject(), sourceSet()
property timestamp as %String (MAXLEN = 1000000, XMLNAME = "timestamp", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Time that the message was sent.

Property methods: timestampDisplayToLogical(), timestampGet(), timestampIsValid(), timestampLogicalToDisplay(), timestampLogicalToOdbc(), timestampNormalize(), timestampSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab