Supply of Products for Healthcare (SUPPLY)
0.3.0 - ci-build International flag

Supply of Products for Healthcare (SUPPLY), published by IHE Pharmacy Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/pharm-supply/ and changes regularly. See the Directory of published versions

Logical Model: InventoryUpdateModel - Detailed Descriptions

Draft as of 2022-12-27

Definitions for the InventoryUpdateModel logical model.

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

0. InventoryUpdateModel
Definition

This is the logical model for the Inventory Change notification - an information about a change of items being added or removed from a given inventory position. This is to be typically used in differential inventory updates (e.g. "Since last time, the following items have been consumed") or to register items added or subtracted (e.g. "The following 2 items were just discarded and should be deducted from inventory ")

ShortEnables a party to provide information on inventory levels and inventory changes.
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. InventoryUpdateModel.identifier
Definition

Unique identification of the inventory report

ShortUnique identification of the inventory report
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
4. InventoryUpdateModel.countType
Definition

The type of counting - whether it is a manual counting, automated data capture, estimate..

ShortThe type of counting - whether it is a manual counting, automated data capture, estimate..
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. InventoryUpdateModel.operationType
Definition

The type of operation - add/subtract

ShortThe type of operation - add/subtract
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. InventoryUpdateModel.operationTypeReason[x]
Definition

The reason or detail for the change. For example a new reception

ShortThe reason or detail for the change. For example a new reception
Control1..1
TypeChoice of: CodeableConcept, Reference
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
10. InventoryUpdateModel.reportDateTime
Definition

Date and time of finalization of the report

ShortDate and time of finalization of the report
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. InventoryUpdateModel.reporter
Definition

Person or entity that creates the report

ShortPerson or entity that creates the report
Control0..1
TypeReference
14. InventoryUpdateModel.reportingPeriod
Definition

The period the inventory changes report to

ShortThe period the inventory changes report to
Control0..1
TypePeriod
16. InventoryUpdateModel.inventoryListing
Definition

Contains the inventory listings

ShortContains the inventory listings
Control0..*
TypeBackboneElement
18. InventoryUpdateModel.inventoryListing.location
Definition

Identification of the site where the items are/were located

ShortIdentification of the site where the items are/were located
Control0..1
TypeReference
20. InventoryUpdateModel.inventoryListing.status
Definition

The inventory status of a set of items (of the same type)

ShortThe inventory status of a set of items (of the same type)
Control0..1
TypeCodeableConcept
22. InventoryUpdateModel.inventoryListing.items
Definition

The inventory items

ShortThe inventory items
Control0..*
TypeBackboneElement
24. InventoryUpdateModel.inventoryListing.items.category
Definition

The category of the inventory items

ShortThe category of the inventory items
Control0..*
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. InventoryUpdateModel.inventoryListing.items.quantity
Definition

Quantity of items

ShortQuantity of items
Control0..1
TypeQuantity
28. InventoryUpdateModel.inventoryListing.items.item
Definition

An item or set of items (of the same type and status)

ShortAn item or set of items (of the same type and status)
Control0..1
TypeBackboneElement
30. InventoryUpdateModel.inventoryListing.countingDateTime
Definition

The time that the changes in this listing actually occurred

ShortThe time that the changes in this listing actually occurred
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. InventoryUpdateModel
Definition

This is the logical model for the Inventory Change notification - an information about a change of items being added or removed from a given inventory position. This is to be typically used in differential inventory updates (e.g. "Since last time, the following items have been consumed") or to register items added or subtracted (e.g. "The following 2 items were just discarded and should be deducted from inventory ")


Base definition for all elements in a resource.

ShortEnables a party to provide information on inventory levels and inventory changes.Base for all elements
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. InventoryUpdateModel.identifier
Definition

Unique identification of the inventory report

ShortUnique identification of the inventory report
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
4. InventoryUpdateModel.countType
Definition

The type of counting - whether it is a manual counting, automated data capture, estimate..

ShortThe type of counting - whether it is a manual counting, automated data capture, estimate..
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. InventoryUpdateModel.operationType
Definition

The type of operation - add/subtract

ShortThe type of operation - add/subtract
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. InventoryUpdateModel.operationTypeReason[x]
Definition

The reason or detail for the change. For example a new reception

ShortThe reason or detail for the change. For example a new reception
Control1..1
TypeChoice of: CodeableConcept, Reference
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
10. InventoryUpdateModel.reportDateTime
Definition

Date and time of finalization of the report

ShortDate and time of finalization of the report
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. InventoryUpdateModel.reporter
Definition

Person or entity that creates the report

ShortPerson or entity that creates the report
Control0..1
TypeReference
14. InventoryUpdateModel.reportingPeriod
Definition

The period the inventory changes report to

ShortThe period the inventory changes report to
Control0..1
TypePeriod
16. InventoryUpdateModel.inventoryListing
Definition

Contains the inventory listings

ShortContains the inventory listings
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. InventoryUpdateModel.inventoryListing.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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. InventoryUpdateModel.inventoryListing.location
Definition

Identification of the site where the items are/were located

ShortIdentification of the site where the items are/were located
Control0..1
TypeReference
22. InventoryUpdateModel.inventoryListing.status
Definition

The inventory status of a set of items (of the same type)

ShortThe inventory status of a set of items (of the same type)
Control0..1
TypeCodeableConcept
24. InventoryUpdateModel.inventoryListing.items
Definition

The inventory items

ShortThe inventory items
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. InventoryUpdateModel.inventoryListing.items.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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. InventoryUpdateModel.inventoryListing.items.category
Definition

The category of the inventory items

ShortThe category of the inventory items
Control0..*
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. InventoryUpdateModel.inventoryListing.items.quantity
Definition

Quantity of items

ShortQuantity of items
Control0..1
TypeQuantity
32. InventoryUpdateModel.inventoryListing.items.item
Definition

An item or set of items (of the same type and status)

ShortAn item or set of items (of the same type and status)
Control0..1
TypeBackboneElement
34. InventoryUpdateModel.inventoryListing.countingDateTime
Definition

The time that the changes in this listing actually occurred

ShortThe time that the changes in this listing actually occurred
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. InventoryUpdateModel
Definition

This is the logical model for the Inventory Change notification - an information about a change of items being added or removed from a given inventory position. This is to be typically used in differential inventory updates (e.g. "Since last time, the following items have been consumed") or to register items added or subtracted (e.g. "The following 2 items were just discarded and should be deducted from inventory ")

ShortEnables a party to provide information on inventory levels and inventory changes.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. InventoryUpdateModel.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
4. InventoryUpdateModel.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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on InventoryUpdateModel.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. InventoryUpdateModel.identifier
    Definition

    Unique identification of the inventory report

    ShortUnique identification of the inventory report
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    TypeIdentifier
    8. InventoryUpdateModel.countType
    Definition

    The type of counting - whether it is a manual counting, automated data capture, estimate..

    ShortThe type of counting - whether it is a manual counting, automated data capture, estimate..
    Control0..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    10. InventoryUpdateModel.operationType
    Definition

    The type of operation - add/subtract

    ShortThe type of operation - add/subtract
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    12. InventoryUpdateModel.operationTypeReason[x]
    Definition

    The reason or detail for the change. For example a new reception

    ShortThe reason or detail for the change. For example a new reception
    Control1..1
    TypeChoice of: CodeableConcept, Reference
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    14. InventoryUpdateModel.reportDateTime
    Definition

    Date and time of finalization of the report

    ShortDate and time of finalization of the report
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. InventoryUpdateModel.reporter
    Definition

    Person or entity that creates the report

    ShortPerson or entity that creates the report
    Control0..1
    TypeReference
    18. InventoryUpdateModel.reportingPeriod
    Definition

    The period the inventory changes report to

    ShortThe period the inventory changes report to
    Control0..1
    TypePeriod
    20. InventoryUpdateModel.inventoryListing
    Definition

    Contains the inventory listings

    ShortContains the inventory listings
    Control0..*
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. InventoryUpdateModel.inventoryListing.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
    24. InventoryUpdateModel.inventoryListing.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()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on InventoryUpdateModel.inventoryListing.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 26. InventoryUpdateModel.inventoryListing.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()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      28. InventoryUpdateModel.inventoryListing.location
      Definition

      Identification of the site where the items are/were located

      ShortIdentification of the site where the items are/were located
      Control0..1
      TypeReference
      30. InventoryUpdateModel.inventoryListing.status
      Definition

      The inventory status of a set of items (of the same type)

      ShortThe inventory status of a set of items (of the same type)
      Control0..1
      TypeCodeableConcept
      32. InventoryUpdateModel.inventoryListing.items
      Definition

      The inventory items

      ShortThe inventory items
      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      34. InventoryUpdateModel.inventoryListing.items.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
      36. InventoryUpdateModel.inventoryListing.items.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()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on InventoryUpdateModel.inventoryListing.items.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 38. InventoryUpdateModel.inventoryListing.items.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()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        40. InventoryUpdateModel.inventoryListing.items.category
        Definition

        The category of the inventory items

        ShortThe category of the inventory items
        Control0..*
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        42. InventoryUpdateModel.inventoryListing.items.quantity
        Definition

        Quantity of items

        ShortQuantity of items
        Control0..1
        TypeQuantity
        44. InventoryUpdateModel.inventoryListing.items.item
        Definition

        An item or set of items (of the same type and status)

        ShortAn item or set of items (of the same type and status)
        Control0..1
        TypeBackboneElement
        46. InventoryUpdateModel.inventoryListing.countingDateTime
        Definition

        The time that the changes in this listing actually occurred

        ShortThe time that the changes in this listing actually occurred
        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension