Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.DTL.vR4.Model.Resource.SupplyRequest

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

Request for a medication, substance or device.

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.vR4.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

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

any FHIR4 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.vR4.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.vR4.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 list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Business Identifier for SupplyRequest.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property itemCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "itemCodeableConcept", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Medication, Substance, or Device requested to be supplied.

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

Property methods: itemCodeableConceptGet(), itemCodeableConceptGetSwizzled(), itemCodeableConceptIsValid(), itemCodeableConceptNewObject(), itemCodeableConceptSet()
property itemReference as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "itemReference", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Medication, Substance, or Device requested to be supplied.

Medication | Substance | Device

Property methods: itemReferenceGet(), itemReferenceGetSwizzled(), itemReferenceIsValid(), itemReferenceNewObject(), itemReferenceSet()
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.vR4.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.vR4.Model.Datatype.Timing (XMLNAME = "occurrenceTiming", XMLPROJECTION = "ELEMENT");
Timing

When the request should be fulfilled.

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

Ordered item details.

Property methods: parameterBuildValueArray(), parameterCollectionToDisplay(), parameterCollectionToOdbc(), parameterDisplayToCollection(), parameterGet(), parameterGetObject(), parameterGetObjectId(), parameterGetSwizzled(), parameterIsValid(), parameterOdbcToCollection(), parameterSet(), parameterSetObject(), parameterSetObjectId()
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 quantity as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "quantity", XMLPROJECTION = "ELEMENT") [ Required ];
Quantity

The requested amount of the item indicated.

Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
property reasonCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

The reason why the supply item was requested.

any FHIR4 code may be used; supplyrequest-reason 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

The reason why the supply item was requested.

Condition | Observation | DiagnosticReport | DocumentReference

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

Individual making the request.

Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device

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

draft | active | suspended +

supplyrequest-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend supplyrequest-status|4.0.1 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.vR4.Model.Base.Reference (XMLNAME = "supplier", XMLPROJECTION = "ELEMENT");
Reference

Who is intended to fulfill the request.

Organization | HealthcareService

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