Class MessageHeader.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Resource>
-
- org.linuxforhealth.fhir.model.resource.Resource.Builder
-
- org.linuxforhealth.fhir.model.resource.DomainResource.Builder
-
- org.linuxforhealth.fhir.model.resource.MessageHeader.Builder
-
- Enclosing class:
- MessageHeader
public static class MessageHeader.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MessageHeader.Builder
author(Reference author)
The logical author of the message - the person or device that decided the described event should happen.MessageHeader
build()
Build theMessageHeader
MessageHeader.Builder
contained(java.util.Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.MessageHeader.Builder
contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.MessageHeader.Builder
definition(Canonical definition)
Permanent link to the MessageDefinition for this message.MessageHeader.Builder
destination(java.util.Collection<MessageHeader.Destination> destination)
The destination application which the message is intended for.MessageHeader.Builder
destination(MessageHeader.Destination... destination)
The destination application which the message is intended for.MessageHeader.Builder
enterer(Reference enterer)
The person or device that performed the data entry leading to this message.MessageHeader.Builder
event(Element event)
Code that identifies the event this message represents and connects it with its definition.MessageHeader.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource.MessageHeader.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.MessageHeader.Builder
focus(java.util.Collection<Reference> focus)
The actual data of the message - a reference to the root/focus class of the event.MessageHeader.Builder
focus(Reference... focus)
The actual data of the message - a reference to the root/focus class of the event.protected MessageHeader.Builder
from(MessageHeader messageHeader)
MessageHeader.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.MessageHeader.Builder
implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.MessageHeader.Builder
language(Code language)
The base language in which the resource is written.MessageHeader.Builder
meta(Meta meta)
The metadata about the resource.MessageHeader.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.MessageHeader.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.MessageHeader.Builder
reason(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.MessageHeader.Builder
response(MessageHeader.Response response)
Information about the message that this message is a response to.MessageHeader.Builder
responsible(Reference responsible)
The person or organization that accepts overall responsibility for the contents of the message.MessageHeader.Builder
sender(Reference sender)
Identifies the sending system to allow the use of a trust relationship.MessageHeader.Builder
source(MessageHeader.Source source)
The source application from which this message originated.MessageHeader.Builder
text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human.protected void
validate(MessageHeader messageHeader)
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public MessageHeader.Builder id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.- Overrides:
id
in classDomainResource.Builder
- Parameters:
id
- Logical id of this artifact- Returns:
- A reference to this Builder instance
-
meta
public MessageHeader.Builder meta(Meta meta)
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.- Overrides:
meta
in classDomainResource.Builder
- Parameters:
meta
- Metadata about the resource- Returns:
- A reference to this Builder instance
-
implicitRules
public MessageHeader.Builder implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.- Overrides:
implicitRules
in classDomainResource.Builder
- Parameters:
implicitRules
- A set of rules under which this content was created- Returns:
- A reference to this Builder instance
-
language
public MessageHeader.Builder language(Code language)
The base language in which the resource is written.- Overrides:
language
in classDomainResource.Builder
- Parameters:
language
- Language of the resource content- Returns:
- A reference to this Builder instance
-
text
public MessageHeader.Builder text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.- Overrides:
text
in classDomainResource.Builder
- Parameters:
text
- Text summary of the resource, for human interpretation- Returns:
- A reference to this Builder instance
-
contained
public MessageHeader.Builder contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public MessageHeader.Builder contained(java.util.Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
extension
public MessageHeader.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public MessageHeader.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public MessageHeader.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public MessageHeader.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
event
public MessageHeader.Builder event(Element 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.This element is required.
This is a choice element with the following allowed types:
- Parameters:
event
- Code for the event this message represents or link to event definition- Returns:
- A reference to this Builder instance
-
destination
public MessageHeader.Builder destination(MessageHeader.Destination... destination)
The destination application which the message is intended for.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
destination
- Message destination application(s)- Returns:
- A reference to this Builder instance
-
destination
public MessageHeader.Builder destination(java.util.Collection<MessageHeader.Destination> destination)
The destination application which the message is intended for.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
destination
- Message destination application(s)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
sender
public MessageHeader.Builder sender(Reference sender)
Identifies the sending system to allow the use of a trust relationship.Allowed resource types for this reference:
- Parameters:
sender
- Real world sender of the message- Returns:
- A reference to this Builder instance
-
enterer
public MessageHeader.Builder enterer(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.Allowed resource types for this reference:
- Parameters:
enterer
- The source of the data entry- Returns:
- A reference to this Builder instance
-
author
public MessageHeader.Builder author(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.Allowed resource types for this reference:
- Parameters:
author
- The source of the decision- Returns:
- A reference to this Builder instance
-
source
public MessageHeader.Builder source(MessageHeader.Source source)
The source application from which this message originated.This element is required.
- Parameters:
source
- Message source application- Returns:
- A reference to this Builder instance
-
responsible
public MessageHeader.Builder responsible(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.Allowed resource types for this reference:
- Parameters:
responsible
- Final responsibility for event- Returns:
- A reference to this Builder instance
-
reason
public MessageHeader.Builder reason(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.- Parameters:
reason
- Cause of event- Returns:
- A reference to this Builder instance
-
response
public MessageHeader.Builder response(MessageHeader.Response response)
Information about the message that this message is a response to. Only present if this message is a response.- Parameters:
response
- If this is a reply to prior message- Returns:
- A reference to this Builder instance
-
focus
public MessageHeader.Builder focus(Reference... focus)
The actual data of the message - a reference to the root/focus class of the event.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
focus
- The actual content of the message- Returns:
- A reference to this Builder instance
-
focus
public MessageHeader.Builder focus(java.util.Collection<Reference> focus)
The actual data of the message - a reference to the root/focus class of the event.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
focus
- The actual content of the message- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
definition
public MessageHeader.Builder definition(Canonical definition)
Permanent link to the MessageDefinition for this message.- Parameters:
definition
- Link to the definition for this message- Returns:
- A reference to this Builder instance
-
build
public MessageHeader build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
MessageHeader
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid MessageHeader per the base specification
-
validate
protected void validate(MessageHeader messageHeader)
-
from
protected MessageHeader.Builder from(MessageHeader messageHeader)
-
-