Package com.ibm.fhir.model.type
Class Coding.Builder
- java.lang.Object
-
- com.ibm.fhir.model.builder.AbstractBuilder<Element>
-
- com.ibm.fhir.model.type.Element.Builder
-
- com.ibm.fhir.model.type.Coding.Builder
-
- Enclosing class:
- Coding
public static class Coding.Builder extends Element.Builder
-
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.Element.Builder
extension, id
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Codingbuild()Build theCodingCoding.Buildercode(Code code)A symbol in syntax defined by the system.Coding.Builderdisplay(String display)A representation of the meaning of the code in the system, following the rules of the system.Coding.Builderextension(Extension... extension)May be used to represent additional information that is not part of the basic definition of the element.Coding.Builderextension(Collection<Extension> extension)May be used to represent additional information that is not part of the basic definition of the element.protected Coding.Builderfrom(Coding coding)Coding.Builderid(String id)Unique id for the element within a resource (for internal references).Coding.Buildersystem(Uri system)The identification of the code system that defines the meaning of the symbol in the code.Coding.BuilderuserSelected(Boolean userSelected)Indicates that this coding was chosen by a user directly - e.g.Coding.Builderversion(String version)The version of the code system which was used when choosing this code.-
Methods inherited from class com.ibm.fhir.model.type.Element.Builder
from
-
-
-
-
Method Detail
-
id
public Coding.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 classElement.Builder- Parameters:
id- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public Coding.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
- Overrides:
extensionin classElement.Builder- Parameters:
extension- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public Coding.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
- Overrides:
extensionin classElement.Builder- Parameters:
extension- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
system
public Coding.Builder system(Uri system)
The identification of the code system that defines the meaning of the symbol in the code.- Parameters:
system- Identity of the terminology system- Returns:
- A reference to this Builder instance
-
version
public Coding.Builder version(String version)
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.- Parameters:
version- Version of the system - if relevant- Returns:
- A reference to this Builder instance
-
code
public Coding.Builder code(Code code)
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).- Parameters:
code- Symbol in syntax defined by the system- Returns:
- A reference to this Builder instance
-
display
public Coding.Builder display(String display)
A representation of the meaning of the code in the system, following the rules of the system.- Parameters:
display- Representation defined by the system- Returns:
- A reference to this Builder instance
-
userSelected
public Coding.Builder userSelected(Boolean userSelected)
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).- Parameters:
userSelected- If this coding was chosen directly by the user- Returns:
- A reference to this Builder instance
-
build
public Coding build()
Build theCoding- Specified by:
buildin interfaceBuilder<Element>- Specified by:
buildin classElement.Builder- Returns:
- An immutable object of type
Coding - Throws:
IllegalStateException- if the current state cannot be built into a valid Coding per the base specification
-
from
protected Coding.Builder from(Coding coding)
-
-