Class BodyStructure.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.BodyStructure.Builder
-
- Enclosing class:
- BodyStructure
public static class BodyStructure.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 BodyStructure.Builder
active(java.lang.Boolean active)
Convenience method for settingactive
.BodyStructure.Builder
active(Boolean active)
Whether this body site is in active use.BodyStructure
build()
Build theBodyStructure
BodyStructure.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.BodyStructure.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.BodyStructure.Builder
description(java.lang.String description)
Convenience method for settingdescription
.BodyStructure.Builder
description(String description)
A summary, characterization or explanation of the body structure.BodyStructure.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.BodyStructure.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected BodyStructure.Builder
from(BodyStructure bodyStructure)
BodyStructure.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.BodyStructure.Builder
identifier(java.util.Collection<Identifier> identifier)
Identifier for this instance of the anatomical structure.BodyStructure.Builder
identifier(Identifier... identifier)
Identifier for this instance of the anatomical structure.BodyStructure.Builder
image(java.util.Collection<Attachment> image)
Image or images used to identify a location.BodyStructure.Builder
image(Attachment... image)
Image or images used to identify a location.BodyStructure.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.BodyStructure.Builder
language(Code language)
The base language in which the resource is written.BodyStructure.Builder
location(CodeableConcept location)
The anatomical location or region of the specimen, lesion, or body structure.BodyStructure.Builder
locationQualifier(java.util.Collection<CodeableConcept> locationQualifier)
Qualifier to refine the anatomical location.BodyStructure.Builder
locationQualifier(CodeableConcept... locationQualifier)
Qualifier to refine the anatomical location.BodyStructure.Builder
meta(Meta meta)
The metadata about the resource.BodyStructure.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.BodyStructure.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.BodyStructure.Builder
morphology(CodeableConcept morphology)
The kind of structure being represented by the body structure at `BodyStructure.location`.BodyStructure.Builder
patient(Reference patient)
The person to which the body site belongs.BodyStructure.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.protected void
validate(BodyStructure bodyStructure)
-
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 BodyStructure.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 BodyStructure.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 BodyStructure.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 BodyStructure.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 BodyStructure.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 BodyStructure.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 BodyStructure.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 BodyStructure.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 BodyStructure.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 BodyStructure.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 BodyStructure.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
-
identifier
public BodyStructure.Builder identifier(Identifier... identifier)
Identifier for this instance of the anatomical structure.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Bodystructure identifier- Returns:
- A reference to this Builder instance
-
identifier
public BodyStructure.Builder identifier(java.util.Collection<Identifier> identifier)
Identifier for this instance of the anatomical structure.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
- Bodystructure identifier- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
active
public BodyStructure.Builder active(java.lang.Boolean active)
Convenience method for settingactive
.- Parameters:
active
- Whether this record is in active use- Returns:
- A reference to this Builder instance
- See Also:
active(org.linuxforhealth.fhir.model.type.Boolean)
-
active
public BodyStructure.Builder active(Boolean active)
Whether this body site is in active use.- Parameters:
active
- Whether this record is in active use- Returns:
- A reference to this Builder instance
-
morphology
public BodyStructure.Builder morphology(CodeableConcept morphology)
The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.- Parameters:
morphology
- Kind of Structure- Returns:
- A reference to this Builder instance
-
location
public BodyStructure.Builder location(CodeableConcept location)
The anatomical location or region of the specimen, lesion, or body structure.- Parameters:
location
- Body site- Returns:
- A reference to this Builder instance
-
locationQualifier
public BodyStructure.Builder locationQualifier(CodeableConcept... locationQualifier)
Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
locationQualifier
- Body site modifier- Returns:
- A reference to this Builder instance
-
locationQualifier
public BodyStructure.Builder locationQualifier(java.util.Collection<CodeableConcept> locationQualifier)
Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.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:
locationQualifier
- Body site modifier- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
description
public BodyStructure.Builder description(java.lang.String description)
Convenience method for settingdescription
.- Parameters:
description
- Text description- Returns:
- A reference to this Builder instance
- See Also:
description(org.linuxforhealth.fhir.model.type.String)
-
description
public BodyStructure.Builder description(String description)
A summary, characterization or explanation of the body structure.- Parameters:
description
- Text description- Returns:
- A reference to this Builder instance
-
image
public BodyStructure.Builder image(Attachment... image)
Image or images used to identify a location.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
image
- Attached images- Returns:
- A reference to this Builder instance
-
image
public BodyStructure.Builder image(java.util.Collection<Attachment> image)
Image or images used to identify a location.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:
image
- Attached images- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
patient
public BodyStructure.Builder patient(Reference patient)
The person to which the body site belongs.This element is required.
Allowed resource types for this reference:
- Parameters:
patient
- Who this is about- Returns:
- A reference to this Builder instance
-
build
public BodyStructure build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
BodyStructure
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid BodyStructure per the base specification
-
validate
protected void validate(BodyStructure bodyStructure)
-
from
protected BodyStructure.Builder from(BodyStructure bodyStructure)
-
-