Release 5
This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. 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: No defined compartments |
This is a representation of the json schema for ClinicalUseDefinition, which is just a part of the full JSON Schema.
Medication Definition
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/ClinicalUseDefinition",
"$ref": "#/definitions/ClinicalUseDefinition",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"ClinicalUseDefinition": {
"description": "A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.",
"properties": {
"resourceType": {
"description": "This is a ClinicalUseDefinition resource",
"const": "ClinicalUseDefinition"
},
"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 managable, 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 managable, 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 issue.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"type": {
"description": "indication | contraindication | interaction | undesirable-effect | warning.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"category": {
"description": "A categorisation of the issue, primarily for dividing warnings into subject heading areas such as \"Pregnancy and Lactation\", \"Overdose\", \"Effects on Ability to Drive and Use Machines\".",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"subject": {
"description": "The medication, product, substance, device, procedure etc. for which this is an indication.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"status": {
"description": "Whether this is a current issue or one that has been retired etc.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"contraindication": {
"description": "Specifics for when this is a contraindication.",
"$ref": "#/definitions/ClinicalUseDefinition_Contraindication"
},
"indication": {
"description": "Specifics for when this is an indication.",
"$ref": "#/definitions/ClinicalUseDefinition_Indication"
},
"interaction": {
"description": "Specifics for when this is an interaction.",
"$ref": "#/definitions/ClinicalUseDefinition_Interaction"
},
"population": {
"description": "The population group to which this applies.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"library": {
"description": "Logic used by the clinical use definition.",
"items": {
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": "array"
},
"undesirableEffect": {
"description": "Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.",
"$ref": "#/definitions/ClinicalUseDefinition_UndesirableEffect"
},
"warning": {
"description": "A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example \u0027Do not operate heavy machinery\u0027, \u0027May cause drowsiness\u0027, or \u0027Get medical advice/attention if you feel unwell\u0027.",
"$ref": "#/definitions/ClinicalUseDefinition_Warning"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"ClinicalUseDefinition_Contraindication": {
"description": "A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.",
"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 managable, 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 managable, 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 situation that is being documented as contraindicating against this item.",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"diseaseStatus": {
"description": "The status of the disease or symptom for the contraindication, for example \"chronic\" or \"metastatic\".",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"comorbidity": {
"description": "A comorbidity (concurrent condition) or coinfection.",
"items": {
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"type": "array"
},
"indication": {
"description": "The indication which this is a contraidication for.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"applicability": {
"description": "An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements.",
"$ref": "Expression.schema.json#/definitions/Expression"
},
"otherTherapy": {
"description": "Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.",
"items": {
"$ref": "#/definitions/ClinicalUseDefinition_OtherTherapy"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ClinicalUseDefinition_OtherTherapy": {
"description": "A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.",
"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 managable, 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 managable, 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"
},
"relationshipType": {
"description": "The type of relationship between the medicinal product indication or contraindication and another therapy.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"treatment": {
"description": "Reference to a specific medication (active substance, medicinal product or class of products, biological, food etc.) as part of an indication or contraindication.",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"treatment",
"relationshipType"
]
},
"ClinicalUseDefinition_Indication": {
"description": "A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.",
"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 managable, 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 managable, 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 situation that is being documented as an indicaton for this item.",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"diseaseStatus": {
"description": "The status of the disease or symptom for the indication, for example \"chronic\" or \"metastatic\".",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"comorbidity": {
"description": "A comorbidity (concurrent condition) or coinfection as part of the indication.",
"items": {
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"type": "array"
},
"intendedEffect": {
"description": "The intended effect, aim or strategy to be achieved.",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"durationRange": {
"description": "Timing or duration information, that may be associated with use with the indicated condition e.g. Adult patients suffering from myocardial infarction (from a few days until less than 35 days), ischaemic stroke (from 7 days until less than 6 months).",
"$ref": "Range.schema.json#/definitions/Range"
},
"durationString": {
"description": "Timing or duration information, that may be associated with use with the indicated condition e.g. Adult patients suffering from myocardial infarction (from a few days until less than 35 days), ischaemic stroke (from 7 days until less than 6 months).",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_durationString": {
"description": "Extensions for durationString",
"$ref": "Element.schema.json#/definitions/Element"
},
"undesirableEffect": {
"description": "An unwanted side effect or negative outcome that may happen if you use the drug (or other subject of this resource) for this indication.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"applicability": {
"description": "An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements.",
"$ref": "Expression.schema.json#/definitions/Expression"
},
"otherTherapy": {
"description": "Information about the use of the medicinal product in relation to other therapies described as part of the indication.",
"items": {
"$ref": "#/definitions/ClinicalUseDefinition_OtherTherapy"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ClinicalUseDefinition_Interaction": {
"description": "A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.",
"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 managable, 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 managable, 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"
},
"interactant": {
"description": "The specific medication, product, food, substance etc. or laboratory test that interacts.",
"items": {
"$ref": "#/definitions/ClinicalUseDefinition_Interactant"
},
"type": "array"
},
"type": {
"description": "The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"effect": {
"description": "The effect of the interaction, for example \"reduced gastric absorption of primary medication\".",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"incidence": {
"description": "The incidence of the interaction, e.g. theoretical, observed.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"management": {
"description": "Actions for managing the interaction.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ClinicalUseDefinition_Interactant": {
"description": "A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.",
"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 managable, 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 managable, 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"
},
"itemReference": {
"description": "The specific medication, product, food, substance etc. or laboratory test that interacts.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"itemCodeableConcept": {
"description": "The specific medication, product, food, substance etc. or laboratory test that interacts.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false
},
"ClinicalUseDefinition_UndesirableEffect": {
"description": "A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.",
"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 managable, 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 managable, 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 situation in which the undesirable effect may manifest.",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"classification": {
"description": "High level classification of the effect.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"frequencyOfOccurrence": {
"description": "How often the effect is seen.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false
},
"ClinicalUseDefinition_Warning": {
"description": "A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.",
"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 managable, 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 managable, 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"
},
"description": {
"description": "A textual definition of this warning, with formatting.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"code": {
"description": "A coded or unformatted textual definition of this warning.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"type": "object",
"additionalProperties": false
}
}
}
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:24+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change