fhir-schemas/fhir.schema.json/Medication.schema.json

Schemas for Fast Healthcare Interoperability Resources.

{
  "schema": "http://json-schema.org/draft-04/schema#",
  "$id": "http://hl7.org/fhir/json-schema/Medication",
  "$ref": "#/definitions/Medication",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "Medication": {
      "allOf": [
        {
          "$ref": "DomainResource#/definitions/DomainResource"
        },
        {
          "description": "This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.",
          "properties": {
            "resourceType": {
              "description": "This is a Medication resource",
              "type": "string",
              "enum": [
                "Medication"
              ]
            },
            "code": {
              "description": "A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.",
              "$ref": "http://hl7.org/fhir/json-schema/CodeableConcept#/definitions/CodeableConcept"
            },
            "status": {
              "description": "A code to indicate if the medication is in active use.",
              "enum": [
                "active",
                "inactive",
                "entered-in-error"
              ],
              "type": "string"
            },
            "_status": {
              "description": "Extensions for status",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "isBrand": {
              "description": "Set to true if the item is attributable to a specific manufacturer.",
              "type": "boolean"
            },
            "_isBrand": {
              "description": "Extensions for isBrand",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "isOverTheCounter": {
              "description": "Set to true if the medication can be obtained without an order from a prescriber.",
              "type": "boolean"
            },
            "_isOverTheCounter": {
              "description": "Extensions for isOverTheCounter",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "manufacturer": {
              "description": "Describes the details of the manufacturer of the medication product.  This is not intended to represent the distributor of a medication product.",
              "$ref": "http://hl7.org/fhir/json-schema/Reference#/definitions/Reference"
            },
            "form": {
              "description": "Describes the form of the item.  Powder; tablets; capsule.",
              "$ref": "http://hl7.org/fhir/json-schema/CodeableConcept#/definitions/CodeableConcept"
            },
            "ingredient": {
              "description": "Identifies a particular constituent of interest in the product.",
              "type": "array",
              "items": {
                "$ref": "#/definitions/Medication_Ingredient"
              }
            },
            "package": {
              "description": "Information that only applies to packages (not products).",
              "$ref": "#/definitions/Medication_Package"
            },
            "image": {
              "description": "Photo(s) or graphic representation(s) of the medication.",
              "type": "array",
              "items": {
                "$ref": "http://hl7.org/fhir/json-schema/Attachment#/definitions/Attachment"
              }
            }
          },
          "required": [
            "resourceType"
          ]
        }
      ]
    },
    "Medication_Ingredient": {
      "allOf": [
        {
          "$ref": "BackboneElement#/definitions/BackboneElement"
        },
        {
          "description": "This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.",
          "properties": {
            "itemCodeableConcept": {
              "description": "The actual ingredient - either a substance (simple ingredient) or another medication.",
              "$ref": "http://hl7.org/fhir/json-schema/CodeableConcept#/definitions/CodeableConcept"
            },
            "itemReference": {
              "description": "The actual ingredient - either a substance (simple ingredient) or another medication.",
              "$ref": "http://hl7.org/fhir/json-schema/Reference#/definitions/Reference"
            },
            "isActive": {
              "description": "Indication of whether this ingredient affects the therapeutic action of the drug.",
              "type": "boolean"
            },
            "_isActive": {
              "description": "Extensions for isActive",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "amount": {
              "description": "Specifies how many (or how much) of the items there are in this Medication.  For example, 250 mg per tablet.  This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.",
              "$ref": "http://hl7.org/fhir/json-schema/Ratio#/definitions/Ratio"
            }
          }
        }
      ]
    },
    "Medication_Package": {
      "allOf": [
        {
          "$ref": "BackboneElement#/definitions/BackboneElement"
        },
        {
          "description": "This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.",
          "properties": {
            "container": {
              "description": "The kind of container that this package comes as.",
              "$ref": "http://hl7.org/fhir/json-schema/CodeableConcept#/definitions/CodeableConcept"
            },
            "content": {
              "description": "A set of components that go to make up the described item.",
              "type": "array",
              "items": {
                "$ref": "#/definitions/Medication_Content"
              }
            },
            "batch": {
              "description": "Information about a group of medication produced or packaged from one production run.",
              "type": "array",
              "items": {
                "$ref": "#/definitions/Medication_Batch"
              }
            }
          }
        }
      ]
    },
    "Medication_Content": {
      "allOf": [
        {
          "$ref": "BackboneElement#/definitions/BackboneElement"
        },
        {
          "description": "This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.",
          "properties": {
            "itemCodeableConcept": {
              "description": "Identifies one of the items in the package.",
              "$ref": "http://hl7.org/fhir/json-schema/CodeableConcept#/definitions/CodeableConcept"
            },
            "itemReference": {
              "description": "Identifies one of the items in the package.",
              "$ref": "http://hl7.org/fhir/json-schema/Reference#/definitions/Reference"
            },
            "amount": {
              "description": "The amount of the product that is in the package.",
              "$ref": "http://hl7.org/fhir/json-schema/Quantity#/definitions/Quantity"
            }
          }
        }
      ]
    },
    "Medication_Batch": {
      "allOf": [
        {
          "$ref": "BackboneElement#/definitions/BackboneElement"
        },
        {
          "description": "This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.",
          "properties": {
            "lotNumber": {
              "description": "The assigned lot number of a batch of the specified product.",
              "type": "string"
            },
            "_lotNumber": {
              "description": "Extensions for lotNumber",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "expirationDate": {
              "description": "When this specific batch of product will expire.",
              "type": "string",
              "pattern": "-?[0-9]{4}(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?"
            },
            "_expirationDate": {
              "description": "Extensions for expirationDate",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            }
          }
        }
      ]
    }
  }
}