public class MessageHeader extends DomainResource
| Modifier and Type | Class and Description |
|---|---|
static class |
MessageHeader.MessageDestinationComponent |
static class |
MessageHeader.MessageHeaderResponseComponent |
static class |
MessageHeader.MessageSourceComponent |
static class |
MessageHeader.ResponseType |
static class |
MessageHeader.ResponseTypeEnumFactory |
| Modifier and Type | Field and Description |
|---|---|
protected Reference |
author
The logical author of the message - the person or device that decided the described event should happen.
|
static ReferenceClientParam |
AUTHOR
Fluent Client search parameter constant for author
|
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.
|
static TokenClientParam |
CODE
Fluent Client search parameter constant for code
|
protected List<MessageHeader.MessageDestinationComponent> |
destination
The destination application which the message is intended for.
|
static StringClientParam |
DESTINATION
Fluent Client search parameter constant for destination
|
static 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 ReferenceClientParam |
ENTERER
Fluent Client search parameter constant for enterer
|
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.
|
protected Coding |
event
Code that identifies the event this message represents and connects it with its definition.
|
static 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 ReferenceClientParam |
FOCUS
Fluent Client search parameter constant for focus
|
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.)
|
static Include |
INCLUDE_AUTHOR
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_ENTERER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_FOCUS
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_RECEIVER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_RESPONSIBLE
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SENDER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_TARGET
Constant for fluent queries to be used to add include statements.
|
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 ReferenceClientParam |
RECEIVER
Fluent Client search parameter constant for receiver
|
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.)
|
protected MessageHeader.MessageHeaderResponseComponent |
response
Information about the message that this message is a response to.
|
static 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 ReferenceClientParam |
RESPONSIBLE
Fluent Client search parameter constant for responsible
|
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.
|
protected Reference |
sender
Identifies the sending system to allow the use of a trust relationship.
|
static ReferenceClientParam |
SENDER
Fluent Client search parameter constant for sender
|
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.)
|
protected MessageHeader.MessageSourceComponent |
source
The source application from which this message originated.
|
static StringClientParam |
SOURCE
Fluent Client search parameter constant for source
|
static UriClientParam |
SOURCE_URI
Fluent Client search parameter constant for source-uri
|
static String |
SP_AUTHOR
Search parameter: author
|
static String |
SP_CODE
Search parameter: code
|
static String |
SP_DESTINATION
Search parameter: destination
|
static String |
SP_DESTINATION_URI
Search parameter: destination-uri
|
static String |
SP_ENTERER
Search parameter: enterer
|
static String |
SP_EVENT
Search parameter: event
|
static String |
SP_FOCUS
Search parameter: focus
|
static String |
SP_RECEIVER
Search parameter: receiver
|
static String |
SP_RESPONSE_ID
Search parameter: response-id
|
static String |
SP_RESPONSIBLE
Search parameter: responsible
|
static String |
SP_SENDER
Search parameter: sender
|
static String |
SP_SOURCE
Search parameter: source
|
static String |
SP_SOURCE_URI
Search parameter: source-uri
|
static String |
SP_TARGET
Search parameter: target
|
static String |
SP_TIMESTAMP
Search parameter: timestamp
|
static ReferenceClientParam |
TARGET
Fluent Client search parameter constant for target
|
protected InstantType |
timestamp
The time that the message was sent.
|
static DateClientParam |
TIMESTAMP
Fluent Client search parameter constant for timestamp
|
contained, extension, modifierExtension, textid, implicitRules, language, metaRES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
MessageHeader()
Constructor
|
MessageHeader(Coding event,
InstantType timestamp,
MessageHeader.MessageSourceComponent source)
Constructor
|
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextcopyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, isResource, setIdcastToAddress, 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, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDatagetMeta, getStructureFhirVersionEnum, setIdgetFormatCommentsPost, getFormatCommentsPre, hasFormatCommentprotected Coding event
protected List<MessageHeader.MessageDestinationComponent> destination
protected Reference receiver
protected Resource receiverTarget
protected Reference sender
protected Resource senderTarget
protected InstantType timestamp
protected Reference enterer
protected Practitioner entererTarget
protected Reference author
protected Practitioner authorTarget
protected MessageHeader.MessageSourceComponent source
protected Reference responsible
protected Resource responsibleTarget
protected CodeableConcept reason
protected MessageHeader.MessageHeaderResponseComponent response
protected List<Reference> focus
protected List<Resource> focusTarget
public static final String SP_CODE
Description: ok | transient-error | fatal-error
Type: token
Path: MessageHeader.response.code
public static final TokenClientParam CODE
Description: ok | transient-error | fatal-error
Type: token
Path: MessageHeader.response.code
public static final String SP_RECEIVER
Description: Intended "real-world" recipient for the data
Type: reference
Path: MessageHeader.receiver
public static final ReferenceClientParam RECEIVER
Description: Intended "real-world" recipient for the data
Type: reference
Path: MessageHeader.receiver
public static final Include INCLUDE_RECEIVER
public static final String SP_AUTHOR
Description: The source of the decision
Type: reference
Path: MessageHeader.author
public static final ReferenceClientParam AUTHOR
Description: The source of the decision
Type: reference
Path: MessageHeader.author
public static final Include INCLUDE_AUTHOR
public static final String SP_DESTINATION
Description: Name of system
Type: string
Path: MessageHeader.destination.name
public static final StringClientParam DESTINATION
Description: Name of system
Type: string
Path: MessageHeader.destination.name
public static final String SP_FOCUS
Description: The actual content of the message
Type: reference
Path: MessageHeader.focus
public static final ReferenceClientParam FOCUS
Description: The actual content of the message
Type: reference
Path: MessageHeader.focus
public static final Include INCLUDE_FOCUS
public static final String SP_SOURCE
Description: Name of system
Type: string
Path: MessageHeader.source.name
public static final StringClientParam SOURCE
Description: Name of system
Type: string
Path: MessageHeader.source.name
public static final String SP_TARGET
Description: Particular delivery destination within the destination
Type: reference
Path: MessageHeader.destination.target
public static final ReferenceClientParam TARGET
Description: Particular delivery destination within the destination
Type: reference
Path: MessageHeader.destination.target
public static final Include INCLUDE_TARGET
public static final String SP_DESTINATION_URI
Description: Actual destination address or id
Type: uri
Path: MessageHeader.destination.endpoint
public static final UriClientParam DESTINATION_URI
Description: Actual destination address or id
Type: uri
Path: MessageHeader.destination.endpoint
public static final String SP_SOURCE_URI
Description: Actual message source address or id
Type: uri
Path: MessageHeader.source.endpoint
public static final UriClientParam SOURCE_URI
Description: Actual message source address or id
Type: uri
Path: MessageHeader.source.endpoint
public static final String SP_SENDER
Description: Real world sender of the message
Type: reference
Path: MessageHeader.sender
public static final ReferenceClientParam SENDER
Description: Real world sender of the message
Type: reference
Path: MessageHeader.sender
public static final Include INCLUDE_SENDER
public static final String SP_RESPONSIBLE
Description: Final responsibility for event
Type: reference
Path: MessageHeader.responsible
public static final ReferenceClientParam RESPONSIBLE
Description: Final responsibility for event
Type: reference
Path: MessageHeader.responsible
public static final Include INCLUDE_RESPONSIBLE
public static final String SP_ENTERER
Description: The source of the data entry
Type: reference
Path: MessageHeader.enterer
public static final ReferenceClientParam ENTERER
Description: The source of the data entry
Type: reference
Path: MessageHeader.enterer
public static final Include INCLUDE_ENTERER
public static final String SP_RESPONSE_ID
Description: Id of original message
Type: token
Path: MessageHeader.response.identifier
public static final TokenClientParam RESPONSE_ID
Description: Id of original message
Type: token
Path: MessageHeader.response.identifier
public static final String SP_EVENT
Description: Code for the event this message represents
Type: token
Path: MessageHeader.event
public static final TokenClientParam EVENT
Description: Code for the event this message represents
Type: token
Path: MessageHeader.event
public static final String SP_TIMESTAMP
Description: Time that the message was sent
Type: date
Path: MessageHeader.timestamp
public static final DateClientParam TIMESTAMP
Description: Time that the message was sent
Type: date
Path: MessageHeader.timestamp
public MessageHeader()
public MessageHeader(Coding event, InstantType timestamp, MessageHeader.MessageSourceComponent source)
public Coding getEvent()
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".)public boolean hasEvent()
public MessageHeader setEvent(Coding value)
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".)public List<MessageHeader.MessageDestinationComponent> getDestination()
destination (The destination application which the message is intended for.)public MessageHeader setDestination(List<MessageHeader.MessageDestinationComponent> theDestination)
this for easy method chainingpublic boolean hasDestination()
public MessageHeader.MessageDestinationComponent addDestination()
public MessageHeader addDestination(MessageHeader.MessageDestinationComponent t)
public MessageHeader.MessageDestinationComponent getDestinationFirstRep()
destination, creating it if it does not already existpublic Reference getReceiver()
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.)public boolean hasReceiver()
public MessageHeader setReceiver(Reference value)
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.)public Resource getReceiverTarget()
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.)public MessageHeader setReceiverTarget(Resource value)
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.)public Reference getSender()
sender (Identifies the sending system to allow the use of a trust relationship.)public boolean hasSender()
public MessageHeader setSender(Reference value)
value - sender (Identifies the sending system to allow the use of a trust relationship.)public Resource getSenderTarget()
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.)public MessageHeader setSenderTarget(Resource value)
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.)public InstantType getTimestampElement()
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 valuepublic boolean hasTimestampElement()
public boolean hasTimestamp()
public MessageHeader setTimestampElement(InstantType value)
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 valuepublic Date getTimestamp()
public MessageHeader setTimestamp(Date value)
value - The time that the message was sent.public Reference getEnterer()
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.)public boolean hasEnterer()
public MessageHeader setEnterer(Reference value)
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.)public Practitioner getEntererTarget()
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.)public MessageHeader setEntererTarget(Practitioner value)
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.)public Reference getAuthor()
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.)public boolean hasAuthor()
public MessageHeader setAuthor(Reference value)
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.)public Practitioner getAuthorTarget()
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.)public MessageHeader setAuthorTarget(Practitioner value)
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.)public MessageHeader.MessageSourceComponent getSource()
source (The source application from which this message originated.)public boolean hasSource()
public MessageHeader setSource(MessageHeader.MessageSourceComponent value)
value - source (The source application from which this message originated.)public Reference getResponsible()
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.)public boolean hasResponsible()
public MessageHeader setResponsible(Reference value)
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.)public Resource getResponsibleTarget()
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.)public MessageHeader setResponsibleTarget(Resource value)
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.)public CodeableConcept getReason()
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.)public boolean hasReason()
public MessageHeader setReason(CodeableConcept value)
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.)public MessageHeader.MessageHeaderResponseComponent getResponse()
response (Information about the message that this message is a response to. Only present if this message is a response.)public boolean hasResponse()
public MessageHeader setResponse(MessageHeader.MessageHeaderResponseComponent value)
value - response (Information about the message that this message is a response to. Only present if this message is a response.)public List<Reference> getFocus()
focus (The actual data of the message - a reference to the root/focus class of the event.)public MessageHeader setFocus(List<Reference> theFocus)
this for easy method chainingpublic boolean hasFocus()
public MessageHeader addFocus(Reference t)
public Reference getFocusFirstRep()
focus, creating it if it does not already exist@Deprecated public List<Resource> getFocusTarget()
protected void listChildren(List<Property> childrenList)
listChildren in class DomainResourcepublic Base[] getProperty(int hash, String name, boolean checkValid) throws FHIRException
getProperty in class DomainResourceFHIRExceptionpublic Base setProperty(int hash, String name, Base value) throws FHIRException
setProperty in class DomainResourceFHIRExceptionpublic Base setProperty(String name, Base value) throws FHIRException
setProperty in class DomainResourceFHIRExceptionpublic Base makeProperty(int hash, String name) throws FHIRException
makeProperty in class DomainResourceFHIRExceptionpublic String[] getTypesForProperty(int hash, String name) throws FHIRException
getTypesForProperty in class DomainResourceFHIRExceptionpublic Base addChild(String name) throws FHIRException
addChild in class DomainResourceFHIRExceptionpublic String fhirType()
fhirType in class DomainResourcepublic MessageHeader copy()
copy in class DomainResourceprotected MessageHeader typedCopy()
public boolean equalsDeep(Base other)
equalsDeep in class DomainResourcepublic boolean equalsShallow(Base other)
equalsShallow in class DomainResourcepublic boolean isEmpty()
isEmpty in interface IBaseisEmpty in class DomainResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2017 University Health Network. All rights reserved.