This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B
Biomedical Research and Regulation 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 MedicinalProductDefinition, 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/MedicinalProductDefinition", "$ref": "#/definitions/MedicinalProductDefinition", "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas", "definitions": { "MedicinalProductDefinition": { "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use, drug catalogs).", "properties": { "resourceType": { "description": "This is a MedicinalProductDefinition resource", "const": "MedicinalProductDefinition" }, "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.", "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 identifier 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": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "version": { "description": "A business identifier relating to a specific version of the product, this is commonly used to support revisions to an existing product.", "$ref": "#/definitions/string" }, "_version": { "description": "Extensions for version", "$ref": "Element.schema.json#/definitions/Element" }, "status": { "description": "The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "statusDate": { "description": "The date at which the given status became applicable.", "$ref": "#/definitions/dateTime" }, "_statusDate": { "description": "Extensions for statusDate", "$ref": "Element.schema.json#/definitions/Element" }, "description": { "description": "General description of this product.", "$ref": "#/definitions/markdown" }, "_description": { "description": "Extensions for description", "$ref": "Element.schema.json#/definitions/Element" }, "combinedPharmaceuticalDoseForm": { "description": "The dose form for a single part product, or combined form of a multiple part product.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "indication": { "description": "Description of indication(s) for this product, used when structured indications are not required. In cases where structured indications are required, they are captured using the ClinicalUseIssue resource. An indication is a medical situation for which using the product is appropriate.", "$ref": "#/definitions/markdown" }, "_indication": { "description": "Extensions for indication", "$ref": "Element.schema.json#/definitions/Element" }, "legalStatusOfSupply": { "description": "The legal status of supply of the medicinal product as classified by the regulator.", "$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": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "type": "array" }, "paediatricUseIndicator": { "description": "If authorised for use in children.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "classification": { "description": "Allows the product to be classified by various systems.", "items": { "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "type": "array" }, "characteristic": { "description": "Allows the key product features to be recorded, such as \"sugar free\", \"modified release\", \"parallel import\".", "items": { "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "type": "array" }, "marketingStatus": { "description": "Marketing status of the medicinal product, in contrast to marketing authorization.", "items": { "$ref": "MarketingStatus.schema.json#/definitions/MarketingStatus" }, "type": "array" }, "ingredient": { "description": "The ingredients of this medicinal product - when not detailed in other resources. This is only needed if the ingredients are not specified by the AdministrableProductDefinition or via the PackagedProductDefinition references above. In cases where those levels of detail are not used, the ingredients may be specified directly here.", "items": { "$ref": "CodeableReference.schema.json#/definitions/CodeableReference" }, "type": "array" }, "impurity": { "description": "Any component of the drug product which is not the chemical entity defined as the drug substance or an excipient in the drug product. This includes process-related impurities and contaminants, product-related impurities including degradation products.", "items": { "$ref": "Reference.schema.json#/definitions/Reference" }, "type": "array" }, "attachedDocument": { "description": "Additional information or supporting documentation about the medicinal product.", "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": "#/definitions/MedicinalProductDefinition_Contact" }, "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/MedicinalProductDefinition_Name" }, "type": "array" }, "crossReference": { "description": "Reference to another product, e.g. for linking authorised to investigational product.", "items": { "$ref": "#/definitions/MedicinalProductDefinition_CrossReference" }, "type": "array" }, "operation": { "description": "A manufacturing or administrative process or step associated with (or performed on) the medicinal product.", "items": { "$ref": "#/definitions/MedicinalProductDefinition_Operation" }, "type": "array" }, "package": { "description": "Package representation for the product.", "items": { "$ref": "#/definitions/MedicinalProductDefinition_Package" }, "type": "array" }, "administrableProduct": { "description": "The product in its final form, mixed from its components if necessary, and ready to be administered to the patient. Also known as the \u0027Pharmaceutical Product\u0027. Can repeat, for cases where the product has components that result in more than one administrable item.", "items": { "$ref": "#/definitions/MedicinalProductDefinition_AdministrableProduct" }, "type": "array" } }, "additionalProperties": false, "required": [ "name", "resourceType" ] }, "MedicinalProductDefinition_Contact": { "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use, drug catalogs).", "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": "Allows the contact to be classified, for example QPPV, Pharmacovigilance Enquiry Information.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "contact": { "description": "A product specific contact, person (in a role), or an organization.", "$ref": "Reference.schema.json#/definitions/Reference" } }, "additionalProperties": false, "required": [ "contact" ] }, "MedicinalProductDefinition_Name": { "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use, drug catalogs).", "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" }, "productName": { "description": "The full product name.", "$ref": "#/definitions/string" }, "_productName": { "description": "Extensions for productName", "$ref": "Element.schema.json#/definitions/Element" }, "type": { "description": "Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "namePart": { "description": "Coding words or phrases of the name.", "items": { "$ref": "#/definitions/MedicinalProductDefinition_NamePart" }, "type": "array" }, "countryLanguage": { "description": "Country where the name applies.", "items": { "$ref": "#/definitions/MedicinalProductDefinition_CountryLanguage" }, "type": "array" } }, "additionalProperties": false }, "MedicinalProductDefinition_NamePart": { "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use, drug catalogs).", "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" }, "part": { "description": "A fragment of a product name.", "$ref": "#/definitions/string" }, "_part": { "description": "Extensions for part", "$ref": "Element.schema.json#/definitions/Element" }, "type": { "description": "Identifying type for this part of the name (e.g. strength part).", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" } }, "additionalProperties": false, "required": [ "type" ] }, "MedicinalProductDefinition_CountryLanguage": { "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use, drug catalogs).", "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" }, "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" ] }, "MedicinalProductDefinition_CrossReference": { "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use, drug catalogs).", "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" }, "product": { "description": "Reference to another product, e.g. for linking authorised to investigational product.", "$ref": "CodeableReference.schema.json#/definitions/CodeableReference" }, "type": { "description": "The type of relationship, for instance branded to generic, product to development product (investigational), parallel import version.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" } }, "additionalProperties": false, "required": [ "product" ] }, "MedicinalProductDefinition_Operation": { "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use, drug catalogs).", "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": "The type of manufacturing operation e.g. manufacturing itself, re-packaging. This may be a subtype of some other wider scope of authorized operation, referenced by the authorization attribute.", "$ref": "CodeableReference.schema.json#/definitions/CodeableReference" }, "effectiveDate": { "description": "Date range of applicability.", "$ref": "Period.schema.json#/definitions/Period" }, "organization": { "description": "The organization or establishment responsible for (or associated with) the particular process or step, examples include the manufacturer, importer, agent.", "items": { "$ref": "Reference.schema.json#/definitions/Reference" }, "type": "array" }, "authorization": { "description": "An authorization for this process, either as a logical reference, holding just an identifier, or a full reference to a resource that captures the details. The authorization may possibly apply to several products or a wider scope of process of which this is a part.", "$ref": "Reference.schema.json#/definitions/Reference" }, "confidentialityIndicator": { "description": "Specifies whether this particular business or manufacturing process is considered proprietary or confidential.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" } }, "additionalProperties": false }, "MedicinalProductDefinition_Package": { "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use, drug catalogs).", "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 descriptive type for this package, such as box, carton or bottle.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "sizeQuantity": { "description": "The amount of items, or of substance, in the package.", "$ref": "Quantity.schema.json#/definitions/Quantity" }, "sizeInteger": { "description": "The amount of items, or of substance, in the package.", "pattern": "^-?([0]|([1-9][0-9]*))$", "type": "number" }, "_sizeInteger": { "description": "Extensions for sizeInteger", "$ref": "Element.schema.json#/definitions/Element" }, "package": { "description": "Full package representation for the product.", "$ref": "Reference.schema.json#/definitions/Reference" } }, "additionalProperties": false }, "MedicinalProductDefinition_AdministrableProduct": { "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use, drug catalogs).", "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" }, "route": { "description": "The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route.", "items": { "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "type": "array" }, "product": { "description": "Full description of the administrable product.", "$ref": "Reference.schema.json#/definitions/Reference" } }, "additionalProperties": false } } }