Class SpecimenDefinition.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.SpecimenDefinition.Builder
-
- Enclosing class:
- SpecimenDefinition
public static class SpecimenDefinition.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 SpecimenDefinition
build()
Build theSpecimenDefinition
SpecimenDefinition.Builder
collection(java.util.Collection<CodeableConcept> collection)
The action to be performed for collecting the specimen.SpecimenDefinition.Builder
collection(CodeableConcept... collection)
The action to be performed for collecting the specimen.SpecimenDefinition.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.SpecimenDefinition.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.SpecimenDefinition.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.SpecimenDefinition.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected SpecimenDefinition.Builder
from(SpecimenDefinition specimenDefinition)
SpecimenDefinition.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.SpecimenDefinition.Builder
identifier(Identifier identifier)
A business identifier associated with the kind of specimen.SpecimenDefinition.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.SpecimenDefinition.Builder
language(Code language)
The base language in which the resource is written.SpecimenDefinition.Builder
meta(Meta meta)
The metadata about the resource.SpecimenDefinition.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.SpecimenDefinition.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.SpecimenDefinition.Builder
patientPreparation(java.util.Collection<CodeableConcept> patientPreparation)
Preparation of the patient for specimen collection.SpecimenDefinition.Builder
patientPreparation(CodeableConcept... patientPreparation)
Preparation of the patient for specimen collection.SpecimenDefinition.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.SpecimenDefinition.Builder
timeAspect(java.lang.String timeAspect)
Convenience method for settingtimeAspect
.SpecimenDefinition.Builder
timeAspect(String timeAspect)
Time aspect of specimen collection (duration or offset).SpecimenDefinition.Builder
typeCollected(CodeableConcept typeCollected)
The kind of material to be collected.SpecimenDefinition.Builder
typeTested(java.util.Collection<SpecimenDefinition.TypeTested> typeTested)
Specimen conditioned in a container as expected by the testing laboratory.SpecimenDefinition.Builder
typeTested(SpecimenDefinition.TypeTested... typeTested)
Specimen conditioned in a container as expected by the testing laboratory.protected void
validate(SpecimenDefinition specimenDefinition)
-
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 SpecimenDefinition.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 SpecimenDefinition.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 SpecimenDefinition.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 SpecimenDefinition.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 SpecimenDefinition.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 SpecimenDefinition.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 SpecimenDefinition.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 SpecimenDefinition.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 SpecimenDefinition.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 SpecimenDefinition.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 SpecimenDefinition.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 SpecimenDefinition.Builder identifier(Identifier identifier)
A business identifier associated with the kind of specimen.- Parameters:
identifier
- Business identifier of a kind of specimen- Returns:
- A reference to this Builder instance
-
typeCollected
public SpecimenDefinition.Builder typeCollected(CodeableConcept typeCollected)
The kind of material to be collected.- Parameters:
typeCollected
- Kind of material to collect- Returns:
- A reference to this Builder instance
-
patientPreparation
public SpecimenDefinition.Builder patientPreparation(CodeableConcept... patientPreparation)
Preparation of the patient for specimen collection.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
patientPreparation
- Patient preparation for collection- Returns:
- A reference to this Builder instance
-
patientPreparation
public SpecimenDefinition.Builder patientPreparation(java.util.Collection<CodeableConcept> patientPreparation)
Preparation of the patient for specimen collection.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:
patientPreparation
- Patient preparation for collection- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
timeAspect
public SpecimenDefinition.Builder timeAspect(java.lang.String timeAspect)
Convenience method for settingtimeAspect
.- Parameters:
timeAspect
- Time aspect for collection- Returns:
- A reference to this Builder instance
- See Also:
timeAspect(org.linuxforhealth.fhir.model.type.String)
-
timeAspect
public SpecimenDefinition.Builder timeAspect(String timeAspect)
Time aspect of specimen collection (duration or offset).- Parameters:
timeAspect
- Time aspect for collection- Returns:
- A reference to this Builder instance
-
collection
public SpecimenDefinition.Builder collection(CodeableConcept... collection)
The action to be performed for collecting the specimen.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
collection
- Specimen collection procedure- Returns:
- A reference to this Builder instance
-
collection
public SpecimenDefinition.Builder collection(java.util.Collection<CodeableConcept> collection)
The action to be performed for collecting the specimen.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:
collection
- Specimen collection procedure- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
typeTested
public SpecimenDefinition.Builder typeTested(SpecimenDefinition.TypeTested... typeTested)
Specimen conditioned in a container as expected by the testing laboratory.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
typeTested
- Specimen in container intended for testing by lab- Returns:
- A reference to this Builder instance
-
typeTested
public SpecimenDefinition.Builder typeTested(java.util.Collection<SpecimenDefinition.TypeTested> typeTested)
Specimen conditioned in a container as expected by the testing laboratory.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:
typeTested
- Specimen in container intended for testing by lab- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public SpecimenDefinition build()
Build theSpecimenDefinition
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
SpecimenDefinition
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid SpecimenDefinition per the base specification
-
validate
protected void validate(SpecimenDefinition specimenDefinition)
-
from
protected SpecimenDefinition.Builder from(SpecimenDefinition specimenDefinition)
-
-