Current Build

11.9 JSON Schema for MedicinalProductClinicals

Biomedical Research and Regulation Work GroupMaturity Level: N/ABallot Status: Informative Compartments: Not linked to any defined compartments

This is a representation of the json schema for MedicinalProductClinicals, 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/MedicinalProductClinicals",
  "$ref": "#/definitions/MedicinalProductClinicals",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "MedicinalProductClinicals": {
      "description": "The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.",
      "properties": {
        "resourceType": {
          "description": "This is a MedicinalProductClinicals resource",
          "const": "MedicinalProductClinicals"
        },
        "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.\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"
        },
        "undesirableEffects": {
          "description": "Describe the undesirable effects of the medicinal product.",
          "items": {
            "$ref": "#/definitions/MedicinalProductClinicals_UndesirableEffects"
          },
          "type": "array"
        },
        "therapeuticIndication": {
          "description": "Indication for the Medicinal Product.",
          "items": {
            "$ref": "#/definitions/MedicinalProductClinicals_TherapeuticIndication"
          },
          "type": "array"
        },
        "contraindication": {
          "description": "Contraindication for the medicinal product.",
          "items": {
            "$ref": "#/definitions/MedicinalProductClinicals_Contraindication"
          },
          "type": "array"
        },
        "interactions": {
          "description": "The interactions of the medicinal product with other medicinal products, or other forms of interactions.",
          "items": {
            "$ref": "#/definitions/MedicinalProductClinicals_Interactions"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "therapeuticIndication",
        "resourceType"
      ]
    },
    "MedicinalProductClinicals_UndesirableEffects": {
      "description": "The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.",
      "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. 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"
        },
        "symptomConditionEffect": {
          "description": "The symptom, condition or undesirable effect.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "classification": {
          "description": "Classification of the effect.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "frequencyOfOccurrence": {
          "description": "The frequency of occurrence of the effect.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "population": {
          "description": "The population group to which this applies.",
          "items": {
            "$ref": "#/definitions/MedicinalProductClinicals_Population"
          },
          "type": "array"
        }
      },
      "additionalProperties": false
    },
    "MedicinalProductClinicals_Population": {
      "description": "The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.",
      "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. 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"
        },
        "ageRange": {
          "description": "The age of the specific population.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "ageCodeableConcept": {
          "description": "The age of the specific population.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "gender": {
          "description": "The gender of the specific population.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "race": {
          "description": "Race of the specific population.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "physiologicalCondition": {
          "description": "The existing physiological conditions of the specific population to which this applies.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        }
      },
      "additionalProperties": false
    },
    "MedicinalProductClinicals_TherapeuticIndication": {
      "description": "The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.",
      "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. 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"
        },
        "diseaseSymptomProcedure": {
          "description": "The disease, symptom or procedure that is the indication for treatment.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "diseaseStatus": {
          "description": "The status of the disease or symptom for which the indication applies.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "comorbidity": {
          "description": "Comorbidity (concurrent condition) or co-infection as part of the indication.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "intendedEffect": {
          "description": "The intended effect, aim or strategy to be achieved by the indication.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "duration": {
          "description": "Timing or duration information as part of the indication.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "undesirableEffects": {
          "description": "Information about the use of the medicinal product in relation to other therapies as part of the indication.",
          "items": {
            "$ref": "#/definitions/MedicinalProductClinicals_UndesirableEffects"
          },
          "type": "array"
        },
        "otherTherapy": {
          "description": "Information about the use of the medicinal product in relation to other therapies described as part of the indication.",
          "items": {
            "$ref": "#/definitions/MedicinalProductClinicals_OtherTherapy"
          },
          "type": "array"
        },
        "population": {
          "description": "The population group to which this applies.",
          "items": {
            "$ref": "#/definitions/MedicinalProductClinicals_Population"
          },
          "type": "array"
        }
      },
      "additionalProperties": false
    },
    "MedicinalProductClinicals_OtherTherapy": {
      "description": "The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.",
      "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. 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"
        },
        "therapyRelationshipType": {
          "description": "The type of relationship between the medicinal product indication or contraindication and another therapy.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "medicationCodeableConcept": {
          "description": "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "medicationReference": {
          "description": "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        }
      },
      "additionalProperties": false,
      "required": [
        "therapyRelationshipType"
      ]
    },
    "MedicinalProductClinicals_Contraindication": {
      "description": "The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.",
      "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. 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"
        },
        "disease": {
          "description": "The disease, symptom or procedure for the contraindication.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "diseaseStatus": {
          "description": "The status of the disease or symptom for the contraindication.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "comorbidity": {
          "description": "A comorbidity (concurrent condition) or coinfection.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "therapeuticIndication": {
          "description": "Information about the use of the medicinal product in relation to other therapies as part of the indication.",
          "items": {
            "$ref": "#/definitions/MedicinalProductClinicals_TherapeuticIndication"
          },
          "type": "array"
        },
        "otherTherapy": {
          "description": "Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.",
          "items": {
            "$ref": "#/definitions/MedicinalProductClinicals_OtherTherapy"
          },
          "type": "array"
        },
        "population": {
          "description": "The population group to which this applies.",
          "items": {
            "$ref": "#/definitions/MedicinalProductClinicals_Population"
          },
          "type": "array"
        }
      },
      "additionalProperties": false
    },
    "MedicinalProductClinicals_Interactions": {
      "description": "The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.",
      "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. 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"
        },
        "interaction": {
          "description": "The interaction described.",
          "$ref": "#/definitions/string"
        },
        "_interaction": {
          "description": "Extensions for interaction",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "interactant": {
          "description": "The specific medication, food or laboratory test that interacts.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "type": {
          "description": "The type of the interaction.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "effect": {
          "description": "The effect of the interaction.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "incidence": {
          "description": "The incidence of the interaction.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "management": {
          "description": "Actions for managing the interaction.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        }
      },
      "additionalProperties": false
    }
  }
}