Skip to main content


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

Item used in healthcare.

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.vR4.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 definition as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");

The reference to the definition for the device.


Property methods: definitionGet(), definitionGetSwizzled(), definitionIsValid(), definitionNewObject(), definitionSet()
property deviceName as list of HS.FHIR.DTL.vR4.Model.Element.Device.deviceName (XMLNAME = "deviceName", XMLPROJECTION = "ELEMENT");

The name of the device as given by the manufacturer.

Property methods: deviceNameBuildValueArray(), deviceNameCollectionToDisplay(), deviceNameCollectionToOdbc(), deviceNameDisplayToCollection(), deviceNameGet(), deviceNameGetObject(), deviceNameGetObjectId(), deviceNameGetSwizzled(), deviceNameIsValid(), deviceNameOdbcToCollection(), deviceNameSet(), deviceNameSetObject(), deviceNameSetObjectId()
property distinctIdentifier as %String (MAXLEN = 1000000, XMLNAME = "distinctIdentifier", XMLPROJECTION = "ATTRIBUTE");

The distinct identification string.

Property methods: distinctIdentifierDisplayToLogical(), distinctIdentifierGet(), distinctIdentifierIsValid(), distinctIdentifierLogicalToDisplay(), distinctIdentifierLogicalToOdbc(), distinctIdentifierNormalize(), distinctIdentifierSet()
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.vR4.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.vR4.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");

Where the device 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 modelNumber as %String (MAXLEN = 1000000, XMLNAME = "modelNumber", XMLPROJECTION = "ATTRIBUTE");

The model number for the device.

Property methods: modelNumberDisplayToLogical(), modelNumberGet(), modelNumberIsValid(), modelNumberLogicalToDisplay(), modelNumberLogicalToOdbc(), modelNumberNormalize(), modelNumberSet()
property note as list of HS.FHIR.DTL.vR4.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.vR4.Model.Base.Reference (XMLNAME = "owner", XMLPROJECTION = "ELEMENT");

Organization responsible for device.


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

The parent device.


Property methods: parentGet(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentSet()
property partNumber as %String (MAXLEN = 1000000, XMLNAME = "partNumber", XMLPROJECTION = "ATTRIBUTE");

The part number of the device.

Property methods: partNumberDisplayToLogical(), partNumberGet(), partNumberIsValid(), partNumberLogicalToDisplay(), partNumberLogicalToOdbc(), partNumberNormalize(), partNumberSet()
property patient as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT");

Patient to whom Device is affixed.


Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property property as list of (XMLNAME = "property", XMLPROJECTION = "ELEMENT");

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

Property methods: propertyBuildValueArray(), propertyCollectionToDisplay(), propertyCollectionToOdbc(), propertyDisplayToCollection(), propertyGet(), propertyGetObject(), propertyGetObjectId(), propertyGetSwizzled(), propertyIsValid(), propertyOdbcToCollection(), propertySet(), propertySetObject(), propertySetObjectId()
property safety as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "safety", XMLPROJECTION = "ELEMENT");

Safety Characteristics of Device.

any FHIR4 code from any ValueSet may be used.

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

Serial number assigned by the manufacturer.

Property methods: serialNumberDisplayToLogical(), serialNumberGet(), serialNumberIsValid(), serialNumberLogicalToDisplay(), serialNumberLogicalToOdbc(), serialNumberNormalize(), serialNumberSet()
property specialization as list of HS.FHIR.DTL.vR4.Model.Element.Device.specialization (XMLNAME = "specialization", XMLPROJECTION = "ELEMENT");

The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

Property methods: specializationBuildValueArray(), specializationCollectionToDisplay(), specializationCollectionToOdbc(), specializationDisplayToCollection(), specializationGet(), specializationGetObject(), specializationGetObjectId(), specializationGetSwizzled(), specializationIsValid(), specializationOdbcToCollection(), specializationSet(), specializationSetObject(), specializationSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");

active | inactive | entered-in-error | unknown

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

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

online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off

device-status-reason is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in device-status-reason, you may formally EXTEND device-status-reason to add codes to it.

Property methods: statusReasonBuildValueArray(), statusReasonCollectionToDisplay(), statusReasonCollectionToOdbc(), statusReasonDisplayToCollection(), statusReasonGet(), statusReasonGetObject(), statusReasonGetObjectId(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonOdbcToCollection(), statusReasonSet(), statusReasonSetObject(), statusReasonSetObjectId()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");

The kind or type of device.

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

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

Unique Device Identifier (UDI) Barcode string.

Property methods: udiCarrierBuildValueArray(), udiCarrierCollectionToDisplay(), udiCarrierCollectionToOdbc(), udiCarrierDisplayToCollection(), udiCarrierGet(), udiCarrierGetObject(), udiCarrierGetObjectId(), udiCarrierGetSwizzled(), udiCarrierIsValid(), udiCarrierOdbcToCollection(), udiCarrierSet(), udiCarrierSetObject(), udiCarrierSetObjectId()
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 list of HS.FHIR.DTL.vR4.Model.Element.Device.version (XMLNAME = "version", XMLPROJECTION = "ELEMENT");

The actual design of the device or software version running on the device.

Property methods: versionBuildValueArray(), versionCollectionToDisplay(), versionCollectionToOdbc(), versionDisplayToCollection(), versionGet(), versionGetObject(), versionGetObjectId(), versionGetSwizzled(), versionIsValid(), versionOdbcToCollection(), versionSet(), versionSetObject(), versionSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab