Current Build

11.7 JSON Schema for MedicinalProduct

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 MedicinalProduct, 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/MedicinalProduct",
  "$ref": "#/definitions/MedicinalProduct",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "MedicinalProduct": {
      "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).",
      "properties": {
        "resourceType": {
          "description": "This is a MedicinalProduct resource",
          "const": "MedicinalProduct"
        },
        "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"
        },
        "identifier": {
          "description": "Business idenfifier for this product. Could be an MPID.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "type": {
          "description": "Regulatory type, e.g. Investigational or Authorized.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "domain": {
          "description": "If this medicine applies to human or veterinary uses.",
          "$ref": "Coding.schema.json#/definitions/Coding"
        },
        "combinedPharmaceuticalDoseForm": {
          "description": "The dose form for a single part product, or combined form of a multiple part product.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "additionalMonitoringIndicator": {
          "description": "Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "specialMeasures": {
          "description": "Whether the Medicinal Product is subject to special measures for regulatory reasons.",
          "items": {
            "$ref": "#/definitions/string"
          },
          "type": "array"
        },
        "_specialMeasures": {
          "description": "Extensions for specialMeasures",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "paediatricUseIndicator": {
          "description": "If authorised for use in children.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "productClassification": {
          "description": "Allows the product to be classified by various systems.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "marketingStatus": {
          "description": "Marketing status of the medicinal product, in contrast to marketing authorizaton.",
          "items": {
            "$ref": "MarketingStatus.schema.json#/definitions/MarketingStatus"
          },
          "type": "array"
        },
        "marketingAuthorization": {
          "description": "Product regulatory authorization.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "packagedMedicinalProduct": {
          "description": "Package representation for the product.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "pharmaceuticalProduct": {
          "description": "Pharmaceutical aspects of product.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "clinicalParticulars": {
          "description": "Clinical particulars, indications etc.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "attachedDocument": {
          "description": "Supporting documentation, typically for regulatory submission.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "masterFile": {
          "description": "A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "contact": {
          "description": "A product specific contact, person (in a role), or an organization.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "clinicalTrial": {
          "description": "Clinical trials or studies that this product is involved in.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "name": {
          "description": "The product\u0027s name, including full name and possibly coded parts.",
          "items": {
            "$ref": "#/definitions/MedicinalProduct_Name"
          },
          "type": "array"
        },
        "crossReference": {
          "description": "Reference to another product, e.g. for linking authorised to investigational product.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "manufacturingBusinessOperation": {
          "description": "An operation applied to the product, for manufacturing or adminsitrative purpose.",
          "items": {
            "$ref": "#/definitions/MedicinalProduct_ManufacturingBusinessOperation"
          },
          "type": "array"
        },
        "orphanDesignation": {
          "description": "Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.",
          "items": {
            "$ref": "#/definitions/MedicinalProduct_OrphanDesignation"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "name",
        "resourceType"
      ]
    },
    "MedicinalProduct_Name": {
      "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).",
      "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"
        },
        "productName": {
          "description": "The full product name.",
          "$ref": "#/definitions/string"
        },
        "_productName": {
          "description": "Extensions for productName",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "namePart": {
          "description": "Coding words or phrases of the name.",
          "items": {
            "$ref": "#/definitions/MedicinalProduct_NamePart"
          },
          "type": "array"
        },
        "countryLanguage": {
          "description": "Country where the name applies.",
          "items": {
            "$ref": "#/definitions/MedicinalProduct_CountryLanguage"
          },
          "type": "array"
        }
      },
      "additionalProperties": false
    },
    "MedicinalProduct_NamePart": {
      "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).",
      "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"
        },
        "part": {
          "description": "A fragment of a product name.",
          "$ref": "#/definitions/string"
        },
        "_part": {
          "description": "Extensions for part",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "type": {
          "description": "Idenifying type for this part of the name (e.g. strength part).",
          "$ref": "Coding.schema.json#/definitions/Coding"
        }
      },
      "additionalProperties": false,
      "required": [
        "type"
      ]
    },
    "MedicinalProduct_CountryLanguage": {
      "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).",
      "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"
        },
        "country": {
          "description": "Country code for where this name applies.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "jurisdiction": {
          "description": "Jurisdiction code for where this name applies.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "language": {
          "description": "Language code for this name.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        }
      },
      "additionalProperties": false,
      "required": [
        "country",
        "language"
      ]
    },
    "MedicinalProduct_ManufacturingBusinessOperation": {
      "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).",
      "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"
        },
        "operationType": {
          "description": "The type of manufacturing operation.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "authorisationReferenceNumber": {
          "description": "Regulatory authorization reference number.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "effectiveDate": {
          "description": "Regulatory authorization date.",
          "$ref": "#/definitions/dateTime"
        },
        "_effectiveDate": {
          "description": "Extensions for effectiveDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "confidentialityIndicator": {
          "description": "To indicate if this proces is commercially confidential.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "manufacturer": {
          "description": "The manufacturer or establishment associated with the process.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "regulator": {
          "description": "A regulator which oversees the operation.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        }
      },
      "additionalProperties": false
    },
    "MedicinalProduct_OrphanDesignation": {
      "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).",
      "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"
        },
        "identifier": {
          "description": "Identifier for the designation, or procedure number.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "intendedUse": {
          "description": "The intended use of the product, e.g. prevention, treatment.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "indication": {
          "description": "Condition for which the medicinal use applies.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "status": {
          "description": "For example granted, pending, expired or withdrawn.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "date": {
          "description": "Date when the designation was granted.",
          "$ref": "#/definitions/dateTime"
        },
        "_date": {
          "description": "Extensions for date",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "species": {
          "description": "Animal species for which this applies.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        }
      },
      "additionalProperties": false
    }
  }
}