8.29.10 JSON Schema for NutritionProduct

Orders and Observations Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Not linked to any defined compartments

This is a representation of the json schema for NutritionProduct, 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/NutritionProduct",
  "$ref": "#/definitions/NutritionProduct",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "NutritionProduct": {
      "description": "A food or supplement that is consumed by patients.",
      "properties": {
        "resourceType": {
          "description": "This is a NutritionProduct resource",
          "const": "NutritionProduct"
        },
        "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 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 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 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.\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"
        },
        "code": {
          "description": "The code assigned to the product, for example a USDA NDB number, a USDA FDC ID number, or a Langual code.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "status": {
          "description": "The current state of the product.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "category": {
          "description": "Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "manufacturer": {
          "description": "The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "nutrient": {
          "description": "The product\u0027s nutritional information expressed by the nutrients.",
          "items": {
            "$ref": "#/definitions/NutritionProduct_Nutrient"
          },
          "type": "array"
        },
        "ingredient": {
          "description": "Ingredients contained in this product.",
          "items": {
            "$ref": "#/definitions/NutritionProduct_Ingredient"
          },
          "type": "array"
        },
        "knownAllergen": {
          "description": "Allergens that are known or suspected to be a part of this nutrition product.",
          "items": {
            "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
          },
          "type": "array"
        },
        "characteristic": {
          "description": "Specifies descriptive properties of the nutrition product.",
          "items": {
            "$ref": "#/definitions/NutritionProduct_Characteristic"
          },
          "type": "array"
        },
        "instance": {
          "description": "Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product.",
          "items": {
            "$ref": "#/definitions/NutritionProduct_Instance"
          },
          "type": "array"
        },
        "note": {
          "description": "Comments made about the product.",
          "items": {
            "$ref": "Annotation.schema.json#/definitions/Annotation"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "resourceType"
      ]
    },
    "NutritionProduct_Nutrient": {
      "description": "A food or supplement that is consumed by patients.",
      "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 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 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 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. 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"
        },
        "item": {
          "description": "The (relevant) nutrients in the product.",
          "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
        },
        "amount": {
          "description": "The amount of nutrient expressed in one or more units: X per pack / per serving / per dose.",
          "items": {
            "$ref": "Ratio.schema.json#/definitions/Ratio"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false
    },
    "NutritionProduct_Ingredient": {
      "description": "A food or supplement that is consumed by patients.",
      "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 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 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 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. 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"
        },
        "item": {
          "description": "The ingredient contained in the product.",
          "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
        },
        "amount": {
          "description": "The amount of ingredient that is in the product.",
          "items": {
            "$ref": "Ratio.schema.json#/definitions/Ratio"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "item"
      ]
    },
    "NutritionProduct_Characteristic": {
      "description": "A food or supplement that is consumed by patients.",
      "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 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 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 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. 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"
        },
        "type": {
          "description": "A code specifying which characteristic of the product is being described (for example, colour, shape).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "valueCodeableConcept": {
          "description": "The actual characteristic value corresponding to the type.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "valueString": {
          "description": "The actual characteristic value corresponding to the type.",
          "pattern": "^[ \\r\\n\\t\\S]+$",
          "type": "string"
        },
        "_valueString": {
          "description": "Extensions for valueString",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueQuantity": {
          "description": "The actual characteristic value corresponding to the type.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "valueBase64Binary": {
          "description": "The actual characteristic value corresponding to the type.",
          "pattern": "^\\s*([A-Za-z0-9+\\\\/]{4})*(([A-Za-z0-9+\\\\/]{2}\u003d\u003d)|([A-Za-z0-9+\\\\/]{3}\u003d)|([A-Za-z0-9+\\\\/]{4}))\\s*$",
          "type": "string"
        },
        "_valueBase64Binary": {
          "description": "Extensions for valueBase64Binary",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueAttachment": {
          "description": "The actual characteristic value corresponding to the type.",
          "$ref": "Attachment.schema.json#/definitions/Attachment"
        },
        "valueBoolean": {
          "description": "The actual characteristic value corresponding to the type.",
          "pattern": "^true|false$",
          "type": "boolean"
        },
        "_valueBoolean": {
          "description": "Extensions for valueBoolean",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type"
      ]
    },
    "NutritionProduct_Instance": {
      "description": "A food or supplement that is consumed by patients.",
      "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 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 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 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. 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"
        },
        "quantity": {
          "description": "The amount of items or instances that the resource considers, for instance when referring to 2 identical units together.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "identifier": {
          "description": "The identifier for the physical instance, typically a serial number or manufacturer number.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "name": {
          "description": "The name for the specific product.",
          "$ref": "#/definitions/string"
        },
        "_name": {
          "description": "Extensions for name",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "lotNumber": {
          "description": "The identification of the batch or lot of the product.",
          "$ref": "#/definitions/string"
        },
        "_lotNumber": {
          "description": "Extensions for lotNumber",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "expiry": {
          "description": "The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.",
          "$ref": "#/definitions/dateTime"
        },
        "_expiry": {
          "description": "Extensions for expiry",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "useBy": {
          "description": "The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.",
          "$ref": "#/definitions/dateTime"
        },
        "_useBy": {
          "description": "Extensions for useBy",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "biologicalSourceEvent": {
          "description": "An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  }
}