public class MessageHeader extends BaseResource implements ca.uhn.fhir.model.api.IResource
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
| 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)
|
| Modifier and Type | Field and Description |
|---|---|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
AUTHOR
Fluent Client search parameter constant for author
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
CODE
Fluent Client search parameter constant for code
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
DATA
Fluent Client search parameter constant for data
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
DESTINATION
Fluent Client search parameter constant for destination
|
static ca.uhn.fhir.rest.gclient.UriClientParam |
DESTINATION_URI
Fluent Client search parameter constant for destination-uri
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
ENTERER
Fluent Client search parameter constant for enterer
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
EVENT
Fluent Client search parameter constant for event
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_AUTHOR
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_DATA
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_ENTERER
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_RECEIVER
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_RESPONSIBLE
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_TARGET
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
RECEIVER
Fluent Client search parameter constant for receiver
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
RESPONSE_ID
Fluent Client search parameter constant for response-id
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
RESPONSIBLE
Fluent Client search parameter constant for responsible
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
SOURCE
Fluent Client search parameter constant for source
|
static ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.ReferenceClientParam |
TARGET
Fluent Client search parameter constant for target
|
static ca.uhn.fhir.rest.gclient.DateClientParam |
TIMESTAMP
Fluent Client search parameter constant for timestamp
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGE| Constructor and Description |
|---|
MessageHeader() |
| 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 ca.uhn.fhir.model.api.IElement> |
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).
|
ca.uhn.fhir.context.FhirVersionEnum |
getStructureFhirVersionEnum() |
Date |
getTimestamp()
Gets the value(s) for timestamp (when.init).
|
ca.uhn.fhir.model.primitive.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,
ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
Sets the value for timestamp (when.init)
|
MessageHeader |
setTimestamp(ca.uhn.fhir.model.primitive.InstantDt theValue)
Sets the value(s) for timestamp (when.init)
|
MessageHeader |
setTimestampWithMillisPrecision(Date theDate)
Sets the value for timestamp (when.init)
|
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatCommentclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final String SP_TIMESTAMP
Description:
Type: date
Path: MessageHeader.timestamp
public static final ca.uhn.fhir.rest.gclient.DateClientParam TIMESTAMP
Description:
Type: date
Path: MessageHeader.timestamp
public static final String SP_EVENT
Description:
Type: token
Path: MessageHeader.event
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EVENT
Description:
Type: token
Path: MessageHeader.event
public static final String SP_RESPONSE_ID
Description:
Type: token
Path: MessageHeader.response.identifier
public static final ca.uhn.fhir.rest.gclient.TokenClientParam RESPONSE_ID
Description:
Type: token
Path: MessageHeader.response.identifier
public static final String SP_CODE
Description:
Type: token
Path: MessageHeader.response.code
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
Description:
Type: token
Path: MessageHeader.response.code
public static final String SP_SOURCE
Description:
Type: string
Path: MessageHeader.source.name
public static final ca.uhn.fhir.rest.gclient.StringClientParam SOURCE
Description:
Type: string
Path: MessageHeader.source.name
public static final String SP_SOURCE_URI
Description:
Type: uri
Path: MessageHeader.source.endpoint
public static final ca.uhn.fhir.rest.gclient.UriClientParam SOURCE_URI
Description:
Type: uri
Path: MessageHeader.source.endpoint
public static final String SP_DESTINATION
Description:
Type: string
Path: MessageHeader.destination.name
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESTINATION
Description:
Type: string
Path: MessageHeader.destination.name
public static final String SP_DESTINATION_URI
Description:
Type: uri
Path: MessageHeader.destination.endpoint
public static final ca.uhn.fhir.rest.gclient.UriClientParam DESTINATION_URI
Description:
Type: uri
Path: MessageHeader.destination.endpoint
public static final String SP_DATA
Description:
Type: reference
Path: MessageHeader.data
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DATA
Description:
Type: reference
Path: MessageHeader.data
public static final String SP_RECEIVER
Description:
Type: reference
Path: MessageHeader.receiver
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECEIVER
Description:
Type: reference
Path: MessageHeader.receiver
public static final String SP_AUTHOR
Description:
Type: reference
Path: MessageHeader.author
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR
Description:
Type: reference
Path: MessageHeader.author
public static final String SP_RESPONSIBLE
Description:
Type: reference
Path: MessageHeader.responsible
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RESPONSIBLE
Description:
Type: reference
Path: MessageHeader.responsible
public static final String SP_ENTERER
Description:
Type: reference
Path: MessageHeader.enterer
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENTERER
Description:
Type: reference
Path: MessageHeader.enterer
public static final String SP_TARGET
Description:
Type: reference
Path: MessageHeader.destination.target
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam TARGET
Description:
Type: reference
Path: MessageHeader.destination.target
public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR
public static final ca.uhn.fhir.model.api.Include INCLUDE_DATA
public static final ca.uhn.fhir.model.api.Include INCLUDE_ENTERER
public static final ca.uhn.fhir.model.api.Include INCLUDE_RECEIVER
public static final ca.uhn.fhir.model.api.Include INCLUDE_RESPONSIBLE
public static final ca.uhn.fhir.model.api.Include INCLUDE_TARGET
public MessageHeader()
public boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBasepublic <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElementpublic ca.uhn.fhir.model.primitive.InstantDt getTimestampElement()
null.
Definition: The time that the message was sent
public Date getTimestamp()
null.
Definition: The time that the message was sent
public MessageHeader setTimestamp(ca.uhn.fhir.model.primitive.InstantDt theValue)
Definition: The time that the message was sent
public MessageHeader setTimestampWithMillisPrecision(Date theDate)
Definition: The time that the message was sent
public MessageHeader setTimestamp(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
Definition: The time that the message was sent
public CodingDt getEvent()
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\"
public MessageHeader setEvent(CodingDt theValue)
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\"
public MessageHeader.Response getResponse()
null.
Definition: Information about the message that this message is a response to. Only present if this message is a response.
public MessageHeader setResponse(MessageHeader.Response theValue)
Definition: Information about the message that this message is a response to. Only present if this message is a response.
public MessageHeader.Source getSource()
null.
Definition: The source application from which this message originated
public MessageHeader setSource(MessageHeader.Source theValue)
Definition: The source application from which this message originated
public List<MessageHeader.Destination> getDestination()
null.
Definition: The destination application which the message is intended for
public MessageHeader setDestination(List<MessageHeader.Destination> theValue)
Definition: The destination application which the message is intended for
public MessageHeader.Destination addDestination()
Definition: The destination application which the message is intended for
public MessageHeader addDestination(MessageHeader.Destination theValue)
Definition: The destination application which the message is intended for
theValue - The destination to add (must not be null)public MessageHeader.Destination getDestinationFirstRep()
Definition: The destination application which the message is intended for
public ResourceReferenceDt getEnterer()
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
public MessageHeader setEnterer(ResourceReferenceDt theValue)
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
public ResourceReferenceDt getAuthor()
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
public MessageHeader setAuthor(ResourceReferenceDt theValue)
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
public ResourceReferenceDt getReceiver()
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.
public MessageHeader setReceiver(ResourceReferenceDt theValue)
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.
public ResourceReferenceDt getResponsible()
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
public MessageHeader setResponsible(ResourceReferenceDt theValue)
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
public CodeableConceptDt getReason()
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
public MessageHeader setReason(CodeableConceptDt theValue)
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
public List<ResourceReferenceDt> getData()
null.
Definition: The actual data of the message - a reference to the root/focus class of the event.
public MessageHeader setData(List<ResourceReferenceDt> theValue)
Definition: The actual data of the message - a reference to the root/focus class of the event.
public ResourceReferenceDt addData()
Definition: The actual data of the message - a reference to the root/focus class of the event.
public String getResourceName()
getResourceName in interface ca.uhn.fhir.model.api.IResourcepublic ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResourcegetStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResourceCopyright © 2014–2018 University Health Network. All rights reserved.