Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.DeviceRequest

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

Medical device request.

Property 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 XMLNAME = DeviceRequest;
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 XMLPROJECTION = ELEMENT;
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 = DeviceRequest;
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 authoredOn as %String (MAXLEN = 1000000, XMLNAME = "authoredOn", XMLPROJECTION = "ATTRIBUTE");
dateTime

When recorded.

Property methods: authoredOnDisplayToLogical(), authoredOnGet(), authoredOnIsValid(), authoredOnLogicalToDisplay(), authoredOnLogicalToOdbc(), authoredOnNormalize(), authoredOnSet()
property basedOn as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

What request fulfills.

Any FHIR4 Resource may be indicated by this Reference

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property codeCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "codeCodeableConcept", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Device requested.

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

Property methods: codeCodeableConceptGet(), codeCodeableConceptGetSwizzled(), codeCodeableConceptIsValid(), codeCodeableConceptNewObject(), codeCodeableConceptSet()
property codeReference as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "codeReference", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Device requested.

Device.

Property methods: codeReferenceGet(), codeReferenceGetSwizzled(), codeReferenceIsValid(), codeReferenceNewObject(), codeReferenceSet()
property encounter as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Reference

Encounter motivating request.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property groupIdentifier as HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "groupIdentifier", XMLPROJECTION = "ELEMENT");
Identifier

Identifier of composite request.

Property methods: groupIdentifierGet(), groupIdentifierGetSwizzled(), groupIdentifierIsValid(), groupIdentifierNewObject(), groupIdentifierSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

External Request identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property instantiatesCanonical as list of %String (MAXLEN = 1000000, XMLNAME = "instantiatesCanonical", XMLPROJECTION = "ELEMENT");
canonical

Instantiates FHIR protocol or definition.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: instantiatesCanonicalBuildValueArray(), instantiatesCanonicalCollectionToDisplay(), instantiatesCanonicalCollectionToOdbc(), instantiatesCanonicalDisplayToCollection(), instantiatesCanonicalDisplayToLogical(), instantiatesCanonicalGet(), instantiatesCanonicalGetObject(), instantiatesCanonicalGetObjectId(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalLogicalToDisplay(), instantiatesCanonicalLogicalToOdbc(), instantiatesCanonicalNormalize(), instantiatesCanonicalOdbcToCollection(), instantiatesCanonicalSet(), instantiatesCanonicalSetObject(), instantiatesCanonicalSetObjectId()
property instantiatesUri as list of %String (MAXLEN = 1000000, XMLNAME = "instantiatesUri", XMLPROJECTION = "ELEMENT");
uri

Instantiates external protocol or definition.

Property methods: instantiatesUriBuildValueArray(), instantiatesUriCollectionToDisplay(), instantiatesUriCollectionToOdbc(), instantiatesUriDisplayToCollection(), instantiatesUriDisplayToLogical(), instantiatesUriGet(), instantiatesUriGetObject(), instantiatesUriGetObjectId(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriLogicalToDisplay(), instantiatesUriLogicalToOdbc(), instantiatesUriNormalize(), instantiatesUriOdbcToCollection(), instantiatesUriSet(), instantiatesUriSetObject(), instantiatesUriSetObjectId()
property insurance as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "insurance", XMLPROJECTION = "ELEMENT");
Reference

Associated insurance coverage.

Coverage | ClaimResponse

Property methods: insuranceBuildValueArray(), insuranceCollectionToDisplay(), insuranceCollectionToOdbc(), insuranceDisplayToCollection(), insuranceGet(), insuranceGetObject(), insuranceGetObjectId(), insuranceGetSwizzled(), insuranceIsValid(), insuranceOdbcToCollection(), insuranceSet(), insuranceSetObject(), insuranceSetObjectId()
property intent as %String (MAXLEN = 1000000, XMLNAME = "intent", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option

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

Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Notes or comments.

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

Desired time or schedule for use.

Property methods: occurrenceDateTimeDisplayToLogical(), occurrenceDateTimeGet(), occurrenceDateTimeIsValid(), occurrenceDateTimeLogicalToDisplay(), occurrenceDateTimeLogicalToOdbc(), occurrenceDateTimeNormalize(), occurrenceDateTimeSet()
property occurrencePeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "occurrencePeriod", XMLPROJECTION = "ELEMENT");
Period

Desired time or schedule for use.

Property methods: occurrencePeriodGet(), occurrencePeriodGetSwizzled(), occurrencePeriodIsValid(), occurrencePeriodNewObject(), occurrencePeriodSet()
property occurrenceTiming as HS.FHIR.DTL.vR4.Model.Datatype.Timing (XMLNAME = "occurrenceTiming", XMLPROJECTION = "ELEMENT");
Timing

Desired time or schedule for use.

Property methods: occurrenceTimingGet(), occurrenceTimingGetSwizzled(), occurrenceTimingIsValid(), occurrenceTimingNewObject(), occurrenceTimingSet()
property parameter as list of HS.FHIR.DTL.vR4.Model.Element.DeviceRequest.parameter (XMLNAME = "parameter", XMLPROJECTION = "ELEMENT");
BackboneElement

Device details.

Property methods: parameterBuildValueArray(), parameterCollectionToDisplay(), parameterCollectionToOdbc(), parameterDisplayToCollection(), parameterGet(), parameterGetObject(), parameterGetObjectId(), parameterGetSwizzled(), parameterIsValid(), parameterOdbcToCollection(), parameterSet(), parameterSetObject(), parameterSetObjectId()
property performer as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Reference

Requested Filler.

Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson

Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet(), performerTypeGet(), performerTypeGetSwizzled(), performerTypeIsValid(), performerTypeNewObject(), performerTypeSet()
property performerType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "performerType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Filler role.

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

Property methods: performerTypeGet(), performerTypeGetSwizzled(), performerTypeIsValid(), performerTypeNewObject(), performerTypeSet()
property priorRequest as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "priorRequest", XMLPROJECTION = "ELEMENT");
Reference

What request replaces.

Any FHIR4 Resource may be indicated by this Reference

Property methods: priorRequestBuildValueArray(), priorRequestCollectionToDisplay(), priorRequestCollectionToOdbc(), priorRequestDisplayToCollection(), priorRequestGet(), priorRequestGetObject(), priorRequestGetObjectId(), priorRequestGetSwizzled(), priorRequestIsValid(), priorRequestOdbcToCollection(), priorRequestSet(), priorRequestSetObject(), priorRequestSetObjectId()
property priority as %String (MAXLEN = 1000000, XMLNAME = "priority", XMLPROJECTION = "ATTRIBUTE");
code

routine | urgent | asap | stat

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

Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
property reasonCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Coded Reason for request.

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

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Linked Reason for request.

Condition | Observation | DiagnosticReport | DocumentReference

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property relevantHistory as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "relevantHistory", XMLPROJECTION = "ELEMENT");
Reference

Request provenance.

Provenance

Property methods: relevantHistoryBuildValueArray(), relevantHistoryCollectionToDisplay(), relevantHistoryCollectionToOdbc(), relevantHistoryDisplayToCollection(), relevantHistoryGet(), relevantHistoryGetObject(), relevantHistoryGetObjectId(), relevantHistoryGetSwizzled(), relevantHistoryIsValid(), relevantHistoryOdbcToCollection(), relevantHistorySet(), relevantHistorySetObject(), relevantHistorySetObjectId()
property requester as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "requester", XMLPROJECTION = "ELEMENT");
Reference

Who/what is requesting diagnostics.

Device | Practitioner | PractitionerRole | Organization

Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");
code

draft | active | on-hold | revoked | completed | entered-in-error | unknown

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

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

Focus of request.

Patient | Group | Location | Device

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property supportingInfo as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "supportingInfo", XMLPROJECTION = "ELEMENT");
Reference

Additional clinical information.

Any FHIR4 Resource may be indicated by this Reference

Property methods: supportingInfoBuildValueArray(), supportingInfoCollectionToDisplay(), supportingInfoCollectionToOdbc(), supportingInfoDisplayToCollection(), supportingInfoGet(), supportingInfoGetObject(), supportingInfoGetObjectId(), supportingInfoGetSwizzled(), supportingInfoIsValid(), supportingInfoOdbcToCollection(), supportingInfoSet(), supportingInfoSetObject(), supportingInfoSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab