Class ActivityDefinition.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.ActivityDefinition.Builder
-
- Enclosing class:
- ActivityDefinition
public static class ActivityDefinition.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 ActivityDefinition.Builder
approvalDate(java.time.LocalDate approvalDate)
Convenience method for settingapprovalDate
.ActivityDefinition.Builder
approvalDate(Date approvalDate)
The date on which the resource content was approved by the publisher.ActivityDefinition.Builder
author(java.util.Collection<ContactDetail> author)
An individiual or organization primarily involved in the creation and maintenance of the content.ActivityDefinition.Builder
author(ContactDetail... author)
An individiual or organization primarily involved in the creation and maintenance of the content.ActivityDefinition.Builder
bodySite(java.util.Collection<CodeableConcept> bodySite)
Indicates the sites on the subject's body where the procedure should be performed (I.e.ActivityDefinition.Builder
bodySite(CodeableConcept... bodySite)
Indicates the sites on the subject's body where the procedure should be performed (I.e.ActivityDefinition
build()
Build theActivityDefinition
ActivityDefinition.Builder
code(CodeableConcept code)
Detailed description of the type of activity; e.g.ActivityDefinition.Builder
contact(java.util.Collection<ContactDetail> contact)
Contact details to assist a user in finding and communicating with the publisher.ActivityDefinition.Builder
contact(ContactDetail... contact)
Contact details to assist a user in finding and communicating with the publisher.ActivityDefinition.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.ActivityDefinition.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.ActivityDefinition.Builder
copyright(Markdown copyright)
A copyright statement relating to the activity definition and/or its contents.ActivityDefinition.Builder
date(DateTime date)
The date (and optionally time) when the activity definition was published.ActivityDefinition.Builder
description(Markdown description)
A free text natural language description of the activity definition from a consumer's perspective.ActivityDefinition.Builder
doNotPerform(java.lang.Boolean doNotPerform)
Convenience method for settingdoNotPerform
.ActivityDefinition.Builder
doNotPerform(Boolean doNotPerform)
Set this to true if the definition is to indicate that a particular activity should NOT be performed.ActivityDefinition.Builder
dosage(java.util.Collection<Dosage> dosage)
Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.ActivityDefinition.Builder
dosage(Dosage... dosage)
Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.ActivityDefinition.Builder
dynamicValue(java.util.Collection<ActivityDefinition.DynamicValue> dynamicValue)
Dynamic values that will be evaluated to produce values for elements of the resulting resource.ActivityDefinition.Builder
dynamicValue(ActivityDefinition.DynamicValue... dynamicValue)
Dynamic values that will be evaluated to produce values for elements of the resulting resource.ActivityDefinition.Builder
editor(java.util.Collection<ContactDetail> editor)
An individual or organization primarily responsible for internal coherence of the content.ActivityDefinition.Builder
editor(ContactDetail... editor)
An individual or organization primarily responsible for internal coherence of the content.ActivityDefinition.Builder
effectivePeriod(Period effectivePeriod)
The period during which the activity definition content was or is planned to be in active use.ActivityDefinition.Builder
endorser(java.util.Collection<ContactDetail> endorser)
An individual or organization responsible for officially endorsing the content for use in some setting.ActivityDefinition.Builder
endorser(ContactDetail... endorser)
An individual or organization responsible for officially endorsing the content for use in some setting.ActivityDefinition.Builder
experimental(java.lang.Boolean experimental)
Convenience method for settingexperimental
.ActivityDefinition.Builder
experimental(Boolean experimental)
A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.ActivityDefinition.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.ActivityDefinition.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected ActivityDefinition.Builder
from(ActivityDefinition activityDefinition)
ActivityDefinition.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.ActivityDefinition.Builder
identifier(java.util.Collection<Identifier> identifier)
A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.ActivityDefinition.Builder
identifier(Identifier... identifier)
A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.ActivityDefinition.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.ActivityDefinition.Builder
intent(RequestIntent intent)
Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.ActivityDefinition.Builder
jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the activity definition is intended to be used.ActivityDefinition.Builder
jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the activity definition is intended to be used.ActivityDefinition.Builder
kind(ActivityDefinitionKind kind)
A description of the kind of resource the activity definition is representing.ActivityDefinition.Builder
language(Code language)
The base language in which the resource is written.ActivityDefinition.Builder
lastReviewDate(java.time.LocalDate lastReviewDate)
Convenience method for settinglastReviewDate
.ActivityDefinition.Builder
lastReviewDate(Date lastReviewDate)
The date on which the resource content was last reviewed.ActivityDefinition.Builder
library(java.util.Collection<Canonical> library)
A reference to a Library resource containing any formal logic used by the activity definition.ActivityDefinition.Builder
library(Canonical... library)
A reference to a Library resource containing any formal logic used by the activity definition.ActivityDefinition.Builder
location(Reference location)
Identifies the facility where the activity will occur; e.g.ActivityDefinition.Builder
meta(Meta meta)
The metadata about the resource.ActivityDefinition.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.ActivityDefinition.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.ActivityDefinition.Builder
name(java.lang.String name)
Convenience method for settingname
.ActivityDefinition.Builder
name(String name)
A natural language name identifying the activity definition.ActivityDefinition.Builder
observationRequirement(java.util.Collection<Reference> observationRequirement)
Defines observation requirements for the action to be performed, such as body weight or surface area.ActivityDefinition.Builder
observationRequirement(Reference... observationRequirement)
Defines observation requirements for the action to be performed, such as body weight or surface area.ActivityDefinition.Builder
observationResultRequirement(java.util.Collection<Reference> observationResultRequirement)
Defines the observations that are expected to be produced by the action.ActivityDefinition.Builder
observationResultRequirement(Reference... observationResultRequirement)
Defines the observations that are expected to be produced by the action.ActivityDefinition.Builder
participant(java.util.Collection<ActivityDefinition.Participant> participant)
Indicates who should participate in performing the action described.ActivityDefinition.Builder
participant(ActivityDefinition.Participant... participant)
Indicates who should participate in performing the action described.ActivityDefinition.Builder
priority(RequestPriority priority)
Indicates how quickly the activity should be addressed with respect to other requests.ActivityDefinition.Builder
product(Element product)
Identifies the food, drug or other product being consumed or supplied in the activity.ActivityDefinition.Builder
profile(Canonical profile)
A profile to which the target of the activity definition is expected to conform.ActivityDefinition.Builder
publisher(java.lang.String publisher)
Convenience method for settingpublisher
.ActivityDefinition.Builder
publisher(String publisher)
The name of the organization or individual that published the activity definition.ActivityDefinition.Builder
purpose(Markdown purpose)
Explanation of why this activity definition is needed and why it has been designed as it has.ActivityDefinition.Builder
quantity(SimpleQuantity quantity)
Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).ActivityDefinition.Builder
relatedArtifact(java.util.Collection<RelatedArtifact> relatedArtifact)
Related artifacts such as additional documentation, justification, or bibliographic references.ActivityDefinition.Builder
relatedArtifact(RelatedArtifact... relatedArtifact)
Related artifacts such as additional documentation, justification, or bibliographic references.ActivityDefinition.Builder
reviewer(java.util.Collection<ContactDetail> reviewer)
An individual or organization primarily responsible for review of some aspect of the content.ActivityDefinition.Builder
reviewer(ContactDetail... reviewer)
An individual or organization primarily responsible for review of some aspect of the content.ActivityDefinition.Builder
specimenRequirement(java.util.Collection<Reference> specimenRequirement)
Defines specimen requirements for the action to be performed, such as required specimens for a lab test.ActivityDefinition.Builder
specimenRequirement(Reference... specimenRequirement)
Defines specimen requirements for the action to be performed, such as required specimens for a lab test.ActivityDefinition.Builder
status(PublicationStatus status)
The status of this activity definition.ActivityDefinition.Builder
subject(Element subject)
A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined.ActivityDefinition.Builder
subtitle(java.lang.String subtitle)
Convenience method for settingsubtitle
.ActivityDefinition.Builder
subtitle(String subtitle)
An explanatory or alternate title for the activity definition giving additional information about its content.ActivityDefinition.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.ActivityDefinition.Builder
timing(Element timing)
The period, timing or frequency upon which the described activity is to occur.ActivityDefinition.Builder
title(java.lang.String title)
Convenience method for settingtitle
.ActivityDefinition.Builder
title(String title)
A short, descriptive, user-friendly title for the activity definition.ActivityDefinition.Builder
topic(java.util.Collection<CodeableConcept> topic)
Descriptive topics related to the content of the activity.ActivityDefinition.Builder
topic(CodeableConcept... topic)
Descriptive topics related to the content of the activity.ActivityDefinition.Builder
transform(Canonical transform)
A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.ActivityDefinition.Builder
url(Uri url)
An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier.ActivityDefinition.Builder
usage(java.lang.String usage)
Convenience method for settingusage
.ActivityDefinition.Builder
usage(String usage)
A detailed description of how the activity definition is used from a clinical perspective.ActivityDefinition.Builder
useContext(java.util.Collection<UsageContext> useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.ActivityDefinition.Builder
useContext(UsageContext... useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.protected void
validate(ActivityDefinition activityDefinition)
ActivityDefinition.Builder
version(java.lang.String version)
Convenience method for settingversion
.ActivityDefinition.Builder
version(String version)
The identifier that is used to identify this version of the activity 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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.Builder url(Uri url)
An absolute URI that is used to identify this activity 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 activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.- Parameters:
url
- Canonical identifier for this activity definition, represented as a URI (globally unique)- Returns:
- A reference to this Builder instance
-
identifier
public ActivityDefinition.Builder identifier(Identifier... identifier)
A formal identifier that is used to identify this activity 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 activity definition- Returns:
- A reference to this Builder instance
-
identifier
public ActivityDefinition.Builder identifier(java.util.Collection<Identifier> identifier)
A formal identifier that is used to identify this activity 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 activity definition- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
version
public ActivityDefinition.Builder version(java.lang.String version)
Convenience method for settingversion
.- Parameters:
version
- Business version of the activity definition- Returns:
- A reference to this Builder instance
- See Also:
version(org.linuxforhealth.fhir.model.type.String)
-
version
public ActivityDefinition.Builder version(String version)
The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity 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 assets.- Parameters:
version
- Business version of the activity definition- Returns:
- A reference to this Builder instance
-
name
public ActivityDefinition.Builder name(java.lang.String name)
Convenience method for settingname
.- Parameters:
name
- Name for this activity definition (computer friendly)- Returns:
- A reference to this Builder instance
- See Also:
name(org.linuxforhealth.fhir.model.type.String)
-
name
public ActivityDefinition.Builder name(String name)
A natural language name identifying the activity 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 activity definition (computer friendly)- Returns:
- A reference to this Builder instance
-
title
public ActivityDefinition.Builder title(java.lang.String title)
Convenience method for settingtitle
.- Parameters:
title
- Name for this activity definition (human friendly)- Returns:
- A reference to this Builder instance
- See Also:
title(org.linuxforhealth.fhir.model.type.String)
-
title
public ActivityDefinition.Builder title(String title)
A short, descriptive, user-friendly title for the activity definition.- Parameters:
title
- Name for this activity definition (human friendly)- Returns:
- A reference to this Builder instance
-
subtitle
public ActivityDefinition.Builder subtitle(java.lang.String subtitle)
Convenience method for settingsubtitle
.- Parameters:
subtitle
- Subordinate title of the activity definition- Returns:
- A reference to this Builder instance
- See Also:
subtitle(org.linuxforhealth.fhir.model.type.String)
-
subtitle
public ActivityDefinition.Builder subtitle(String subtitle)
An explanatory or alternate title for the activity definition giving additional information about its content.- Parameters:
subtitle
- Subordinate title of the activity definition- Returns:
- A reference to this Builder instance
-
status
public ActivityDefinition.Builder status(PublicationStatus status)
The status of this activity 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 ActivityDefinition.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 ActivityDefinition.Builder experimental(Boolean experimental)
A Boolean value to indicate that this activity 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 ActivityDefinition.Builder subject(Element subject)
A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. 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 activity definition is intended for- Returns:
- A reference to this Builder instance
-
date
public ActivityDefinition.Builder date(DateTime date)
The date (and optionally time) when the activity 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 activity definition changes.- Parameters:
date
- Date last changed- Returns:
- A reference to this Builder instance
-
publisher
public ActivityDefinition.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 ActivityDefinition.Builder publisher(String publisher)
The name of the organization or individual that published the activity definition.- Parameters:
publisher
- Name of the publisher (organization or individual)- Returns:
- A reference to this Builder instance
-
contact
public ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.Builder description(Markdown description)
A free text natural language description of the activity definition from a consumer's perspective.- Parameters:
description
- Natural language description of the activity definition- Returns:
- A reference to this Builder instance
-
useContext
public ActivityDefinition.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 activity 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 ActivityDefinition.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 activity 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 ActivityDefinition.Builder jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the activity 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 activity definition (if applicable)- Returns:
- A reference to this Builder instance
-
jurisdiction
public ActivityDefinition.Builder jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the activity 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 activity definition (if applicable)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
purpose
public ActivityDefinition.Builder purpose(Markdown purpose)
Explanation of why this activity definition is needed and why it has been designed as it has.- Parameters:
purpose
- Why this activity definition is defined- Returns:
- A reference to this Builder instance
-
usage
public ActivityDefinition.Builder usage(java.lang.String usage)
Convenience method for settingusage
.- Parameters:
usage
- Describes the clinical usage of the activity definition- Returns:
- A reference to this Builder instance
- See Also:
usage(org.linuxforhealth.fhir.model.type.String)
-
usage
public ActivityDefinition.Builder usage(String usage)
A detailed description of how the activity definition is used from a clinical perspective.- Parameters:
usage
- Describes the clinical usage of the activity definition- Returns:
- A reference to this Builder instance
-
copyright
public ActivityDefinition.Builder copyright(Markdown copyright)
A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.- Parameters:
copyright
- Use and/or publishing restrictions- Returns:
- A reference to this Builder instance
-
approvalDate
public ActivityDefinition.Builder approvalDate(java.time.LocalDate approvalDate)
Convenience method for settingapprovalDate
.- Parameters:
approvalDate
- When the activity definition was approved by publisher- Returns:
- A reference to this Builder instance
- See Also:
approvalDate(org.linuxforhealth.fhir.model.type.Date)
-
approvalDate
public ActivityDefinition.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 activity definition was approved by publisher- Returns:
- A reference to this Builder instance
-
lastReviewDate
public ActivityDefinition.Builder lastReviewDate(java.time.LocalDate lastReviewDate)
Convenience method for settinglastReviewDate
.- Parameters:
lastReviewDate
- When the activity definition was last reviewed- Returns:
- A reference to this Builder instance
- See Also:
lastReviewDate(org.linuxforhealth.fhir.model.type.Date)
-
lastReviewDate
public ActivityDefinition.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 activity definition was last reviewed- Returns:
- A reference to this Builder instance
-
effectivePeriod
public ActivityDefinition.Builder effectivePeriod(Period effectivePeriod)
The period during which the activity definition content was or is planned to be in active use.- Parameters:
effectivePeriod
- When the activity definition is expected to be used- Returns:
- A reference to this Builder instance
-
topic
public ActivityDefinition.Builder topic(CodeableConcept... topic)
Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity 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, etc.- Returns:
- A reference to this Builder instance
-
topic
public ActivityDefinition.Builder topic(java.util.Collection<CodeableConcept> topic)
Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity 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, etc.- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
author
public ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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 ActivityDefinition.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, etc.- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
library
public ActivityDefinition.Builder library(Canonical... library)
A reference to a Library resource containing any formal logic used by the activity 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 activity definition- Returns:
- A reference to this Builder instance
-
library
public ActivityDefinition.Builder library(java.util.Collection<Canonical> library)
A reference to a Library resource containing any formal logic used by the activity 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 activity definition- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
kind
public ActivityDefinition.Builder kind(ActivityDefinitionKind kind)
A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.- Parameters:
kind
- Kind of resource- Returns:
- A reference to this Builder instance
-
profile
public ActivityDefinition.Builder profile(Canonical profile)
A profile to which the target of the activity definition is expected to conform.- Parameters:
profile
- What profile the resource needs to conform to- Returns:
- A reference to this Builder instance
-
code
public ActivityDefinition.Builder code(CodeableConcept code)
Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.- Parameters:
code
- Detail type of activity- Returns:
- A reference to this Builder instance
-
intent
public ActivityDefinition.Builder intent(RequestIntent intent)
Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.- Parameters:
intent
- proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option- Returns:
- A reference to this Builder instance
-
priority
public ActivityDefinition.Builder priority(RequestPriority priority)
Indicates how quickly the activity should be addressed with respect to other requests.- Parameters:
priority
- routine | urgent | asap | stat- Returns:
- A reference to this Builder instance
-
doNotPerform
public ActivityDefinition.Builder doNotPerform(java.lang.Boolean doNotPerform)
Convenience method for settingdoNotPerform
.- Parameters:
doNotPerform
- True if the activity should not be performed- Returns:
- A reference to this Builder instance
- See Also:
doNotPerform(org.linuxforhealth.fhir.model.type.Boolean)
-
doNotPerform
public ActivityDefinition.Builder doNotPerform(Boolean doNotPerform)
Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.- Parameters:
doNotPerform
- True if the activity should not be performed- Returns:
- A reference to this Builder instance
-
timing
public ActivityDefinition.Builder timing(Element timing)
The period, timing or frequency upon which the described activity is to occur.This is a choice element with the following allowed types:
- Parameters:
timing
- When activity is to occur- Returns:
- A reference to this Builder instance
-
location
public ActivityDefinition.Builder location(Reference location)
Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.Allowed resource types for this reference:
- Parameters:
location
- Where it should happen- Returns:
- A reference to this Builder instance
-
participant
public ActivityDefinition.Builder participant(ActivityDefinition.Participant... participant)
Indicates who should participate in performing the action described.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
participant
- Who should participate in the action- Returns:
- A reference to this Builder instance
-
participant
public ActivityDefinition.Builder participant(java.util.Collection<ActivityDefinition.Participant> participant)
Indicates who should participate in performing the action described.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:
participant
- Who should participate in the action- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
product
public ActivityDefinition.Builder product(Element product)
Identifies the food, drug or other product being consumed or supplied in the activity.This is a choice element with the following allowed types:
When of typeReference
, the allowed resource types for this reference are:- Parameters:
product
- What's administered/supplied- Returns:
- A reference to this Builder instance
-
quantity
public ActivityDefinition.Builder quantity(SimpleQuantity quantity)
Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).- Parameters:
quantity
- How much is administered/consumed/supplied- Returns:
- A reference to this Builder instance
-
dosage
public ActivityDefinition.Builder dosage(Dosage... dosage)
Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
dosage
- Detailed dosage instructions- Returns:
- A reference to this Builder instance
-
dosage
public ActivityDefinition.Builder dosage(java.util.Collection<Dosage> dosage)
Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.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:
dosage
- Detailed dosage instructions- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
bodySite
public ActivityDefinition.Builder bodySite(CodeableConcept... bodySite)
Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
bodySite
- What part of body to perform on- Returns:
- A reference to this Builder instance
-
bodySite
public ActivityDefinition.Builder bodySite(java.util.Collection<CodeableConcept> bodySite)
Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).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:
bodySite
- What part of body to perform on- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
specimenRequirement
public ActivityDefinition.Builder specimenRequirement(Reference... specimenRequirement)
Defines specimen requirements for the action to be performed, such as required specimens for a lab test.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
specimenRequirement
- What specimens are required to perform this action- Returns:
- A reference to this Builder instance
-
specimenRequirement
public ActivityDefinition.Builder specimenRequirement(java.util.Collection<Reference> specimenRequirement)
Defines specimen requirements for the action to be performed, such as required specimens for a lab test.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
specimenRequirement
- What specimens are required to perform this action- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
observationRequirement
public ActivityDefinition.Builder observationRequirement(Reference... observationRequirement)
Defines observation requirements for the action to be performed, such as body weight or surface area.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
observationRequirement
- What observations are required to perform this action- Returns:
- A reference to this Builder instance
-
observationRequirement
public ActivityDefinition.Builder observationRequirement(java.util.Collection<Reference> observationRequirement)
Defines observation requirements for the action to be performed, such as body weight or surface area.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
observationRequirement
- What observations are required to perform this action- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
observationResultRequirement
public ActivityDefinition.Builder observationResultRequirement(Reference... observationResultRequirement)
Defines the observations that are expected to be produced by the action.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
observationResultRequirement
- What observations must be produced by this action- Returns:
- A reference to this Builder instance
-
observationResultRequirement
public ActivityDefinition.Builder observationResultRequirement(java.util.Collection<Reference> observationResultRequirement)
Defines the observations that are expected to be produced by the action.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
observationResultRequirement
- What observations must be produced by this action- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
transform
public ActivityDefinition.Builder transform(Canonical transform)
A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.- Parameters:
transform
- Transform to apply the template- Returns:
- A reference to this Builder instance
-
dynamicValue
public ActivityDefinition.Builder dynamicValue(ActivityDefinition.DynamicValue... dynamicValue)
Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
dynamicValue
- Dynamic aspects of the definition- Returns:
- A reference to this Builder instance
-
dynamicValue
public ActivityDefinition.Builder dynamicValue(java.util.Collection<ActivityDefinition.DynamicValue> dynamicValue)
Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.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:
dynamicValue
- Dynamic aspects of the definition- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public ActivityDefinition build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
ActivityDefinition
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid ActivityDefinition per the base specification
-
validate
protected void validate(ActivityDefinition activityDefinition)
-
from
protected ActivityDefinition.Builder from(ActivityDefinition activityDefinition)
-
-