Skip to main content


class HS.FHIR.DTL.vSTU3.Model.Resource.Device extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

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


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 XMLNAME = Device;
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;
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.


property contact as list of HS.FHIR.DTL.vSTU3.Model.Datatype.ContactPoint (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");

Details for human/organization for support.

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property expirationDate as %String (MAXLEN = 1000000, XMLNAME = "expirationDate", XMLPROJECTION = "ATTRIBUTE");

Date and time of expiry of this device (if applicable)

Property methods: expirationDateDisplayToLogical(), expirationDateGet(), expirationDateIsValid(), expirationDateLogicalToDisplay(), expirationDateLogicalToOdbc(), expirationDateNormalize(), expirationDateSet()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Instance identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property location as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");

Where the resource is found.


Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property lotNumber as %String (MAXLEN = 1000000, XMLNAME = "lotNumber", XMLPROJECTION = "ATTRIBUTE");

Lot number of manufacture.

Property methods: lotNumberDisplayToLogical(), lotNumberGet(), lotNumberIsValid(), lotNumberLogicalToDisplay(), lotNumberLogicalToOdbc(), lotNumberNormalize(), lotNumberSet()
property manufactureDate as %String (MAXLEN = 1000000, XMLNAME = "manufactureDate", XMLPROJECTION = "ATTRIBUTE");

Date when the device was made.

Property methods: manufactureDateDisplayToLogical(), manufactureDateGet(), manufactureDateIsValid(), manufactureDateLogicalToDisplay(), manufactureDateLogicalToOdbc(), manufactureDateNormalize(), manufactureDateSet()
property manufacturer as %String (MAXLEN = 1000000, XMLNAME = "manufacturer", XMLPROJECTION = "ATTRIBUTE");

Name of device manufacturer.

Property methods: manufacturerDisplayToLogical(), manufacturerGet(), manufacturerIsValid(), manufacturerLogicalToDisplay(), manufacturerLogicalToOdbc(), manufacturerNormalize(), manufacturerSet()
property model as %String (MAXLEN = 1000000, XMLNAME = "model", XMLPROJECTION = "ATTRIBUTE");

Model id assigned by the manufacturer.

Property methods: modelDisplayToLogical(), modelGet(), modelIsValid(), modelLogicalToDisplay(), modelLogicalToOdbc(), modelNormalize(), modelSet()
property note as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");

Device notes and comments.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property owner as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "owner", XMLPROJECTION = "ELEMENT");

Organization responsible for device.


Property methods: ownerGet(), ownerGetSwizzled(), ownerIsValid(), ownerNewObject(), ownerSet()
property patient as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT");

Patient to whom Device is affixed.


Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property safety as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "safety", XMLPROJECTION = "ELEMENT");

Safety Characteristics of Device.

any FHIR3 code may be used; device-safety shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: safetyBuildValueArray(), safetyCollectionToDisplay(), safetyCollectionToOdbc(), safetyDisplayToCollection(), safetyGet(), safetyGetObject(), safetyGetObjectId(), safetyGetSwizzled(), safetyIsValid(), safetyOdbcToCollection(), safetySet(), safetySetObject(), safetySetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");

active | inactive | entered-in-error | unknown

device-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend device-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property type as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");

What kind of device this is.

any FHIR3 code may be used; device-kind shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property udi as HS.FHIR.DTL.vSTU3.Model.Element.Device.udi (XMLNAME = "udi", XMLPROJECTION = "ELEMENT");

Unique Device Identifier (UDI) Barcode string.

Property methods: udiGet(), udiGetSwizzled(), udiIsValid(), udiNewObject(), udiSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");

Network address to contact device.

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");

Version number (i.e. software)

Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab