Class Device.UdiCarrier.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Element>
-
- org.linuxforhealth.fhir.model.type.Element.Builder
-
- org.linuxforhealth.fhir.model.type.BackboneElement.Builder
-
- org.linuxforhealth.fhir.model.resource.Device.UdiCarrier.Builder
-
- Enclosing class:
- Device.UdiCarrier
public static class Device.UdiCarrier.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Device.UdiCarrier
build()
Build theDevice.UdiCarrier
Device.UdiCarrier.Builder
carrierAIDC(Base64Binary carrierAIDC)
The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID.Device.UdiCarrier.Builder
carrierHRF(java.lang.String carrierHRF)
Convenience method for settingcarrierHRF
.Device.UdiCarrier.Builder
carrierHRF(String carrierHRF)
The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.Device.UdiCarrier.Builder
deviceIdentifier(java.lang.String deviceIdentifier)
Convenience method for settingdeviceIdentifier
.Device.UdiCarrier.Builder
deviceIdentifier(String deviceIdentifier)
The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.Device.UdiCarrier.Builder
entryType(UDIEntryType entryType)
A coded entry to indicate how the data was entered.Device.UdiCarrier.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.Device.UdiCarrier.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected Device.UdiCarrier.Builder
from(Device.UdiCarrier udiCarrier)
Device.UdiCarrier.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).Device.UdiCarrier.Builder
issuer(Uri issuer)
Organization that is charged with issuing UDIs for devices.Device.UdiCarrier.Builder
jurisdiction(Uri jurisdiction)
The identity of the authoritative source for UDI generation within a jurisdiction.Device.UdiCarrier.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.Device.UdiCarrier.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.protected void
validate(Device.UdiCarrier udiCarrier)
-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public Device.UdiCarrier.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 Device.UdiCarrier.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 Device.UdiCarrier.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 Device.UdiCarrier.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 Device.UdiCarrier.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
-
deviceIdentifier
public Device.UdiCarrier.Builder deviceIdentifier(java.lang.String deviceIdentifier)
Convenience method for settingdeviceIdentifier
.- Parameters:
deviceIdentifier
- Mandatory fixed portion of UDI- Returns:
- A reference to this Builder instance
- See Also:
deviceIdentifier(org.linuxforhealth.fhir.model.type.String)
-
deviceIdentifier
public Device.UdiCarrier.Builder deviceIdentifier(String deviceIdentifier)
The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.- Parameters:
deviceIdentifier
- Mandatory fixed portion of UDI- Returns:
- A reference to this Builder instance
-
issuer
public Device.UdiCarrier.Builder issuer(Uri issuer)
Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.- Parameters:
issuer
- UDI Issuing Organization- Returns:
- A reference to this Builder instance
-
jurisdiction
public Device.UdiCarrier.Builder jurisdiction(Uri jurisdiction)
The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.- Parameters:
jurisdiction
- Regional UDI authority- Returns:
- A reference to this Builder instance
-
carrierAIDC
public Device.UdiCarrier.Builder carrierAIDC(Base64Binary carrierAIDC)
The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats *SHALL* be base64 encoded.- Parameters:
carrierAIDC
- UDI Machine Readable Barcode String- Returns:
- A reference to this Builder instance
-
carrierHRF
public Device.UdiCarrier.Builder carrierHRF(java.lang.String carrierHRF)
Convenience method for settingcarrierHRF
.- Parameters:
carrierHRF
- UDI Human Readable Barcode String- Returns:
- A reference to this Builder instance
- See Also:
carrierHRF(org.linuxforhealth.fhir.model.type.String)
-
carrierHRF
public Device.UdiCarrier.Builder carrierHRF(String carrierHRF)
The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.- Parameters:
carrierHRF
- UDI Human Readable Barcode String- Returns:
- A reference to this Builder instance
-
entryType
public Device.UdiCarrier.Builder entryType(UDIEntryType entryType)
A coded entry to indicate how the data was entered.- Parameters:
entryType
- barcode | rfid | manual +- Returns:
- A reference to this Builder instance
-
build
public Device.UdiCarrier build()
Build theDevice.UdiCarrier
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
Device.UdiCarrier
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid UdiCarrier per the base specification
-
validate
protected void validate(Device.UdiCarrier udiCarrier)
-
from
protected Device.UdiCarrier.Builder from(Device.UdiCarrier udiCarrier)
-
-