BioMaxis Implementation Guide
0.0.0-semantic-release - ci-build
BioMaxis Implementation Guide - Local Development build (v0.0.0-semantic-release) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://biomaxis.com/fhir/StructureDefinition/InventoryReport | Version: 0.0.0-semantic-release | |||
| Active as of 2025-12-12 | Computable Name: InventoryReport | |||
A report that details the transactions of inventory items
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DomainResource | InventoryReport Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension | |||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for the inventory transaction | ||||
![]() ![]() |
1..1 | code | draft | requested | active | entered-in-error Binding: inventoryreport-status (??) (required) | |||||
![]() ![]() |
1..1 | code | snapshot | difference Binding: inventoryreport-counttype (??) (required) | |||||
![]() ![]() |
0..1 | CodeableConcept | addition | subtraction | |||||
![]() ![]() |
0..1 | CodeableConcept | The reason for the transaction | |||||
![]() ![]() |
1..1 | dateTime | The date and time when the report was generated | |||||
![]() ![]() |
1..1 | BackboneElement | Details of the inventory item involved in the transaction | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Reference(InventoryItem) | The InventoryItem that is being reported on | |||||
![]() ![]() ![]() |
1..1 | string | The lot number of the InventoryItem | |||||
![]() ![]() ![]() |
1..1 | Reference(Location) | The location of the InventoryItem as of the report | |||||
![]() ![]() ![]() |
1..1 | SimpleQuantity | The quantity of the InventoryItem involved in the transaction | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| InventoryReport.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| InventoryReport.status | Base | required | http://hl7.org/fhir/ValueSet/inventoryreport-status | Not State | Unknown |
| InventoryReport.countType | Base | required | http://hl7.org/fhir/ValueSet/inventoryreport-counttype | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | InventoryReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | InventoryReport | 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | InventoryReport | 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 | error | InventoryReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | InventoryReport | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DomainResource
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DomainResource | InventoryReport Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for the inventory transaction |
![]() ![]() |
1..1 | code | draft | requested | active | entered-in-error Binding: inventoryreport-status (??) (required) | |
![]() ![]() |
1..1 | code | snapshot | difference Binding: inventoryreport-counttype (??) (required) | |
![]() ![]() |
0..1 | CodeableConcept | addition | subtraction | |
![]() ![]() |
0..1 | CodeableConcept | The reason for the transaction | |
![]() ![]() |
1..1 | dateTime | The date and time when the report was generated | |
![]() ![]() |
1..1 | BackboneElement | Details of the inventory item involved in the transaction | |
![]() ![]() ![]() |
1..1 | Reference(InventoryItem) | The InventoryItem that is being reported on | |
![]() ![]() ![]() |
1..1 | string | The lot number of the InventoryItem | |
![]() ![]() ![]() |
1..1 | Reference(Location) | The location of the InventoryItem as of the report | |
![]() ![]() ![]() |
1..1 | SimpleQuantity | The quantity of the InventoryItem involved in the transaction | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| InventoryReport.status | Base | required | http://hl7.org/fhir/ValueSet/inventoryreport-status | Not State | Unknown |
| InventoryReport.countType | Base | required | http://hl7.org/fhir/ValueSet/inventoryreport-counttype | Not State | Unknown |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DomainResource | InventoryReport Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension | |||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for the inventory transaction | ||||
![]() ![]() |
1..1 | code | draft | requested | active | entered-in-error Binding: inventoryreport-status (??) (required) | |||||
![]() ![]() |
1..1 | code | snapshot | difference Binding: inventoryreport-counttype (??) (required) | |||||
![]() ![]() |
0..1 | CodeableConcept | addition | subtraction | |||||
![]() ![]() |
0..1 | CodeableConcept | The reason for the transaction | |||||
![]() ![]() |
1..1 | dateTime | The date and time when the report was generated | |||||
![]() ![]() |
1..1 | BackboneElement | Details of the inventory item involved in the transaction | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Reference(InventoryItem) | The InventoryItem that is being reported on | |||||
![]() ![]() ![]() |
1..1 | string | The lot number of the InventoryItem | |||||
![]() ![]() ![]() |
1..1 | Reference(Location) | The location of the InventoryItem as of the report | |||||
![]() ![]() ![]() |
1..1 | SimpleQuantity | The quantity of the InventoryItem involved in the transaction | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| InventoryReport.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| InventoryReport.status | Base | required | http://hl7.org/fhir/ValueSet/inventoryreport-status | Not State | Unknown |
| InventoryReport.countType | Base | required | http://hl7.org/fhir/ValueSet/inventoryreport-counttype | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | InventoryReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | InventoryReport | 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | InventoryReport | 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 | error | InventoryReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | InventoryReport | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DomainResource
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DomainResource | InventoryReport Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension | |||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for the inventory transaction | ||||
![]() ![]() |
1..1 | code | draft | requested | active | entered-in-error Binding: inventoryreport-status (??) (required) | |||||
![]() ![]() |
1..1 | code | snapshot | difference Binding: inventoryreport-counttype (??) (required) | |||||
![]() ![]() |
0..1 | CodeableConcept | addition | subtraction | |||||
![]() ![]() |
0..1 | CodeableConcept | The reason for the transaction | |||||
![]() ![]() |
1..1 | dateTime | The date and time when the report was generated | |||||
![]() ![]() |
1..1 | BackboneElement | Details of the inventory item involved in the transaction | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Reference(InventoryItem) | The InventoryItem that is being reported on | |||||
![]() ![]() ![]() |
1..1 | string | The lot number of the InventoryItem | |||||
![]() ![]() ![]() |
1..1 | Reference(Location) | The location of the InventoryItem as of the report | |||||
![]() ![]() ![]() |
1..1 | SimpleQuantity | The quantity of the InventoryItem involved in the transaction | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| InventoryReport.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| InventoryReport.status | Base | required | http://hl7.org/fhir/ValueSet/inventoryreport-status | Not State | Unknown |
| InventoryReport.countType | Base | required | http://hl7.org/fhir/ValueSet/inventoryreport-counttype | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | InventoryReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | InventoryReport | 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | InventoryReport | 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 | error | InventoryReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | InventoryReport | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from DomainResource
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DomainResource | InventoryReport Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for the inventory transaction |
![]() ![]() |
1..1 | code | draft | requested | active | entered-in-error Binding: inventoryreport-status (??) (required) | |
![]() ![]() |
1..1 | code | snapshot | difference Binding: inventoryreport-counttype (??) (required) | |
![]() ![]() |
0..1 | CodeableConcept | addition | subtraction | |
![]() ![]() |
0..1 | CodeableConcept | The reason for the transaction | |
![]() ![]() |
1..1 | dateTime | The date and time when the report was generated | |
![]() ![]() |
1..1 | BackboneElement | Details of the inventory item involved in the transaction | |
![]() ![]() ![]() |
1..1 | Reference(InventoryItem) | The InventoryItem that is being reported on | |
![]() ![]() ![]() |
1..1 | string | The lot number of the InventoryItem | |
![]() ![]() ![]() |
1..1 | Reference(Location) | The location of the InventoryItem as of the report | |
![]() ![]() ![]() |
1..1 | SimpleQuantity | The quantity of the InventoryItem involved in the transaction | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| InventoryReport.status | Base | required | http://hl7.org/fhir/ValueSet/inventoryreport-status | Not State | Unknown |
| InventoryReport.countType | Base | required | http://hl7.org/fhir/ValueSet/inventoryreport-counttype | Not State | Unknown |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DomainResource | InventoryReport Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension | |||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for the inventory transaction | ||||
![]() ![]() |
1..1 | code | draft | requested | active | entered-in-error Binding: inventoryreport-status (??) (required) | |||||
![]() ![]() |
1..1 | code | snapshot | difference Binding: inventoryreport-counttype (??) (required) | |||||
![]() ![]() |
0..1 | CodeableConcept | addition | subtraction | |||||
![]() ![]() |
0..1 | CodeableConcept | The reason for the transaction | |||||
![]() ![]() |
1..1 | dateTime | The date and time when the report was generated | |||||
![]() ![]() |
1..1 | BackboneElement | Details of the inventory item involved in the transaction | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Reference(InventoryItem) | The InventoryItem that is being reported on | |||||
![]() ![]() ![]() |
1..1 | string | The lot number of the InventoryItem | |||||
![]() ![]() ![]() |
1..1 | Reference(Location) | The location of the InventoryItem as of the report | |||||
![]() ![]() ![]() |
1..1 | SimpleQuantity | The quantity of the InventoryItem involved in the transaction | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| InventoryReport.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| InventoryReport.status | Base | required | http://hl7.org/fhir/ValueSet/inventoryreport-status | Not State | Unknown |
| InventoryReport.countType | Base | required | http://hl7.org/fhir/ValueSet/inventoryreport-counttype | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | InventoryReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | InventoryReport | 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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | InventoryReport | 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 | error | InventoryReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | InventoryReport | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DomainResource
Other representations of profile: CSV, Excel, Schematron