Class Group.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.Group.Builder
-
- Enclosing class:
- Group
public static class Group.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 Group.Builder
active(java.lang.Boolean active)
Convenience method for settingactive
.Group.Builder
active(Boolean active)
Indicates whether the record for the group is available for use or is merely being retained for historical purposes.Group.Builder
actual(java.lang.Boolean actual)
Convenience method for settingactual
.Group.Builder
actual(Boolean actual)
If true, indicates that the resource refers to a specific group of real individuals.Group
build()
Build theGroup
Group.Builder
characteristic(java.util.Collection<Group.Characteristic> characteristic)
Identifies traits whose presence r absence is shared by members of the group.Group.Builder
characteristic(Group.Characteristic... characteristic)
Identifies traits whose presence r absence is shared by members of the group.Group.Builder
code(CodeableConcept code)
Provides a specific type of resource the group includes; e.g.Group.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.Group.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.Group.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.Group.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected Group.Builder
from(Group group)
Group.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.Group.Builder
identifier(java.util.Collection<Identifier> identifier)
A unique business identifier for this group.Group.Builder
identifier(Identifier... identifier)
A unique business identifier for this group.Group.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.Group.Builder
language(Code language)
The base language in which the resource is written.Group.Builder
managingEntity(Reference managingEntity)
Entity responsible for defining and maintaining Group characteristics and/or registered members.Group.Builder
member(java.util.Collection<Group.Member> member)
Identifies the resource instances that are members of the group.Group.Builder
member(Group.Member... member)
Identifies the resource instances that are members of the group.Group.Builder
meta(Meta meta)
The metadata about the resource.Group.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.Group.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.Group.Builder
name(java.lang.String name)
Convenience method for settingname
.Group.Builder
name(String name)
A label assigned to the group for human identification and communication.Group.Builder
quantity(UnsignedInt quantity)
A count of the number of resource instances that are part of the group.Group.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.Group.Builder
type(GroupType type)
Identifies the broad classification of the kind of resources the group includes.protected void
validate(Group group)
-
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 Group.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 Group.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 Group.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 Group.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 Group.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 Group.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 Group.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 Group.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 Group.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 Group.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 Group.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 Group.Builder identifier(Identifier... identifier)
A unique business identifier for this group.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Unique id- Returns:
- A reference to this Builder instance
-
identifier
public Group.Builder identifier(java.util.Collection<Identifier> identifier)
A unique business identifier for this group.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
- Unique id- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
active
public Group.Builder active(java.lang.Boolean active)
Convenience method for settingactive
.- Parameters:
active
- Whether this group's record is in active use- Returns:
- A reference to this Builder instance
- See Also:
active(org.linuxforhealth.fhir.model.type.Boolean)
-
active
public Group.Builder active(Boolean active)
Indicates whether the record for the group is available for use or is merely being retained for historical purposes.- Parameters:
active
- Whether this group's record is in active use- Returns:
- A reference to this Builder instance
-
type
public Group.Builder type(GroupType type)
Identifies the broad classification of the kind of resources the group includes.This element is required.
- Parameters:
type
- person | animal | practitioner | device | medication | substance- Returns:
- A reference to this Builder instance
-
actual
public Group.Builder actual(java.lang.Boolean actual)
Convenience method for settingactual
.This element is required.
- Parameters:
actual
- Descriptive or actual- Returns:
- A reference to this Builder instance
- See Also:
actual(org.linuxforhealth.fhir.model.type.Boolean)
-
actual
public Group.Builder actual(Boolean actual)
If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.This element is required.
- Parameters:
actual
- Descriptive or actual- Returns:
- A reference to this Builder instance
-
code
public Group.Builder code(CodeableConcept code)
Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.- Parameters:
code
- Kind of Group members- Returns:
- A reference to this Builder instance
-
name
public Group.Builder name(java.lang.String name)
Convenience method for settingname
.- Parameters:
name
- Label for Group- Returns:
- A reference to this Builder instance
- See Also:
name(org.linuxforhealth.fhir.model.type.String)
-
name
public Group.Builder name(String name)
A label assigned to the group for human identification and communication.- Parameters:
name
- Label for Group- Returns:
- A reference to this Builder instance
-
quantity
public Group.Builder quantity(UnsignedInt quantity)
A count of the number of resource instances that are part of the group.- Parameters:
quantity
- Number of members- Returns:
- A reference to this Builder instance
-
managingEntity
public Group.Builder managingEntity(Reference managingEntity)
Entity responsible for defining and maintaining Group characteristics and/or registered members.Allowed resource types for this reference:
- Parameters:
managingEntity
- Entity that is the custodian of the Group's definition- Returns:
- A reference to this Builder instance
-
characteristic
public Group.Builder characteristic(Group.Characteristic... characteristic)
Identifies traits whose presence r absence is shared by members of the group.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
characteristic
- Include / Exclude group members by Trait- Returns:
- A reference to this Builder instance
-
characteristic
public Group.Builder characteristic(java.util.Collection<Group.Characteristic> characteristic)
Identifies traits whose presence r absence is shared by members of the group.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:
characteristic
- Include / Exclude group members by Trait- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
member
public Group.Builder member(Group.Member... member)
Identifies the resource instances that are members of the group.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
member
- Who or what is in group- Returns:
- A reference to this Builder instance
-
member
public Group.Builder member(java.util.Collection<Group.Member> member)
Identifies the resource instances that are members of the group.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:
member
- Who or what is in group- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public Group build()
-
validate
protected void validate(Group group)
-
from
protected Group.Builder from(Group group)
-
-