ANCODE.APP.FHIR.ANHEALTH\null - Definitions

Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions

Logical Model: InventoryModel - Detailed Descriptions

Draft as of 2023-01-20

Definitions for the InventoryModel logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

1. Inventory
Control	0..*
Type	Element
2. Inventory.identifier
Note	This is a business identifier, not a resource identifier (see discussion)
Control	1..*
Type	Identifier(Identifier)
3. Inventory.active
Control	1..1
Type	boolean(boolean)
4. Inventory.Item
Control	1..1
Type	Reference(Medication\|DeviceDefinition))
5. Inventory.group
Control	0..1
Type	Reference(Group))
6. Inventory.package
Control	0..1
Type	BackboneElement
7. Inventory.package.inventory
Control	1..1
Type	Reference(PackagedProductDefinition))
8. Inventory.package.supply
Control	1..1
Type	Reference(PackagedProductDefinition))
9. Inventory.package.use
Control	1..1
Type	Reference(PackagedProductDefinition))
10. Inventory.resupply
Control	1..1
Type	BackboneElement
11. Inventory.resupply.minimum
Control	1..1
Type	decimal(decimal)
12. Inventory.resupply.ideal
Control	1..1
Type	decimal(decimal)
13. Inventory.resupply.maximum
Control	1..1
Type	decimal(decimal)
14. Inventory.technicalSpecifications
Control	0..*
Type	string(string)
15. Inventory.batch
Control	0..*
Type	BackboneElement
16. Inventory.batch.number
Control	0..1
Type	string(string)
17. Inventory.batch.validity
Control	0..1
Type	dateTime(dateTime)
18. Inventory.batch.location
Control	1..1
Type	Reference(Location))
19. Inventory.batch.package
Control	1..1
Type	Reference(PackagedProductDefinition))
20. Inventory.batch.quantity
Control	1..1
Type	decimal(decimal)
21. Inventory.total
Control	1..1
Type	decimal(decimal)
22. Inventory.bodySite
Control	0..1
Binding	The codes SHALL be taken from BRViaAcesso
Type	CodeableConcept(CodeableConcept)

1. Inventory
Definition	Base definition for all elements in a resource.
Control	0..* This element is affected by the following invariants: ele-1
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters)
2. Inventory.identifier
Note	This is a business identifier, not a resource identifier (see discussion)
Control	1..*
Type	Identifier(Identifier)
3. Inventory.active
Control	1..1
Type	boolean(boolean)
4. Inventory.Item
Control	1..1
Type	Reference(Medication\|DeviceDefinition))
5. Inventory.group
Control	0..1
Type	Reference(Group))
6. Inventory.package
Control	0..1
Type	BackboneElement
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters)
7. Inventory.package.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 manageable, 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).
Control	0..*
Type	Extension
Is Modifier	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
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.
Invariants	Defined on this element 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())
8. Inventory.package.inventory
Control	1..1
Type	Reference(PackagedProductDefinition))
9. Inventory.package.supply
Control	1..1
Type	Reference(PackagedProductDefinition))
10. Inventory.package.use
Control	1..1
Type	Reference(PackagedProductDefinition))
11. Inventory.resupply
Control	1..1
Type	BackboneElement
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters)
12. Inventory.resupply.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 manageable, 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).
Control	0..*
Type	Extension
Is Modifier	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
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.
Invariants	Defined on this element 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())
13. Inventory.resupply.minimum
Control	1..1
Type	decimal(decimal)
14. Inventory.resupply.ideal
Control	1..1
Type	decimal(decimal)
15. Inventory.resupply.maximum
Control	1..1
Type	decimal(decimal)
16. Inventory.technicalSpecifications
Control	0..*
Type	string(string)
17. Inventory.batch
Control	0..*
Type	BackboneElement
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters)
18. Inventory.batch.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 manageable, 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).
Control	0..*
Type	Extension
Is Modifier	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
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.
Invariants	Defined on this element 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())
19. Inventory.batch.number
Control	0..1
Type	string(string)
20. Inventory.batch.validity
Control	0..1
Type	dateTime(dateTime)
21. Inventory.batch.location
Control	1..1
Type	Reference(Location))
22. Inventory.batch.package
Control	1..1
Type	Reference(PackagedProductDefinition))
23. Inventory.batch.quantity
Control	1..1
Type	decimal(decimal)
24. Inventory.total
Control	1..1
Type	decimal(decimal)
25. Inventory.bodySite
Control	0..1
Binding	The codes SHALL be taken from BRViaAcesso
Type	CodeableConcept(CodeableConcept)

1. Inventory
Definition	Base definition for all elements in a resource.
Control	0..* This element is affected by the following invariants: ele-1
Type	Element
2. Inventory.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	id
XML Representation	In the XML format, this property is represented as an attribute.
3. Inventory.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 manageable, 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.
Control	0..*
Type	Extension
Alternate Names	extensionsuser content
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.
Invariants	Defined on this element 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 Inventory.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
4. Inventory.identifier
Note	This is a business identifier, not a resource identifier (see discussion)
Control	1..*
Type	Identifier(Identifier)
5. Inventory.active
Control	1..1
Type	boolean(boolean)
6. Inventory.Item
Control	1..1
Type	Reference(Medication DeviceDefinition))
7. Inventory.group
Control	0..1
Type	Reference(Group))
8. Inventory.package
Control	0..1
Type	BackboneElement
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters)
9. Inventory.package.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	id
XML Representation	In the XML format, this property is represented as an attribute.
10. Inventory.package.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 manageable, 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.
Control	0..*
Type	Extension
Alternate Names	extensionsuser content
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.
Invariants	Defined on this element 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 Inventory.package.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
11. Inventory.package.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	id
XML Representation	In the XML format, this property is represented as an attribute.
12. Inventory.package.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 manageable, 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.
Control	0..*
Type	Extension
Alternate Names	extensionsuser content
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.
Invariants	Defined on this element 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 Inventory.package.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
13. Inventory.package.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 manageable, 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).
Control	0..*
Type	Extension
Is Modifier	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	extensionsuser contentmodifiers
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.
Invariants	Defined on this element 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())
14. Inventory.package.inventory
Control	1..1
Type	Reference(PackagedProductDefinition))
15. Inventory.package.supply
Control	1..1
Type	Reference(PackagedProductDefinition))
16. Inventory.package.use
Control	1..1
Type	Reference(PackagedProductDefinition))
17. Inventory.resupply
Control	1..1
Type	BackboneElement
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters)
18. Inventory.resupply.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	id
XML Representation	In the XML format, this property is represented as an attribute.
19. Inventory.resupply.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 manageable, 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.
Control	0..*
Type	Extension
Alternate Names	extensionsuser content
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.
Invariants	Defined on this element 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 Inventory.resupply.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
20. Inventory.resupply.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	id
XML Representation	In the XML format, this property is represented as an attribute.
21. Inventory.resupply.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 manageable, 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.
Control	0..*
Type	Extension
Alternate Names	extensionsuser content
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.
Invariants	Defined on this element 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 Inventory.resupply.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
22. Inventory.resupply.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 manageable, 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).
Control	0..*
Type	Extension
Is Modifier	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	extensionsuser contentmodifiers
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.
Invariants	Defined on this element 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())
23. Inventory.resupply.minimum
Control	1..1
Type	decimal(decimal)
24. Inventory.resupply.ideal
Control	1..1
Type	decimal(decimal)
25. Inventory.resupply.maximum
Control	1..1
Type	decimal(decimal)
26. Inventory.technicalSpecifications
Control	0..*
Type	string(string)
27. Inventory.batch
Control	0..*
Type	BackboneElement
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters)
28. Inventory.batch.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	id
XML Representation	In the XML format, this property is represented as an attribute.
29. Inventory.batch.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 manageable, 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.
Control	0..*
Type	Extension
Alternate Names	extensionsuser content
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.
Invariants	Defined on this element 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 Inventory.batch.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
30. Inventory.batch.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	id
XML Representation	In the XML format, this property is represented as an attribute.
31. Inventory.batch.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 manageable, 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.
Control	0..*
Type	Extension
Alternate Names	extensionsuser content
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.
Invariants	Defined on this element 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 Inventory.batch.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
32. Inventory.batch.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 manageable, 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).
Control	0..*
Type	Extension
Is Modifier	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	extensionsuser contentmodifiers
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.
Invariants	Defined on this element 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())
33. Inventory.batch.number
Control	0..1
Type	string(string)
34. Inventory.batch.validity
Control	0..1
Type	dateTime(dateTime)
35. Inventory.batch.location
Control	1..1
Type	Reference(Location))
36. Inventory.batch.package
Control	1..1
Type	Reference(PackagedProductDefinition))
37. Inventory.batch.quantity
Control	1..1
Type	decimal(decimal)
38. Inventory.total
Control	1..1
Type	decimal(decimal)
39. Inventory.bodySite
Control	0..1
Binding	The codes SHALL be taken from BRViaAcesso
Type	CodeableConcept(CodeableConcept)