12.27.11 JSON Schema for SupplyRequest

Orders and Observations Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Device, Patient, Practitioner, RelatedPerson

This is a representation of the json schema for SupplyRequest, 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/SupplyRequest",
  "$ref": "#/definitions/SupplyRequest",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "SupplyRequest": {
      "description": "A record of a request for a medication, substance or device used in the healthcare setting.",
      "properties": {
        "resourceType": {
          "description": "This is a SupplyRequest resource",
          "const": "SupplyRequest"
        },
        "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"
        },
        "identifier": {
          "description": "Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "status": {
          "description": "Status of the supply request.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "basedOn": {
          "description": "Plan/proposal/order fulfilled by this request.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "category": {
          "description": "Category of supply, e.g.  central, non-stock, etc. This is used to support work flows associated with the supply process.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "priority": {
          "description": "Indicates how quickly this SupplyRequest should be addressed with respect to other requests.",
          "$ref": "#/definitions/code"
        },
        "_priority": {
          "description": "Extensions for priority",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "item": {
          "description": "The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.",
          "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
        },
        "quantity": {
          "description": "The amount that is being ordered of the indicated item.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "parameter": {
          "description": "Specific parameters for the ordered item.  For example, the size of the indicated item.",
          "items": {
            "$ref": "#/definitions/SupplyRequest_Parameter"
          },
          "type": "array"
        },
        "occurrenceDateTime": {
          "description": "When the request should be fulfilled.",
          "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"
        },
        "_occurrenceDateTime": {
          "description": "Extensions for occurrenceDateTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "occurrencePeriod": {
          "description": "When the request should be fulfilled.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "occurrenceTiming": {
          "description": "When the request should be fulfilled.",
          "$ref": "Timing.schema.json#/definitions/Timing"
        },
        "authoredOn": {
          "description": "When the request was made.",
          "$ref": "#/definitions/dateTime"
        },
        "_authoredOn": {
          "description": "Extensions for authoredOn",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "requester": {
          "description": "The device, practitioner, etc. who initiated the request.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "supplier": {
          "description": "Who is intended to fulfill the request.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "reason": {
          "description": "The reason why the supply item was requested.",
          "items": {
            "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
          },
          "type": "array"
        },
        "deliverFrom": {
          "description": "Where the supply is expected to come from.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "deliverTo": {
          "description": "Where the supply is destined to go.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "item",
        "quantity",
        "resourceType"
      ]
    },
    "SupplyRequest_Parameter": {
      "description": "A record of a request for a medication, substance or device used in the healthcare setting.",
      "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"
        },
        "code": {
          "description": "A code or string that identifies the device detail being asserted.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "valueCodeableConcept": {
          "description": "The value of the device detail.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "valueQuantity": {
          "description": "The value of the device detail.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "valueRange": {
          "description": "The value of the device detail.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "valueBoolean": {
          "description": "The value of the device detail.",
          "pattern": "^true|false$",
          "type": "boolean"
        },
        "_valueBoolean": {
          "description": "Extensions for valueBoolean",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  }
}