Class ExampleScenario.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.ExampleScenario.Builder
-
- Enclosing class:
- ExampleScenario
public static class ExampleScenario.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 ExampleScenario.Builder
actor(java.util.Collection<ExampleScenario.Actor> actor)
Actor participating in the resource.ExampleScenario.Builder
actor(ExampleScenario.Actor... actor)
Actor participating in the resource.ExampleScenario
build()
Build theExampleScenario
ExampleScenario.Builder
contact(java.util.Collection<ContactDetail> contact)
Contact details to assist a user in finding and communicating with the publisher.ExampleScenario.Builder
contact(ContactDetail... contact)
Contact details to assist a user in finding and communicating with the publisher.ExampleScenario.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.ExampleScenario.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.ExampleScenario.Builder
copyright(Markdown copyright)
A copyright statement relating to the example scenario and/or its contents.ExampleScenario.Builder
date(DateTime date)
The date (and optionally time) when the example scenario was published.ExampleScenario.Builder
experimental(java.lang.Boolean experimental)
Convenience method for settingexperimental
.ExampleScenario.Builder
experimental(Boolean experimental)
A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.ExampleScenario.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.ExampleScenario.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected ExampleScenario.Builder
from(ExampleScenario exampleScenario)
ExampleScenario.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.ExampleScenario.Builder
identifier(java.util.Collection<Identifier> identifier)
A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.ExampleScenario.Builder
identifier(Identifier... identifier)
A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.ExampleScenario.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.ExampleScenario.Builder
instance(java.util.Collection<ExampleScenario.Instance> instance)
Each resource and each version that is present in the workflow.ExampleScenario.Builder
instance(ExampleScenario.Instance... instance)
Each resource and each version that is present in the workflow.ExampleScenario.Builder
jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the example scenario is intended to be used.ExampleScenario.Builder
jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the example scenario is intended to be used.ExampleScenario.Builder
language(Code language)
The base language in which the resource is written.ExampleScenario.Builder
meta(Meta meta)
The metadata about the resource.ExampleScenario.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.ExampleScenario.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.ExampleScenario.Builder
name(java.lang.String name)
Convenience method for settingname
.ExampleScenario.Builder
name(String name)
A natural language name identifying the example scenario.ExampleScenario.Builder
process(java.util.Collection<ExampleScenario.Process> process)
Each major process - a group of operations.ExampleScenario.Builder
process(ExampleScenario.Process... process)
Each major process - a group of operations.ExampleScenario.Builder
publisher(java.lang.String publisher)
Convenience method for settingpublisher
.ExampleScenario.Builder
publisher(String publisher)
The name of the organization or individual that published the example scenario.ExampleScenario.Builder
purpose(Markdown purpose)
What the example scenario resource is created for.ExampleScenario.Builder
status(PublicationStatus status)
The status of this example scenario.ExampleScenario.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.ExampleScenario.Builder
url(Uri url)
An absolute URI that is used to identify this example scenario when it is referenced in a specification, model, design or an instance; also called its canonical identifier.ExampleScenario.Builder
useContext(java.util.Collection<UsageContext> useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.ExampleScenario.Builder
useContext(UsageContext... useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.protected void
validate(ExampleScenario exampleScenario)
ExampleScenario.Builder
version(java.lang.String version)
Convenience method for settingversion
.ExampleScenario.Builder
version(String version)
The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance.ExampleScenario.Builder
workflow(java.util.Collection<Canonical> workflow)
Another nested workflow.ExampleScenario.Builder
workflow(Canonical... workflow)
Another nested workflow.-
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 ExampleScenario.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 ExampleScenario.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 ExampleScenario.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 ExampleScenario.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 ExampleScenario.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 ExampleScenario.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 ExampleScenario.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 ExampleScenario.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 ExampleScenario.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 ExampleScenario.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 ExampleScenario.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 ExampleScenario.Builder url(Uri url)
An absolute URI that is used to identify this example scenario 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 example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario is stored on different servers.- Parameters:
url
- Canonical identifier for this example scenario, represented as a URI (globally unique)- Returns:
- A reference to this Builder instance
-
identifier
public ExampleScenario.Builder identifier(Identifier... identifier)
A formal identifier that is used to identify this example scenario 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 example scenario- Returns:
- A reference to this Builder instance
-
identifier
public ExampleScenario.Builder identifier(java.util.Collection<Identifier> identifier)
A formal identifier that is used to identify this example scenario 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 example scenario- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
version
public ExampleScenario.Builder version(java.lang.String version)
Convenience method for settingversion
.- Parameters:
version
- Business version of the example scenario- Returns:
- A reference to this Builder instance
- See Also:
version(org.linuxforhealth.fhir.model.type.String)
-
version
public ExampleScenario.Builder version(String version)
The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the example scenario author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.- Parameters:
version
- Business version of the example scenario- Returns:
- A reference to this Builder instance
-
name
public ExampleScenario.Builder name(java.lang.String name)
Convenience method for settingname
.- Parameters:
name
- Name for this example scenario (computer friendly)- Returns:
- A reference to this Builder instance
- See Also:
name(org.linuxforhealth.fhir.model.type.String)
-
name
public ExampleScenario.Builder name(String name)
A natural language name identifying the example scenario. This name should be usable as an identifier for the module by machine processing applications such as code generation.- Parameters:
name
- Name for this example scenario (computer friendly)- Returns:
- A reference to this Builder instance
-
status
public ExampleScenario.Builder status(PublicationStatus status)
The status of this example scenario. 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 ExampleScenario.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 ExampleScenario.Builder experimental(Boolean experimental)
A Boolean value to indicate that this example scenario 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
-
date
public ExampleScenario.Builder date(DateTime date)
The date (and optionally time) when the example scenario 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 example scenario changes. (e.g. the 'content logical definition').- Parameters:
date
- Date last changed- Returns:
- A reference to this Builder instance
-
publisher
public ExampleScenario.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 ExampleScenario.Builder publisher(String publisher)
The name of the organization or individual that published the example scenario.- Parameters:
publisher
- Name of the publisher (organization or individual)- Returns:
- A reference to this Builder instance
-
contact
public ExampleScenario.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 ExampleScenario.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
-
useContext
public ExampleScenario.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 example scenario 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 ExampleScenario.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 example scenario 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 ExampleScenario.Builder jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the example scenario 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 example scenario (if applicable)- Returns:
- A reference to this Builder instance
-
jurisdiction
public ExampleScenario.Builder jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the example scenario 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 example scenario (if applicable)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
copyright
public ExampleScenario.Builder copyright(Markdown copyright)
A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.- Parameters:
copyright
- Use and/or publishing restrictions- Returns:
- A reference to this Builder instance
-
purpose
public ExampleScenario.Builder purpose(Markdown purpose)
What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario.- Parameters:
purpose
- The purpose of the example, e.g. to illustrate a scenario- Returns:
- A reference to this Builder instance
-
actor
public ExampleScenario.Builder actor(ExampleScenario.Actor... actor)
Actor participating in the resource.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
actor
- Actor participating in the resource- Returns:
- A reference to this Builder instance
-
actor
public ExampleScenario.Builder actor(java.util.Collection<ExampleScenario.Actor> actor)
Actor participating in the resource.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
actor
- Actor participating in the resource- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
instance
public ExampleScenario.Builder instance(ExampleScenario.Instance... instance)
Each resource and each version that is present in the workflow.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
instance
- Each resource and each version that is present in the workflow- Returns:
- A reference to this Builder instance
-
instance
public ExampleScenario.Builder instance(java.util.Collection<ExampleScenario.Instance> instance)
Each resource and each version that is present in the workflow.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:
instance
- Each resource and each version that is present in the workflow- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
process
public ExampleScenario.Builder process(ExampleScenario.Process... process)
Each major process - a group of operations.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
process
- Each major process - a group of operations- Returns:
- A reference to this Builder instance
-
process
public ExampleScenario.Builder process(java.util.Collection<ExampleScenario.Process> process)
Each major process - a group of operations.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:
process
- Each major process - a group of operations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
workflow
public ExampleScenario.Builder workflow(Canonical... workflow)
Another nested workflow.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
workflow
- Another nested workflow- Returns:
- A reference to this Builder instance
-
workflow
public ExampleScenario.Builder workflow(java.util.Collection<Canonical> workflow)
Another nested workflow.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:
workflow
- Another nested workflow- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public ExampleScenario build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
ExampleScenario
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid ExampleScenario per the base specification
-
validate
protected void validate(ExampleScenario exampleScenario)
-
from
protected ExampleScenario.Builder from(ExampleScenario exampleScenario)
-
-