Class Composition.Event.Builder
- java.lang.Object
-
- com.ibm.fhir.model.builder.AbstractBuilder<Element>
-
- com.ibm.fhir.model.type.Element.Builder
-
- com.ibm.fhir.model.type.BackboneElement.Builder
-
- com.ibm.fhir.model.resource.Composition.Event.Builder
-
- Enclosing class:
- Composition.Event
public static class Composition.Event.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class com.ibm.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class com.ibm.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Composition.Event
build()
Build theComposition.Event
Composition.Event.Builder
code(CodeableConcept... code)
This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented.Composition.Event.Builder
code(Collection<CodeableConcept> code)
This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented.Composition.Event.Builder
detail(Reference... detail)
The description and/or reference of the event(s) being documented.Composition.Event.Builder
detail(Collection<Reference> detail)
The description and/or reference of the event(s) being documented.Composition.Event.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.Composition.Event.Builder
extension(Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.protected Composition.Event.Builder
from(Composition.Event event)
Composition.Event.Builder
id(String id)
Unique id for the element within a resource (for internal references).Composition.Event.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.Composition.Event.Builder
modifierExtension(Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.Composition.Event.Builder
period(Period period)
The period of time covered by the documentation.protected void
validate(Composition.Event event)
-
Methods inherited from class com.ibm.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public Composition.Event.Builder id(String id)
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.- Overrides:
id
in classBackboneElement.Builder
- Parameters:
id
- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public Composition.Event.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element. 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 classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public Composition.Event.Builder extension(Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element. 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 classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
modifierExtension
public Composition.Event.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public Composition.Event.Builder modifierExtension(Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
code
public Composition.Event.Builder code(CodeableConcept... code)
This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
code
- Code(s) that apply to the event being documented- Returns:
- A reference to this Builder instance
-
code
public Composition.Event.Builder code(Collection<CodeableConcept> code)
This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.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:
code
- Code(s) that apply to the event being documented- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
period
public Composition.Event.Builder period(Period period)
The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.- Parameters:
period
- The period covered by the documentation- Returns:
- A reference to this Builder instance
-
detail
public Composition.Event.Builder detail(Reference... detail)
The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
detail
- The event(s) being documented- Returns:
- A reference to this Builder instance
-
detail
public Composition.Event.Builder detail(Collection<Reference> detail)
The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.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:
detail
- The event(s) being documented- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
build
public Composition.Event build()
Build theComposition.Event
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
Composition.Event
- Throws:
IllegalStateException
- if the current state cannot be built into a valid Event per the base specification
-
validate
protected void validate(Composition.Event event)
-
from
protected Composition.Event.Builder from(Composition.Event event)
-
-