Skip to main content


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

A record of a device being used by a patient where the record is the result of a report from the patient or another clinician. NOTE: These resources have not yet undergone proper review by PC, CQI, CDS, and OO. At this time, they are to be considered only as draft resource proposals for potential submission.

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 = DeviceUseStatement;
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 = DeviceUseStatement;
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 bodySite as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "bodySite", XMLPROJECTION = "ELEMENT");

Target body site.

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

Property methods: bodySiteGet(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteNewObject(), bodySiteSet()
property device as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "device", XMLPROJECTION = "ELEMENT") [ Required ];

Reference to device used.


Property methods: deviceGet(), deviceGetSwizzled(), deviceIsValid(), deviceNewObject(), deviceSet()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

External identifier for this record.

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

Why device was used.

any FHIR3 code from any ValueSet may be used.

Property methods: indicationBuildValueArray(), indicationCollectionToDisplay(), indicationCollectionToOdbc(), indicationDisplayToCollection(), indicationGet(), indicationGetObject(), indicationGetObjectId(), indicationGetSwizzled(), indicationIsValid(), indicationOdbcToCollection(), indicationSet(), indicationSetObject(), indicationSetObjectId()
property note as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");

Addition details (comments, instructions)

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property recordedOn as %String (MAXLEN = 1000000, XMLNAME = "recordedOn", XMLPROJECTION = "ATTRIBUTE");

When statement was recorded.

Property methods: recordedOnDisplayToLogical(), recordedOnGet(), recordedOnIsValid(), recordedOnLogicalToDisplay(), recordedOnLogicalToOdbc(), recordedOnNormalize(), recordedOnSet()
property source as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "source", XMLPROJECTION = "ELEMENT");

Who made the statement.

Patient | Practitioner | RelatedPerson

Property methods: sourceGet(), sourceGetSwizzled(), sourceIsValid(), sourceNewObject(), sourceSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

active | completed | entered-in-error +

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];

Patient using device.

Patient | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property timingDateTime as %String (MAXLEN = 1000000, XMLNAME = "timingDateTime", XMLPROJECTION = "ATTRIBUTE");

How often the device was used.

Property methods: timingDateTimeDisplayToLogical(), timingDateTimeGet(), timingDateTimeIsValid(), timingDateTimeLogicalToDisplay(), timingDateTimeLogicalToOdbc(), timingDateTimeNormalize(), timingDateTimeSet()
property timingPeriod as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "timingPeriod", XMLPROJECTION = "ELEMENT");

How often the device was used.

Property methods: timingPeriodGet(), timingPeriodGetSwizzled(), timingPeriodIsValid(), timingPeriodNewObject(), timingPeriodSet()
property timingTiming as HS.FHIR.DTL.vSTU3.Model.Datatype.Timing (XMLNAME = "timingTiming", XMLPROJECTION = "ELEMENT");

How often the device was used.

Property methods: timingTimingGet(), timingTimingGetSwizzled(), timingTimingIsValid(), timingTimingNewObject(), timingTimingSet()
property whenUsed as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "whenUsed", XMLPROJECTION = "ELEMENT");

Period device was used.

Property methods: whenUsedGet(), whenUsedGetSwizzled(), whenUsedIsValid(), whenUsedNewObject(), whenUsedSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab