Class PlanDefinition.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.PlanDefinition.Builder
-
- Enclosing class:
- PlanDefinition
public static class PlanDefinition.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 PlanDefinition.Builder
action(java.util.Collection<PlanDefinition.Action> action)
An action or group of actions to be taken as part of the plan.PlanDefinition.Builder
action(PlanDefinition.Action... action)
An action or group of actions to be taken as part of the plan.PlanDefinition.Builder
approvalDate(java.time.LocalDate approvalDate)
Convenience method for settingapprovalDate
.PlanDefinition.Builder
approvalDate(Date approvalDate)
The date on which the resource content was approved by the publisher.PlanDefinition.Builder
author(java.util.Collection<ContactDetail> author)
An individiual or organization primarily involved in the creation and maintenance of the content.PlanDefinition.Builder
author(ContactDetail... author)
An individiual or organization primarily involved in the creation and maintenance of the content.PlanDefinition
build()
Build thePlanDefinition
PlanDefinition.Builder
contact(java.util.Collection<ContactDetail> contact)
Contact details to assist a user in finding and communicating with the publisher.PlanDefinition.Builder
contact(ContactDetail... contact)
Contact details to assist a user in finding and communicating with the publisher.PlanDefinition.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.PlanDefinition.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.PlanDefinition.Builder
copyright(Markdown copyright)
A copyright statement relating to the plan definition and/or its contents.PlanDefinition.Builder
date(DateTime date)
The date (and optionally time) when the plan definition was published.PlanDefinition.Builder
description(Markdown description)
A free text natural language description of the plan definition from a consumer's perspective.PlanDefinition.Builder
editor(java.util.Collection<ContactDetail> editor)
An individual or organization primarily responsible for internal coherence of the content.PlanDefinition.Builder
editor(ContactDetail... editor)
An individual or organization primarily responsible for internal coherence of the content.PlanDefinition.Builder
effectivePeriod(Period effectivePeriod)
The period during which the plan definition content was or is planned to be in active use.PlanDefinition.Builder
endorser(java.util.Collection<ContactDetail> endorser)
An individual or organization responsible for officially endorsing the content for use in some setting.PlanDefinition.Builder
endorser(ContactDetail... endorser)
An individual or organization responsible for officially endorsing the content for use in some setting.PlanDefinition.Builder
experimental(java.lang.Boolean experimental)
Convenience method for settingexperimental
.PlanDefinition.Builder
experimental(Boolean experimental)
A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.PlanDefinition.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.PlanDefinition.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected PlanDefinition.Builder
from(PlanDefinition planDefinition)
PlanDefinition.Builder
goal(java.util.Collection<PlanDefinition.Goal> goal)
A goal describes an expected outcome that activities within the plan are intended to achieve.PlanDefinition.Builder
goal(PlanDefinition.Goal... goal)
A goal describes an expected outcome that activities within the plan are intended to achieve.PlanDefinition.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.PlanDefinition.Builder
identifier(java.util.Collection<Identifier> identifier)
A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.PlanDefinition.Builder
identifier(Identifier... identifier)
A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.PlanDefinition.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.PlanDefinition.Builder
jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the plan definition is intended to be used.PlanDefinition.Builder
jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the plan definition is intended to be used.PlanDefinition.Builder
language(Code language)
The base language in which the resource is written.PlanDefinition.Builder
lastReviewDate(java.time.LocalDate lastReviewDate)
Convenience method for settinglastReviewDate
.PlanDefinition.Builder
lastReviewDate(Date lastReviewDate)
The date on which the resource content was last reviewed.PlanDefinition.Builder
library(java.util.Collection<Canonical> library)
A reference to a Library resource containing any formal logic used by the plan definition.PlanDefinition.Builder
library(Canonical... library)
A reference to a Library resource containing any formal logic used by the plan definition.PlanDefinition.Builder
meta(Meta meta)
The metadata about the resource.PlanDefinition.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.PlanDefinition.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.PlanDefinition.Builder
name(java.lang.String name)
Convenience method for settingname
.PlanDefinition.Builder
name(String name)
A natural language name identifying the plan definition.PlanDefinition.Builder
publisher(java.lang.String publisher)
Convenience method for settingpublisher
.PlanDefinition.Builder
publisher(String publisher)
The name of the organization or individual that published the plan definition.PlanDefinition.Builder
purpose(Markdown purpose)
Explanation of why this plan definition is needed and why it has been designed as it has.PlanDefinition.Builder
relatedArtifact(java.util.Collection<RelatedArtifact> relatedArtifact)
Related artifacts such as additional documentation, justification, or bibliographic references.PlanDefinition.Builder
relatedArtifact(RelatedArtifact... relatedArtifact)
Related artifacts such as additional documentation, justification, or bibliographic references.PlanDefinition.Builder
reviewer(java.util.Collection<ContactDetail> reviewer)
An individual or organization primarily responsible for review of some aspect of the content.PlanDefinition.Builder
reviewer(ContactDetail... reviewer)
An individual or organization primarily responsible for review of some aspect of the content.PlanDefinition.Builder
status(PublicationStatus status)
The status of this plan definition.PlanDefinition.Builder
subject(Element subject)
A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition.PlanDefinition.Builder
subtitle(java.lang.String subtitle)
Convenience method for settingsubtitle
.PlanDefinition.Builder
subtitle(String subtitle)
An explanatory or alternate title for the plan definition giving additional information about its content.PlanDefinition.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.PlanDefinition.Builder
title(java.lang.String title)
Convenience method for settingtitle
.PlanDefinition.Builder
title(String title)
A short, descriptive, user-friendly title for the plan definition.PlanDefinition.Builder
topic(java.util.Collection<CodeableConcept> topic)
Descriptive topics related to the content of the plan definition.PlanDefinition.Builder
topic(CodeableConcept... topic)
Descriptive topics related to the content of the plan definition.PlanDefinition.Builder
type(CodeableConcept type)
A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.PlanDefinition.Builder
url(Uri url)
An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier.PlanDefinition.Builder
usage(java.lang.String usage)
Convenience method for settingusage
.PlanDefinition.Builder
usage(String usage)
A detailed description of how the plan definition is used from a clinical perspective.PlanDefinition.Builder
useContext(java.util.Collection<UsageContext> useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.PlanDefinition.Builder
useContext(UsageContext... useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.protected void
validate(PlanDefinition planDefinition)
PlanDefinition.Builder
version(java.lang.String version)
Convenience method for settingversion
.PlanDefinition.Builder
version(String version)
The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance.-
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 PlanDefinition.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 PlanDefinition.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 PlanDefinition.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 PlanDefinition.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 PlanDefinition.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 PlanDefinition.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 PlanDefinition.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 PlanDefinition.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 PlanDefinition.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 PlanDefinition.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 PlanDefinition.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
-
url
public PlanDefinition.Builder url(Uri url)
An absolute URI that is used to identify this plan definition 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 plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.- Parameters:
url
- Canonical identifier for this plan definition, represented as a URI (globally unique)- Returns:
- A reference to this Builder instance
-
identifier
public PlanDefinition.Builder identifier(Identifier... identifier)
A formal identifier that is used to identify this plan definition 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 plan definition- Returns:
- A reference to this Builder instance
-
identifier
public PlanDefinition.Builder identifier(java.util.Collection<Identifier> identifier)
A formal identifier that is used to identify this plan definition 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 plan definition- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
version
public PlanDefinition.Builder version(java.lang.String version)
Convenience method for settingversion
.- Parameters:
version
- Business version of the plan definition- Returns:
- A reference to this Builder instance
- See Also:
version(org.linuxforhealth.fhir.model.type.String)
-
version
public PlanDefinition.Builder version(String version)
The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.- Parameters:
version
- Business version of the plan definition- Returns:
- A reference to this Builder instance
-
name
public PlanDefinition.Builder name(java.lang.String name)
Convenience method for settingname
.- Parameters:
name
- Name for this plan definition (computer friendly)- Returns:
- A reference to this Builder instance
- See Also:
name(org.linuxforhealth.fhir.model.type.String)
-
name
public PlanDefinition.Builder name(String name)
A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.- Parameters:
name
- Name for this plan definition (computer friendly)- Returns:
- A reference to this Builder instance
-
title
public PlanDefinition.Builder title(java.lang.String title)
Convenience method for settingtitle
.- Parameters:
title
- Name for this plan definition (human friendly)- Returns:
- A reference to this Builder instance
- See Also:
title(org.linuxforhealth.fhir.model.type.String)
-
title
public PlanDefinition.Builder title(String title)
A short, descriptive, user-friendly title for the plan definition.- Parameters:
title
- Name for this plan definition (human friendly)- Returns:
- A reference to this Builder instance
-
subtitle
public PlanDefinition.Builder subtitle(java.lang.String subtitle)
Convenience method for settingsubtitle
.- Parameters:
subtitle
- Subordinate title of the plan definition- Returns:
- A reference to this Builder instance
- See Also:
subtitle(org.linuxforhealth.fhir.model.type.String)
-
subtitle
public PlanDefinition.Builder subtitle(String subtitle)
An explanatory or alternate title for the plan definition giving additional information about its content.- Parameters:
subtitle
- Subordinate title of the plan definition- Returns:
- A reference to this Builder instance
-
type
public PlanDefinition.Builder type(CodeableConcept type)
A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.- Parameters:
type
- order-set | clinical-protocol | eca-rule | workflow-definition- Returns:
- A reference to this Builder instance
-
status
public PlanDefinition.Builder status(PublicationStatus status)
The status of this plan definition. 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 PlanDefinition.Builder experimental(java.lang.Boolean experimental)
Convenience method for settingexperimental
.- Parameters:
experimental
- For testing purposes, not real usage- Returns:
- A reference to this Builder instance
- See Also:
experimental(org.linuxforhealth.fhir.model.type.Boolean)
-
experimental
public PlanDefinition.Builder experimental(Boolean experimental)
A Boolean value to indicate that this plan definition 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
-
subject
public PlanDefinition.Builder subject(Element subject)
A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.This is a choice element with the following allowed types:
When of typeReference
, the allowed resource types for this reference are:- Parameters:
subject
- Type of individual the plan definition is focused on- Returns:
- A reference to this Builder instance
-
date
public PlanDefinition.Builder date(DateTime date)
The date (and optionally time) when the plan definition 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 plan definition changes.- Parameters:
date
- Date last changed- Returns:
- A reference to this Builder instance
-
publisher
public PlanDefinition.Builder publisher(java.lang.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(org.linuxforhealth.fhir.model.type.String)
-
publisher
public PlanDefinition.Builder publisher(String publisher)
The name of the organization or individual that published the plan definition.- Parameters:
publisher
- Name of the publisher (organization or individual)- Returns:
- A reference to this Builder instance
-
contact
public PlanDefinition.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 PlanDefinition.Builder contact(java.util.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:
java.lang.NullPointerException
- If the passed collection is null
-
description
public PlanDefinition.Builder description(Markdown description)
A free text natural language description of the plan definition from a consumer's perspective.- Parameters:
description
- Natural language description of the plan definition- Returns:
- A reference to this Builder instance
-
useContext
public PlanDefinition.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 plan definition 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 PlanDefinition.Builder useContext(java.util.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 plan definition 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:
java.lang.NullPointerException
- If the passed collection is null
-
jurisdiction
public PlanDefinition.Builder jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the plan definition 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 plan definition (if applicable)- Returns:
- A reference to this Builder instance
-
jurisdiction
public PlanDefinition.Builder jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the plan definition 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 plan definition (if applicable)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
purpose
public PlanDefinition.Builder purpose(Markdown purpose)
Explanation of why this plan definition is needed and why it has been designed as it has.- Parameters:
purpose
- Why this plan definition is defined- Returns:
- A reference to this Builder instance
-
usage
public PlanDefinition.Builder usage(java.lang.String usage)
Convenience method for settingusage
.- Parameters:
usage
- Describes the clinical usage of the plan- Returns:
- A reference to this Builder instance
- See Also:
usage(org.linuxforhealth.fhir.model.type.String)
-
usage
public PlanDefinition.Builder usage(String usage)
A detailed description of how the plan definition is used from a clinical perspective.- Parameters:
usage
- Describes the clinical usage of the plan- Returns:
- A reference to this Builder instance
-
copyright
public PlanDefinition.Builder copyright(Markdown copyright)
A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.- Parameters:
copyright
- Use and/or publishing restrictions- Returns:
- A reference to this Builder instance
-
approvalDate
public PlanDefinition.Builder approvalDate(java.time.LocalDate approvalDate)
Convenience method for settingapprovalDate
.- Parameters:
approvalDate
- When the plan definition was approved by publisher- Returns:
- A reference to this Builder instance
- See Also:
approvalDate(org.linuxforhealth.fhir.model.type.Date)
-
approvalDate
public PlanDefinition.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 plan definition was approved by publisher- Returns:
- A reference to this Builder instance
-
lastReviewDate
public PlanDefinition.Builder lastReviewDate(java.time.LocalDate lastReviewDate)
Convenience method for settinglastReviewDate
.- Parameters:
lastReviewDate
- When the plan definition was last reviewed- Returns:
- A reference to this Builder instance
- See Also:
lastReviewDate(org.linuxforhealth.fhir.model.type.Date)
-
lastReviewDate
public PlanDefinition.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 plan definition was last reviewed- Returns:
- A reference to this Builder instance
-
effectivePeriod
public PlanDefinition.Builder effectivePeriod(Period effectivePeriod)
The period during which the plan definition content was or is planned to be in active use.- Parameters:
effectivePeriod
- When the plan definition is expected to be used- Returns:
- A reference to this Builder instance
-
topic
public PlanDefinition.Builder topic(CodeableConcept... topic)
Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition 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
- E.g. Education, Treatment, Assessment- Returns:
- A reference to this Builder instance
-
topic
public PlanDefinition.Builder topic(java.util.Collection<CodeableConcept> topic)
Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition 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
- E.g. Education, Treatment, Assessment- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
author
public PlanDefinition.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 PlanDefinition.Builder author(java.util.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:
java.lang.NullPointerException
- If the passed collection is null
-
editor
public PlanDefinition.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 PlanDefinition.Builder editor(java.util.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:
java.lang.NullPointerException
- If the passed collection is null
-
reviewer
public PlanDefinition.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 PlanDefinition.Builder reviewer(java.util.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:
java.lang.NullPointerException
- If the passed collection is null
-
endorser
public PlanDefinition.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 PlanDefinition.Builder endorser(java.util.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:
java.lang.NullPointerException
- If the passed collection is null
-
relatedArtifact
public PlanDefinition.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- Returns:
- A reference to this Builder instance
-
relatedArtifact
public PlanDefinition.Builder relatedArtifact(java.util.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- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
library
public PlanDefinition.Builder library(Canonical... library)
A reference to a Library resource containing any formal logic used by the plan definition.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
library
- Logic used by the plan definition- Returns:
- A reference to this Builder instance
-
library
public PlanDefinition.Builder library(java.util.Collection<Canonical> library)
A reference to a Library resource containing any formal logic used by the plan definition.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:
library
- Logic used by the plan definition- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
goal
public PlanDefinition.Builder goal(PlanDefinition.Goal... goal)
A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
goal
- What the plan is trying to accomplish- Returns:
- A reference to this Builder instance
-
goal
public PlanDefinition.Builder goal(java.util.Collection<PlanDefinition.Goal> goal)
A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.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:
goal
- What the plan is trying to accomplish- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
action
public PlanDefinition.Builder action(PlanDefinition.Action... action)
An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
action
- Action defined by the plan- Returns:
- A reference to this Builder instance
-
action
public PlanDefinition.Builder action(java.util.Collection<PlanDefinition.Action> action)
An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.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:
action
- Action defined by the plan- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public PlanDefinition build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
PlanDefinition
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid PlanDefinition per the base specification
-
validate
protected void validate(PlanDefinition planDefinition)
-
from
protected PlanDefinition.Builder from(PlanDefinition planDefinition)
-
-