Skip to main content

HS.FHIR.vSTU3.Model.Resource.Device.Udi

deprecated class HS.FHIR.vSTU3.Model.Resource.Device.Udi extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
This resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = Device.Udi;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = Device.Udi;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property carrierAIDC as HS.FHIR.vSTU3.Model.Datatype.Base64Binary (XMLNAME = "carrierAIDC", XMLPROJECTION = "ELEMENT");
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.
Property methods: carrierAIDCGet(), carrierAIDCGetSwizzled(), carrierAIDCIsValid(), carrierAIDCNewObject(), carrierAIDCSet()
property carrierHRF as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "carrierHRF", XMLPROJECTION = "ELEMENT");
The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
Property methods: carrierHRFGet(), carrierHRFGetSwizzled(), carrierHRFIsValid(), carrierHRFNewObject(), carrierHRFSet()
property deviceIdentifier as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "deviceIdentifier", XMLPROJECTION = "ELEMENT");
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.
Property methods: deviceIdentifierGet(), deviceIdentifierGetSwizzled(), deviceIdentifierIsValid(), deviceIdentifierNewObject(), deviceIdentifierSet()
property entryType as HS.FHIR.vSTU3.Model.Base.UDIEntryType (XMLNAME = "entryType", XMLPROJECTION = "ELEMENT");
A coded entry to indicate how the data was entered.
Property methods: entryTypeGet(), entryTypeGetSwizzled(), entryTypeIsValid(), entryTypeNewObject(), entryTypeSet()
property issuer as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "issuer", XMLPROJECTION = "ELEMENT");
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.
Property methods: issuerGet(), issuerGetSwizzled(), issuerIsValid(), issuerNewObject(), issuerSet()
property jurisdiction as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
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.
Property methods: jurisdictionGet(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionNewObject(), jurisdictionSet()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT");
Name of device as used in labeling or catalog.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()

Methods

deprecated method SetCarrierAIDC(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "carrierAIDC" property.
deprecated method SetCarrierHRF(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "carrierHRF" property.
deprecated method SetDeviceIdentifier(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "deviceIdentifier" property.
deprecated method SetEntryType(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "entryType" property.
deprecated method SetIssuer(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "issuer" property.
deprecated method SetJurisdiction(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "jurisdiction" property.
deprecated method SetName(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "name" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab