OO Incubator Implementation Guide
0.1.0 - ci-build Global (Whole world)

OO Incubator Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/oo-incubator/ and changes regularly. See the Directory of published versions

Resource: SupplyDelivery - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the SupplyDelivery resource

Guidance on how to interpret the contents of this table can be foundhere

0. SupplyDelivery
Definition

Record of movement of supplies from one location to another.


A resource that includes narrative, extensions, and contained resources.

ShortRecord of movement of supplies from one location to anotherA resource with narrative, extensions, and contained resources
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. SupplyDelivery.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resource id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. SupplyDelivery.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. SupplyDelivery.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the additionalImplicitRules extension.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. SupplyDelivery.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot5
(required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot5)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. SupplyDelivery.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. SupplyDelivery.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. SupplyDelivery.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on SupplyDelivery.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 16. SupplyDelivery.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Must Supportfalse
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on SupplyDelivery.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 18. SupplyDelivery.identifier
      Definition

      Identifier for the supply delivery event that is used to identify it across multiple disparate systems.

      ShortExternal identifier
      Comments

      This identifier is typically assigned by the supplier, and may be used to reference the delivery when exchanging information about it with other systems.

      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      20. SupplyDelivery.basedOn
      Definition

      A plan, proposal or order that is fulfilled in whole or in part by this event.

      ShortFulfills plan, proposal or order
      Control0..*
      TypeReference(SupplyRequest)
      Summarytrue
      Requirements

      Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

      22. SupplyDelivery.partOf
      Definition

      A larger event of which this particular event is a component or step.

      ShortPart of referenced event
      Comments

      Not to be used to link an event to an Encounter - use Event.context for that.

      [The allowed reference resources may be adjusted as appropriate for the event resource].

      Control0..*
      TypeReference(SupplyDelivery, http://hl7.org/fhir/StructureDefinition/Contract)
      Summarytrue
      Requirements

      E.g. Drug administration as part of a procedure, procedure as part of observation, etc.

      24. SupplyDelivery.status
      Definition

      A code specifying the state of the dispense event.

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

      This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

      Control1..1
      BindingThe codes SHALL be taken from Supply Delivery Status Valueshttp://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-status
      (required to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-status)

      Status of the supply delivery.

      Typecode
      Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      26. SupplyDelivery.subject
      Definition

      A link to a resource representing the person whom the delivered item is for.

      ShortIndividual(s) or organization for whom the item is supplied
      Comments

      Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

      Control0..1
      TypeReference(Patient, Group, Organization)
      28. SupplyDelivery.type
      Definition

      Indicates the type of supply being provided. Examples include: Medication, Device, Biologically Derived Product.

      ShortCategory of supply event
      Control0..1
      BindingUnless not suitable, these codes SHALL be taken from Supply Delivery Supply Item Type Valueshttp://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-supplyitemtype
      (extensible to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-supplyitemtype)

      The type of supply dispense.

      TypeCodeableConcept
      30. SupplyDelivery.stage
      Definition

      Indicates the stage of the delivery. In case the delivery is tracked only at the specific events (e.g. receipt), this resource represents the stage represented, not the entire history nor previous delivery stages.

      ShortStage or event of delivery
      Control1..1
      BindingUnless not suitable, these codes SHALL be taken from Supply Delivery Stage Valueshttp://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-stage
      (extensible to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-stage)

      The stage of supply delivery.

      TypeCodeableConcept
      Summarytrue
      32. SupplyDelivery.suppliedItem
      Definition

      The item that is being delivered or has been supplied.

      ShortThe item that is delivered or supplied
      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
      34. SupplyDelivery.suppliedItem.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      This element is affected by the following invariants: ele-1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      36. SupplyDelivery.suppliedItem.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on SupplyDelivery.suppliedItem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 38. SupplyDelivery.suppliedItem.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on SupplyDelivery.suppliedItem.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 40. SupplyDelivery.suppliedItem.quantity
          Definition

          The amount of the item that has been supplied. Unit of measure may be included.

          ShortAmount supplied
          Control0..1
          TypeQuantity(SimpleQuantity)
          42. SupplyDelivery.suppliedItem.condition
          Definition

          The condition in which the supplied item was at the event (shipment, or receipt, etc.). For example, to indicate when the supplied item is not suitable for use (e.g., damaged or out of temperature control).

          ShortA description of the supplied item's condition (e.g., box is damaged)
          Control0..1
          BindingFor example codes, see Supply Delivery Supply Item Condition Valueshttp://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-supplyitemcondition
          (example to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-supplyitemcondition)

          The condition of the supplied or received item.

          TypeCodeableConcept
          44. SupplyDelivery.suppliedItem.item[x]
          Definition

          Identifies the medication, substance, device or biologically derived product being supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.

          ShortMedication, Substance, Device or Biologically Derived Product supplied
          Control0..1
          BindingFor example codes, see Supply Delivery Supply Item Type Valueshttp://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-supplyitemtype
          (example to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-supplyitemtype)

          The item that was delivered.

          TypeChoice of: CodeableConcept, Reference(Medication, Substance, Device, BiologicallyDerivedProduct, NutritionProduct, InventoryItem)
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          46. SupplyDelivery.occurrence[x]
          Definition

          The date or time(s) the activity occurred.

          ShortWhen event occurred
          Comments

          [The list of types may be constrained as appropriate for the type of event].

          Control0..1
          TypeChoice of: dateTime, Period, Timing
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          48. SupplyDelivery.supplier
          Definition

          The individual or organization responsible for supplying the delivery.

          ShortThe item supplier
          Control0..1
          TypeReference(Practitioner, PractitionerRole, Organization)
          50. SupplyDelivery.destination
          Definition

          Identification of the facility, location or person where the delivery is shipped to.

          ShortWhere the delivery was sent
          Control0..1
          TypeReference(Location, Practitioner, PractitionerRole, Organization)
          52. SupplyDelivery.receiver
          Definition

          Identifies the individual(s) or organization that received the delivery.

          ShortWho received the delivery
          Comments

          Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

          Control0..*
          TypeReference(Practitioner, PractitionerRole, Organization, Group)

          Guidance on how to interpret the contents of this table can be foundhere

          0. SupplyDelivery
          Definition

          Record of movement of supplies from one location to another.

          ShortRecord of movement of supplies from one location to another
          Control0..*
          2. SupplyDelivery.identifier
          Definition

          Identifier for the supply delivery event that is used to identify it across multiple disparate systems.

          ShortExternal identifier
          Comments

          This identifier is typically assigned by the supplier, and may be used to reference the delivery when exchanging information about it with other systems.

          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier
          4. SupplyDelivery.basedOn
          Definition

          A plan, proposal or order that is fulfilled in whole or in part by this event.

          ShortFulfills plan, proposal or order
          Control0..*
          TypeReference(SupplyRequest)
          Requirements

          Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

          6. SupplyDelivery.partOf
          Definition

          A larger event of which this particular event is a component or step.

          ShortPart of referenced event
          Comments

          Not to be used to link an event to an Encounter - use Event.context for that.

          [The allowed reference resources may be adjusted as appropriate for the event resource].

          Control0..*
          TypeReference(SupplyDelivery, http://hl7.org/fhir/StructureDefinition/Contract)
          Requirements

          E.g. Drug administration as part of a procedure, procedure as part of observation, etc.

          8. SupplyDelivery.status
          Definition

          A code specifying the state of the dispense event.

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

          This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

          Control1..1
          BindingThe codes SHALL be taken from Supply Delivery Status Values
          (required to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-status)

          Status of the supply delivery.

          Typecode
          Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          10. SupplyDelivery.subject
          Definition

          A link to a resource representing the person whom the delivered item is for.

          ShortIndividual(s) or organization for whom the item is supplied
          Comments

          Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

          Control0..1
          TypeReference(Patient, Group, Organization)
          12. SupplyDelivery.type
          Definition

          Indicates the type of supply being provided. Examples include: Medication, Device, Biologically Derived Product.

          ShortCategory of supply event
          Control0..1
          BindingUnless not suitable, these codes SHALL be taken from Supply Delivery Supply Item Type Values
          (extensible to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-supplyitemtype)

          The type of supply dispense.

          TypeCodeableConcept
          14. SupplyDelivery.stage
          Definition

          Indicates the stage of the delivery. In case the delivery is tracked only at the specific events (e.g. receipt), this resource represents the stage represented, not the entire history nor previous delivery stages.

          ShortStage or event of delivery
          Control1..1
          BindingUnless not suitable, these codes SHALL be taken from Supply Delivery Stage Values
          (extensible to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-stage)

          The stage of supply delivery.

          TypeCodeableConcept
          16. SupplyDelivery.suppliedItem
          Definition

          The item that is being delivered or has been supplied.

          ShortThe item that is delivered or supplied
          Control0..*
          TypeBackboneElement
          18. SupplyDelivery.suppliedItem.quantity
          Definition

          The amount of the item that has been supplied. Unit of measure may be included.

          ShortAmount supplied
          Control0..1
          TypeQuantity(SimpleQuantity)
          20. SupplyDelivery.suppliedItem.condition
          Definition

          The condition in which the supplied item was at the event (shipment, or receipt, etc.). For example, to indicate when the supplied item is not suitable for use (e.g., damaged or out of temperature control).

          ShortA description of the supplied item's condition (e.g., box is damaged)
          Control0..1
          BindingFor example codes, see Supply Delivery Supply Item Condition Values
          (example to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-supplyitemcondition)

          The condition of the supplied or received item.

          TypeCodeableConcept
          22. SupplyDelivery.suppliedItem.item[x]
          Definition

          Identifies the medication, substance, device or biologically derived product being supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.

          ShortMedication, Substance, Device or Biologically Derived Product supplied
          Control0..1
          BindingFor example codes, see Supply Delivery Supply Item Type Values
          (example to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-supplyitemtype)

          The item that was delivered.

          TypeChoice of: CodeableConcept, Reference(Medication, Substance, Device, BiologicallyDerivedProduct, NutritionProduct, InventoryItem)
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          24. SupplyDelivery.occurrence[x]
          Definition

          The date or time(s) the activity occurred.

          ShortWhen event occurred
          Comments

          [The list of types may be constrained as appropriate for the type of event].

          Control0..1
          TypeChoice of: dateTime, Period, Timing
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          26. SupplyDelivery.supplier
          Definition

          The individual or organization responsible for supplying the delivery.

          ShortThe item supplier
          Control0..1
          TypeReference(Practitioner, PractitionerRole, Organization)
          28. SupplyDelivery.destination
          Definition

          Identification of the facility, location or person where the delivery is shipped to.

          ShortWhere the delivery was sent
          Control0..1
          TypeReference(Location, Practitioner, PractitionerRole, Organization)
          30. SupplyDelivery.receiver
          Definition

          Identifies the individual(s) or organization that received the delivery.

          ShortWho received the delivery
          Comments

          Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

          Control0..*
          TypeReference(Practitioner, PractitionerRole, Organization, Group)

          Guidance on how to interpret the contents of this table can be foundhere

          0. SupplyDelivery
          Definition

          Record of movement of supplies from one location to another.

          ShortRecord of movement of supplies from one location to another
          Control0..*
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())
          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
          dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
          dom-6: A resource should have narrative for robust management (text.`div`.exists())
          2. SupplyDelivery.id
          Definition

          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

          ShortLogical id of this artifact
          Comments

          Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resource id depends on the given use case.

          Control0..1
          Typeid
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          4. SupplyDelivery.meta
          Definition

          The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          6. SupplyDelivery.implicitRules
          Definition

          A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the additionalImplicitRules extension.

          ShortA set of rules under which this content was created
          Comments

          Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

          Control0..1
          Typeuri
          Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          8. SupplyDelivery.language
          Definition

          The base language in which the resource is written.

          ShortLanguage of the resource content
          Comments

          Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

          Control0..1
          BindingThe codes SHALL be taken from AllLanguages
          (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot5)

          IETF language tag for a human language

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          10. SupplyDelivery.text
          Definition

          A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

          ShortText summary of the resource, for human interpretation
          Comments

          Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

          Control0..1
          This element is affected by the following invariants: dom-6
          TypeNarrative
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesnarrative, html, xhtml, display
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. SupplyDelivery.contained
          Definition

          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

          ShortContained, inline Resources
          Comments

          This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

          Control0..*
          This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
          TypeResource
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          14. SupplyDelivery.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on SupplyDelivery.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 16. SupplyDelivery.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
            Must Supportfalse
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on SupplyDelivery.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 18. SupplyDelivery.identifier
              Definition

              Identifier for the supply delivery event that is used to identify it across multiple disparate systems.

              ShortExternal identifier
              Comments

              This identifier is typically assigned by the supplier, and may be used to reference the delivery when exchanging information about it with other systems.

              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..*
              TypeIdentifier
              20. SupplyDelivery.basedOn
              Definition

              A plan, proposal or order that is fulfilled in whole or in part by this event.

              ShortFulfills plan, proposal or order
              Control0..*
              TypeReference(SupplyRequest)
              Summarytrue
              Requirements

              Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

              22. SupplyDelivery.partOf
              Definition

              A larger event of which this particular event is a component or step.

              ShortPart of referenced event
              Comments

              Not to be used to link an event to an Encounter - use Event.context for that.

              [The allowed reference resources may be adjusted as appropriate for the event resource].

              Control0..*
              TypeReference(SupplyDelivery, http://hl7.org/fhir/StructureDefinition/Contract)
              Summarytrue
              Requirements

              E.g. Drug administration as part of a procedure, procedure as part of observation, etc.

              24. SupplyDelivery.status
              Definition

              A code specifying the state of the dispense event.

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

              This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

              Control1..1
              BindingThe codes SHALL be taken from Supply Delivery Status Values
              (required to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-status)

              Status of the supply delivery.

              Typecode
              Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              26. SupplyDelivery.subject
              Definition

              A link to a resource representing the person whom the delivered item is for.

              ShortIndividual(s) or organization for whom the item is supplied
              Comments

              Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

              Control0..1
              TypeReference(Patient, Group, Organization)
              28. SupplyDelivery.type
              Definition

              Indicates the type of supply being provided. Examples include: Medication, Device, Biologically Derived Product.

              ShortCategory of supply event
              Control0..1
              BindingUnless not suitable, these codes SHALL be taken from Supply Delivery Supply Item Type Values
              (extensible to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-supplyitemtype)

              The type of supply dispense.

              TypeCodeableConcept
              30. SupplyDelivery.stage
              Definition

              Indicates the stage of the delivery. In case the delivery is tracked only at the specific events (e.g. receipt), this resource represents the stage represented, not the entire history nor previous delivery stages.

              ShortStage or event of delivery
              Control1..1
              BindingUnless not suitable, these codes SHALL be taken from Supply Delivery Stage Values
              (extensible to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-stage)

              The stage of supply delivery.

              TypeCodeableConcept
              Summarytrue
              32. SupplyDelivery.suppliedItem
              Definition

              The item that is being delivered or has been supplied.

              ShortThe item that is delivered or supplied
              Control0..*
              TypeBackboneElement
              Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
              34. SupplyDelivery.suppliedItem.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              This element is affected by the following invariants: ele-1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              36. SupplyDelivery.suppliedItem.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              SlicingThis element introduces a set of slices on SupplyDelivery.suppliedItem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 38. SupplyDelivery.suppliedItem.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on SupplyDelivery.suppliedItem.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 40. SupplyDelivery.suppliedItem.quantity
                  Definition

                  The amount of the item that has been supplied. Unit of measure may be included.

                  ShortAmount supplied
                  Control0..1
                  TypeQuantity(SimpleQuantity)
                  42. SupplyDelivery.suppliedItem.condition
                  Definition

                  The condition in which the supplied item was at the event (shipment, or receipt, etc.). For example, to indicate when the supplied item is not suitable for use (e.g., damaged or out of temperature control).

                  ShortA description of the supplied item's condition (e.g., box is damaged)
                  Control0..1
                  BindingFor example codes, see Supply Delivery Supply Item Condition Values
                  (example to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-supplyitemcondition)

                  The condition of the supplied or received item.

                  TypeCodeableConcept
                  44. SupplyDelivery.suppliedItem.item[x]
                  Definition

                  Identifies the medication, substance, device or biologically derived product being supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.

                  ShortMedication, Substance, Device or Biologically Derived Product supplied
                  Control0..1
                  BindingFor example codes, see Supply Delivery Supply Item Type Values
                  (example to http://hl7.org/fhir/uv/oo-incubator/ValueSet/supplydelivery-supplyitemtype)

                  The item that was delivered.

                  TypeChoice of: CodeableConcept, Reference(Medication, Substance, Device, BiologicallyDerivedProduct, NutritionProduct, InventoryItem)
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  46. SupplyDelivery.occurrence[x]
                  Definition

                  The date or time(s) the activity occurred.

                  ShortWhen event occurred
                  Comments

                  [The list of types may be constrained as appropriate for the type of event].

                  Control0..1
                  TypeChoice of: dateTime, Period, Timing
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  48. SupplyDelivery.supplier
                  Definition

                  The individual or organization responsible for supplying the delivery.

                  ShortThe item supplier
                  Control0..1
                  TypeReference(Practitioner, PractitionerRole, Organization)
                  50. SupplyDelivery.destination
                  Definition

                  Identification of the facility, location or person where the delivery is shipped to.

                  ShortWhere the delivery was sent
                  Control0..1
                  TypeReference(Location, Practitioner, PractitionerRole, Organization)
                  52. SupplyDelivery.receiver
                  Definition

                  Identifies the individual(s) or organization that received the delivery.

                  ShortWho received the delivery
                  Comments

                  Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

                  Control0..*
                  TypeReference(Practitioner, PractitionerRole, Organization, Group)