Release 5
WorkflowThis 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 
| 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 InventoryItem, 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/InventoryItem",
"$ref": "#/definitions/InventoryItem",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"InventoryItem": {
"description": "A functional description of an inventory item used in inventory and supply-related workflows.",
"properties": {
"resourceType": {
"description": "This is a InventoryItem resource",
"const": "InventoryItem"
},
"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 inventory item.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"status": {
"description": "Status of the item entry.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"category": {
"description": "Category or class of the item.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"code": {
"description": "Code designating the specific type of item.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"name": {
"description": "The item name(s) - the brand name, or common name, functional name, generic name.",
"items": {
"$ref": "#/definitions/InventoryItem_Name"
},
"type": "array"
},
"responsibleOrganization": {
"description": "Organization(s) responsible for the product.",
"items": {
"$ref": "#/definitions/InventoryItem_ResponsibleOrganization"
},
"type": "array"
},
"description": {
"description": "The descriptive characteristics of the inventory item.",
"$ref": "#/definitions/InventoryItem_Description"
},
"inventoryStatus": {
"description": "The usage status e.g. recalled, in use, discarded... This can be used to indicate that the items have been taken out of inventory, or are in use, etc.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"baseUnit": {
"description": "The base unit of measure - the unit in which the product is used or counted.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"netContent": {
"description": "Net content or amount present in the item.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"association": {
"description": "Association with other items or products.",
"items": {
"$ref": "#/definitions/InventoryItem_Association"
},
"type": "array"
},
"characteristic": {
"description": "The descriptive or identifying characteristics of the item.",
"items": {
"$ref": "#/definitions/InventoryItem_Characteristic"
},
"type": "array"
},
"instance": {
"description": "Instances or occurrences of the product.",
"$ref": "#/definitions/InventoryItem_Instance"
},
"productReference": {
"description": "Link to a product resource used in clinical workflows.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"InventoryItem_Name": {
"description": "A functional description of an inventory item used in inventory and supply-related workflows.",
"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"
},
"nameType": {
"description": "The type of name e.g. \u0027brand-name\u0027, \u0027functional-name\u0027, \u0027common-name\u0027.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"language": {
"description": "The language that the item name is expressed in.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"name": {
"description": "The name or designation that the item is given.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"nameType"
]
},
"InventoryItem_ResponsibleOrganization": {
"description": "A functional description of an inventory item used in inventory and supply-related workflows.",
"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"
},
"role": {
"description": "The role of the organization e.g. manufacturer, distributor, etc.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"organization": {
"description": "An organization that has an association with the item, e.g. manufacturer, distributor, responsible, etc.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"role",
"organization"
]
},
"InventoryItem_Description": {
"description": "A functional description of an inventory item used in inventory and supply-related workflows.",
"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"
},
"language": {
"description": "The language for the item description, when an item must be described in different languages and those languages may be authoritative and not translations of a \u0027main\u0027 language.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "Textual description of the item.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"InventoryItem_Association": {
"description": "A functional description of an inventory item used in inventory and supply-related workflows.",
"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"
},
"associationType": {
"description": "This attribute defined the type of association when establishing associations or relations between items, e.g. \u0027packaged within\u0027 or \u0027used with\u0027 or \u0027to be mixed with.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"relatedItem": {
"description": "The related item or product.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"quantity": {
"description": "The quantity of the related product in this product - Numerator is the quantity of the related product. Denominator is the quantity of the present product. For example a value of 20 means that this product contains 20 units of the related product; a value of 1:20 means the inverse - that the contained product contains 20 units of the present product.",
"$ref": "Ratio.schema.json#/definitions/Ratio"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"quantity",
"associationType",
"relatedItem"
]
},
"InventoryItem_Characteristic": {
"description": "A functional description of an inventory item used in inventory and supply-related workflows.",
"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"
},
"characteristicType": {
"description": "The type of characteristic that is being defined.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueString": {
"description": "The value of the attribute.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueInteger": {
"description": "The value of the attribute.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDecimal": {
"description": "The value of the attribute.",
"pattern": "^-?(0|[1-9][0-9]{0,17})(\\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$",
"type": "number"
},
"_valueDecimal": {
"description": "Extensions for valueDecimal",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueBoolean": {
"description": "The value of the attribute.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUrl": {
"description": "The value of the attribute.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueUrl": {
"description": "Extensions for valueUrl",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDateTime": {
"description": "The value of the attribute.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_valueDateTime": {
"description": "Extensions for valueDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueQuantity": {
"description": "The value of the attribute.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"valueRange": {
"description": "The value of the attribute.",
"$ref": "Range.schema.json#/definitions/Range"
},
"valueRatio": {
"description": "The value of the attribute.",
"$ref": "Ratio.schema.json#/definitions/Ratio"
},
"valueAnnotation": {
"description": "The value of the attribute.",
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"valueAddress": {
"description": "The value of the attribute.",
"$ref": "Address.schema.json#/definitions/Address"
},
"valueDuration": {
"description": "The value of the attribute.",
"$ref": "Duration.schema.json#/definitions/Duration"
},
"valueCodeableConcept": {
"description": "The value of the attribute.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"characteristicType"
]
},
"InventoryItem_Instance": {
"description": "A functional description of an inventory item used in inventory and supply-related workflows.",
"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"
},
"identifier": {
"description": "The identifier for the physical instance, typically a serial number.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"lotNumber": {
"description": "The lot or batch number of the item.",
"$ref": "#/definitions/string"
},
"_lotNumber": {
"description": "Extensions for lotNumber",
"$ref": "Element.schema.json#/definitions/Element"
},
"expiry": {
"description": "The expiry date or date and time for the product.",
"$ref": "#/definitions/dateTime"
},
"_expiry": {
"description": "Extensions for expiry",
"$ref": "Element.schema.json#/definitions/Element"
},
"subject": {
"description": "The subject that the item is associated with.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"location": {
"description": "The location that the item is associated with.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
}
}
}
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:25+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change