Class NamingSystem.UniqueId.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.NamingSystem.UniqueId.Builder
 
 
 
 
- 
- Enclosing class:
- NamingSystem.UniqueId
 
 public static class NamingSystem.UniqueId.Builder extends BackboneElement.Builder 
- 
- 
Field Summary- 
Fields inherited from class com.ibm.fhir.model.type.BackboneElement.BuildermodifierExtension
 - 
Fields inherited from class com.ibm.fhir.model.type.Element.Builderextension, id
 - 
Fields inherited from class com.ibm.fhir.model.builder.AbstractBuildervalidating
 
- 
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description NamingSystem.UniqueIdbuild()Build theNamingSystem.UniqueIdNamingSystem.UniqueId.Buildercomment(String comment)Notes about the past or intended usage of this identifier.NamingSystem.UniqueId.Buildercomment(String comment)Convenience method for settingcomment.NamingSystem.UniqueId.Builderextension(Extension... extension)May be used to represent additional information that is not part of the basic definition of the element.NamingSystem.UniqueId.Builderextension(Collection<Extension> extension)May be used to represent additional information that is not part of the basic definition of the element.protected NamingSystem.UniqueId.Builderfrom(NamingSystem.UniqueId uniqueId)NamingSystem.UniqueId.Builderid(String id)Unique id for the element within a resource (for internal references).NamingSystem.UniqueId.BuildermodifierExtension(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.NamingSystem.UniqueId.BuildermodifierExtension(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.NamingSystem.UniqueId.Builderperiod(Period period)Identifies the period of time over which this identifier is considered appropriate to refer to the naming system.NamingSystem.UniqueId.Builderpreferred(Boolean preferred)Indicates whether this identifier is the "preferred" identifier of this type.NamingSystem.UniqueId.Builderpreferred(Boolean preferred)Convenience method for settingpreferred.NamingSystem.UniqueId.Buildertype(NamingSystemIdentifierType type)Identifies the unique identifier scheme used for this particular identifier.protected voidvalidate(NamingSystem.UniqueId uniqueId)NamingSystem.UniqueId.Buildervalue(String value)The string that should be sent over the wire to identify the code system or identifier system.NamingSystem.UniqueId.Buildervalue(String value)Convenience method for settingvalue.- 
Methods inherited from class com.ibm.fhir.model.type.BackboneElement.Builderfrom, validate
 - 
Methods inherited from class com.ibm.fhir.model.type.Element.Builderfrom, validate
 - 
Methods inherited from class com.ibm.fhir.model.builder.AbstractBuilderisValidating, setValidating
 
- 
 
- 
- 
- 
Method Detail- 
idpublic NamingSystem.UniqueId.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:
- idin class- BackboneElement.Builder
- Parameters:
- id- Unique id for inter-element referencing
- Returns:
- A reference to this Builder instance
 
 - 
extensionpublic NamingSystem.UniqueId.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:
- extensionin class- BackboneElement.Builder
- Parameters:
- extension- Additional content defined by implementations
- Returns:
- A reference to this Builder instance
 
 - 
extensionpublic NamingSystem.UniqueId.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:
- extensionin class- BackboneElement.Builder
- Parameters:
- extension- Additional content defined by implementations
- Returns:
- A reference to this Builder instance
- Throws:
- NullPointerException- If the passed collection is null
 
 - 
modifierExtensionpublic NamingSystem.UniqueId.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:
- modifierExtensionin class- BackboneElement.Builder
- Parameters:
- modifierExtension- Extensions that cannot be ignored even if unrecognized
- Returns:
- A reference to this Builder instance
 
 - 
modifierExtensionpublic NamingSystem.UniqueId.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:
- modifierExtensionin class- BackboneElement.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
 
 - 
typepublic NamingSystem.UniqueId.Builder type(NamingSystemIdentifierType type) Identifies the unique identifier scheme used for this particular identifier.This element is required. - Parameters:
- type- oid | uuid | uri | other
- Returns:
- A reference to this Builder instance
 
 - 
valuepublic NamingSystem.UniqueId.Builder value(String value) Convenience method for settingvalue.This element is required. - Parameters:
- value- The unique identifier
- Returns:
- A reference to this Builder instance
- See Also:
- value(com.ibm.fhir.model.type.String)
 
 - 
valuepublic NamingSystem.UniqueId.Builder value(String value) The string that should be sent over the wire to identify the code system or identifier system.This element is required. - Parameters:
- value- The unique identifier
- Returns:
- A reference to this Builder instance
 
 - 
preferredpublic NamingSystem.UniqueId.Builder preferred(Boolean preferred) Convenience method for settingpreferred.- Parameters:
- preferred- Is this the id that should be used for this type
- Returns:
- A reference to this Builder instance
- See Also:
- preferred(com.ibm.fhir.model.type.Boolean)
 
 - 
preferredpublic NamingSystem.UniqueId.Builder preferred(Boolean preferred) Indicates whether this identifier is the "preferred" identifier of this type.- Parameters:
- preferred- Is this the id that should be used for this type
- Returns:
- A reference to this Builder instance
 
 - 
commentpublic NamingSystem.UniqueId.Builder comment(String comment) Convenience method for settingcomment.- Parameters:
- comment- Notes about identifier usage
- Returns:
- A reference to this Builder instance
- See Also:
- comment(com.ibm.fhir.model.type.String)
 
 - 
commentpublic NamingSystem.UniqueId.Builder comment(String comment) Notes about the past or intended usage of this identifier.- Parameters:
- comment- Notes about identifier usage
- Returns:
- A reference to this Builder instance
 
 - 
periodpublic NamingSystem.UniqueId.Builder period(Period period) Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.- Parameters:
- period- When is identifier valid?
- Returns:
- A reference to this Builder instance
 
 - 
buildpublic NamingSystem.UniqueId build() - Specified by:
- buildin interface- Builder<Element>
- Specified by:
- buildin class- BackboneElement.Builder
- Returns:
- An immutable object of type NamingSystem.UniqueId
- Throws:
- IllegalStateException- if the current state cannot be built into a valid UniqueId per the base specification
 
 - 
validateprotected void validate(NamingSystem.UniqueId uniqueId) 
 - 
fromprotected NamingSystem.UniqueId.Builder from(NamingSystem.UniqueId uniqueId) 
 
- 
 
-