ca.uhn.fhir.model.dstu.resource

Class MessageHeader

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

ca.uhn.fhir.model.dstu.resource.MessageHeader

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

public class MessageHeader
extends BaseResource
implements IResource

HAPI/FHIR MessageHeader Resource (A resource that describes a message that is exchanged between systems)

Definition: The header for a message exchange that is either requesting or responding to an action. The resource(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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageHeader.Destination Block class for child element: MessageHeader.destination (Message Destination Application(s))
static class	MessageHeader.Response Block class for child element: MessageHeader.response (If this is a reply to prior message)
static class	MessageHeader.Source Block class for child element: MessageHeader.source (Message Source Application)

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
MessageHeader()

Method Summary

Methods

Modifier and Type	Method and Description
ResourceReferenceDt	addData() Adds and returns a new value for data (The actual content of the message)
MessageHeader.Destination	addDestination() Adds and returns a new value for destination (Message Destination Application(s))
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
ResourceReferenceDt	getAuthor() Gets the value(s) for author (The source of the decision).
List<ResourceReferenceDt>	getData() Gets the value(s) for data (The actual content of the message).
List<MessageHeader.Destination>	getDestination() Gets the value(s) for destination (Message Destination Application(s)).
MessageHeader.Destination	getDestinationFirstRep() Gets the first repetition for destination (Message Destination Application(s)), creating it if it does not already exist.
ResourceReferenceDt	getEnterer() Gets the value(s) for enterer (The source of the data entry).
CodingDt	getEvent() Gets the value(s) for event (Code for the event this message represents).
IdDt	getIdentifier() Gets the value(s) for identifier (Id of this message).
CodeableConceptDt	getReason() Gets the value(s) for reason (Cause of event).
ResourceReferenceDt	getReceiver() Gets the value(s) for receiver (Intended \"real-world\" recipient for the data).
MessageHeader.Response	getResponse() Gets the value(s) for response (If this is a reply to prior message).
ResourceReferenceDt	getResponsible() Gets the value(s) for responsible (Final responsibility for event).
MessageHeader.Source	getSource() Gets the value(s) for source (Message Source Application).
InstantDt	getTimestamp() Gets the value(s) for timestamp (Time that the message was sent).
boolean	isEmpty()
MessageHeader	setAuthor(ResourceReferenceDt theValue) Sets the value(s) for author (The source of the decision)
MessageHeader	setData(List<ResourceReferenceDt> theValue) Sets the value(s) for data (The actual content of the message)
MessageHeader	setDestination(List<MessageHeader.Destination> theValue) Sets the value(s) for destination (Message Destination Application(s))
MessageHeader	setEnterer(ResourceReferenceDt theValue) Sets the value(s) for enterer (The source of the data entry)
MessageHeader	setEvent(CodingDt theValue) Sets the value(s) for event (Code for the event this message represents)
MessageHeader	setIdentifier(IdDt theValue) Sets the value(s) for identifier (Id of this message)
MessageHeader	setIdentifier(String theId) Sets the value for identifier (Id of this message)
MessageHeader	setReason(CodeableConceptDt theValue) Sets the value(s) for reason (Cause of event)
MessageHeader	setReceiver(ResourceReferenceDt theValue) Sets the value(s) for receiver (Intended \"real-world\" recipient for the data)
MessageHeader	setResponse(MessageHeader.Response theValue) Sets the value(s) for response (If this is a reply to prior message)
MessageHeader	setResponsible(ResourceReferenceDt theValue) Sets the value(s) for responsible (Final responsibility for event)
MessageHeader	setSource(MessageHeader.Source theValue) Sets the value(s) for source (Message Source Application)
MessageHeader	setTimestamp(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for timestamp (Time that the message was sent)
MessageHeader	setTimestamp(InstantDt theValue) Sets the value(s) for timestamp (Time that the message was sent)
MessageHeader	setTimestampWithMillisPrecision(Date theDate) Sets the value for timestamp (Time that the message was sent)

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

getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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

Constructor Detail

MessageHeader

public MessageHeader()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getIdentifier

public IdDt getIdentifier()

Gets the value(s) for identifier (Id of this message). creating it if it does not exist. Will not return null.

Definition: The identifier of this message

setIdentifier

public MessageHeader setIdentifier(IdDt theValue)

Sets the value(s) for identifier (Id of this message)

Definition: The identifier of this message

setIdentifier

public MessageHeader setIdentifier(String theId)

Sets the value for identifier (Id of this message)

Definition: The identifier of this message

getTimestamp

public InstantDt getTimestamp()

Gets the value(s) for timestamp (Time that the message was sent). 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 (Time that the message was sent)

Definition: The time that the message was sent

setTimestamp

public MessageHeader setTimestamp(Date theDate,
                         TemporalPrecisionEnum thePrecision)

Sets the value for timestamp (Time that the message was sent)

Definition: The time that the message was sent

setTimestampWithMillisPrecision

public MessageHeader setTimestampWithMillisPrecision(Date theDate)

Sets the value for timestamp (Time that the message was sent)

Definition: The time that the message was sent

getEvent

public CodingDt getEvent()

Gets the value(s) for event (Code for the event this message represents). creating it if it does not exist. Will not return null.

Definition: Code that identifies the event this message represents and connects it with it's definition. Events defined as part of the FHIR specification have the system value \"http://hl7.org/fhir/message-type\"

setEvent

public MessageHeader setEvent(CodingDt theValue)

Sets the value(s) for event (Code for the event this message represents)

Definition: Code that identifies the event this message represents and connects it with it's definition. Events defined as part of the FHIR specification have the system value \"http://hl7.org/fhir/message-type\"

getResponse

public MessageHeader.Response getResponse()

Gets the value(s) for response (If this is a reply to prior message). 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 (If this is a reply to prior message)

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 (Message Source Application). 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 (Message Source Application)

Definition: The source application from which this message originated

getDestination

public List<MessageHeader.Destination> getDestination()

Gets the value(s) for destination (Message Destination Application(s)). 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 (Message Destination Application(s))

Definition: The destination application which the message is intended for

addDestination

public MessageHeader.Destination addDestination()

Adds and returns a new value for destination (Message Destination Application(s))

Definition: The destination application which the message is intended for

getDestinationFirstRep

public MessageHeader.Destination getDestinationFirstRep()

Gets the first repetition for destination (Message Destination Application(s)), 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 (The source of the data entry). 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 (The source of the data entry)

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 (The source of the decision). 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 (The source of the decision)

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 (Intended \"real-world\" recipient for the data). 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 (Intended \"real-world\" recipient for the data)

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 (Final responsibility for event). 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 (Final responsibility for event)

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 (Cause of event). 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 occurance of the event that is a focus of this message

setReason

public MessageHeader setReason(CodeableConceptDt theValue)

Sets the value(s) for reason (Cause of event)

Definition: Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message

getData

public List<ResourceReferenceDt> getData()

Gets the value(s) for data (The actual content of the message). 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 (The actual content of the message)

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 (The actual content of the message)

Definition: The actual data of the message - a reference to the root/focus class of the event.