OO Incubator Implementation Guide
0.1.0 - ci-build International flag

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: DeviceDispense - Detailed Descriptions

Page standards status: Normative Maturity Level: 1

Definitions for the DeviceDispense resource

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

0. DeviceDispense
Definition

A record of dispensation of a device - i.e., assigning a device to a patient, or to a professional for their use.


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

ShortA record of dispensation of a deviceA 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. DeviceDispense.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 resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. DeviceDispense.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. DeviceDispense.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.

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. DeviceDispense.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-ballot3
(required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)

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. DeviceDispense.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. DeviceDispense.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. DeviceDispense.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 DeviceDispense.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 16. DeviceDispense.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 DeviceDispense.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 18. DeviceDispense.identifier
      Definition

      Business identifier for this dispensation.

      ShortBusiness identifier for this dispensation
      Comments

      This is a business identifier, not a resource identifier.

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

      The order or request that this dispense is fulfilling.

      ShortThe order or request that this dispense is fulfilling
      Control0..*
      TypeReference(CarePlan, DeviceRequest)
      22. DeviceDispense.partOf
      Definition

      The bigger event that this dispense is a part of.

      ShortThe bigger event that this dispense is a part of
      Control0..*
      TypeReference(Procedure)
      24. DeviceDispense.status
      Definition

      A code specifying the state of the set of dispense events.

      Shortpreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
      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 DeviceDispenseStatusCodeshttp://hl7.org/fhir/ValueSet/devicedispense-status
      (required to http://hl7.org/fhir/ValueSet/devicedispense-status)

      Describes the lifecycle of the dispense.

      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. DeviceDispense.statusReason
      Definition

      Indicates the reason why a dispense was or was not performed.

      ShortWhy a dispense was or was not performed
      Control0..1
      BindingFor example codes, see DeviceDispenseStatusReasonCodeshttp://hl7.org/fhir/ValueSet/devicedispense-status-reason
      (example to http://hl7.org/fhir/ValueSet/devicedispense-status-reason)
      TypeCodeableReference(DetectedIssue)
      28. DeviceDispense.category
      Definition

      Indicates the type of device dispense.

      ShortType of device dispense
      Comments

      The category can be used to include where the device is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.

      Control0..*
      TypeCodeableConcept
      30. DeviceDispense.device
      Definition

      Identifies the device being dispensed. This is either a link to a resource representing the details of the device or a simple attribute carrying a code that identifies the device from a known list of devices.

      ShortWhat device was supplied
      Control1..1
      TypeCodeableReference(Device, DeviceDefinition)
      Summarytrue
      32. DeviceDispense.subject
      Definition

      A link to a resource representing the person to whom the device is intended.

      ShortWho the dispense is for
      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.

      Control1..1
      TypeReference(Patient, Practitioner, Group)
      Summarytrue
      34. DeviceDispense.receiver
      Definition

      Identifies the person who picked up the device or the person or location where the device was delivered. This may be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.

      ShortWho collected the device or where the medication was delivered
      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, Practitioner, RelatedPerson, Location, PractitionerRole, Group)
      36. DeviceDispense.encounter
      Definition

      The encounter that establishes the context for this event.

      ShortEncounter associated with event
      Control0..1
      TypeReference(Encounter)
      38. DeviceDispense.supportingInformation
      Definition

      Additional information that supports the device being dispensed.

      ShortInformation that supports the dispensing of the device
      Control0..*
      TypeReference(Resource)
      40. DeviceDispense.performer
      Definition

      Indicates who or what performed the event.

      ShortWho performed event
      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
      42. DeviceDispense.performer.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
      Typeidstring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      44. DeviceDispense.performer.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 DeviceDispense.performer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 46. DeviceDispense.performer.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()))
        48. DeviceDispense.performer.function
        Definition

        Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.

        ShortWho performed the dispense and what they did
        Control0..1
        TypeCodeableConcept
        Requirements

        Allows disambiguation of the types of involvement of different performers.

        50. DeviceDispense.performer.actor
        Definition

        The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the device.

        ShortIndividual who was performing
        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.

        Control1..1
        TypeReference(Practitioner, PractitionerRole, Organization, Patient, Device, RelatedPerson, CareTeam, Group)
        52. DeviceDispense.location
        Definition

        The principal physical location where the dispense was performed.

        ShortWhere the dispense occurred
        Control0..1
        TypeReference(Location)
        54. DeviceDispense.type
        Definition

        Indicates the type of dispensing event that is performed.

        ShortTrial fill, partial fill, emergency fill, etc
        Control0..1
        TypeCodeableConcept
        56. DeviceDispense.quantity
        Definition

        The number of devices that have been dispensed.

        ShortAmount dispensed
        Control0..1
        TypeQuantity(SimpleQuantity)
        58. DeviceDispense.preparedDate
        Definition

        The time when the dispensed product was packaged and reviewed.

        ShortWhen product was packaged and reviewed
        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        60. DeviceDispense.whenHandedOver
        Definition

        The time the dispensed product was made available to the patient or their representative.

        ShortWhen product was given out
        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        62. DeviceDispense.destination
        Definition

        Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.

        ShortWhere the device was sent or should be sent
        Control0..1
        TypeReference(Location)
        64. DeviceDispense.note
        Definition

        Extra information about the dispense that could not be conveyed in the other attributes.

        ShortInformation about the dispense
        Control0..*
        TypeAnnotation
        66. DeviceDispense.usageInstruction
        Definition

        The full representation of the instructions.

        ShortFull representation of the usage instructions
        Comments

        The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.

        Control0..1
        Typemarkdown
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        68. DeviceDispense.relevantHistory
        Definition

        A summary of the events of interest that have occurred, such as when the dispense was verified.

        ShortA list of relevant lifecycle events
        Comments

        This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).

        Control0..*
        TypeReference(Provenance)

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

        0. DeviceDispense
        Definition

        A record of dispensation of a device - i.e., assigning a device to a patient, or to a professional for their use.

        ShortA record of dispensation of a device
        Control0..*
        2. DeviceDispense.identifier
        Definition

        Business identifier for this dispensation.

        ShortBusiness identifier for this dispensation
        Comments

        This is a business identifier, not a resource identifier.

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

        The order or request that this dispense is fulfilling.

        ShortThe order or request that this dispense is fulfilling
        Control0..*
        TypeReference(CarePlan, DeviceRequest)
        6. DeviceDispense.partOf
        Definition

        The bigger event that this dispense is a part of.

        ShortThe bigger event that this dispense is a part of
        Control0..*
        TypeReference(Procedure)
        8. DeviceDispense.status
        Definition

        A code specifying the state of the set of dispense events.

        Shortpreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
        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 DeviceDispenseStatusCodes
        (required to http://hl7.org/fhir/ValueSet/devicedispense-status)

        Describes the lifecycle of the dispense.

        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. DeviceDispense.statusReason
        Definition

        Indicates the reason why a dispense was or was not performed.

        ShortWhy a dispense was or was not performed
        Control0..1
        BindingFor example codes, see DeviceDispenseStatusReasonCodes
        (example to http://hl7.org/fhir/ValueSet/devicedispense-status-reason)
        TypeCodeableReference(DetectedIssue)
        12. DeviceDispense.category
        Definition

        Indicates the type of device dispense.

        ShortType of device dispense
        Comments

        The category can be used to include where the device is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.

        Control0..*
        TypeCodeableConcept
        14. DeviceDispense.device
        Definition

        Identifies the device being dispensed. This is either a link to a resource representing the details of the device or a simple attribute carrying a code that identifies the device from a known list of devices.

        ShortWhat device was supplied
        Control1..1
        TypeCodeableReference(Device, DeviceDefinition)
        16. DeviceDispense.subject
        Definition

        A link to a resource representing the person to whom the device is intended.

        ShortWho the dispense is for
        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.

        Control1..1
        TypeReference(Patient, Practitioner, Group)
        18. DeviceDispense.receiver
        Definition

        Identifies the person who picked up the device or the person or location where the device was delivered. This may be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.

        ShortWho collected the device or where the medication was delivered
        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, Practitioner, RelatedPerson, Location, PractitionerRole, Group)
        20. DeviceDispense.encounter
        Definition

        The encounter that establishes the context for this event.

        ShortEncounter associated with event
        Control0..1
        TypeReference(Encounter)
        22. DeviceDispense.supportingInformation
        Definition

        Additional information that supports the device being dispensed.

        ShortInformation that supports the dispensing of the device
        Control0..*
        TypeReference(Resource)
        24. DeviceDispense.performer
        Definition

        Indicates who or what performed the event.

        ShortWho performed event
        Control0..*
        TypeBackboneElement
        26. DeviceDispense.performer.function
        Definition

        Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.

        ShortWho performed the dispense and what they did
        Control0..1
        TypeCodeableConcept
        Requirements

        Allows disambiguation of the types of involvement of different performers.

        28. DeviceDispense.performer.actor
        Definition

        The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the device.

        ShortIndividual who was performing
        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.

        Control1..1
        TypeReference(Practitioner, PractitionerRole, Organization, Patient, Device, RelatedPerson, CareTeam, Group)
        30. DeviceDispense.location
        Definition

        The principal physical location where the dispense was performed.

        ShortWhere the dispense occurred
        Control0..1
        TypeReference(Location)
        32. DeviceDispense.type
        Definition

        Indicates the type of dispensing event that is performed.

        ShortTrial fill, partial fill, emergency fill, etc
        Control0..1
        TypeCodeableConcept
        34. DeviceDispense.quantity
        Definition

        The number of devices that have been dispensed.

        ShortAmount dispensed
        Control0..1
        TypeQuantity(SimpleQuantity)
        36. DeviceDispense.preparedDate
        Definition

        The time when the dispensed product was packaged and reviewed.

        ShortWhen product was packaged and reviewed
        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        38. DeviceDispense.whenHandedOver
        Definition

        The time the dispensed product was made available to the patient or their representative.

        ShortWhen product was given out
        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        40. DeviceDispense.destination
        Definition

        Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.

        ShortWhere the device was sent or should be sent
        Control0..1
        TypeReference(Location)
        42. DeviceDispense.note
        Definition

        Extra information about the dispense that could not be conveyed in the other attributes.

        ShortInformation about the dispense
        Control0..*
        TypeAnnotation
        44. DeviceDispense.usageInstruction
        Definition

        The full representation of the instructions.

        ShortFull representation of the usage instructions
        Comments

        The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.

        Control0..1
        Typemarkdown
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        46. DeviceDispense.relevantHistory
        Definition

        A summary of the events of interest that have occurred, such as when the dispense was verified.

        ShortA list of relevant lifecycle events
        Comments

        This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).

        Control0..*
        TypeReference(Provenance)

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

        0. DeviceDispense
        Definition

        A record of dispensation of a device - i.e., assigning a device to a patient, or to a professional for their use.

        ShortA record of dispensation of a device
        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. DeviceDispense.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 resouce id depends on the given use case.

        Control0..1
        Typeid
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        4. DeviceDispense.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. DeviceDispense.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.

        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. DeviceDispense.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-ballot3)

        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. DeviceDispense.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. DeviceDispense.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. DeviceDispense.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 DeviceDispense.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 16. DeviceDispense.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 DeviceDispense.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 18. DeviceDispense.identifier
            Definition

            Business identifier for this dispensation.

            ShortBusiness identifier for this dispensation
            Comments

            This is a business identifier, not a resource identifier.

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

            The order or request that this dispense is fulfilling.

            ShortThe order or request that this dispense is fulfilling
            Control0..*
            TypeReference(CarePlan, DeviceRequest)
            22. DeviceDispense.partOf
            Definition

            The bigger event that this dispense is a part of.

            ShortThe bigger event that this dispense is a part of
            Control0..*
            TypeReference(Procedure)
            24. DeviceDispense.status
            Definition

            A code specifying the state of the set of dispense events.

            Shortpreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
            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 DeviceDispenseStatusCodes
            (required to http://hl7.org/fhir/ValueSet/devicedispense-status)

            Describes the lifecycle of the dispense.

            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. DeviceDispense.statusReason
            Definition

            Indicates the reason why a dispense was or was not performed.

            ShortWhy a dispense was or was not performed
            Control0..1
            BindingFor example codes, see DeviceDispenseStatusReasonCodes
            (example to http://hl7.org/fhir/ValueSet/devicedispense-status-reason)
            TypeCodeableReference(DetectedIssue)
            28. DeviceDispense.category
            Definition

            Indicates the type of device dispense.

            ShortType of device dispense
            Comments

            The category can be used to include where the device is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.

            Control0..*
            TypeCodeableConcept
            30. DeviceDispense.device
            Definition

            Identifies the device being dispensed. This is either a link to a resource representing the details of the device or a simple attribute carrying a code that identifies the device from a known list of devices.

            ShortWhat device was supplied
            Control1..1
            TypeCodeableReference(Device, DeviceDefinition)
            Summarytrue
            32. DeviceDispense.subject
            Definition

            A link to a resource representing the person to whom the device is intended.

            ShortWho the dispense is for
            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.

            Control1..1
            TypeReference(Patient, Practitioner, Group)
            Summarytrue
            34. DeviceDispense.receiver
            Definition

            Identifies the person who picked up the device or the person or location where the device was delivered. This may be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.

            ShortWho collected the device or where the medication was delivered
            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, Practitioner, RelatedPerson, Location, PractitionerRole, Group)
            36. DeviceDispense.encounter
            Definition

            The encounter that establishes the context for this event.

            ShortEncounter associated with event
            Control0..1
            TypeReference(Encounter)
            38. DeviceDispense.supportingInformation
            Definition

            Additional information that supports the device being dispensed.

            ShortInformation that supports the dispensing of the device
            Control0..*
            TypeReference(Resource)
            40. DeviceDispense.performer
            Definition

            Indicates who or what performed the event.

            ShortWho performed event
            Control0..*
            TypeBackboneElement
            Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
            42. DeviceDispense.performer.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
            Typeid
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            44. DeviceDispense.performer.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 DeviceDispense.performer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 46. DeviceDispense.performer.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()))
              48. DeviceDispense.performer.function
              Definition

              Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.

              ShortWho performed the dispense and what they did
              Control0..1
              TypeCodeableConcept
              Requirements

              Allows disambiguation of the types of involvement of different performers.

              50. DeviceDispense.performer.actor
              Definition

              The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the device.

              ShortIndividual who was performing
              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.

              Control1..1
              TypeReference(Practitioner, PractitionerRole, Organization, Patient, Device, RelatedPerson, CareTeam, Group)
              52. DeviceDispense.location
              Definition

              The principal physical location where the dispense was performed.

              ShortWhere the dispense occurred
              Control0..1
              TypeReference(Location)
              54. DeviceDispense.type
              Definition

              Indicates the type of dispensing event that is performed.

              ShortTrial fill, partial fill, emergency fill, etc
              Control0..1
              TypeCodeableConcept
              56. DeviceDispense.quantity
              Definition

              The number of devices that have been dispensed.

              ShortAmount dispensed
              Control0..1
              TypeQuantity(SimpleQuantity)
              58. DeviceDispense.preparedDate
              Definition

              The time when the dispensed product was packaged and reviewed.

              ShortWhen product was packaged and reviewed
              Control0..1
              TypedateTime
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              60. DeviceDispense.whenHandedOver
              Definition

              The time the dispensed product was made available to the patient or their representative.

              ShortWhen product was given out
              Control0..1
              TypedateTime
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              62. DeviceDispense.destination
              Definition

              Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.

              ShortWhere the device was sent or should be sent
              Control0..1
              TypeReference(Location)
              64. DeviceDispense.note
              Definition

              Extra information about the dispense that could not be conveyed in the other attributes.

              ShortInformation about the dispense
              Control0..*
              TypeAnnotation
              66. DeviceDispense.usageInstruction
              Definition

              The full representation of the instructions.

              ShortFull representation of the usage instructions
              Comments

              The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.

              Control0..1
              Typemarkdown
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              68. DeviceDispense.relevantHistory
              Definition

              A summary of the events of interest that have occurred, such as when the dispense was verified.

              ShortA list of relevant lifecycle events
              Comments

              This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).

              Control0..*
              TypeReference(Provenance)