This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions

12.29.11 JSON Schema for InventoryReport

Orders and Observations Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: No defined compartments

This is a representation of the json schema for InventoryReport, which is just a part of the full JSON Schema.

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "id": "http://hl7.org/fhir/json-schema/InventoryReport",
  "$ref": "#/definitions/InventoryReport",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "InventoryReport": {
      "description": "A report of inventory or stock items.",
      "properties": {
        "resourceType": {
          "description": "This is a InventoryReport resource",
          "const": "InventoryReport"
        },
        "id": {
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
          "$ref": "id.schema.json#/definitions/id"
        },
        "meta": {
          "description": "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.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "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.",
          "$ref": "#/definitions/uri"
        },
        "_implicitRules": {
          "description": "Extensions for implicitRules",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "language": {
          "description": "The base language in which the resource is written.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "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.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "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.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "identifier": {
          "description": "Business identifier for the InventoryReport.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "status": {
          "description": "The status of the inventory check or notification - whether this is draft (e.g. the report is still pending some updates) or active.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "countType": {
          "description": "Whether the report is about the current inventory count (snapshot) or a differential change in inventory (change).",
          "$ref": "#/definitions/code"
        },
        "_countType": {
          "description": "Extensions for countType",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "operationType": {
          "description": "What type of operation is being performed - addition or subtraction.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "operationTypeReason": {
          "description": "The reason for this count - regular count, ad-hoc count, new arrivals, etc.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "reportedDateTime": {
          "description": "When the report has been submitted.",
          "$ref": "#/definitions/dateTime"
        },
        "_reportedDateTime": {
          "description": "Extensions for reportedDateTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "reporter": {
          "description": "Who submits the report.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "reportingPeriod": {
          "description": "The period the report refers to.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "inventoryListing": {
          "description": "An inventory listing section (grouped by any of the attributes).",
          "items": {
            "$ref": "#/definitions/InventoryReport_InventoryListing"
          },
          "type": "array"
        },
        "note": {
          "description": "A note associated with the InventoryReport.",
          "items": {
            "$ref": "Annotation.schema.json#/definitions/Annotation"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "resourceType"
      ]
    },
    "InventoryReport_InventoryListing": {
      "description": "A report of inventory or stock items.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "location": {
          "description": "Location of the inventory items.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "itemStatus": {
          "description": "The status of the items.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "countingDateTime": {
          "description": "The date and time when the items were counted.",
          "$ref": "#/definitions/dateTime"
        },
        "_countingDateTime": {
          "description": "Extensions for countingDateTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "item": {
          "description": "The item or items in this listing.",
          "items": {
            "$ref": "#/definitions/InventoryReport_Item"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false
    },
    "InventoryReport_Item": {
      "description": "A report of inventory or stock items.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "category": {
          "description": "The inventory category or classification of the items being reported. This is meant not for defining the product, but for inventory categories e.g. \u0027pending recount\u0027 or \u0027damaged\u0027.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "quantity": {
          "description": "The quantity of the item or items being reported.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "item": {
          "description": "The code or reference to the item type.",
          "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "item",
        "quantity"
      ]
    }
  }
}