Skip to main content

HS.FHIR.DTL.vSTU3.Model.Resource.SupplyRequest

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

A record of a request for a medication, substance or device used in the healthcare setting. NOTE: This resource is a request resource from a FHIR workflow perspective - see Workflow.

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 = SupplyRequest;
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 = SupplyRequest;
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 the request was made.

Property methods: authoredOnDisplayToLogical(), authoredOnGet(), authoredOnIsValid(), authoredOnLogicalToDisplay(), authoredOnLogicalToOdbc(), authoredOnNormalize(), authoredOnSet()
property category as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

The kind of supply (central, non-stock, etc.)

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

Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property deliverFrom as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "deliverFrom", XMLPROJECTION = "ELEMENT");
Reference

The origin of the supply.

Organization | Location

Property methods: deliverFromGet(), deliverFromGetSwizzled(), deliverFromIsValid(), deliverFromNewObject(), deliverFromSet()
property deliverTo as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "deliverTo", XMLPROJECTION = "ELEMENT");
Reference

The destination of the supply.

Organization | Location | Patient

Property methods: deliverToGet(), deliverToGetSwizzled(), deliverToIsValid(), deliverToNewObject(), deliverToSet()
property identifier as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Unique identifier.

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property occurrenceDateTime as %String (MAXLEN = 1000000, XMLNAME = "occurrenceDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

When the request should be fulfilled.

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

When the request should be fulfilled.

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

When the request should be fulfilled.

Property methods: occurrenceTimingGet(), occurrenceTimingGetSwizzled(), occurrenceTimingIsValid(), occurrenceTimingNewObject(), occurrenceTimingSet()
property orderedItem as HS.FHIR.DTL.vSTU3.Model.Element.SupplyRequest.orderedItem (XMLNAME = "orderedItem", XMLPROJECTION = "ELEMENT");
BackboneElement

The item being requested.

Property methods: orderedItemGet(), orderedItemGetSwizzled(), orderedItemIsValid(), orderedItemNewObject(), orderedItemSet()
property priority as %String (MAXLEN = 1000000, XMLNAME = "priority", XMLPROJECTION = "ATTRIBUTE");
code

routine | urgent | asap | stat

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

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

Why the supply item was requested.

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

Property methods: reasonCodeableConceptGet(), reasonCodeableConceptGetSwizzled(), reasonCodeableConceptIsValid(), reasonCodeableConceptNewObject(), reasonCodeableConceptSet()
property reasonReference as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Why the supply item was requested.

Any FHIR3 Resource may be indicated by this Reference.

Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property requester as HS.FHIR.DTL.vSTU3.Model.Element.SupplyRequest.requester (XMLNAME = "requester", XMLPROJECTION = "ELEMENT");
BackboneElement

Who/what is requesting service.

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

draft | active | suspended +

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

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

Who is intended to fulfill the request.

Organization

Property methods: supplierBuildValueArray(), supplierCollectionToDisplay(), supplierCollectionToOdbc(), supplierDisplayToCollection(), supplierGet(), supplierGetObject(), supplierGetObjectId(), supplierGetSwizzled(), supplierIsValid(), supplierOdbcToCollection(), supplierSet(), supplierSetObject(), supplierSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab