HS.FHIRModel.R4.MessageHeader
class HS.FHIRModel.R4.MessageHeader extends HS.FHIRModel.FHIRClassSuper
******************************************* MessageHeader generated class schema
*****************************************
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
- _eventUri
- _implicitRules
- _language
- author
- contained
- definition
- destination
- enterer
- eventCoding
- eventUri
- extension
- fhirID
- focus
- implicitRules
- language
- meta
- modifierExtension
- reason
- resourceType
- response
- responsible
- sender
- source
- text
Method Inventory
- IncludeAuthor()
- IncludeContained()
- IncludeDestination()
- IncludeEnterer()
- IncludeEventCoding()
- IncludeExtension()
- IncludeFocus()
- IncludeMeta()
- IncludeModifierExtension()
- IncludeReason()
- IncludeResponse()
- IncludeResponsible()
- IncludeSender()
- IncludeSource()
- IncludeText()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_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.
Properties
property _eventUri as HS.FHIRModel.R4.Element;
Extensions for eventUri
Property methods: _eventUriGet(), _eventUriGetSwizzled(), _eventUriIsValid(), _eventUriNewObject(), _eventUriSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property author as HS.FHIRModel.R4.Reference;
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 contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the
resource that contains them - they cannot be identified independently,
and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property definition as %String;
Permanent link to the MessageDefinition for this message.
Property methods: definitionDisplayToLogical(), definitionGet(), definitionIsValid(), definitionLogicalToDisplay(), definitionLogicalToOdbc(), definitionNormalize(), definitionSet()
property destination as HS.FHIRModel.R4.MessageHeaderX.SeqOfMessageHeaderXDestination;
The destination application which the message is intended for.
Property methods: destinationGet(), destinationGetSwizzled(), destinationIsValid(), destinationNewObject(), destinationSet()
property enterer as HS.FHIRModel.R4.Reference;
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 eventCoding as HS.FHIRModel.R4.Coding;
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://terminology.hl7.org/CodeSystem/message-events".
Alternatively uri to the EventDefinition.
Property methods: eventCodingGet(), eventCodingGetSwizzled(), eventCodingIsValid(), eventCodingNewObject(), eventCodingSet()
property eventUri as %String;
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://terminology.hl7.org/CodeSystem/message-events".
Alternatively uri to the EventDefinition.
Property methods: eventUriDisplayToLogical(), eventUriGet(), eventUriIsValid(), eventUriLogicalToDisplay(), eventUriLogicalToOdbc(), eventUriNormalize(), eventUriSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property focus as HS.FHIRModel.R4.SeqOfReference;
The actual data of the message - a reference to the root/focus class
of the event.
Property methods: focusGet(), focusGetSwizzled(), focusIsValid(), focusNewObject(), focusSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource
was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained
by the infrastructure. Changes to the content might not always be
associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource and that modifies the understanding
of the element that contains it and/or the understanding of the
containing element's descendants. Usually modifier elements provide
negation or qualification. To make the use of extensions safe and
manageable, there is a strict set of governance applied to the definition
and use of extensions. Though any implementer is allowed to define
an extension, there is a set of requirements that SHALL be met as
part of the definition of the extension. Applications processing
a resource are required to check for modifier extensions. Modifier
extensions SHALL NOT change the meaning of any elements on Resource
or DomainResource (including cannot change the meaning of modifierExtension
itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property reason as HS.FHIRModel.R4.CodeableConcept;
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 resourceType as %String [ InitialExpression = "MessageHeader" , Required ];
This is a MessageHeader resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property response as HS.FHIRModel.R4.MessageHeaderX.Response;
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.FHIRModel.R4.Reference;
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.FHIRModel.R4.Reference;
Identifies the sending system to allow the use of a trust relationship.
Property methods: senderGet(), senderGetSwizzled(), senderIsValid(), senderNewObject(), senderSet()
property source as HS.FHIRModel.R4.MessageHeaderX.Source [ Required ];
The source application from which this message originated.
Property methods: sourceGet(), sourceGetSwizzled(), sourceIsValid(), sourceNewObject(), sourceSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human.
The narrative need not encode all the structured data, but is required
to contain sufficient detail to make it "clinically safe" for a
human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
Methods
method IncludeAuthor()
method IncludeContained()
method IncludeDestination()
method IncludeEnterer()
method IncludeEventCoding()
method IncludeExtension()
method IncludeFocus()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeReason()
method IncludeResponse()
method IncludeResponsible()
method IncludeSender()
method IncludeSource()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.MessageHeader
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()