
Class MessageHeader
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.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 class
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 ca.uhn.fhir.rest.gclient.ReferenceClientParam
AUTHOR
Fluent Client search parameter constant for authorprotected Practitioner
authorTarget
The actual object that is the target of the reference (The logical author of the message - the person or device that decided the described event should happen.static ca.uhn.fhir.rest.gclient.TokenClientParam
CODE
Fluent Client search parameter constant for codeprotected List<MessageHeader.MessageDestinationComponent>
destination
The destination application which the message is intended for.static ca.uhn.fhir.rest.gclient.StringClientParam
DESTINATION
Fluent Client search parameter constant for destinationstatic ca.uhn.fhir.rest.gclient.UriClientParam
DESTINATION_URI
Fluent Client search parameter constant for destination-uriprotected Reference
enterer
The person or device that performed the data entry leading to this message.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
ENTERER
Fluent Client search parameter constant for entererprotected Practitioner
entererTarget
The actual object that is the target of the reference (The person or device that performed the data entry leading to this message.protected Coding
event
Code that identifies the event this message represents and connects it with its definition.static ca.uhn.fhir.rest.gclient.TokenClientParam
EVENT
Fluent Client search parameter constant for eventprotected List<Reference>
focus
The actual data of the message - a reference to the root/focus class of the event.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
FOCUS
Fluent Client search parameter constant for focusprotected List<Resource>
focusTarget
The actual objects that are the target of the reference (The actual data of the message - a reference to the root/focus class of the 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_ENTERER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_FOCUS
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_SENDER
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.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.protected Reference
receiver
Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
RECEIVER
Fluent Client search parameter constant for receiverprotected Resource
receiverTarget
The actual object that is the target of the reference (Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.)protected MessageHeader.MessageHeaderResponseComponent
response
Information about the message that this message is a response to.static ca.uhn.fhir.rest.gclient.TokenClientParam
RESPONSE_ID
Fluent Client search parameter constant for response-idprotected Reference
responsible
The person or organization that accepts overall responsibility for the contents of the message.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
RESPONSIBLE
Fluent Client search parameter constant for responsibleprotected Resource
responsibleTarget
The actual object that is the target of the reference (The person or organization that accepts overall responsibility for the contents of the message.protected Reference
sender
Identifies the sending system to allow the use of a trust relationship.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
SENDER
Fluent Client search parameter constant for senderprotected Resource
senderTarget
The actual object that is the target of the reference (Identifies the sending system to allow the use of a trust relationship.)protected MessageHeader.MessageSourceComponent
source
The source application from which this message originated.static ca.uhn.fhir.rest.gclient.StringClientParam
SOURCE
Fluent Client search parameter constant for sourcestatic ca.uhn.fhir.rest.gclient.UriClientParam
SOURCE_URI
Fluent Client search parameter constant for source-uristatic String
SP_AUTHOR
Search parameter: authorstatic String
SP_CODE
Search parameter: codestatic String
SP_DESTINATION
Search parameter: destinationstatic String
SP_DESTINATION_URI
Search parameter: destination-uristatic String
SP_ENTERER
Search parameter: entererstatic String
SP_EVENT
Search parameter: eventstatic String
SP_FOCUS
Search parameter: focusstatic String
SP_RECEIVER
Search parameter: receiverstatic String
SP_RESPONSE_ID
Search parameter: response-idstatic String
SP_RESPONSIBLE
Search parameter: responsiblestatic String
SP_SENDER
Search parameter: senderstatic String
SP_SOURCE
Search parameter: sourcestatic String
SP_SOURCE_URI
Search parameter: source-uristatic String
SP_TARGET
Search parameter: targetstatic String
SP_TIMESTAMP
Search parameter: timestampstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
TARGET
Fluent Client search parameter constant for targetprotected InstantType
timestamp
The time that the message was sent.static ca.uhn.fhir.rest.gclient.DateClientParam
TIMESTAMP
Fluent Client search parameter constant for timestamp-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description MessageHeader()
ConstructorMessageHeader(Coding event, InstantType timestamp, MessageHeader.MessageSourceComponent source)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
-
-
-
-
Field Detail
-
event
protected Coding 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://hl7.org/fhir/message-events".
-
destination
protected List<MessageHeader.MessageDestinationComponent> destination
The destination application which the message is intended for.
-
receiver
protected Reference receiver
Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
-
receiverTarget
protected Resource receiverTarget
The actual object that is the target of the reference (Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.)
-
sender
protected Reference sender
Identifies the sending system to allow the use of a trust relationship.
-
senderTarget
protected Resource senderTarget
The actual object that is the target of the reference (Identifies the sending system to allow the use of a trust relationship.)
-
timestamp
protected InstantType timestamp
The time that the message was sent.
-
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.
-
entererTarget
protected Practitioner entererTarget
The actual object that is the target of the reference (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.
-
authorTarget
protected Practitioner authorTarget
The actual object that is the target of the reference (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.
-
responsibleTarget
protected Resource responsibleTarget
The actual object that is the target of the reference (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.
-
focusTarget
protected List<Resource> focusTarget
The actual objects that are the target of the reference (The actual data of the message - a reference to the root/focus class of the event.)
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: 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 codeDescription: ok | transient-error | fatal-error
Type: token
Path: MessageHeader.response.code
-
SP_RECEIVER
public static final String SP_RECEIVER
Search parameter: receiverDescription: Intended "real-world" recipient for the data
Type: reference
Path: MessageHeader.receiver
- See Also:
- Constant Field Values
-
RECEIVER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECEIVER
Fluent Client search parameter constant for receiverDescription: Intended "real-world" recipient for the data
Type: reference
Path: MessageHeader.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_AUTHOR
public static final String SP_AUTHOR
Search parameter: authorDescription: 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 authorDescription: 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_DESTINATION
public static final String SP_DESTINATION
Search parameter: destinationDescription: 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 destinationDescription: Name of system
Type: string
Path: MessageHeader.destination.name
-
SP_FOCUS
public static final String SP_FOCUS
Search parameter: focusDescription: 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 focusDescription: 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_SOURCE
public static final String SP_SOURCE
Search parameter: sourceDescription: 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 sourceDescription: Name of system
Type: string
Path: MessageHeader.source.name
-
SP_TARGET
public static final String SP_TARGET
Search parameter: targetDescription: 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 targetDescription: 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".
-
SP_DESTINATION_URI
public static final String SP_DESTINATION_URI
Search parameter: destination-uriDescription: 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-uriDescription: Actual destination address or id
Type: uri
Path: MessageHeader.destination.endpoint
-
SP_SOURCE_URI
public static final String SP_SOURCE_URI
Search parameter: source-uriDescription: 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-uriDescription: Actual message source address or id
Type: uri
Path: MessageHeader.source.endpoint
-
SP_SENDER
public static final String SP_SENDER
Search parameter: senderDescription: 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 senderDescription: 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_RESPONSIBLE
public static final String SP_RESPONSIBLE
Search parameter: responsibleDescription: 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 responsibleDescription: 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_ENTERER
public static final String SP_ENTERER
Search parameter: entererDescription: 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 entererDescription: 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_RESPONSE_ID
public static final String SP_RESPONSE_ID
Search parameter: response-idDescription: 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-idDescription: Id of original message
Type: token
Path: MessageHeader.response.identifier
-
SP_EVENT
public static final String SP_EVENT
Search parameter: eventDescription: Code for the event this message represents
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 eventDescription: Code for the event this message represents
Type: token
Path: MessageHeader.event
-
SP_TIMESTAMP
public static final String SP_TIMESTAMP
Search parameter: timestampDescription: Time that the message was sent
Type: date
Path: MessageHeader.timestamp
- See Also:
- Constant Field Values
-
TIMESTAMP
public static final ca.uhn.fhir.rest.gclient.DateClientParam TIMESTAMP
Fluent Client search parameter constant for timestampDescription: Time that the message was sent
Type: date
Path: MessageHeader.timestamp
-
-
Constructor Detail
-
MessageHeader
public MessageHeader()
Constructor
-
MessageHeader
public MessageHeader(Coding event, InstantType timestamp, MessageHeader.MessageSourceComponent source)
Constructor
-
-
Method Detail
-
getEvent
public Coding 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://hl7.org/fhir/message-events".)
-
hasEvent
public boolean hasEvent()
-
setEvent
public MessageHeader setEvent(Coding 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://hl7.org/fhir/message-events".)
-
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
-
getReceiver
public Reference getReceiver()
- Returns:
receiver
(Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.)
-
hasReceiver
public boolean hasReceiver()
-
setReceiver
public MessageHeader setReceiver(Reference value)
- Parameters:
value
-receiver
(Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.)
-
getReceiverTarget
public Resource getReceiverTarget()
- Returns:
receiver
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.)
-
setReceiverTarget
public MessageHeader setReceiverTarget(Resource value)
- Parameters:
value
-receiver
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.)
-
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.)
-
getSenderTarget
public Resource getSenderTarget()
- Returns:
sender
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Identifies the sending system to allow the use of a trust relationship.)
-
setSenderTarget
public MessageHeader setSenderTarget(Resource value)
- Parameters:
value
-sender
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Identifies the sending system to allow the use of a trust relationship.)
-
getTimestampElement
public InstantType getTimestampElement()
- Returns:
timestamp
(The time that the message was sent.). This is the underlying object with id, value and extensions. The accessor "getTimestamp" gives direct access to the value
-
hasTimestampElement
public boolean hasTimestampElement()
-
hasTimestamp
public boolean hasTimestamp()
-
setTimestampElement
public MessageHeader setTimestampElement(InstantType value)
- Parameters:
value
-timestamp
(The time that the message was sent.). This is the underlying object with id, value and extensions. The accessor "getTimestamp" gives direct access to the value
-
getTimestamp
public Date getTimestamp()
- Returns:
- The time that the message was sent.
-
setTimestamp
public MessageHeader setTimestamp(Date value)
- Parameters:
value
- The time that the message was sent.
-
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.)
-
getEntererTarget
public Practitioner getEntererTarget()
- Returns:
enterer
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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.)
-
setEntererTarget
public MessageHeader setEntererTarget(Practitioner value)
- Parameters:
value
-enterer
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)
-
getAuthorTarget
public Practitioner getAuthorTarget()
- Returns:
author
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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.)
-
setAuthorTarget
public MessageHeader setAuthorTarget(Practitioner value)
- Parameters:
value
-author
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)
-
getResponsibleTarget
public Resource getResponsibleTarget()
- Returns:
responsible
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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.)
-
setResponsibleTarget
public MessageHeader setResponsibleTarget(Resource value)
- Parameters:
value
-responsible
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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 MessageHeader addFocus(Reference t)
-
getFocusFirstRep
public Reference getFocusFirstRep()
- Returns:
- The first repetition of repeating field
focus
, creating it if it does not already exist
-
getFocusTarget
@Deprecated public List<Resource> getFocusTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public MessageHeader copy()
- Specified by:
copy
in classDomainResource
-
typedCopy
protected MessageHeader typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-