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
Draft as of 2022-12-27 |
Definitions for the InventoryStatusModel logical model.
Guidance on how to interpret the contents of this table can be found here
0. InventoryStatusModel | |
Definition | This is the logical model for the Inventory Status report - an information about the current status of a given inventory position. This is to be typically used in inventory counts - physical counts or estimates. It supports a report per status, per location, or a combination of both (which is how typically items are counted and reported). |
Short | Enables a party to provide information on inventory levels |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. InventoryStatusModel.identifier | |
Definition | Unique identification of the inventory report |
Short | Unique identification of the inventory report |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
4. InventoryStatusModel.countType | |
Definition | The type of counting - whether it is a manual counting, automated data capture, estimate.. |
Short | The type of counting - whether it is a manual counting, automated data capture, estimate.. |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. InventoryStatusModel.requestIdentifier | |
Definition | The logistics inventory report request, if applicable |
Short | The logistics inventory report request, if applicable |
Control | 0..1 |
Type | Identifier |
8. InventoryStatusModel.reportDateTime | |
Definition | Date and time of finalization of the report |
Short | Date and time of finalization of the report |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. InventoryStatusModel.reporter | |
Definition | Person or entity that creates the report |
Short | Person or entity that creates the report |
Control | 0..1 |
Type | Reference |
12. InventoryStatusModel.reportingPeriod | |
Definition | The period to which the inventory status refers |
Short | The period to which the inventory status refers |
Control | 0..1 |
Type | Period |
14. InventoryStatusModel.inventoryListing | |
Definition | Contains the inventory information entries |
Short | Contains the inventory information entries |
Control | 0..* |
Type | BackboneElement |
16. InventoryStatusModel.inventoryListing.location | |
Definition | Identification of the site where the items are located |
Short | Identification of the site where the items are located |
Control | 0..1 |
Type | Reference |
18. InventoryStatusModel.inventoryListing.status | |
Definition | The inventory status of a set of items (of the same type) at a specific sub-location at a specific point in time |
Short | The inventory status of a set of items (of the same type) at a specific sub-location at a specific point in time |
Control | 0..1 |
Type | CodeableConcept |
20. InventoryStatusModel.inventoryListing.items | |
Definition | The inventory items |
Short | The inventory items |
Control | 0..* |
Type | BackboneElement |
22. InventoryStatusModel.inventoryListing.items.category | |
Definition | The category of the inventory items |
Short | The category of the inventory items |
Control | 0..* |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. InventoryStatusModel.inventoryListing.items.quantity | |
Definition | Quantity of items |
Short | Quantity of items |
Control | 0..1 |
Type | Quantity |
26. InventoryStatusModel.inventoryListing.items.item | |
Definition | An item or set of items (of the same type and status) |
Short | An item or set of items (of the same type and status) |
Control | 0..1 |
Type | BackboneElement |
28. InventoryStatusModel.inventoryListing.countingDateTime | |
Definition | The time that the inventory items in this listing were physically checked |
Short | The time that the inventory items in this listing were physically checked |
Control | 0..1 |
Type | dateTime |
Primitive Value | This 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. InventoryStatusModel | |
Definition | This is the logical model for the Inventory Status report - an information about the current status of a given inventory position. This is to be typically used in inventory counts - physical counts or estimates. It supports a report per status, per location, or a combination of both (which is how typically items are counted and reported). Base definition for all elements in a resource. |
Short | Enables a party to provide information on inventory levelsBase for all elements |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
2. InventoryStatusModel.identifier | |
Definition | Unique identification of the inventory report |
Short | Unique identification of the inventory report |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
4. InventoryStatusModel.countType | |
Definition | The type of counting - whether it is a manual counting, automated data capture, estimate.. |
Short | The type of counting - whether it is a manual counting, automated data capture, estimate.. |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. InventoryStatusModel.requestIdentifier | |
Definition | The logistics inventory report request, if applicable |
Short | The logistics inventory report request, if applicable |
Control | 0..1 |
Type | Identifier |
8. InventoryStatusModel.reportDateTime | |
Definition | Date and time of finalization of the report |
Short | Date and time of finalization of the report |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. InventoryStatusModel.reporter | |
Definition | Person or entity that creates the report |
Short | Person or entity that creates the report |
Control | 0..1 |
Type | Reference |
12. InventoryStatusModel.reportingPeriod | |
Definition | The period to which the inventory status refers |
Short | The period to which the inventory status refers |
Control | 0..1 |
Type | Period |
14. InventoryStatusModel.inventoryListing | |
Definition | Contains the inventory information entries |
Short | Contains the inventory information entries |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
16. InventoryStatusModel.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | ele-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()) |
18. InventoryStatusModel.inventoryListing.location | |
Definition | Identification of the site where the items are located |
Short | Identification of the site where the items are located |
Control | 0..1 |
Type | Reference |
20. InventoryStatusModel.inventoryListing.status | |
Definition | The inventory status of a set of items (of the same type) at a specific sub-location at a specific point in time |
Short | The inventory status of a set of items (of the same type) at a specific sub-location at a specific point in time |
Control | 0..1 |
Type | CodeableConcept |
22. InventoryStatusModel.inventoryListing.items | |
Definition | The inventory items |
Short | The inventory items |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
24. InventoryStatusModel.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | ele-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()) |
26. InventoryStatusModel.inventoryListing.items.category | |
Definition | The category of the inventory items |
Short | The category of the inventory items |
Control | 0..* |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. InventoryStatusModel.inventoryListing.items.quantity | |
Definition | Quantity of items |
Short | Quantity of items |
Control | 0..1 |
Type | Quantity |
30. InventoryStatusModel.inventoryListing.items.item | |
Definition | An item or set of items (of the same type and status) |
Short | An item or set of items (of the same type and status) |
Control | 0..1 |
Type | BackboneElement |
32. InventoryStatusModel.inventoryListing.countingDateTime | |
Definition | The time that the inventory items in this listing were physically checked |
Short | The time that the inventory items in this listing were physically checked |
Control | 0..1 |
Type | dateTime |
Primitive Value | This 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. InventoryStatusModel | |
Definition | This is the logical model for the Inventory Status report - an information about the current status of a given inventory position. This is to be typically used in inventory counts - physical counts or estimates. It supports a report per status, per location, or a combination of both (which is how typically items are counted and reported). |
Short | Enables a party to provide information on inventory levels |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
2. InventoryStatusModel.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
4. InventoryStatusModel.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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-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() ) |
Slicing | This element introduces a set of slices on InventoryStatusModel.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. InventoryStatusModel.identifier | |
Definition | Unique identification of the inventory report |
Short | Unique identification of the inventory report |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
8. InventoryStatusModel.countType | |
Definition | The type of counting - whether it is a manual counting, automated data capture, estimate.. |
Short | The type of counting - whether it is a manual counting, automated data capture, estimate.. |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. InventoryStatusModel.requestIdentifier | |
Definition | The logistics inventory report request, if applicable |
Short | The logistics inventory report request, if applicable |
Control | 0..1 |
Type | Identifier |
12. InventoryStatusModel.reportDateTime | |
Definition | Date and time of finalization of the report |
Short | Date and time of finalization of the report |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. InventoryStatusModel.reporter | |
Definition | Person or entity that creates the report |
Short | Person or entity that creates the report |
Control | 0..1 |
Type | Reference |
16. InventoryStatusModel.reportingPeriod | |
Definition | The period to which the inventory status refers |
Short | The period to which the inventory status refers |
Control | 0..1 |
Type | Period |
18. InventoryStatusModel.inventoryListing | |
Definition | Contains the inventory information entries |
Short | Contains the inventory information entries |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
20. InventoryStatusModel.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. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
22. InventoryStatusModel.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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-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() ) |
Slicing | This element introduces a set of slices on InventoryStatusModel.inventoryListing.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
24. InventoryStatusModel.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | ele-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() ) |
26. InventoryStatusModel.inventoryListing.location | |
Definition | Identification of the site where the items are located |
Short | Identification of the site where the items are located |
Control | 0..1 |
Type | Reference |
28. InventoryStatusModel.inventoryListing.status | |
Definition | The inventory status of a set of items (of the same type) at a specific sub-location at a specific point in time |
Short | The inventory status of a set of items (of the same type) at a specific sub-location at a specific point in time |
Control | 0..1 |
Type | CodeableConcept |
30. InventoryStatusModel.inventoryListing.items | |
Definition | The inventory items |
Short | The inventory items |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
32. InventoryStatusModel.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. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
34. InventoryStatusModel.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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-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() ) |
Slicing | This element introduces a set of slices on InventoryStatusModel.inventoryListing.items.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
36. InventoryStatusModel.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | ele-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() ) |
38. InventoryStatusModel.inventoryListing.items.category | |
Definition | The category of the inventory items |
Short | The category of the inventory items |
Control | 0..* |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. InventoryStatusModel.inventoryListing.items.quantity | |
Definition | Quantity of items |
Short | Quantity of items |
Control | 0..1 |
Type | Quantity |
42. InventoryStatusModel.inventoryListing.items.item | |
Definition | An item or set of items (of the same type and status) |
Short | An item or set of items (of the same type and status) |
Control | 0..1 |
Type | BackboneElement |
44. InventoryStatusModel.inventoryListing.countingDateTime | |
Definition | The time that the inventory items in this listing were physically checked |
Short | The time that the inventory items in this listing were physically checked |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
IG © 2020+ IHE Pharmacy Technical Committee. Package ihe.pharm.supply#0.3.0 based on FHIR 5.0.0. Generated 2024-06-18
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change