Class Flag.Builder
- java.lang.Object
-
- com.ibm.fhir.model.builder.AbstractBuilder<Resource>
-
- com.ibm.fhir.model.resource.Resource.Builder
-
- com.ibm.fhir.model.resource.DomainResource.Builder
-
- com.ibm.fhir.model.resource.Flag.Builder
-
- Enclosing class:
- Flag
public static class Flag.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
Fields inherited from class com.ibm.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Flag.Builder
author(Reference author)
The person, organization or device that created the flag.Flag
build()
Build theFlag
Flag.Builder
category(CodeableConcept... category)
Allows a flag to be divided into different categories like clinical, administrative etc.Flag.Builder
category(Collection<CodeableConcept> category)
Allows a flag to be divided into different categories like clinical, administrative etc.Flag.Builder
code(CodeableConcept code)
The coded value or textual component of the flag to display to the user.Flag.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.Flag.Builder
contained(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.Flag.Builder
encounter(Reference encounter)
This alert is only relevant during the encounter.Flag.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.Flag.Builder
extension(Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected Flag.Builder
from(Flag flag)
Flag.Builder
id(String id)
The logical id of the resource, as used in the URL for the resource.Flag.Builder
identifier(Identifier... identifier)
Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.Flag.Builder
identifier(Collection<Identifier> identifier)
Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.Flag.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.Flag.Builder
language(Code language)
The base language in which the resource is written.Flag.Builder
meta(Meta meta)
The metadata about the resource.Flag.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.Flag.Builder
modifierExtension(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.Flag.Builder
period(Period period)
The period of time from the activation of the flag to inactivation of the flag.Flag.Builder
status(FlagStatus status)
Supports basic workflow.Flag.Builder
subject(Reference subject)
The patient, location, group, organization, or practitioner etc.Flag.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(Flag flag)
-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.resource.Resource.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public Flag.Builder id(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 Flag.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 Flag.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 Flag.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 Flag.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 Flag.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
- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public Flag.Builder contained(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
- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
extension
public Flag.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
- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public Flag.Builder extension(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
- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
modifierExtension
public Flag.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
- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public Flag.Builder modifierExtension(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
- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
identifier
public Flag.Builder identifier(Identifier... identifier)
Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.Adds new element(s) to the existing list
- Parameters:
identifier
- Business identifier- Returns:
- A reference to this Builder instance
-
identifier
public Flag.Builder identifier(Collection<Identifier> identifier)
Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
identifier
- Business identifier- Returns:
- A reference to this Builder instance
-
status
public Flag.Builder status(FlagStatus status)
Supports basic workflow.This element is required.
- Parameters:
status
- active | inactive | entered-in-error- Returns:
- A reference to this Builder instance
-
category
public Flag.Builder category(CodeableConcept... category)
Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.Adds new element(s) to the existing list
- Parameters:
category
- Clinical, administrative, etc.- Returns:
- A reference to this Builder instance
-
category
public Flag.Builder category(Collection<CodeableConcept> category)
Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
category
- Clinical, administrative, etc.- Returns:
- A reference to this Builder instance
-
code
public Flag.Builder code(CodeableConcept code)
The coded value or textual component of the flag to display to the user.This element is required.
- Parameters:
code
- Coded or textual message to display to user- Returns:
- A reference to this Builder instance
-
subject
public Flag.Builder subject(Reference subject)
The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with.This element is required.
Allowed resource types for this reference:
- Parameters:
subject
- Who/What is flag about?- Returns:
- A reference to this Builder instance
-
period
public Flag.Builder period(Period period)
The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.- Parameters:
period
- Time period when flag is active- Returns:
- A reference to this Builder instance
-
encounter
public Flag.Builder encounter(Reference encounter)
This alert is only relevant during the encounter.Allowed resource types for this reference:
- Parameters:
encounter
- Alert relevant during encounter- Returns:
- A reference to this Builder instance
-
author
public Flag.Builder author(Reference author)
The person, organization or device that created the flag.Allowed resource types for this reference:
- Parameters:
author
- Flag creator- Returns:
- A reference to this Builder instance
-
build
public Flag build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
Flag
- Throws:
IllegalStateException
- if the current state cannot be built into a valid Flag per the base specification
-
validate
protected void validate(Flag flag)
-
from
protected Flag.Builder from(Flag flag)
-
-