This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

2.42 JSON Schema for ItemInstance

Orders and Observations Work Group

Maturity Level: N/A

Ballot Status: Informative

Compartments: Patient

This is a representation of the json schema for ItemInstance, 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/ItemInstance",
  "$ref": "#/definitions/ItemInstance",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "ItemInstance": {
      "description": "A physical, countable instance of an item, for example one box or one unit.",
      "properties": {
        "resourceType": {
          "description": "This is a ItemInstance resource",
          "const": "ItemInstance"
        },
        "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, and nor can they have their own independent transaction scope.",
          "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 manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer 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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "count": {
          "description": "The quantity or amount of instances. For example if several units are being counted for inventory, this quantity can be more than one, provided they are not unique. Seriallized items are considered unique and as such would have a quantity max 1. This element is required and its presence asserts that the reource refers to a physical item.",
          "$ref": "#/definitions/integer"
        },
        "_count": {
          "description": "Extensions for count",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "location": {
          "description": "The location where the item is phisically located.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "subject": {
          "description": "The patient that the item is associated with (implanted in, given to).",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "manufactureDate": {
          "description": "The manufacture or preparation date and time. Times are necessary for several examples - for example biologically derived products, prepared or coumpounded medication, rapidly decaying isotopes.",
          "$ref": "#/definitions/dateTime"
        },
        "_manufactureDate": {
          "description": "Extensions for manufactureDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "expiryDate": {
          "description": "The expiry or preparation date and time.",
          "$ref": "#/definitions/dateTime"
        },
        "_expiryDate": {
          "description": "Extensions for expiryDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "currentSWVersion": {
          "description": "The Software version associated with the device, typically only used for devices with embedded software or firmware.",
          "$ref": "#/definitions/string"
        },
        "_currentSWVersion": {
          "description": "Extensions for currentSWVersion",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "lotNumber": {
          "description": "The lot or batch number.",
          "$ref": "#/definitions/string"
        },
        "_lotNumber": {
          "description": "Extensions for lotNumber",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "serialNumber": {
          "description": "The serial number if available.",
          "$ref": "#/definitions/string"
        },
        "_serialNumber": {
          "description": "Extensions for serialNumber",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "carrierAIDC": {
          "description": "The machine-readable AIDC string in base64 encoding. Can correspond to the UDI pattern in devices.",
          "$ref": "#/definitions/string"
        },
        "_carrierAIDC": {
          "description": "Extensions for carrierAIDC",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "carrierHRF": {
          "description": "The human-readable barcode string. Can correspond to the UDI pattern in devices.",
          "$ref": "#/definitions/string"
        },
        "_carrierHRF": {
          "description": "Extensions for carrierHRF",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false,
      "required": [
        "resourceType"
      ]
    }
  }
}