
Class 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic enumstatic classNested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ReferenceThe logical author of the message - the personor device that decided the described event should happen.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for authorstatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for codeprotected CanonicalTypePermanent link to the MessageDefinition for this message.protected List<MessageHeader.MessageDestinationComponent> The destination application which the message is intended for.static final ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for destinationprotected DataTypeCode that identifies the event this message represents and connects it with its definition.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for eventThe actual data of the message - a reference to the root/focus class of the event.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for focusstatic final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.protected CodeableConceptCoded 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.ReferenceClientParamFluent Client search parameter constant for receiverInformation about the message that this message is a response to.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for response-idprotected ReferenceThe person or organization that accepts overall responsibility for the contents of the message.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for responsibleprotected ReferenceIdentifies the sending system to allow the use of a trust relationship.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for senderprotected MessageHeader.MessageSourceComponentThe source application from which this message originated.static final ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for sourcestatic final StringSearch parameter: authorstatic final StringSearch parameter: codestatic final StringSearch parameter: destinationstatic final StringSearch parameter: eventstatic final StringSearch parameter: focusstatic final StringSearch parameter: receiverstatic final StringSearch parameter: response-idstatic final StringSearch parameter: responsiblestatic final StringSearch parameter: senderstatic final StringSearch parameter: sourcestatic final StringSearch parameter: targetstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for targetFields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXTFields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionConstructorMessageHeader(DataType event, MessageHeader.MessageSourceComponent source) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddFocus()copy()voidcopyValues(MessageHeader dst) booleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getEvent()getFocus()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) String[]getTypesForProperty(int hash, String name) booleanbooleanbooleanbooleanbooleanhasEvent()booleanbooleanbooleanhasFocus()booleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) voidremoveChild(String name, Base value) setDefinition(String value) setDestination(List<MessageHeader.MessageDestinationComponent> theDestination) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setReason(CodeableConcept value) setResponsible(Reference value) protected MessageHeaderMethods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setTextMethods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPathMethods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtmlMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
event
Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification are defined by the implementation. Alternatively a canonical uri to the EventDefinition. -
destination
The destination application which the message is intended for. -
sender
Identifies the sending system to allow the use of a trust relationship. -
author
The logical author of the message - the personor 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
The source application from which this message originated. -
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
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
Information about the message that this message is a response to. Only present if this message is a response. -
focus
The actual data of the message - a reference to the root/focus class of the event. This is allowed to be a Parameters resource. -
definition
Permanent link to the MessageDefinition for this message. -
SP_AUTHOR
Search parameter: authorDescription: The source of the decision
Type: reference
Path: MessageHeader.author
- See Also:
-
AUTHOR
Fluent Client search parameter constant for authorDescription: The source of the decision
Type: reference
Path: MessageHeader.author
-
INCLUDE_AUTHOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:author". -
SP_CODE
Search parameter: codeDescription: ok | transient-error | fatal-error
Type: token
Path: MessageHeader.response.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: ok | transient-error | fatal-error
Type: token
Path: MessageHeader.response.code
-
SP_DESTINATION
Search parameter: destinationDescription: Name of system
Type: string
Path: MessageHeader.destination.name
- See Also:
-
DESTINATION
Fluent Client search parameter constant for destinationDescription: Name of system
Type: string
Path: MessageHeader.destination.name
-
SP_EVENT
Search parameter: eventDescription: Code for the event this message represents or link to event definition
Type: token
Path: MessageHeader.event.ofType(Coding) | MessageHeader.event.ofType(canonical)
- See Also:
-
EVENT
Fluent Client search parameter constant for eventDescription: Code for the event this message represents or link to event definition
Type: token
Path: MessageHeader.event.ofType(Coding) | MessageHeader.event.ofType(canonical)
-
SP_FOCUS
Search parameter: focusDescription: The actual content of the message
Type: reference
Path: MessageHeader.focus
- See Also:
-
FOCUS
Fluent Client search parameter constant for focusDescription: The actual content of the message
Type: reference
Path: MessageHeader.focus
-
INCLUDE_FOCUS
Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:focus". -
SP_RECEIVER
Search parameter: receiverDescription: Intended "real-world" recipient for the data
Type: reference
Path: MessageHeader.destination.receiver
- See Also:
-
RECEIVER
Fluent Client search parameter constant for receiverDescription: Intended "real-world" recipient for the data
Type: reference
Path: MessageHeader.destination.receiver
-
INCLUDE_RECEIVER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:receiver". -
SP_RESPONSE_ID
Search parameter: response-idDescription: Id of original message
Type: token
Path: MessageHeader.response.identifier
- See Also:
-
RESPONSE_ID
Fluent Client search parameter constant for response-idDescription: Id of original message
Type: token
Path: MessageHeader.response.identifier
-
SP_RESPONSIBLE
Search parameter: responsibleDescription: Final responsibility for event
Type: reference
Path: MessageHeader.responsible
- See Also:
-
RESPONSIBLE
Fluent Client search parameter constant for responsibleDescription: Final responsibility for event
Type: reference
Path: MessageHeader.responsible
-
INCLUDE_RESPONSIBLE
Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:responsible". -
SP_SENDER
Search parameter: senderDescription: Real world sender of the message
Type: reference
Path: MessageHeader.sender
- See Also:
-
SENDER
Fluent Client search parameter constant for senderDescription: Real world sender of the message
Type: reference
Path: MessageHeader.sender
-
INCLUDE_SENDER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:sender". -
SP_SOURCE
Search parameter: sourceDescription: Name of system
Type: string
Path: MessageHeader.source.name
- See Also:
-
SOURCE
Fluent Client search parameter constant for sourceDescription: Name of system
Type: string
Path: MessageHeader.source.name
-
SP_TARGET
Search parameter: targetDescription: Particular delivery destination within the destination
Type: reference
Path: MessageHeader.destination.target
- See Also:
-
TARGET
Fluent Client search parameter constant for targetDescription: Particular delivery destination within the destination
Type: reference
Path: MessageHeader.destination.target
-
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
Constructor
-
-
Method Details
-
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 are defined by the implementation. Alternatively a canonical uri to the EventDefinition.)
-
getEventCoding
- Returns:
event(Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification are defined by the implementation. Alternatively a canonical uri to the EventDefinition.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasEventCoding
-
getEventCanonicalType
- Returns:
event(Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification are defined by the implementation. Alternatively a canonical uri to the EventDefinition.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasEventCanonicalType
-
hasEvent
-
setEvent
- 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 are defined by the implementation. Alternatively a canonical uri to the EventDefinition.)
-
getDestination
- Returns:
destination(The destination application which the message is intended for.)
-
setDestination
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDestination
-
addDestination
-
addDestination
-
getDestinationFirstRep
- Returns:
- The first repetition of repeating field
destination, creating it if it does not already exist {3}
-
getSender
- Returns:
sender(Identifies the sending system to allow the use of a trust relationship.)
-
hasSender
-
setSender
- Parameters:
value-sender(Identifies the sending system to allow the use of a trust relationship.)
-
getAuthor
- Returns:
author(The logical author of the message - the personor 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
-
setAuthor
- Parameters:
value-author(The logical author of the message - the personor 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
- Returns:
source(The source application from which this message originated.)
-
hasSource
-
setSource
- Parameters:
value-source(The source application from which this message originated.)
-
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
-
setResponsible
- 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
- 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
-
setReason
- 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
- Returns:
response(Information about the message that this message is a response to. Only present if this message is a response.)
-
hasResponse
-
setResponse
- Parameters:
value-response(Information about the message that this message is a response to. Only present if this message is a response.)
-
getFocus
- Returns:
focus(The actual data of the message - a reference to the root/focus class of the event. This is allowed to be a Parameters resource.)
-
setFocus
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasFocus
-
addFocus
-
addFocus
-
getFocusFirstRep
- Returns:
- The first repetition of repeating field
focus, creating it if it does not already exist {3}
-
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
-
hasDefinition
-
setDefinitionElement
- 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
- Returns:
- Permanent link to the MessageDefinition for this message.
-
setDefinition
- Parameters:
value- Permanent link to the MessageDefinition for this message.
-
listChildren
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource- Returns:
- the FHIR type name of the instance (not the java class name)
-
copy
- Specified by:
copyin classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-