Class QuestionnaireResponse.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.QuestionnaireResponse.Builder
-
- Enclosing class:
- QuestionnaireResponse
public static class QuestionnaireResponse.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 QuestionnaireResponse.Builder
author(Reference author)
Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.QuestionnaireResponse.Builder
authored(DateTime authored)
The date and/or time that this set of answers were last changed.QuestionnaireResponse.Builder
basedOn(java.util.Collection<Reference> basedOn)
The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse.QuestionnaireResponse.Builder
basedOn(Reference... basedOn)
The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse.QuestionnaireResponse
build()
Build theQuestionnaireResponse
QuestionnaireResponse.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.QuestionnaireResponse.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.QuestionnaireResponse.Builder
encounter(Reference encounter)
The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.QuestionnaireResponse.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.QuestionnaireResponse.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected QuestionnaireResponse.Builder
from(QuestionnaireResponse questionnaireResponse)
QuestionnaireResponse.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.QuestionnaireResponse.Builder
identifier(Identifier identifier)
A business identifier assigned to a particular completed (or partially completed) questionnaire.QuestionnaireResponse.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.QuestionnaireResponse.Builder
item(java.util.Collection<QuestionnaireResponse.Item> item)
A group or question item from the original questionnaire for which answers are provided.QuestionnaireResponse.Builder
item(QuestionnaireResponse.Item... item)
A group or question item from the original questionnaire for which answers are provided.QuestionnaireResponse.Builder
language(Code language)
The base language in which the resource is written.QuestionnaireResponse.Builder
meta(Meta meta)
The metadata about the resource.QuestionnaireResponse.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.QuestionnaireResponse.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.QuestionnaireResponse.Builder
partOf(java.util.Collection<Reference> partOf)
A procedure or observation that this questionnaire was performed as part of the execution of.QuestionnaireResponse.Builder
partOf(Reference... partOf)
A procedure or observation that this questionnaire was performed as part of the execution of.QuestionnaireResponse.Builder
questionnaire(Canonical questionnaire)
The Questionnaire that defines and organizes the questions for which answers are being provided.QuestionnaireResponse.Builder
source(Reference source)
The person who answered the questions about the subject.QuestionnaireResponse.Builder
status(QuestionnaireResponseStatus status)
The position of the questionnaire response within its overall lifecycle.QuestionnaireResponse.Builder
subject(Reference subject)
The subject of the questionnaire response.QuestionnaireResponse.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(QuestionnaireResponse questionnaireResponse)
-
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 QuestionnaireResponse.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 QuestionnaireResponse.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 QuestionnaireResponse.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 QuestionnaireResponse.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 QuestionnaireResponse.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 QuestionnaireResponse.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 QuestionnaireResponse.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 QuestionnaireResponse.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 QuestionnaireResponse.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 QuestionnaireResponse.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 QuestionnaireResponse.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
-
identifier
public QuestionnaireResponse.Builder identifier(Identifier identifier)
A business identifier assigned to a particular completed (or partially completed) questionnaire.- Parameters:
identifier
- Unique id for this set of answers- Returns:
- A reference to this Builder instance
-
basedOn
public QuestionnaireResponse.Builder basedOn(Reference... basedOn)
The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
basedOn
- Request fulfilled by this QuestionnaireResponse- Returns:
- A reference to this Builder instance
-
basedOn
public QuestionnaireResponse.Builder basedOn(java.util.Collection<Reference> basedOn)
The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
basedOn
- Request fulfilled by this QuestionnaireResponse- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
partOf
public QuestionnaireResponse.Builder partOf(Reference... partOf)
A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
partOf
- Part of this action- Returns:
- A reference to this Builder instance
-
partOf
public QuestionnaireResponse.Builder partOf(java.util.Collection<Reference> partOf)
A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
partOf
- Part of this action- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
questionnaire
public QuestionnaireResponse.Builder questionnaire(Canonical questionnaire)
The Questionnaire that defines and organizes the questions for which answers are being provided.- Parameters:
questionnaire
- Form being answered- Returns:
- A reference to this Builder instance
-
status
public QuestionnaireResponse.Builder status(QuestionnaireResponseStatus status)
The position of the questionnaire response within its overall lifecycle.This element is required.
- Parameters:
status
- in-progress | completed | amended | entered-in-error | stopped- Returns:
- A reference to this Builder instance
-
subject
public QuestionnaireResponse.Builder subject(Reference subject)
The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.- Parameters:
subject
- The subject of the questions- Returns:
- A reference to this Builder instance
-
encounter
public QuestionnaireResponse.Builder encounter(Reference encounter)
The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.Allowed resource types for this reference:
- Parameters:
encounter
- Encounter created as part of- Returns:
- A reference to this Builder instance
-
authored
public QuestionnaireResponse.Builder authored(DateTime authored)
The date and/or time that this set of answers were last changed.- Parameters:
authored
- Date the answers were gathered- Returns:
- A reference to this Builder instance
-
author
public QuestionnaireResponse.Builder author(Reference author)
Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.Allowed resource types for this reference:
- Parameters:
author
- Person who received and recorded the answers- Returns:
- A reference to this Builder instance
-
source
public QuestionnaireResponse.Builder source(Reference source)
The person who answered the questions about the subject.Allowed resource types for this reference:
- Parameters:
source
- The person who answered the questions- Returns:
- A reference to this Builder instance
-
item
public QuestionnaireResponse.Builder item(QuestionnaireResponse.Item... item)
A group or question item from the original questionnaire for which answers are provided.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
item
- Groups and questions- Returns:
- A reference to this Builder instance
-
item
public QuestionnaireResponse.Builder item(java.util.Collection<QuestionnaireResponse.Item> item)
A group or question item from the original questionnaire for which answers are provided.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:
item
- Groups and questions- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public QuestionnaireResponse build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
QuestionnaireResponse
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid QuestionnaireResponse per the base specification
-
validate
protected void validate(QuestionnaireResponse questionnaireResponse)
-
from
protected QuestionnaireResponse.Builder from(QuestionnaireResponse questionnaireResponse)
-
-