
Package org.hl7.fhir.dstu3.model
Class Device.DeviceUdiComponent
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.Element
-
- org.hl7.fhir.dstu3.model.BackboneElement
-
- org.hl7.fhir.dstu3.model.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 Summary
Fields Modifier and Type Field Description 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.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.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.protected Enumeration<Device.UDIEntryType>
entryType
A coded entry to indicate how the data was entered.protected UriType
issuer
Organization that is charged with issuing UDIs for devices.protected UriType
jurisdiction
The identity of the authoritative source for UDI generation within a jurisdiction.protected StringType
name
Name of device as used in labeling or catalog.-
Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement
modifierExtension
-
-
Constructor Summary
Constructors Constructor Description DeviceUdiComponent()
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension
-
Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
-
-
-
-
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.
-
entryType
protected Enumeration<Device.UDIEntryType> entryType
A coded entry to indicate how the data was entered.
-
-
Constructor Detail
-
DeviceUdiComponent
public DeviceUdiComponent()
Constructor
-
-
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
-
hasDeviceIdentifierElement
public boolean hasDeviceIdentifierElement()
-
hasDeviceIdentifier
public boolean hasDeviceIdentifier()
-
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
-
hasNameElement
public boolean hasNameElement()
-
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
-
setName
public Device.DeviceUdiComponent setName(String value)
- Parameters:
value
- 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
-
hasJurisdictionElement
public boolean hasJurisdictionElement()
-
hasJurisdiction
public boolean hasJurisdiction()
-
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
-
hasCarrierHRFElement
public boolean hasCarrierHRFElement()
-
hasCarrierHRF
public boolean hasCarrierHRF()
-
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
-
hasCarrierAIDCElement
public boolean hasCarrierAIDCElement()
-
hasCarrierAIDC
public boolean hasCarrierAIDC()
-
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
-
hasIssuerElement
public boolean hasIssuerElement()
-
hasIssuer
public boolean hasIssuer()
-
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.
-
getEntryTypeElement
public Enumeration<Device.UDIEntryType> getEntryTypeElement()
- Returns:
entryType
(A coded entry to indicate how the data was entered.). This is the underlying object with id, value and extensions. The accessor "getEntryType" gives direct access to the value
-
hasEntryTypeElement
public boolean hasEntryTypeElement()
-
hasEntryType
public boolean hasEntryType()
-
setEntryTypeElement
public Device.DeviceUdiComponent setEntryTypeElement(Enumeration<Device.UDIEntryType> value)
- Parameters:
value
-entryType
(A coded entry to indicate how the data was entered.). This is the underlying object with id, value and extensions. The accessor "getEntryType" gives direct access to the value
-
getEntryType
public Device.UDIEntryType getEntryType()
- Returns:
- A coded entry to indicate how the data was entered.
-
setEntryType
public Device.DeviceUdiComponent setEntryType(Device.UDIEntryType value)
- Parameters:
value
- A coded entry to indicate how the data was entered.
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
public Device.DeviceUdiComponent copy()
- Specified by:
copy
in classBackboneElement
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
-
-