Class Device.DeviceUdiComponent

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
    Enclosing class:
    Device

    public static class Device.DeviceUdiComponent
    extends BackboneElement
    implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
    See Also:
    Serialized Form
    • Field Detail

      • deviceIdentifier

        protected StringType 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.
      • name

        protected StringType name
        Name of device as used in labeling or catalog.
      • jurisdiction

        protected UriType 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.
      • carrierHRF

        protected StringType carrierHRF
        The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
      • carrierAIDC

        protected Base64BinaryType 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.
      • issuer

        protected UriType 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.
    • Method Detail

      • getDeviceIdentifierElement

        public StringType getDeviceIdentifierElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getDeviceIdentifier" gives direct access to the value
      • setDeviceIdentifierElement

        public Device.DeviceUdiComponent setDeviceIdentifierElement​(StringType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getDeviceIdentifier" gives direct access to the value
      • getDeviceIdentifier

        public String getDeviceIdentifier()
        Returns:
        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.
      • setDeviceIdentifier

        public Device.DeviceUdiComponent setDeviceIdentifier​(String value)
        Parameters:
        value - 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.
      • getNameElement

        public StringType getNameElement()
        Returns:
        name (Name of device as used in labeling or catalog.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
      • hasName

        public boolean hasName()
      • setNameElement

        public Device.DeviceUdiComponent setNameElement​(StringType value)
        Parameters:
        value - name (Name of device as used in labeling or catalog.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
      • getName

        public String getName()
        Returns:
        Name of device as used in labeling or catalog.
      • getJurisdictionElement

        public UriType getJurisdictionElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getJurisdiction" gives direct access to the value
      • setJurisdictionElement

        public Device.DeviceUdiComponent setJurisdictionElement​(UriType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getJurisdiction" gives direct access to the value
      • getJurisdiction

        public String getJurisdiction()
        Returns:
        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.
      • setJurisdiction

        public Device.DeviceUdiComponent setJurisdiction​(String value)
        Parameters:
        value - 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.
      • getCarrierHRFElement

        public StringType getCarrierHRFElement()
        Returns:
        carrierHRF (The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.). This is the underlying object with id, value and extensions. The accessor "getCarrierHRF" gives direct access to the value
      • setCarrierHRFElement

        public Device.DeviceUdiComponent setCarrierHRFElement​(StringType value)
        Parameters:
        value - carrierHRF (The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.). This is the underlying object with id, value and extensions. The accessor "getCarrierHRF" gives direct access to the value
      • getCarrierHRF

        public String getCarrierHRF()
        Returns:
        The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
      • setCarrierHRF

        public Device.DeviceUdiComponent setCarrierHRF​(String value)
        Parameters:
        value - The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
      • getCarrierAIDCElement

        public Base64BinaryType getCarrierAIDCElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getCarrierAIDC" gives direct access to the value
      • setCarrierAIDCElement

        public Device.DeviceUdiComponent setCarrierAIDCElement​(Base64BinaryType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getCarrierAIDC" gives direct access to the value
      • getCarrierAIDC

        public byte[] getCarrierAIDC()
        Returns:
        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.
      • setCarrierAIDC

        public Device.DeviceUdiComponent setCarrierAIDC​(byte[] value)
        Parameters:
        value - 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.
      • getIssuerElement

        public UriType getIssuerElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getIssuer" gives direct access to the value
      • setIssuerElement

        public Device.DeviceUdiComponent setIssuerElement​(UriType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getIssuer" gives direct access to the value
      • getIssuer

        public String getIssuer()
        Returns:
        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.
      • setIssuer

        public Device.DeviceUdiComponent setIssuer​(String value)
        Parameters:
        value - 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.
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class BackboneElement