Package com.ibm.fhir.model.resource
Class Device.UdiCarrier
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.type.Element
-
- com.ibm.fhir.model.type.BackboneElement
-
- com.ibm.fhir.model.resource.Device.UdiCarrier
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- Device
public static class Device.UdiCarrier extends BackboneElement
Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDevice.UdiCarrier.Builder
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(java.lang.String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static Device.UdiCarrier.Builderbuilder()booleanequals(java.lang.Object obj)Base64BinarygetCarrierAIDC()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.StringgetCarrierHRF()The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.StringgetDeviceIdentifier()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.UDIEntryTypegetEntryType()A coded entry to indicate how the data was entered.UrigetIssuer()Organization that is charged with issuing UDIs for devices.UrigetJurisdiction()The identity of the authoritative source for UDI generation within a jurisdiction.booleanhasChildren()inthashCode()Device.UdiCarrier.BuildertoBuilder()Create a new Builder from the contents of this Element-
Methods inherited from class com.ibm.fhir.model.type.BackboneElement
getModifierExtension
-
-
-
-
Method Detail
-
getDeviceIdentifier
public String getDeviceIdentifier()
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.- Returns:
- An immutable object of type
Stringthat may be null.
-
getIssuer
public Uri getIssuer()
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.- Returns:
- An immutable object of type
Urithat may be null.
-
getJurisdiction
public Uri getJurisdiction()
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.- Returns:
- An immutable object of type
Urithat may be null.
-
getCarrierAIDC
public Base64Binary getCarrierAIDC()
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.- Returns:
- An immutable object of type
Base64Binarythat may be null.
-
getCarrierHRF
public String getCarrierHRF()
The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.- Returns:
- An immutable object of type
Stringthat may be null.
-
getEntryType
public UDIEntryType getEntryType()
A coded entry to indicate how the data was entered.- Returns:
- An immutable object of type
UDIEntryTypethat may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classBackboneElement
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
acceptin interfaceVisitable- Specified by:
acceptin classAbstractVisitable- Parameters:
elementName- the name of the element in the context of this visitelementIndex- the index of the element in a list or -1 if it is not contained within a Listvisitor- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toBuilder
public Device.UdiCarrier.Builder toBuilder()
Description copied from class:ElementCreate a new Builder from the contents of this Element- Specified by:
toBuilderin classBackboneElement
-
builder
public static Device.UdiCarrier.Builder builder()
-
-