Class Encounter.Location.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.Encounter.Location.Builder
-
- Enclosing class:
- Encounter.Location
public static class Encounter.Location.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 Encounter.Location
build()
Build theEncounter.Location
Encounter.Location.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.Encounter.Location.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.protected Encounter.Location.Builder
from(Encounter.Location location)
Encounter.Location.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).Encounter.Location.Builder
location(Reference location)
The location where the encounter takes place.Encounter.Location.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.Encounter.Location.Builder
modifierExtension(java.util.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.Encounter.Location.Builder
period(Period period)
Time period during which the patient was present at the location.Encounter.Location.Builder
physicalType(CodeableConcept physicalType)
This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.Encounter.Location.Builder
status(EncounterLocationStatus status)
The status of the participants' presence at the specified location during the period specified.protected void
validate(Encounter.Location location)
-
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 Encounter.Location.Builder id(java.lang.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 Encounter.Location.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 Encounter.Location.Builder extension(java.util.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:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public Encounter.Location.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 Encounter.Location.Builder modifierExtension(java.util.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:
java.lang.NullPointerException
- If the passed collection is null
-
location
public Encounter.Location.Builder location(Reference location)
The location where the encounter takes place.This element is required.
Allowed resource types for this reference:
- Parameters:
location
- Location the encounter takes place- Returns:
- A reference to this Builder instance
-
status
public Encounter.Location.Builder status(EncounterLocationStatus status)
The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.- Parameters:
status
- planned | active | reserved | completed- Returns:
- A reference to this Builder instance
-
physicalType
public Encounter.Location.Builder physicalType(CodeableConcept physicalType)
This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.- Parameters:
physicalType
- The physical type of the location (usually the level in the location hierachy - bed room ward etc.)- Returns:
- A reference to this Builder instance
-
period
public Encounter.Location.Builder period(Period period)
Time period during which the patient was present at the location.- Parameters:
period
- Time period during which the patient was present at the location- Returns:
- A reference to this Builder instance
-
build
public Encounter.Location build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
Encounter.Location
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Location per the base specification
-
validate
protected void validate(Encounter.Location location)
-
from
protected Encounter.Location.Builder from(Encounter.Location location)
-
-