Class EffectEvidenceSynthesis.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.EffectEvidenceSynthesis.Builder
-
- Enclosing class:
- EffectEvidenceSynthesis
public static class EffectEvidenceSynthesis.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 EffectEvidenceSynthesis.Builder
approvalDate(Date approvalDate)
The date on which the resource content was approved by the publisher.EffectEvidenceSynthesis.Builder
approvalDate(LocalDate approvalDate)
Convenience method for settingapprovalDate
.EffectEvidenceSynthesis.Builder
author(ContactDetail... author)
An individiual or organization primarily involved in the creation and maintenance of the content.EffectEvidenceSynthesis.Builder
author(Collection<ContactDetail> author)
An individiual or organization primarily involved in the creation and maintenance of the content.EffectEvidenceSynthesis
build()
Build theEffectEvidenceSynthesis
EffectEvidenceSynthesis.Builder
certainty(EffectEvidenceSynthesis.Certainty... certainty)
A description of the certainty of the effect estimate.EffectEvidenceSynthesis.Builder
certainty(Collection<EffectEvidenceSynthesis.Certainty> certainty)
A description of the certainty of the effect estimate.EffectEvidenceSynthesis.Builder
contact(ContactDetail... contact)
Contact details to assist a user in finding and communicating with the publisher.EffectEvidenceSynthesis.Builder
contact(Collection<ContactDetail> contact)
Contact details to assist a user in finding and communicating with the publisher.EffectEvidenceSynthesis.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.EffectEvidenceSynthesis.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.EffectEvidenceSynthesis.Builder
copyright(Markdown copyright)
A copyright statement relating to the effect evidence synthesis and/or its contents.EffectEvidenceSynthesis.Builder
date(DateTime date)
The date (and optionally time) when the effect evidence synthesis was published.EffectEvidenceSynthesis.Builder
description(Markdown description)
A free text natural language description of the effect evidence synthesis from a consumer's perspective.EffectEvidenceSynthesis.Builder
editor(ContactDetail... editor)
An individual or organization primarily responsible for internal coherence of the content.EffectEvidenceSynthesis.Builder
editor(Collection<ContactDetail> editor)
An individual or organization primarily responsible for internal coherence of the content.EffectEvidenceSynthesis.Builder
effectEstimate(EffectEvidenceSynthesis.EffectEstimate... effectEstimate)
The estimated effect of the exposure variant.EffectEvidenceSynthesis.Builder
effectEstimate(Collection<EffectEvidenceSynthesis.EffectEstimate> effectEstimate)
The estimated effect of the exposure variant.EffectEvidenceSynthesis.Builder
effectivePeriod(Period effectivePeriod)
The period during which the effect evidence synthesis content was or is planned to be in active use.EffectEvidenceSynthesis.Builder
endorser(ContactDetail... endorser)
An individual or organization responsible for officially endorsing the content for use in some setting.EffectEvidenceSynthesis.Builder
endorser(Collection<ContactDetail> endorser)
An individual or organization responsible for officially endorsing the content for use in some setting.EffectEvidenceSynthesis.Builder
exposure(Reference exposure)
A reference to a EvidenceVariable resource that defines the exposure for the research.EffectEvidenceSynthesis.Builder
exposureAlternative(Reference exposureAlternative)
A reference to a EvidenceVariable resource that defines the comparison exposure for the research.EffectEvidenceSynthesis.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.EffectEvidenceSynthesis.Builder
extension(Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected EffectEvidenceSynthesis.Builder
from(EffectEvidenceSynthesis effectEvidenceSynthesis)
EffectEvidenceSynthesis.Builder
id(String id)
The logical id of the resource, as used in the URL for the resource.EffectEvidenceSynthesis.Builder
identifier(Identifier... identifier)
A formal identifier that is used to identify this effect evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.EffectEvidenceSynthesis.Builder
identifier(Collection<Identifier> identifier)
A formal identifier that is used to identify this effect evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.EffectEvidenceSynthesis.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.EffectEvidenceSynthesis.Builder
jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the effect evidence synthesis is intended to be used.EffectEvidenceSynthesis.Builder
jurisdiction(Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the effect evidence synthesis is intended to be used.EffectEvidenceSynthesis.Builder
language(Code language)
The base language in which the resource is written.EffectEvidenceSynthesis.Builder
lastReviewDate(Date lastReviewDate)
The date on which the resource content was last reviewed.EffectEvidenceSynthesis.Builder
lastReviewDate(LocalDate lastReviewDate)
Convenience method for settinglastReviewDate
.EffectEvidenceSynthesis.Builder
meta(Meta meta)
The metadata about the resource.EffectEvidenceSynthesis.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.EffectEvidenceSynthesis.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.EffectEvidenceSynthesis.Builder
name(String name)
A natural language name identifying the effect evidence synthesis.EffectEvidenceSynthesis.Builder
name(String name)
Convenience method for settingname
.EffectEvidenceSynthesis.Builder
note(Annotation... note)
A human-readable string to clarify or explain concepts about the resource.EffectEvidenceSynthesis.Builder
note(Collection<Annotation> note)
A human-readable string to clarify or explain concepts about the resource.EffectEvidenceSynthesis.Builder
outcome(Reference outcome)
A reference to a EvidenceVariable resomece that defines the outcome for the research.EffectEvidenceSynthesis.Builder
population(Reference population)
A reference to a EvidenceVariable resource that defines the population for the research.EffectEvidenceSynthesis.Builder
publisher(String publisher)
The name of the organization or individual that published the effect evidence synthesis.EffectEvidenceSynthesis.Builder
publisher(String publisher)
Convenience method for settingpublisher
.EffectEvidenceSynthesis.Builder
relatedArtifact(RelatedArtifact... relatedArtifact)
Related artifacts such as additional documentation, justification, or bibliographic references.EffectEvidenceSynthesis.Builder
relatedArtifact(Collection<RelatedArtifact> relatedArtifact)
Related artifacts such as additional documentation, justification, or bibliographic references.EffectEvidenceSynthesis.Builder
resultsByExposure(EffectEvidenceSynthesis.ResultsByExposure... resultsByExposure)
A description of the results for each exposure considered in the effect estimate.EffectEvidenceSynthesis.Builder
resultsByExposure(Collection<EffectEvidenceSynthesis.ResultsByExposure> resultsByExposure)
A description of the results for each exposure considered in the effect estimate.EffectEvidenceSynthesis.Builder
reviewer(ContactDetail... reviewer)
An individual or organization primarily responsible for review of some aspect of the content.EffectEvidenceSynthesis.Builder
reviewer(Collection<ContactDetail> reviewer)
An individual or organization primarily responsible for review of some aspect of the content.EffectEvidenceSynthesis.Builder
sampleSize(EffectEvidenceSynthesis.SampleSize sampleSize)
A description of the size of the sample involved in the synthesis.EffectEvidenceSynthesis.Builder
status(PublicationStatus status)
The status of this effect evidence synthesis.EffectEvidenceSynthesis.Builder
studyType(CodeableConcept studyType)
Type of study eg randomized trial.EffectEvidenceSynthesis.Builder
synthesisType(CodeableConcept synthesisType)
Type of synthesis eg meta-analysis.EffectEvidenceSynthesis.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.EffectEvidenceSynthesis.Builder
title(String title)
A short, descriptive, user-friendly title for the effect evidence synthesis.EffectEvidenceSynthesis.Builder
title(String title)
Convenience method for settingtitle
.EffectEvidenceSynthesis.Builder
topic(CodeableConcept... topic)
Descriptive topics related to the content of the EffectEvidenceSynthesis.EffectEvidenceSynthesis.Builder
topic(Collection<CodeableConcept> topic)
Descriptive topics related to the content of the EffectEvidenceSynthesis.EffectEvidenceSynthesis.Builder
url(Uri url)
An absolute URI that is used to identify this effect evidence synthesis when it is referenced in a specification, model, design or an instance; also called its canonical identifier.EffectEvidenceSynthesis.Builder
useContext(UsageContext... useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.EffectEvidenceSynthesis.Builder
useContext(Collection<UsageContext> useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.protected void
validate(EffectEvidenceSynthesis effectEvidenceSynthesis)
EffectEvidenceSynthesis.Builder
version(String version)
The identifier that is used to identify this version of the effect evidence synthesis when it is referenced in a specification, model, design or instance.EffectEvidenceSynthesis.Builder
version(String version)
Convenience method for settingversion
.-
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 EffectEvidenceSynthesis.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 EffectEvidenceSynthesis.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 EffectEvidenceSynthesis.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 EffectEvidenceSynthesis.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 EffectEvidenceSynthesis.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 EffectEvidenceSynthesis.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 EffectEvidenceSynthesis.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. 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:
NullPointerException
- If the passed collection is null
-
extension
public EffectEvidenceSynthesis.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 EffectEvidenceSynthesis.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. 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:
NullPointerException
- If the passed collection is null
-
modifierExtension
public EffectEvidenceSynthesis.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 EffectEvidenceSynthesis.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. 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:
NullPointerException
- If the passed collection is null
-
url
public EffectEvidenceSynthesis.Builder url(Uri url)
An absolute URI that is used to identify this effect evidence synthesis 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 effect evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the effect evidence synthesis is stored on different servers.- Parameters:
url
- Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique)- Returns:
- A reference to this Builder instance
-
identifier
public EffectEvidenceSynthesis.Builder identifier(Identifier... identifier)
A formal identifier that is used to identify this effect evidence synthesis 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. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Additional identifier for the effect evidence synthesis- Returns:
- A reference to this Builder instance
-
identifier
public EffectEvidenceSynthesis.Builder identifier(Collection<Identifier> identifier)
A formal identifier that is used to identify this effect evidence synthesis 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. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Additional identifier for the effect evidence synthesis- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
version
public EffectEvidenceSynthesis.Builder version(String version)
Convenience method for settingversion
.- Parameters:
version
- Business version of the effect evidence synthesis- Returns:
- A reference to this Builder instance
- See Also:
version(com.ibm.fhir.model.type.String)
-
version
public EffectEvidenceSynthesis.Builder version(String version)
The identifier that is used to identify this version of the effect evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the effect evidence synthesis 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 effect evidence synthesis- Returns:
- A reference to this Builder instance
-
name
public EffectEvidenceSynthesis.Builder name(String name)
Convenience method for settingname
.- Parameters:
name
- Name for this effect evidence synthesis (computer friendly)- Returns:
- A reference to this Builder instance
- See Also:
name(com.ibm.fhir.model.type.String)
-
name
public EffectEvidenceSynthesis.Builder name(String name)
A natural language name identifying the effect evidence synthesis. This name should be usable as an identifier for the module by machine processing applications such as code generation.- Parameters:
name
- Name for this effect evidence synthesis (computer friendly)- Returns:
- A reference to this Builder instance
-
title
public EffectEvidenceSynthesis.Builder title(String title)
Convenience method for settingtitle
.- Parameters:
title
- Name for this effect evidence synthesis (human friendly)- Returns:
- A reference to this Builder instance
- See Also:
title(com.ibm.fhir.model.type.String)
-
title
public EffectEvidenceSynthesis.Builder title(String title)
A short, descriptive, user-friendly title for the effect evidence synthesis.- Parameters:
title
- Name for this effect evidence synthesis (human friendly)- Returns:
- A reference to this Builder instance
-
status
public EffectEvidenceSynthesis.Builder status(PublicationStatus status)
The status of this effect evidence synthesis. 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
-
date
public EffectEvidenceSynthesis.Builder date(DateTime date)
The date (and optionally time) when the effect evidence synthesis 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 effect evidence synthesis changes.- Parameters:
date
- Date last changed- Returns:
- A reference to this Builder instance
-
publisher
public EffectEvidenceSynthesis.Builder publisher(String publisher)
Convenience method for settingpublisher
.- Parameters:
publisher
- Name of the publisher (organization or individual)- Returns:
- A reference to this Builder instance
- See Also:
publisher(com.ibm.fhir.model.type.String)
-
publisher
public EffectEvidenceSynthesis.Builder publisher(String publisher)
The name of the organization or individual that published the effect evidence synthesis.- Parameters:
publisher
- Name of the publisher (organization or individual)- Returns:
- A reference to this Builder instance
-
contact
public EffectEvidenceSynthesis.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. If any of the elements are null, calling
build()
will fail.- Parameters:
contact
- Contact details for the publisher- Returns:
- A reference to this Builder instance
-
contact
public EffectEvidenceSynthesis.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. If any of the elements are null, calling
build()
will fail.- Parameters:
contact
- Contact details for the publisher- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
description
public EffectEvidenceSynthesis.Builder description(Markdown description)
A free text natural language description of the effect evidence synthesis from a consumer's perspective.- Parameters:
description
- Natural language description of the effect evidence synthesis- Returns:
- A reference to this Builder instance
-
note
public EffectEvidenceSynthesis.Builder note(Annotation... note)
A human-readable string to clarify or explain concepts about the resource.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
note
- Used for footnotes or explanatory notes- Returns:
- A reference to this Builder instance
-
note
public EffectEvidenceSynthesis.Builder note(Collection<Annotation> note)
A human-readable string to clarify or explain concepts about the resource.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:
note
- Used for footnotes or explanatory notes- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
useContext
public EffectEvidenceSynthesis.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 effect evidence synthesis instances.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
useContext
- The context that the content is intended to support- Returns:
- A reference to this Builder instance
-
useContext
public EffectEvidenceSynthesis.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 effect evidence synthesis instances.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:
useContext
- The context that the content is intended to support- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
jurisdiction
public EffectEvidenceSynthesis.Builder jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the effect evidence synthesis is intended to be used.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
jurisdiction
- Intended jurisdiction for effect evidence synthesis (if applicable)- Returns:
- A reference to this Builder instance
-
jurisdiction
public EffectEvidenceSynthesis.Builder jurisdiction(Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the effect evidence synthesis is intended to be used.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:
jurisdiction
- Intended jurisdiction for effect evidence synthesis (if applicable)- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
copyright
public EffectEvidenceSynthesis.Builder copyright(Markdown copyright)
A copyright statement relating to the effect evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the effect evidence synthesis.- Parameters:
copyright
- Use and/or publishing restrictions- Returns:
- A reference to this Builder instance
-
approvalDate
public EffectEvidenceSynthesis.Builder approvalDate(LocalDate approvalDate)
Convenience method for settingapprovalDate
.- Parameters:
approvalDate
- When the effect evidence synthesis was approved by publisher- Returns:
- A reference to this Builder instance
- See Also:
approvalDate(com.ibm.fhir.model.type.Date)
-
approvalDate
public EffectEvidenceSynthesis.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 effect evidence synthesis was approved by publisher- Returns:
- A reference to this Builder instance
-
lastReviewDate
public EffectEvidenceSynthesis.Builder lastReviewDate(LocalDate lastReviewDate)
Convenience method for settinglastReviewDate
.- Parameters:
lastReviewDate
- When the effect evidence synthesis was last reviewed- Returns:
- A reference to this Builder instance
- See Also:
lastReviewDate(com.ibm.fhir.model.type.Date)
-
lastReviewDate
public EffectEvidenceSynthesis.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 effect evidence synthesis was last reviewed- Returns:
- A reference to this Builder instance
-
effectivePeriod
public EffectEvidenceSynthesis.Builder effectivePeriod(Period effectivePeriod)
The period during which the effect evidence synthesis content was or is planned to be in active use.- Parameters:
effectivePeriod
- When the effect evidence synthesis is expected to be used- Returns:
- A reference to this Builder instance
-
topic
public EffectEvidenceSynthesis.Builder topic(CodeableConcept... topic)
Descriptive topics related to the content of the EffectEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
topic
- The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc.- Returns:
- A reference to this Builder instance
-
topic
public EffectEvidenceSynthesis.Builder topic(Collection<CodeableConcept> topic)
Descriptive topics related to the content of the EffectEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.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:
topic
- The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc.- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
author
public EffectEvidenceSynthesis.Builder author(ContactDetail... author)
An individiual or organization primarily involved in the creation and maintenance of the content.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
author
- Who authored the content- Returns:
- A reference to this Builder instance
-
author
public EffectEvidenceSynthesis.Builder author(Collection<ContactDetail> author)
An individiual or organization primarily involved in the creation and maintenance of the content.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:
author
- Who authored the content- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
editor
public EffectEvidenceSynthesis.Builder editor(ContactDetail... editor)
An individual or organization primarily responsible for internal coherence of the content.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
editor
- Who edited the content- Returns:
- A reference to this Builder instance
-
editor
public EffectEvidenceSynthesis.Builder editor(Collection<ContactDetail> editor)
An individual or organization primarily responsible for internal coherence of the content.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:
editor
- Who edited the content- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
reviewer
public EffectEvidenceSynthesis.Builder reviewer(ContactDetail... reviewer)
An individual or organization primarily responsible for review of some aspect of the content.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
reviewer
- Who reviewed the content- Returns:
- A reference to this Builder instance
-
reviewer
public EffectEvidenceSynthesis.Builder reviewer(Collection<ContactDetail> reviewer)
An individual or organization primarily responsible for review of some aspect of the content.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:
reviewer
- Who reviewed the content- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
endorser
public EffectEvidenceSynthesis.Builder endorser(ContactDetail... endorser)
An individual or organization responsible for officially endorsing the content for use in some setting.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
endorser
- Who endorsed the content- Returns:
- A reference to this Builder instance
-
endorser
public EffectEvidenceSynthesis.Builder endorser(Collection<ContactDetail> endorser)
An individual or organization responsible for officially endorsing the content for use in some setting.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:
endorser
- Who endorsed the content- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
relatedArtifact
public EffectEvidenceSynthesis.Builder relatedArtifact(RelatedArtifact... relatedArtifact)
Related artifacts such as additional documentation, justification, or bibliographic references.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
relatedArtifact
- Additional documentation, citations, etc.- Returns:
- A reference to this Builder instance
-
relatedArtifact
public EffectEvidenceSynthesis.Builder relatedArtifact(Collection<RelatedArtifact> relatedArtifact)
Related artifacts such as additional documentation, justification, or bibliographic references.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:
relatedArtifact
- Additional documentation, citations, etc.- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
synthesisType
public EffectEvidenceSynthesis.Builder synthesisType(CodeableConcept synthesisType)
Type of synthesis eg meta-analysis.- Parameters:
synthesisType
- Type of synthesis- Returns:
- A reference to this Builder instance
-
studyType
public EffectEvidenceSynthesis.Builder studyType(CodeableConcept studyType)
Type of study eg randomized trial.- Parameters:
studyType
- Type of study- Returns:
- A reference to this Builder instance
-
population
public EffectEvidenceSynthesis.Builder population(Reference population)
A reference to a EvidenceVariable resource that defines the population for the research.This element is required.
Allowed resource types for this reference:
- Parameters:
population
- What population?- Returns:
- A reference to this Builder instance
-
exposure
public EffectEvidenceSynthesis.Builder exposure(Reference exposure)
A reference to a EvidenceVariable resource that defines the exposure for the research.This element is required.
Allowed resource types for this reference:
- Parameters:
exposure
- What exposure?- Returns:
- A reference to this Builder instance
-
exposureAlternative
public EffectEvidenceSynthesis.Builder exposureAlternative(Reference exposureAlternative)
A reference to a EvidenceVariable resource that defines the comparison exposure for the research.This element is required.
Allowed resource types for this reference:
- Parameters:
exposureAlternative
- What comparison exposure?- Returns:
- A reference to this Builder instance
-
outcome
public EffectEvidenceSynthesis.Builder outcome(Reference outcome)
A reference to a EvidenceVariable resomece that defines the outcome for the research.This element is required.
Allowed resource types for this reference:
- Parameters:
outcome
- What outcome?- Returns:
- A reference to this Builder instance
-
sampleSize
public EffectEvidenceSynthesis.Builder sampleSize(EffectEvidenceSynthesis.SampleSize sampleSize)
A description of the size of the sample involved in the synthesis.- Parameters:
sampleSize
- What sample size was involved?- Returns:
- A reference to this Builder instance
-
resultsByExposure
public EffectEvidenceSynthesis.Builder resultsByExposure(EffectEvidenceSynthesis.ResultsByExposure... resultsByExposure)
A description of the results for each exposure considered in the effect estimate.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
resultsByExposure
- What was the result per exposure?- Returns:
- A reference to this Builder instance
-
resultsByExposure
public EffectEvidenceSynthesis.Builder resultsByExposure(Collection<EffectEvidenceSynthesis.ResultsByExposure> resultsByExposure)
A description of the results for each exposure considered in the effect estimate.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:
resultsByExposure
- What was the result per exposure?- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
effectEstimate
public EffectEvidenceSynthesis.Builder effectEstimate(EffectEvidenceSynthesis.EffectEstimate... effectEstimate)
The estimated effect of the exposure variant.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
effectEstimate
- What was the estimated effect- Returns:
- A reference to this Builder instance
-
effectEstimate
public EffectEvidenceSynthesis.Builder effectEstimate(Collection<EffectEvidenceSynthesis.EffectEstimate> effectEstimate)
The estimated effect of the exposure variant.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:
effectEstimate
- What was the estimated effect- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
certainty
public EffectEvidenceSynthesis.Builder certainty(EffectEvidenceSynthesis.Certainty... certainty)
A description of the certainty of the effect estimate.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
certainty
- How certain is the effect- Returns:
- A reference to this Builder instance
-
certainty
public EffectEvidenceSynthesis.Builder certainty(Collection<EffectEvidenceSynthesis.Certainty> certainty)
A description of the certainty of the effect estimate.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:
certainty
- How certain is the effect- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
build
public EffectEvidenceSynthesis build()
Build theEffectEvidenceSynthesis
Required elements:
- status
- population
- exposure
- exposureAlternative
- outcome
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
EffectEvidenceSynthesis
- Throws:
IllegalStateException
- if the current state cannot be built into a valid EffectEvidenceSynthesis per the base specification
-
validate
protected void validate(EffectEvidenceSynthesis effectEvidenceSynthesis)
-
from
protected EffectEvidenceSynthesis.Builder from(EffectEvidenceSynthesis effectEvidenceSynthesis)
-
-