Class MessageHeader
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.MessageHeader
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class MessageHeader extends 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.Maturity level: FMM4 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MessageHeader.Builder
static class
MessageHeader.Destination
The destination application which the message is intended for.static class
MessageHeader.Response
Information about the message that this message is a response to.static class
MessageHeader.Source
The source application from which this message originated.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static MessageHeader.Builder
builder()
boolean
equals(java.lang.Object obj)
Reference
getAuthor()
The logical author of the message - the person or device that decided the described event should happen.Canonical
getDefinition()
Permanent link to the MessageDefinition for this message.java.util.List<MessageHeader.Destination>
getDestination()
The destination application which the message is intended for.Reference
getEnterer()
The person or device that performed the data entry leading to this message.Element
getEvent()
Code that identifies the event this message represents and connects it with its definition.java.util.List<Reference>
getFocus()
The actual data of the message - a reference to the root/focus class of the event.CodeableConcept
getReason()
Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.MessageHeader.Response
getResponse()
Information about the message that this message is a response to.Reference
getResponsible()
The person or organization that accepts overall responsibility for the contents of the message.Reference
getSender()
Identifies the sending system to allow the use of a trust relationship.MessageHeader.Source
getSource()
The source application from which this message originated.boolean
hasChildren()
int
hashCode()
MessageHeader.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getEvent
public Element getEvent()
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.
-
getDestination
public java.util.List<MessageHeader.Destination> getDestination()
The destination application which the message is intended for.- Returns:
- An unmodifiable list containing immutable objects of type
MessageHeader.Destination
that may be empty.
-
getSender
public Reference getSender()
Identifies the sending system to allow the use of a trust relationship.- Returns:
- An immutable object of type
Reference
that may be null.
-
getEnterer
public Reference getEnterer()
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.- Returns:
- An immutable object of type
Reference
that may be null.
-
getAuthor
public Reference getAuthor()
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.- Returns:
- An immutable object of type
Reference
that may be null.
-
getSource
public MessageHeader.Source getSource()
The source application from which this message originated.- Returns:
- An immutable object of type
MessageHeader.Source
that is non-null.
-
getResponsible
public Reference getResponsible()
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.- Returns:
- An immutable object of type
Reference
that may be null.
-
getReason
public CodeableConcept getReason()
Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getResponse
public MessageHeader.Response getResponse()
Information about the message that this message is a response to. Only present if this message is a response.- Returns:
- An immutable object of type
MessageHeader.Response
that may be null.
-
getFocus
public java.util.List<Reference> getFocus()
The actual data of the message - a reference to the root/focus class of the event.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getDefinition
public Canonical getDefinition()
Permanent link to the MessageDefinition for this message.- Returns:
- An immutable object of type
Canonical
that may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public MessageHeader.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static MessageHeader.Builder builder()
-
-