OO Incubator Implementation Guide
0.1.0 - ci-build International flag

OO Incubator Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/oo-incubator/ and changes regularly. See the Directory of published versions

Resource: InventoryReport - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the InventoryReport resource

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

0. InventoryReport
Definition

A report of inventory or stock items.


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

ShortA report of inventory or stock itemsA resource with narrative, extensions, and contained resources
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. InventoryReport.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. InventoryReport.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. InventoryReport.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. InventoryReport.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3
(required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. InventoryReport.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. InventoryReport.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. InventoryReport.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on InventoryReport.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 16. InventoryReport.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Must Supportfalse
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on InventoryReport.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 18. InventoryReport.identifier
      Definition

      Business identifier for the InventoryReport.

      ShortBusiness identifier for the report
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      Summarytrue
      20. InventoryReport.status
      Definition

      The status of the inventory check or notification - whether this is draft (e.g. the report is still pending some updates) or active.

      Shortdraft | requested | active | entered-in-error
      Control1..1
      BindingThe codes SHALL be taken from InventoryReportStatushttp://hl7.org/fhir/ValueSet/inventoryreport-status
      (required to http://hl7.org/fhir/ValueSet/inventoryreport-status)

      The status of the InventoryReport.

      Typecode
      Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      22. InventoryReport.countType
      Definition

      Whether the report is about the current inventory count (snapshot) or a differential change in inventory (change).

      Shortsnapshot | difference
      Control1..1
      BindingThe codes SHALL be taken from InventoryCountTypehttp://hl7.org/fhir/ValueSet/inventoryreport-counttype
      (required to http://hl7.org/fhir/ValueSet/inventoryreport-counttype)

      The type of count.

      Typecode
      Is Modifiertrue because Not known why this is labelled a modifier
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      24. InventoryReport.operationType
      Definition

      What type of operation is being performed - addition or subtraction.

      Shortaddition | subtraction
      Control0..1
      TypeCodeableConcept
      Summarytrue
      26. InventoryReport.operationTypeReason
      Definition

      The reason for this count - regular count, ad-hoc count, new arrivals, etc.

      ShortThe reason for this count - regular count, ad-hoc count, new arrivals, etc
      Control0..1
      TypeCodeableConcept
      Summarytrue
      28. InventoryReport.reportedDateTime
      Definition

      When the report has been submitted.

      ShortWhen the report has been submitted
      Control1..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      30. InventoryReport.reporter
      Definition

      Who submits the report.

      ShortWho submits the report
      Control0..1
      TypeReference(Practitioner, Patient, RelatedPerson, Device)
      32. InventoryReport.reportingPeriod
      Definition

      The period the report refers to.

      ShortThe period the report refers to
      Control0..1
      TypePeriod
      34. InventoryReport.inventoryListing
      Definition

      An inventory listing section (grouped by any of the attributes).

      ShortAn inventory listing section (grouped by any of the attributes)
      Control0..*
      TypeBackboneElement
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
      36. InventoryReport.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
      Typeidstring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      38. InventoryReport.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()))
      SlicingThis element introduces a set of slices on InventoryReport.inventoryListing.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 40. InventoryReport.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()))
        42. InventoryReport.inventoryListing.location
        Definition

        Location of the inventory items.

        ShortLocation of the inventory items
        Control0..1
        TypeReference(Location)
        44. InventoryReport.inventoryListing.itemStatus
        Definition

        The status of the items.

        ShortThe status of the items that are being reported
        Control0..1
        TypeCodeableConcept
        Summarytrue
        46. InventoryReport.inventoryListing.countingDateTime
        Definition

        The date and time when the items were counted.

        ShortThe date and time when the items were counted
        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        48. InventoryReport.inventoryListing.item
        Definition

        The item or items in this listing.

        ShortThe item or items in this listing
        Control0..*
        TypeBackboneElement
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
        50. InventoryReport.inventoryListing.item.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        This element is affected by the following invariants: ele-1
        Typeidstring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        52. InventoryReport.inventoryListing.item.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on InventoryReport.inventoryListing.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 54. InventoryReport.inventoryListing.item.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()))
          56. InventoryReport.inventoryListing.item.category
          Definition

          The inventory category or classification of the items being reported. This is meant not for defining the product, but for inventory categories e.g. 'pending recount' or 'damaged'.

          ShortThe inventory category or classification of the items being reported
          Control0..1
          TypeCodeableConcept
          Summarytrue
          58. InventoryReport.inventoryListing.item.quantity
          Definition

          The quantity of the item or items being reported.

          ShortThe quantity of the item or items being reported
          Control1..1
          TypeQuantity
          Summarytrue
          60. InventoryReport.inventoryListing.item.item
          Definition

          The code or reference to the item type.

          ShortThe code or reference to the item type
          Control1..1
          TypeCodeableReference(Medication, Device, NutritionProduct, InventoryItem, BiologicallyDerivedProduct)
          Summarytrue
          62. InventoryReport.note
          Definition

          A note associated with the InventoryReport.

          ShortA note associated with the InventoryReport
          Control0..*
          TypeAnnotation

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

          0. InventoryReport
          Definition

          A report of inventory or stock items.

          ShortA report of inventory or stock items
          Control0..*
          2. InventoryReport.identifier
          Definition

          Business identifier for the InventoryReport.

          ShortBusiness identifier for the report
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier
          4. InventoryReport.status
          Definition

          The status of the inventory check or notification - whether this is draft (e.g. the report is still pending some updates) or active.

          Shortdraft | requested | active | entered-in-error
          Control1..1
          BindingThe codes SHALL be taken from InventoryReportStatus
          (required to http://hl7.org/fhir/ValueSet/inventoryreport-status)

          The status of the InventoryReport.

          Typecode
          Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          6. InventoryReport.countType
          Definition

          Whether the report is about the current inventory count (snapshot) or a differential change in inventory (change).

          Shortsnapshot | difference
          Control1..1
          BindingThe codes SHALL be taken from InventoryCountType
          (required to http://hl7.org/fhir/ValueSet/inventoryreport-counttype)

          The type of count.

          Typecode
          Is Modifiertrue because Not known why this is labelled a modifier
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          8. InventoryReport.operationType
          Definition

          What type of operation is being performed - addition or subtraction.

          Shortaddition | subtraction
          Control0..1
          TypeCodeableConcept
          10. InventoryReport.operationTypeReason
          Definition

          The reason for this count - regular count, ad-hoc count, new arrivals, etc.

          ShortThe reason for this count - regular count, ad-hoc count, new arrivals, etc
          Control0..1
          TypeCodeableConcept
          12. InventoryReport.reportedDateTime
          Definition

          When the report has been submitted.

          ShortWhen the report has been submitted
          Control1..1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          14. InventoryReport.reporter
          Definition

          Who submits the report.

          ShortWho submits the report
          Control0..1
          TypeReference(Practitioner, Patient, RelatedPerson, Device)
          16. InventoryReport.reportingPeriod
          Definition

          The period the report refers to.

          ShortThe period the report refers to
          Control0..1
          TypePeriod
          18. InventoryReport.inventoryListing
          Definition

          An inventory listing section (grouped by any of the attributes).

          ShortAn inventory listing section (grouped by any of the attributes)
          Control0..*
          TypeBackboneElement
          20. InventoryReport.inventoryListing.location
          Definition

          Location of the inventory items.

          ShortLocation of the inventory items
          Control0..1
          TypeReference(Location)
          22. InventoryReport.inventoryListing.itemStatus
          Definition

          The status of the items.

          ShortThe status of the items that are being reported
          Control0..1
          TypeCodeableConcept
          24. InventoryReport.inventoryListing.countingDateTime
          Definition

          The date and time when the items were counted.

          ShortThe date and time when the items were counted
          Control0..1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          26. InventoryReport.inventoryListing.item
          Definition

          The item or items in this listing.

          ShortThe item or items in this listing
          Control0..*
          TypeBackboneElement
          28. InventoryReport.inventoryListing.item.category
          Definition

          The inventory category or classification of the items being reported. This is meant not for defining the product, but for inventory categories e.g. 'pending recount' or 'damaged'.

          ShortThe inventory category or classification of the items being reported
          Control0..1
          TypeCodeableConcept
          30. InventoryReport.inventoryListing.item.quantity
          Definition

          The quantity of the item or items being reported.

          ShortThe quantity of the item or items being reported
          Control1..1
          TypeQuantity
          32. InventoryReport.inventoryListing.item.item
          Definition

          The code or reference to the item type.

          ShortThe code or reference to the item type
          Control1..1
          TypeCodeableReference(Medication, Device, NutritionProduct, InventoryItem, BiologicallyDerivedProduct)
          34. InventoryReport.note
          Definition

          A note associated with the InventoryReport.

          ShortA note associated with the InventoryReport
          Control0..*
          TypeAnnotation

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

          0. InventoryReport
          Definition

          A report of inventory or stock items.

          ShortA report of inventory or stock items
          Control0..*
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())
          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
          dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
          dom-6: A resource should have narrative for robust management (text.`div`.exists())
          2. InventoryReport.id
          Definition

          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

          ShortLogical id of this artifact
          Comments

          Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

          Control0..1
          Typeid
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          4. InventoryReport.meta
          Definition

          The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          6. InventoryReport.implicitRules
          Definition

          A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

          ShortA set of rules under which this content was created
          Comments

          Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

          Control0..1
          Typeuri
          Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          8. InventoryReport.language
          Definition

          The base language in which the resource is written.

          ShortLanguage of the resource content
          Comments

          Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

          Control0..1
          BindingThe codes SHALL be taken from AllLanguages
          (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)

          IETF language tag for a human language

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          10. InventoryReport.text
          Definition

          A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

          ShortText summary of the resource, for human interpretation
          Comments

          Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

          Control0..1
          This element is affected by the following invariants: dom-6
          TypeNarrative
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesnarrative, html, xhtml, display
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. InventoryReport.contained
          Definition

          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

          ShortContained, inline Resources
          Comments

          This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

          Control0..*
          This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
          TypeResource
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          14. InventoryReport.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on InventoryReport.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 16. InventoryReport.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
            Must Supportfalse
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on InventoryReport.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 18. InventoryReport.identifier
              Definition

              Business identifier for the InventoryReport.

              ShortBusiness identifier for the report
              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..*
              TypeIdentifier
              Summarytrue
              20. InventoryReport.status
              Definition

              The status of the inventory check or notification - whether this is draft (e.g. the report is still pending some updates) or active.

              Shortdraft | requested | active | entered-in-error
              Control1..1
              BindingThe codes SHALL be taken from InventoryReportStatus
              (required to http://hl7.org/fhir/ValueSet/inventoryreport-status)

              The status of the InventoryReport.

              Typecode
              Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              22. InventoryReport.countType
              Definition

              Whether the report is about the current inventory count (snapshot) or a differential change in inventory (change).

              Shortsnapshot | difference
              Control1..1
              BindingThe codes SHALL be taken from InventoryCountType
              (required to http://hl7.org/fhir/ValueSet/inventoryreport-counttype)

              The type of count.

              Typecode
              Is Modifiertrue because Not known why this is labelled a modifier
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              24. InventoryReport.operationType
              Definition

              What type of operation is being performed - addition or subtraction.

              Shortaddition | subtraction
              Control0..1
              TypeCodeableConcept
              Summarytrue
              26. InventoryReport.operationTypeReason
              Definition

              The reason for this count - regular count, ad-hoc count, new arrivals, etc.

              ShortThe reason for this count - regular count, ad-hoc count, new arrivals, etc
              Control0..1
              TypeCodeableConcept
              Summarytrue
              28. InventoryReport.reportedDateTime
              Definition

              When the report has been submitted.

              ShortWhen the report has been submitted
              Control1..1
              TypedateTime
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              30. InventoryReport.reporter
              Definition

              Who submits the report.

              ShortWho submits the report
              Control0..1
              TypeReference(Practitioner, Patient, RelatedPerson, Device)
              32. InventoryReport.reportingPeriod
              Definition

              The period the report refers to.

              ShortThe period the report refers to
              Control0..1
              TypePeriod
              34. InventoryReport.inventoryListing
              Definition

              An inventory listing section (grouped by any of the attributes).

              ShortAn inventory listing section (grouped by any of the attributes)
              Control0..*
              TypeBackboneElement
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
              36. InventoryReport.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
              38. InventoryReport.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()))
              SlicingThis element introduces a set of slices on InventoryReport.inventoryListing.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 40. InventoryReport.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()))
                42. InventoryReport.inventoryListing.location
                Definition

                Location of the inventory items.

                ShortLocation of the inventory items
                Control0..1
                TypeReference(Location)
                44. InventoryReport.inventoryListing.itemStatus
                Definition

                The status of the items.

                ShortThe status of the items that are being reported
                Control0..1
                TypeCodeableConcept
                Summarytrue
                46. InventoryReport.inventoryListing.countingDateTime
                Definition

                The date and time when the items were counted.

                ShortThe date and time when the items were counted
                Control0..1
                TypedateTime
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                48. InventoryReport.inventoryListing.item
                Definition

                The item or items in this listing.

                ShortThe item or items in this listing
                Control0..*
                TypeBackboneElement
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                50. InventoryReport.inventoryListing.item.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
                52. InventoryReport.inventoryListing.item.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on InventoryReport.inventoryListing.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 54. InventoryReport.inventoryListing.item.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()))
                  56. InventoryReport.inventoryListing.item.category
                  Definition

                  The inventory category or classification of the items being reported. This is meant not for defining the product, but for inventory categories e.g. 'pending recount' or 'damaged'.

                  ShortThe inventory category or classification of the items being reported
                  Control0..1
                  TypeCodeableConcept
                  Summarytrue
                  58. InventoryReport.inventoryListing.item.quantity
                  Definition

                  The quantity of the item or items being reported.

                  ShortThe quantity of the item or items being reported
                  Control1..1
                  TypeQuantity
                  Summarytrue
                  60. InventoryReport.inventoryListing.item.item
                  Definition

                  The code or reference to the item type.

                  ShortThe code or reference to the item type
                  Control1..1
                  TypeCodeableReference(Medication, Device, NutritionProduct, InventoryItem, BiologicallyDerivedProduct)
                  Summarytrue
                  62. InventoryReport.note
                  Definition

                  A note associated with the InventoryReport.

                  ShortA note associated with the InventoryReport
                  Control0..*
                  TypeAnnotation