Skip to main content


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

Delivery of bulk Supplies.

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

Fulfills plan, proposal or order.


Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property destination as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "destination", XMLPROJECTION = "ELEMENT");

Where the Supply was sent.


Property methods: destinationGet(), destinationGetSwizzled(), destinationIsValid(), destinationNewObject(), destinationSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

External identifier.

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

When event occurred.

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

When event occurred.

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

When event occurred.

Property methods: occurrenceTimingGet(), occurrenceTimingGetSwizzled(), occurrenceTimingIsValid(), occurrenceTimingNewObject(), occurrenceTimingSet()
property partOf as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");

Part of referenced event.

SupplyDelivery | Contract

Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property patient as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT");

Patient for whom the item is supplied.


Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property receiver as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "receiver", XMLPROJECTION = "ELEMENT");

Who collected the Supply.

Practitioner | PractitionerRole

Property methods: receiverBuildValueArray(), receiverCollectionToDisplay(), receiverCollectionToOdbc(), receiverDisplayToCollection(), receiverGet(), receiverGetObject(), receiverGetObjectId(), receiverGetSwizzled(), receiverIsValid(), receiverOdbcToCollection(), receiverSet(), receiverSetObject(), receiverSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");

in-progress | completed | abandoned | entered-in-error

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property suppliedItem as HS.FHIR.DTL.vR4.Model.Element.SupplyDelivery.suppliedItem (XMLNAME = "suppliedItem", XMLPROJECTION = "ELEMENT");

The item that is delivered or supplied.

Property methods: suppliedItemGet(), suppliedItemGetSwizzled(), suppliedItemIsValid(), suppliedItemNewObject(), suppliedItemSet()
property supplier as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "supplier", XMLPROJECTION = "ELEMENT");


Practitioner | PractitionerRole | Organization

Property methods: supplierGet(), supplierGetSwizzled(), supplierIsValid(), supplierNewObject(), supplierSet()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");

Category of dispense event.

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

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab