Package org.hl7.fhir.r5.model

Class MessageHeader

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.MessageHeader

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

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.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageHeader.MessageDestinationComponent
static class	MessageHeader.MessageHeaderResponseComponent
static class	MessageHeader.MessageSourceComponent
static enum	MessageHeader.ResponseType
static class	MessageHeader.ResponseTypeEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected Reference	author	The logical author of the message - the person or device that decided the described event should happen.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	AUTHOR	Fluent Client search parameter constant for author
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
protected CanonicalType	definition	Permanent link to the MessageDefinition for this message.
protected List<MessageHeader.MessageDestinationComponent>	destination	The destination application which the message is intended for.
static final ca.uhn.fhir.rest.gclient.StringClientParam	DESTINATION	Fluent Client search parameter constant for destination
static final ca.uhn.fhir.rest.gclient.UriClientParam	DESTINATION_URI	Fluent Client search parameter constant for destination-uri
protected Reference	enterer	The person or device that performed the data entry leading to this message.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENTERER	Fluent Client search parameter constant for enterer
protected DataType	event	Code that identifies the event this message represents and connects it with its definition.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	EVENT	Fluent Client search parameter constant for event
protected List<Reference>	focus	The actual data of the message - a reference to the root/focus class of the event.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	FOCUS	Fluent Client search parameter constant for focus
static final ca.uhn.fhir.model.api.Include	INCLUDE_AUTHOR	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENTERER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_FOCUS	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_RECEIVER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_RESPONSIBLE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SENDER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_TARGET	Constant for fluent queries to be used to add include statements.
protected CodeableConcept	reason	Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	RECEIVER	Fluent Client search parameter constant for receiver
protected MessageHeader.MessageHeaderResponseComponent	response	Information about the message that this message is a response to.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	RESPONSE_ID	Fluent Client search parameter constant for response-id
protected Reference	responsible	The person or organization that accepts overall responsibility for the contents of the message.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	RESPONSIBLE	Fluent Client search parameter constant for responsible
protected Reference	sender	Identifies the sending system to allow the use of a trust relationship.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SENDER	Fluent Client search parameter constant for sender
protected MessageHeader.MessageSourceComponent	source	The source application from which this message originated.
static final ca.uhn.fhir.rest.gclient.StringClientParam	SOURCE	Fluent Client search parameter constant for source
static final ca.uhn.fhir.rest.gclient.UriClientParam	SOURCE_URI	Fluent Client search parameter constant for source-uri
static final String	SP_AUTHOR	Search parameter: author
static final String	SP_CODE	Search parameter: code
static final String	SP_DESTINATION	Search parameter: destination
static final String	SP_DESTINATION_URI	Search parameter: destination-uri
static final String	SP_ENTERER	Search parameter: enterer
static final String	SP_EVENT	Search parameter: event
static final String	SP_FOCUS	Search parameter: focus
static final String	SP_RECEIVER	Search parameter: receiver
static final String	SP_RESPONSE_ID	Search parameter: response-id
static final String	SP_RESPONSIBLE	Search parameter: responsible
static final String	SP_SENDER	Search parameter: sender
static final String	SP_SOURCE	Search parameter: source
static final String	SP_SOURCE_URI	Search parameter: source-uri
static final String	SP_TARGET	Search parameter: target
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	TARGET	Fluent Client search parameter constant for target

Fields inherited from class org.hl7.fhir.r5.model.DomainResource

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.model.Resource

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
MessageHeader()	Constructor
MessageHeader(DataType event, MessageHeader.MessageSourceComponent source)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
MessageHeader.MessageDestinationComponent	addDestination()
MessageHeader	addDestination(MessageHeader.MessageDestinationComponent t)
Reference	addFocus()
MessageHeader	addFocus(Reference t)
MessageHeader	copy()
void	copyValues(MessageHeader dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Reference	getAuthor()
String	getDefinition()
CanonicalType	getDefinitionElement()
List<MessageHeader.MessageDestinationComponent>	getDestination()
MessageHeader.MessageDestinationComponent	getDestinationFirstRep()
Reference	getEnterer()
DataType	getEvent()
Coding	getEventCoding()
UriType	getEventUriType()
List<Reference>	getFocus()
Reference	getFocusFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
CodeableConcept	getReason()
ResourceType	getResourceType()
MessageHeader.MessageHeaderResponseComponent	getResponse()
Reference	getResponsible()
Reference	getSender()
MessageHeader.MessageSourceComponent	getSource()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAuthor()
boolean	hasDefinition()
boolean	hasDefinitionElement()
boolean	hasDestination()
boolean	hasEnterer()
boolean	hasEvent()
boolean	hasEventCoding()
boolean	hasEventUriType()
boolean	hasFocus()
boolean	hasReason()
boolean	hasResponse()
boolean	hasResponsible()
boolean	hasSender()
boolean	hasSource()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
MessageHeader	setAuthor(Reference value)
MessageHeader	setDefinition(String value)
MessageHeader	setDefinitionElement(CanonicalType value)
MessageHeader	setDestination(List<MessageHeader.MessageDestinationComponent> theDestination)
MessageHeader	setEnterer(Reference value)
MessageHeader	setEvent(DataType value)
MessageHeader	setFocus(List<Reference> theFocus)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
MessageHeader	setReason(CodeableConcept value)
MessageHeader	setResponse(MessageHeader.MessageHeaderResponseComponent value)
MessageHeader	setResponsible(Reference value)
MessageHeader	setSender(Reference value)
MessageHeader	setSource(MessageHeader.MessageSourceComponent value)
protected MessageHeader	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r5.model.Base

children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, setId

Field Details

event

protected DataType event

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.

destination

protected List<MessageHeader.MessageDestinationComponent> destination

The destination application which the message is intended for.

sender

protected Reference sender

Identifies the sending system to allow the use of a trust relationship.

enterer

protected Reference enterer

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.

author

protected Reference author

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.

source

protected MessageHeader.MessageSourceComponent source

The source application from which this message originated.

responsible

protected Reference responsible

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.

reason

protected CodeableConcept reason

Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.

response

protected MessageHeader.MessageHeaderResponseComponent response

Information about the message that this message is a response to. Only present if this message is a response.

focus

protected List<Reference> focus

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

definition

protected CanonicalType definition

Permanent link to the MessageDefinition for this message.

SP_AUTHOR

public static final String SP_AUTHOR

Search parameter: author

Description: The source of the decision
Type: reference
Path: MessageHeader.author

See Also:

• Constant Field Values

AUTHOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR

Fluent Client search parameter constant for author

Description: The source of the decision
Type: reference
Path: MessageHeader.author

INCLUDE_AUTHOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:author".

SP_CODE

public static final String SP_CODE

Search parameter: code

Description: ok | transient-error | fatal-error
Type: token
Path: MessageHeader.response.code

See Also:

• Constant Field Values

CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE

Fluent Client search parameter constant for code

Description: ok | transient-error | fatal-error
Type: token
Path: MessageHeader.response.code

SP_DESTINATION_URI

public static final String SP_DESTINATION_URI

Search parameter: destination-uri

Description: Actual destination address or id
Type: uri
Path: MessageHeader.destination.endpoint

See Also:

• Constant Field Values

DESTINATION_URI

public static final ca.uhn.fhir.rest.gclient.UriClientParam DESTINATION_URI

Fluent Client search parameter constant for destination-uri

Description: Actual destination address or id
Type: uri
Path: MessageHeader.destination.endpoint

SP_DESTINATION

public static final String SP_DESTINATION

Search parameter: destination

Description: Name of system
Type: string
Path: MessageHeader.destination.name

See Also:

• Constant Field Values

DESTINATION

public static final ca.uhn.fhir.rest.gclient.StringClientParam DESTINATION

Fluent Client search parameter constant for destination

Description: Name of system
Type: string
Path: MessageHeader.destination.name

SP_ENTERER

public static final String SP_ENTERER

Search parameter: enterer

Description: The source of the data entry
Type: reference
Path: MessageHeader.enterer

See Also:

• Constant Field Values

ENTERER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENTERER

Fluent Client search parameter constant for enterer

Description: The source of the data entry
Type: reference
Path: MessageHeader.enterer

INCLUDE_ENTERER

public static final ca.uhn.fhir.model.api.Include INCLUDE_ENTERER

Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:enterer".

SP_EVENT

public static final String SP_EVENT

Search parameter: event

Description: Code for the event this message represents or link to event definition
Type: token
Path: MessageHeader.event

See Also:

• Constant Field Values

EVENT

public static final ca.uhn.fhir.rest.gclient.TokenClientParam EVENT

Fluent Client search parameter constant for event

Description: Code for the event this message represents or link to event definition
Type: token
Path: MessageHeader.event

SP_FOCUS

public static final String SP_FOCUS

Search parameter: focus

Description: The actual content of the message
Type: reference
Path: MessageHeader.focus

See Also:

• Constant Field Values

FOCUS

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam FOCUS

Fluent Client search parameter constant for focus

Description: The actual content of the message
Type: reference
Path: MessageHeader.focus

INCLUDE_FOCUS

public static final ca.uhn.fhir.model.api.Include INCLUDE_FOCUS

Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:focus".

SP_RECEIVER

public static final String SP_RECEIVER

Search parameter: receiver

Description: Intended "real-world" recipient for the data
Type: reference
Path: MessageHeader.destination.receiver

See Also:

• Constant Field Values

RECEIVER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECEIVER

Fluent Client search parameter constant for receiver

Description: Intended "real-world" recipient for the data
Type: reference
Path: MessageHeader.destination.receiver

INCLUDE_RECEIVER

public static final ca.uhn.fhir.model.api.Include INCLUDE_RECEIVER

Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:receiver".

SP_RESPONSE_ID

public static final String SP_RESPONSE_ID

Search parameter: response-id

Description: Id of original message
Type: token
Path: MessageHeader.response.identifier

See Also:

• Constant Field Values

RESPONSE_ID

public static final ca.uhn.fhir.rest.gclient.TokenClientParam RESPONSE_ID

Fluent Client search parameter constant for response-id

Description: Id of original message
Type: token
Path: MessageHeader.response.identifier

SP_RESPONSIBLE

public static final String SP_RESPONSIBLE

Search parameter: responsible

Description: Final responsibility for event
Type: reference
Path: MessageHeader.responsible

See Also:

• Constant Field Values

RESPONSIBLE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RESPONSIBLE

Fluent Client search parameter constant for responsible

Description: Final responsibility for event
Type: reference
Path: MessageHeader.responsible

INCLUDE_RESPONSIBLE

public static final ca.uhn.fhir.model.api.Include INCLUDE_RESPONSIBLE

Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:responsible".

SP_SENDER

public static final String SP_SENDER

Search parameter: sender

Description: Real world sender of the message
Type: reference
Path: MessageHeader.sender

See Also:

• Constant Field Values

SENDER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SENDER

Fluent Client search parameter constant for sender

Description: Real world sender of the message
Type: reference
Path: MessageHeader.sender

INCLUDE_SENDER

public static final ca.uhn.fhir.model.api.Include INCLUDE_SENDER

Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:sender".

SP_SOURCE_URI

public static final String SP_SOURCE_URI

Search parameter: source-uri

Description: Actual message source address or id
Type: uri
Path: MessageHeader.source.endpoint

See Also:

• Constant Field Values

SOURCE_URI

public static final ca.uhn.fhir.rest.gclient.UriClientParam SOURCE_URI

Fluent Client search parameter constant for source-uri

Description: Actual message source address or id
Type: uri
Path: MessageHeader.source.endpoint

SP_SOURCE

public static final String SP_SOURCE

Search parameter: source

Description: Name of system
Type: string
Path: MessageHeader.source.name

See Also:

• Constant Field Values

SOURCE

public static final ca.uhn.fhir.rest.gclient.StringClientParam SOURCE

Fluent Client search parameter constant for source

Description: Name of system
Type: string
Path: MessageHeader.source.name

SP_TARGET

public static final String SP_TARGET

Search parameter: target

Description: Particular delivery destination within the destination
Type: reference
Path: MessageHeader.destination.target

See Also:

• Constant Field Values

TARGET

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam TARGET

Fluent Client search parameter constant for target

Description: Particular delivery destination within the destination
Type: reference
Path: MessageHeader.destination.target

INCLUDE_TARGET

public static final ca.uhn.fhir.model.api.Include INCLUDE_TARGET

Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:target".

Constructor Details

MessageHeader

public MessageHeader()

Constructor

MessageHeader

public MessageHeader(DataType event,
 MessageHeader.MessageSourceComponent source)

Constructor

Method Details

getEvent

public DataType getEvent()

Returns:

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

getEventCoding

public Coding getEventCoding()
                      throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasEventCoding

public boolean hasEventCoding()

getEventUriType

public UriType getEventUriType()
                        throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasEventUriType

public boolean hasEventUriType()

hasEvent

public boolean hasEvent()

setEvent

public MessageHeader setEvent(DataType value)

Parameters:

value - event (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 List<MessageHeader.MessageDestinationComponent> getDestination()

Returns:

destination (The destination application which the message is intended for.)

setDestination

public MessageHeader setDestination(List<MessageHeader.MessageDestinationComponent> theDestination)

Returns:

Returns a reference to this for easy method chaining

hasDestination

public boolean hasDestination()

addDestination

public MessageHeader.MessageDestinationComponent addDestination()

addDestination

public MessageHeader addDestination(MessageHeader.MessageDestinationComponent t)

getDestinationFirstRep

public MessageHeader.MessageDestinationComponent getDestinationFirstRep()

Returns:

The first repetition of repeating field destination, creating it if it does not already exist {3}

getSender

public Reference getSender()

Returns:

sender (Identifies the sending system to allow the use of a trust relationship.)

hasSender

public boolean hasSender()

setSender

public MessageHeader setSender(Reference value)

Parameters:

value - sender (Identifies the sending system to allow the use of a trust relationship.)

getEnterer

public Reference getEnterer()

Returns:

enterer (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.)

hasEnterer

public boolean hasEnterer()

setEnterer

public MessageHeader setEnterer(Reference value)

Parameters:

value - enterer (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.)

getAuthor

public Reference getAuthor()

Returns:

author (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.)

hasAuthor

public boolean hasAuthor()

setAuthor

public MessageHeader setAuthor(Reference value)

Parameters:

value - author (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.)

getSource

public MessageHeader.MessageSourceComponent getSource()

Returns:

source (The source application from which this message originated.)

hasSource

public boolean hasSource()

setSource

public MessageHeader setSource(MessageHeader.MessageSourceComponent value)

Parameters:

value - source (The source application from which this message originated.)

getResponsible

public Reference getResponsible()

Returns:

responsible (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.)

hasResponsible

public boolean hasResponsible()

setResponsible

public MessageHeader setResponsible(Reference value)

Parameters:

value - responsible (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 CodeableConcept getReason()

Returns:

reason (Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.)

hasReason

public boolean hasReason()

setReason

public MessageHeader setReason(CodeableConcept value)

Parameters:

value - reason (Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.)

getResponse

public MessageHeader.MessageHeaderResponseComponent getResponse()

Returns:

response (Information about the message that this message is a response to. Only present if this message is a response.)

hasResponse

public boolean hasResponse()

setResponse

public MessageHeader setResponse(MessageHeader.MessageHeaderResponseComponent value)

Parameters:

value - response (Information about the message that this message is a response to. Only present if this message is a response.)

getFocus

public List<Reference> getFocus()

Returns:

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

setFocus

public MessageHeader setFocus(List<Reference> theFocus)

Returns:

Returns a reference to this for easy method chaining

hasFocus

public boolean hasFocus()

addFocus

public Reference addFocus()

addFocus

public MessageHeader addFocus(Reference t)

getFocusFirstRep

public Reference getFocusFirstRep()

Returns:

The first repetition of repeating field focus, creating it if it does not already exist {3}

getDefinitionElement

public CanonicalType getDefinitionElement()

Returns:

definition (Permanent link to the MessageDefinition for this message.). This is the underlying object with id, value and extensions. The accessor "getDefinition" gives direct access to the value

hasDefinitionElement

public boolean hasDefinitionElement()

hasDefinition

public boolean hasDefinition()

setDefinitionElement

public MessageHeader setDefinitionElement(CanonicalType value)

Parameters:

value - definition (Permanent link to the MessageDefinition for this message.). This is the underlying object with id, value and extensions. The accessor "getDefinition" gives direct access to the value

getDefinition

public String getDefinition()

Returns:

Permanent link to the MessageDefinition for this message.

setDefinition

public MessageHeader setDefinition(String value)

Parameters:

value - Permanent link to the MessageDefinition for this message.

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public MessageHeader copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(MessageHeader dst)

typedCopy

protected MessageHeader typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource