Class Questionnaire.Builder
- java.lang.Object
-
- com.ibm.fhir.model.builder.AbstractBuilder<Resource>
-
- com.ibm.fhir.model.resource.Resource.Builder
-
- com.ibm.fhir.model.resource.DomainResource.Builder
-
- com.ibm.fhir.model.resource.Questionnaire.Builder
-
- Enclosing class:
- Questionnaire
public static class Questionnaire.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
Fields inherited from class com.ibm.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Questionnaire.Builder
approvalDate(Date approvalDate)
The date on which the resource content was approved by the publisher.Questionnaire
build()
Build theQuestionnaire
Questionnaire.Builder
code(Coding... code)
An identifier for this question or group of questions in a particular terminology such as LOINC.Questionnaire.Builder
code(Collection<Coding> code)
An identifier for this question or group of questions in a particular terminology such as LOINC.Questionnaire.Builder
contact(ContactDetail... contact)
Contact details to assist a user in finding and communicating with the publisher.Questionnaire.Builder
contact(Collection<ContactDetail> contact)
Contact details to assist a user in finding and communicating with the publisher.Questionnaire.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.Questionnaire.Builder
contained(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.Questionnaire.Builder
copyright(Markdown copyright)
A copyright statement relating to the questionnaire and/or its contents.Questionnaire.Builder
date(DateTime date)
The date (and optionally time) when the questionnaire was published.Questionnaire.Builder
derivedFrom(Canonical... derivedFrom)
The URL of a Questionnaire that this Questionnaire is based on.Questionnaire.Builder
derivedFrom(Collection<Canonical> derivedFrom)
The URL of a Questionnaire that this Questionnaire is based on.Questionnaire.Builder
description(Markdown description)
A free text natural language description of the questionnaire from a consumer's perspective.Questionnaire.Builder
effectivePeriod(Period effectivePeriod)
The period during which the questionnaire content was or is planned to be in active use.Questionnaire.Builder
experimental(Boolean experimental)
A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.Questionnaire.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.Questionnaire.Builder
extension(Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected Questionnaire.Builder
from(Questionnaire questionnaire)
Questionnaire.Builder
id(String id)
The logical id of the resource, as used in the URL for the resource.Questionnaire.Builder
identifier(Identifier... identifier)
A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.Questionnaire.Builder
identifier(Collection<Identifier> identifier)
A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.Questionnaire.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.Questionnaire.Builder
item(Questionnaire.Item... item)
A particular question, question grouping or display text that is part of the questionnaire.Questionnaire.Builder
item(Collection<Questionnaire.Item> item)
A particular question, question grouping or display text that is part of the questionnaire.Questionnaire.Builder
jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the questionnaire is intended to be used.Questionnaire.Builder
jurisdiction(Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the questionnaire is intended to be used.Questionnaire.Builder
language(Code language)
The base language in which the resource is written.Questionnaire.Builder
lastReviewDate(Date lastReviewDate)
The date on which the resource content was last reviewed.Questionnaire.Builder
meta(Meta meta)
The metadata about the resource.Questionnaire.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.Questionnaire.Builder
modifierExtension(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.Questionnaire.Builder
name(String name)
A natural language name identifying the questionnaire.Questionnaire.Builder
publisher(String publisher)
The name of the organization or individual that published the questionnaire.Questionnaire.Builder
purpose(Markdown purpose)
Explanation of why this questionnaire is needed and why it has been designed as it has.Questionnaire.Builder
status(PublicationStatus status)
The status of this questionnaire.Questionnaire.Builder
subjectType(ResourceType... subjectType)
The types of subjects that can be the subject of responses created for the questionnaire.Questionnaire.Builder
subjectType(Collection<ResourceType> subjectType)
The types of subjects that can be the subject of responses created for the questionnaire.Questionnaire.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.Questionnaire.Builder
title(String title)
A short, descriptive, user-friendly title for the questionnaire.Questionnaire.Builder
url(Uri url)
An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier.Questionnaire.Builder
useContext(UsageContext... useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.Questionnaire.Builder
useContext(Collection<UsageContext> useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.protected void
validate(Questionnaire questionnaire)
Questionnaire.Builder
version(String version)
The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance.-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.resource.Resource.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public Questionnaire.Builder id(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 Questionnaire.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 Questionnaire.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 Questionnaire.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 Questionnaire.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 Questionnaire.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
- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public Questionnaire.Builder contained(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
- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
extension
public Questionnaire.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
- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public Questionnaire.Builder extension(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
- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
modifierExtension
public Questionnaire.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
- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public Questionnaire.Builder modifierExtension(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
- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
url
public Questionnaire.Builder url(Uri url)
An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers.- Parameters:
url
- Canonical identifier for this questionnaire, represented as a URI (globally unique)- Returns:
- A reference to this Builder instance
-
identifier
public Questionnaire.Builder identifier(Identifier... identifier)
A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.Adds new element(s) to the existing list
- Parameters:
identifier
- Additional identifier for the questionnaire- Returns:
- A reference to this Builder instance
-
identifier
public Questionnaire.Builder identifier(Collection<Identifier> identifier)
A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
identifier
- Additional identifier for the questionnaire- Returns:
- A reference to this Builder instance
-
version
public Questionnaire.Builder version(String version)
The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.- Parameters:
version
- Business version of the questionnaire- Returns:
- A reference to this Builder instance
-
name
public Questionnaire.Builder name(String name)
A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.- Parameters:
name
- Name for this questionnaire (computer friendly)- Returns:
- A reference to this Builder instance
-
title
public Questionnaire.Builder title(String title)
A short, descriptive, user-friendly title for the questionnaire.- Parameters:
title
- Name for this questionnaire (human friendly)- Returns:
- A reference to this Builder instance
-
derivedFrom
public Questionnaire.Builder derivedFrom(Canonical... derivedFrom)
The URL of a Questionnaire that this Questionnaire is based on.Adds new element(s) to the existing list
- Parameters:
derivedFrom
- Instantiates protocol or definition- Returns:
- A reference to this Builder instance
-
derivedFrom
public Questionnaire.Builder derivedFrom(Collection<Canonical> derivedFrom)
The URL of a Questionnaire that this Questionnaire is based on.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
derivedFrom
- Instantiates protocol or definition- Returns:
- A reference to this Builder instance
-
status
public Questionnaire.Builder status(PublicationStatus status)
The status of this questionnaire. Enables tracking the life-cycle of the content.This element is required.
- Parameters:
status
- draft | active | retired | unknown- Returns:
- A reference to this Builder instance
-
experimental
public Questionnaire.Builder experimental(Boolean experimental)
A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.- Parameters:
experimental
- For testing purposes, not real usage- Returns:
- A reference to this Builder instance
-
subjectType
public Questionnaire.Builder subjectType(ResourceType... subjectType)
The types of subjects that can be the subject of responses created for the questionnaire.Adds new element(s) to the existing list
- Parameters:
subjectType
- Resource that can be subject of QuestionnaireResponse- Returns:
- A reference to this Builder instance
-
subjectType
public Questionnaire.Builder subjectType(Collection<ResourceType> subjectType)
The types of subjects that can be the subject of responses created for the questionnaire.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
subjectType
- Resource that can be subject of QuestionnaireResponse- Returns:
- A reference to this Builder instance
-
date
public Questionnaire.Builder date(DateTime date)
The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.- Parameters:
date
- Date last changed- Returns:
- A reference to this Builder instance
-
publisher
public Questionnaire.Builder publisher(String publisher)
The name of the organization or individual that published the questionnaire.- Parameters:
publisher
- Name of the publisher (organization or individual)- Returns:
- A reference to this Builder instance
-
contact
public Questionnaire.Builder contact(ContactDetail... contact)
Contact details to assist a user in finding and communicating with the publisher.Adds new element(s) to the existing list
- Parameters:
contact
- Contact details for the publisher- Returns:
- A reference to this Builder instance
-
contact
public Questionnaire.Builder contact(Collection<ContactDetail> contact)
Contact details to assist a user in finding and communicating with the publisher.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
contact
- Contact details for the publisher- Returns:
- A reference to this Builder instance
-
description
public Questionnaire.Builder description(Markdown description)
A free text natural language description of the questionnaire from a consumer's perspective.- Parameters:
description
- Natural language description of the questionnaire- Returns:
- A reference to this Builder instance
-
useContext
public Questionnaire.Builder useContext(UsageContext... useContext)
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.Adds new element(s) to the existing list
- Parameters:
useContext
- The context that the content is intended to support- Returns:
- A reference to this Builder instance
-
useContext
public Questionnaire.Builder useContext(Collection<UsageContext> useContext)
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
useContext
- The context that the content is intended to support- Returns:
- A reference to this Builder instance
-
jurisdiction
public Questionnaire.Builder jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the questionnaire is intended to be used.Adds new element(s) to the existing list
- Parameters:
jurisdiction
- Intended jurisdiction for questionnaire (if applicable)- Returns:
- A reference to this Builder instance
-
jurisdiction
public Questionnaire.Builder jurisdiction(Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the questionnaire is intended to be used.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
jurisdiction
- Intended jurisdiction for questionnaire (if applicable)- Returns:
- A reference to this Builder instance
-
purpose
public Questionnaire.Builder purpose(Markdown purpose)
Explanation of why this questionnaire is needed and why it has been designed as it has.- Parameters:
purpose
- Why this questionnaire is defined- Returns:
- A reference to this Builder instance
-
copyright
public Questionnaire.Builder copyright(Markdown copyright)
A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.- Parameters:
copyright
- Use and/or publishing restrictions- Returns:
- A reference to this Builder instance
-
approvalDate
public Questionnaire.Builder approvalDate(Date approvalDate)
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.- Parameters:
approvalDate
- When the questionnaire was approved by publisher- Returns:
- A reference to this Builder instance
-
lastReviewDate
public Questionnaire.Builder lastReviewDate(Date lastReviewDate)
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.- Parameters:
lastReviewDate
- When the questionnaire was last reviewed- Returns:
- A reference to this Builder instance
-
effectivePeriod
public Questionnaire.Builder effectivePeriod(Period effectivePeriod)
The period during which the questionnaire content was or is planned to be in active use.- Parameters:
effectivePeriod
- When the questionnaire is expected to be used- Returns:
- A reference to this Builder instance
-
code
public Questionnaire.Builder code(Coding... code)
An identifier for this question or group of questions in a particular terminology such as LOINC.Adds new element(s) to the existing list
- Parameters:
code
- Concept that represents the overall questionnaire- Returns:
- A reference to this Builder instance
-
code
public Questionnaire.Builder code(Collection<Coding> code)
An identifier for this question or group of questions in a particular terminology such as LOINC.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
code
- Concept that represents the overall questionnaire- Returns:
- A reference to this Builder instance
-
item
public Questionnaire.Builder item(Questionnaire.Item... item)
A particular question, question grouping or display text that is part of the questionnaire.Adds new element(s) to the existing list
- Parameters:
item
- Questions and sections within the Questionnaire- Returns:
- A reference to this Builder instance
-
item
public Questionnaire.Builder item(Collection<Questionnaire.Item> item)
A particular question, question grouping or display text that is part of the questionnaire.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
item
- Questions and sections within the Questionnaire- Returns:
- A reference to this Builder instance
-
build
public Questionnaire build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
Questionnaire
- Throws:
IllegalStateException
- if the current state cannot be built into a valid Questionnaire per the base specification
-
validate
protected void validate(Questionnaire questionnaire)
-
from
protected Questionnaire.Builder from(Questionnaire questionnaire)
-
-