MessageHeader (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.MessageHeader

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class MessageHeader
extends BaseResource
implements IResource
```
HAPI/FHIR MessageHeader Resource (infrastructure.exchange)
Definition: 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.

Requirements: Many implementations are not prepared to use REST and need a messaging based infrastructure

Profile Definition: http://hl7.org/fhir/profiles/MessageHeader

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MessageHeader.Destination` Block class for child element: MessageHeader.destination (who.focus)
`static class`	`MessageHeader.Response` Block class for child element: MessageHeader.response ()
`static class`	`MessageHeader.Source` Block class for child element: MessageHeader.source (who.actor)

Field Summary

Fields
Modifier and Type	Field and Description
`static ReferenceClientParam`	`AUTHOR` Fluent Client search parameter constant for author
`static TokenClientParam`	`CODE` Fluent Client search parameter constant for code
`static ReferenceClientParam`	`DATA` Fluent Client search parameter constant for data
`static StringClientParam`	`DESTINATION` Fluent Client search parameter constant for destination
`static UriClientParam`	`DESTINATION_URI` Fluent Client search parameter constant for destination-uri
`static ReferenceClientParam`	`ENTERER` Fluent Client search parameter constant for enterer
`static TokenClientParam`	`EVENT` Fluent Client search parameter constant for event
`static Include`	`INCLUDE_AUTHOR` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_DATA` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_ENTERER` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_RECEIVER` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_RESPONSIBLE` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_TARGET` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`RECEIVER` Fluent Client search parameter constant for receiver
`static TokenClientParam`	`RESPONSE_ID` Fluent Client search parameter constant for response-id
`static ReferenceClientParam`	`RESPONSIBLE` Fluent Client search parameter constant for responsible
`static StringClientParam`	`SOURCE` Fluent Client search parameter constant for source
`static UriClientParam`	`SOURCE_URI` Fluent Client search parameter constant for source-uri
`static String`	`SP_AUTHOR` Search parameter constant for author
`static String`	`SP_CODE` Search parameter constant for code
`static String`	`SP_DATA` Search parameter constant for data
`static String`	`SP_DESTINATION` Search parameter constant for destination
`static String`	`SP_DESTINATION_URI` Search parameter constant for destination-uri
`static String`	`SP_ENTERER` Search parameter constant for enterer
`static String`	`SP_EVENT` Search parameter constant for event
`static String`	`SP_RECEIVER` Search parameter constant for receiver
`static String`	`SP_RESPONSE_ID` Search parameter constant for response-id
`static String`	`SP_RESPONSIBLE` Search parameter constant for responsible
`static String`	`SP_SOURCE` Search parameter constant for source
`static String`	`SP_SOURCE_URI` Search parameter constant for source-uri
`static String`	`SP_TARGET` Search parameter constant for target
`static String`	`SP_TIMESTAMP` Search parameter constant for timestamp
`static ReferenceClientParam`	`TARGET` Fluent Client search parameter constant for target
`static DateClientParam`	`TIMESTAMP` Fluent Client search parameter constant for timestamp

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

MessageHeader()

Constructors
Constructor and Description
`MessageHeader()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResourceReferenceDt`	`addData()` Adds and returns a new value for data ()
`MessageHeader.Destination`	`addDestination()` Adds and returns a new value for destination (who.focus)
`MessageHeader`	`addDestination(MessageHeader.Destination theValue)` Adds a given new value for destination (who.focus)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`ResourceReferenceDt`	`getAuthor()` Gets the value(s) for author (who.author).
`List<ResourceReferenceDt>`	`getData()` Gets the value(s) for data ().
`List<MessageHeader.Destination>`	`getDestination()` Gets the value(s) for destination (who.focus).
`MessageHeader.Destination`	`getDestinationFirstRep()` Gets the first repetition for destination (who.focus), creating it if it does not already exist.
`ResourceReferenceDt`	`getEnterer()` Gets the value(s) for enterer (who.author).
`CodingDt`	`getEvent()` Gets the value(s) for event (what).
`CodeableConceptDt`	`getReason()` Gets the value(s) for reason (why).
`ResourceReferenceDt`	`getReceiver()` Gets the value(s) for receiver (who.focus).
`String`	`getResourceName()`
`MessageHeader.Response`	`getResponse()` Gets the value(s) for response ().
`ResourceReferenceDt`	`getResponsible()` Gets the value(s) for responsible (who.witness).
`MessageHeader.Source`	`getSource()` Gets the value(s) for source (who.actor).
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`Date`	`getTimestamp()` Gets the value(s) for timestamp (when.init).
`InstantDt`	`getTimestampElement()` Gets the value(s) for timestamp (when.init).
`boolean`	`isEmpty()`
`MessageHeader`	`setAuthor(ResourceReferenceDt theValue)` Sets the value(s) for author (who.author)
`MessageHeader`	`setData(List<ResourceReferenceDt> theValue)` Sets the value(s) for data ()
`MessageHeader`	`setDestination(List<MessageHeader.Destination> theValue)` Sets the value(s) for destination (who.focus)
`MessageHeader`	`setEnterer(ResourceReferenceDt theValue)` Sets the value(s) for enterer (who.author)
`MessageHeader`	`setEvent(CodingDt theValue)` Sets the value(s) for event (what)
`MessageHeader`	`setReason(CodeableConceptDt theValue)` Sets the value(s) for reason (why)
`MessageHeader`	`setReceiver(ResourceReferenceDt theValue)` Sets the value(s) for receiver (who.focus)
`MessageHeader`	`setResponse(MessageHeader.Response theValue)` Sets the value(s) for response ()
`MessageHeader`	`setResponsible(ResourceReferenceDt theValue)` Sets the value(s) for responsible (who.witness)
`MessageHeader`	`setSource(MessageHeader.Source theValue)` Sets the value(s) for source (who.actor)
`MessageHeader`	`setTimestamp(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for timestamp (when.init)
`MessageHeader`	`setTimestamp(InstantDt theValue)` Sets the value(s) for timestamp (when.init)
`MessageHeader`	`setTimestampWithMillisPrecision(Date theDate)` Sets the value for timestamp (when.init)

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId

- Field Detail
  - SP_TIMESTAMP
```
public static final String SP_TIMESTAMP
```
    Search parameter constant for timestamp
    Description:
    Type: date
    Path: MessageHeader.timestamp
    
    See Also:
    
    Constant Field Values
  - TIMESTAMP
```
public static final DateClientParam TIMESTAMP
```
    Fluent Client search parameter constant for timestamp
    Description:
    Type: date
    Path: MessageHeader.timestamp
  - SP_EVENT
```
public static final String SP_EVENT
```
    Search parameter constant for event
    Description:
    Type: token
    Path: MessageHeader.event
    
    See Also:
    
    Constant Field Values
  - EVENT
```
public static final TokenClientParam EVENT
```
    Fluent Client search parameter constant for event
    Description:
    Type: token
    Path: MessageHeader.event
  - SP_RESPONSE_ID
```
public static final String SP_RESPONSE_ID
```
    Search parameter constant for response-id
    Description:
    Type: token
    Path: MessageHeader.response.identifier
    
    See Also:
    
    Constant Field Values
  - RESPONSE_ID
```
public static final TokenClientParam RESPONSE_ID
```
    Fluent Client search parameter constant for response-id
    Description:
    Type: token
    Path: MessageHeader.response.identifier
  - SP_CODE
```
public static final String SP_CODE
```
    Search parameter constant for code
    Description:
    Type: token
    Path: MessageHeader.response.code
    
    See Also:
    
    Constant Field Values
  - CODE
```
public static final TokenClientParam CODE
```
    Fluent Client search parameter constant for code
    Description:
    Type: token
    Path: MessageHeader.response.code
  - SP_SOURCE
```
public static final String SP_SOURCE
```
    Search parameter constant for source
    Description:
    Type: string
    Path: MessageHeader.source.name
    
    See Also:
    
    Constant Field Values
  - SOURCE
```
public static final StringClientParam SOURCE
```
    Fluent Client search parameter constant for source
    Description:
    Type: string
    Path: MessageHeader.source.name
  - SP_SOURCE_URI
```
public static final String SP_SOURCE_URI
```
    Search parameter constant for source-uri
    Description:
    Type: uri
    Path: MessageHeader.source.endpoint
    
    See Also:
    
    Constant Field Values
  - SOURCE_URI
```
public static final UriClientParam SOURCE_URI
```
    Fluent Client search parameter constant for source-uri
    Description:
    Type: uri
    Path: MessageHeader.source.endpoint
  - SP_DESTINATION
```
public static final String SP_DESTINATION
```
    Search parameter constant for destination
    Description:
    Type: string
    Path: MessageHeader.destination.name
    
    See Also:
    
    Constant Field Values
  - DESTINATION
```
public static final StringClientParam DESTINATION
```
    Fluent Client search parameter constant for destination
    Description:
    Type: string
    Path: MessageHeader.destination.name
  - SP_DESTINATION_URI
```
public static final String SP_DESTINATION_URI
```
    Search parameter constant for destination-uri
    Description:
    Type: uri
    Path: MessageHeader.destination.endpoint
    
    See Also:
    
    Constant Field Values
  - DESTINATION_URI
```
public static final UriClientParam DESTINATION_URI
```
    Fluent Client search parameter constant for destination-uri
    Description:
    Type: uri
    Path: MessageHeader.destination.endpoint
  - SP_DATA
```
public static final String SP_DATA
```
    Search parameter constant for data
    Description:
    Type: reference
    Path: MessageHeader.data
    
    See Also:
    
    Constant Field Values
  - DATA
```
public static final ReferenceClientParam DATA
```
    Fluent Client search parameter constant for data
    Description:
    Type: reference
    Path: MessageHeader.data
  - SP_RECEIVER
```
public static final String SP_RECEIVER
```
    Search parameter constant for receiver
    Description:
    Type: reference
    Path: MessageHeader.receiver
    
    See Also:
    
    Constant Field Values
  - RECEIVER
```
public static final ReferenceClientParam RECEIVER
```
    Fluent Client search parameter constant for receiver
    Description:
    Type: reference
    Path: MessageHeader.receiver
  - SP_AUTHOR
```
public static final String SP_AUTHOR
```
    Search parameter constant for author
    Description:
    Type: reference
    Path: MessageHeader.author
    
    See Also:
    
    Constant Field Values
  - AUTHOR
```
public static final ReferenceClientParam AUTHOR
```
    Fluent Client search parameter constant for author
    Description:
    Type: reference
    Path: MessageHeader.author
  - SP_RESPONSIBLE
```
public static final String SP_RESPONSIBLE
```
    Search parameter constant for responsible
    Description:
    Type: reference
    Path: MessageHeader.responsible
    
    See Also:
    
    Constant Field Values
  - RESPONSIBLE
```
public static final ReferenceClientParam RESPONSIBLE
```
    Fluent Client search parameter constant for responsible
    Description:
    Type: reference
    Path: MessageHeader.responsible
  - SP_ENTERER
```
public static final String SP_ENTERER
```
    Search parameter constant for enterer
    Description:
    Type: reference
    Path: MessageHeader.enterer
    
    See Also:
    
    Constant Field Values
  - ENTERER
```
public static final ReferenceClientParam ENTERER
```
    Fluent Client search parameter constant for enterer
    Description:
    Type: reference
    Path: MessageHeader.enterer
  - SP_TARGET
```
public static final String SP_TARGET
```
    Search parameter constant for target
    Description:
    Type: reference
    Path: MessageHeader.destination.target
    
    See Also:
    
    Constant Field Values
  - TARGET
```
public static final ReferenceClientParam TARGET
```
    Fluent Client search parameter constant for target
    Description:
    Type: reference
    Path: MessageHeader.destination.target
  - INCLUDE_AUTHOR
```
public static final Include INCLUDE_AUTHOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:author".
  - INCLUDE_DATA
```
public static final Include INCLUDE_DATA
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:data".
  - INCLUDE_ENTERER
```
public static final Include INCLUDE_ENTERER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:enterer".
  - INCLUDE_RECEIVER
```
public static final Include INCLUDE_RECEIVER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:receiver".
  - INCLUDE_RESPONSIBLE
```
public static final Include INCLUDE_RESPONSIBLE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:responsible".
  - INCLUDE_TARGET
```
public static final Include INCLUDE_TARGET
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:target".
- Constructor Detail
  - MessageHeader
```
public MessageHeader()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getTimestampElement
```
public InstantDt getTimestampElement()
```
    Gets the value(s) for timestamp (when.init). creating it if it does not exist. Will not return null.
    Definition: The time that the message was sent
  - getTimestamp
```
public Date getTimestamp()
```
    Gets the value(s) for timestamp (when.init). creating it if it does not exist. Will not return null.
    Definition: The time that the message was sent
  - setTimestamp
```
public MessageHeader setTimestamp(InstantDt theValue)
```
    Sets the value(s) for timestamp (when.init)
    Definition: The time that the message was sent
  - setTimestampWithMillisPrecision
```
public MessageHeader setTimestampWithMillisPrecision(Date theDate)
```
    Sets the value for timestamp (when.init)
    Definition: The time that the message was sent
  - setTimestamp
```
public MessageHeader setTimestamp(Date theDate,
                                  TemporalPrecisionEnum thePrecision)
```
    Sets the value for timestamp (when.init)
    Definition: The time that the message was sent
  - getEvent
```
public CodingDt getEvent()
```
    Gets the value(s) for event (what). creating it if it does not exist. Will not return null.
    Definition: 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\"
  - setEvent
```
public MessageHeader setEvent(CodingDt theValue)
```
    Sets the value(s) for event (what)
    Definition: 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\"
  - getResponse
```
public MessageHeader.Response getResponse()
```
    Gets the value(s) for response (). creating it if it does not exist. Will not return null.
    Definition: Information about the message that this message is a response to. Only present if this message is a response.
  - setResponse
```
public MessageHeader setResponse(MessageHeader.Response theValue)
```
    Sets the value(s) for response ()
    Definition: Information about the message that this message is a response to. Only present if this message is a response.
  - getSource
```
public MessageHeader.Source getSource()
```
    Gets the value(s) for source (who.actor). creating it if it does not exist. Will not return null.
    Definition: The source application from which this message originated
  - setSource
```
public MessageHeader setSource(MessageHeader.Source theValue)
```
    Sets the value(s) for source (who.actor)
    Definition: The source application from which this message originated
  - getDestination
```
public List<MessageHeader.Destination> getDestination()
```
    Gets the value(s) for destination (who.focus). creating it if it does not exist. Will not return null.
    Definition: The destination application which the message is intended for
  - setDestination
```
public MessageHeader setDestination(List<MessageHeader.Destination> theValue)
```
    Sets the value(s) for destination (who.focus)
    Definition: The destination application which the message is intended for
  - addDestination
```
public MessageHeader.Destination addDestination()
```
    Adds and returns a new value for destination (who.focus)
    Definition: The destination application which the message is intended for
  - addDestination
```
public MessageHeader addDestination(MessageHeader.Destination theValue)
```
    Adds a given new value for destination (who.focus)
    Definition: The destination application which the message is intended for
    
    Parameters:
    
    theValue - The destination to add (must not be null)
  - getDestinationFirstRep
```
public MessageHeader.Destination getDestinationFirstRep()
```
    Gets the first repetition for destination (who.focus), creating it if it does not already exist.
    Definition: The destination application which the message is intended for
  - getEnterer
```
public ResourceReferenceDt getEnterer()
```
    Gets the value(s) for enterer (who.author). creating it if it does not exist. Will not return null.
    Definition: The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions
  - setEnterer
```
public MessageHeader setEnterer(ResourceReferenceDt theValue)
```
    Sets the value(s) for enterer (who.author)
    Definition: The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions
  - getAuthor
```
public ResourceReferenceDt getAuthor()
```
    Gets the value(s) for author (who.author). creating it if it does not exist. Will not return null.
    Definition: The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions
  - setAuthor
```
public MessageHeader setAuthor(ResourceReferenceDt theValue)
```
    Sets the value(s) for author (who.author)
    Definition: The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions
  - getReceiver
```
public ResourceReferenceDt getReceiver()
```
    Gets the value(s) for receiver (who.focus). creating it if it does not exist. Will not return null.
    Definition: Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
  - setReceiver
```
public MessageHeader setReceiver(ResourceReferenceDt theValue)
```
    Sets the value(s) for receiver (who.focus)
    Definition: Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
  - getResponsible
```
public ResourceReferenceDt getResponsible()
```
    Gets the value(s) for responsible (who.witness). creating it if it does not exist. Will not return null.
    Definition: 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
  - setResponsible
```
public MessageHeader setResponsible(ResourceReferenceDt theValue)
```
    Sets the value(s) for responsible (who.witness)
    Definition: 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
  - getReason
```
public CodeableConceptDt getReason()
```
    Gets the value(s) for reason (why). creating it if it does not exist. Will not return null.
    Definition: Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message
  - setReason
```
public MessageHeader setReason(CodeableConceptDt theValue)
```
    Sets the value(s) for reason (why)
    Definition: Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message
  - getData
```
public List<ResourceReferenceDt> getData()
```
    Gets the value(s) for data (). creating it if it does not exist. Will not return null.
    Definition: The actual data of the message - a reference to the root/focus class of the event.
  - setData
```
public MessageHeader setData(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for data ()
    Definition: The actual data of the message - a reference to the root/focus class of the event.
  - addData
```
public ResourceReferenceDt addData()
```
    Adds and returns a new value for data ()
    Definition: The actual data of the message - a reference to the root/focus class of the event.
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class MessageHeader

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

SP_TIMESTAMP

TIMESTAMP

SP_EVENT

EVENT

SP_RESPONSE_ID

RESPONSE_ID

SP_CODE

CODE

SP_SOURCE

SOURCE

SP_SOURCE_URI

SOURCE_URI

SP_DESTINATION

DESTINATION

SP_DESTINATION_URI

DESTINATION_URI

SP_DATA

DATA

SP_RECEIVER

RECEIVER

SP_AUTHOR

AUTHOR

SP_RESPONSIBLE

RESPONSIBLE

SP_ENTERER

ENTERER

SP_TARGET

TARGET

INCLUDE_AUTHOR

INCLUDE_DATA

INCLUDE_ENTERER

INCLUDE_RECEIVER

INCLUDE_RESPONSIBLE

INCLUDE_TARGET

Constructor Detail

MessageHeader

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getTimestampElement

getTimestamp

setTimestamp

setTimestampWithMillisPrecision

setTimestamp

getEvent

setEvent

getResponse

setResponse

getSource

setSource

getDestination

setDestination

addDestination

addDestination

getDestinationFirstRep

getEnterer

setEnterer

getAuthor

setAuthor

getReceiver

setReceiver

getResponsible

setResponsible

getReason

setReason

getData

setData