Release 4B Ballot #1
This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| 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 ClinicalUseIssue, 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/ClinicalUseIssue",
"$ref": "#/definitions/ClinicalUseIssue",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"ClinicalUseIssue": {
"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 ClinicalUseIssue resource",
"const": "ClinicalUseIssue"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "string.schema.json#/definitions/string"
},
"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 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 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\".",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"subject": {
"description": "The medication or procedure 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"
},
"description": {
"description": "General description of an effect (particularly for a general warning, rather than any of the more specific types such as indication) for when a distinct coded or textual description is not appropriate using Indication.diseaseSymptomProcedure.text, Contraindication.diseaseSymptomProcedure.text etc. For example \"May affect ability to drive\".",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"contraindication": {
"description": "Specifics for when this is a contraindication.",
"$ref": "#/definitions/ClinicalUseIssue_Contraindication"
},
"indication": {
"description": "Specifics for when this is an indication.",
"$ref": "#/definitions/ClinicalUseIssue_Indication"
},
"interaction": {
"description": "Specifics for when this is an interaction.",
"$ref": "#/definitions/ClinicalUseIssue_Interaction"
},
"population": {
"description": "The population group to which this applies.",
"items": {
"$ref": "Population.schema.json#/definitions/Population"
},
"type": "array"
},
"undesirableEffect": {
"description": "Describe the undesirable effects of the medicinal product.",
"$ref": "#/definitions/ClinicalUseIssue_UndesirableEffect"
}
},
"additionalProperties": false,
"required": [
"resourceType"
]
},
"ClinicalUseIssue_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 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"
},
"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.",
"$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"
},
"otherTherapy": {
"description": "Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.",
"items": {
"$ref": "#/definitions/ClinicalUseIssue_OtherTherapy"
},
"type": "array"
}
},
"additionalProperties": false
},
"ClinicalUseIssue_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 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"
},
"relationshipType": {
"description": "The type of relationship between the medicinal product indication or contraindication and another therapy.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"therapy[x]": {
"description": "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
}
},
"additionalProperties": false,
"required": [
"relationshipType",
"therapy[x]"
]
},
"ClinicalUseIssue_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 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"
},
"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.",
"$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"
},
"duration": {
"description": "Timing or duration information.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"undesirableEffect": {
"description": "The specific undesirable effects of the medicinal product.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"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/ClinicalUseIssue_OtherTherapy"
},
"type": "array"
}
},
"additionalProperties": false
},
"ClinicalUseIssue_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 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"
},
"interactant": {
"description": "The specific medication, food, substance or laboratory test that interacts.",
"items": {
"$ref": "#/definitions/ClinicalUseIssue_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.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"additionalProperties": false
},
"ClinicalUseIssue_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 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"
},
"itemReference": {
"description": "The specific medication, food or laboratory test that interacts.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"itemCodeableConcept": {
"description": "The specific medication, food or laboratory test that interacts.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"additionalProperties": false
},
"ClinicalUseIssue_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 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"
},
"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"
}
},
"additionalProperties": false
}
}
}
FHIR ®© HL7.org 2011+. FHIR R4B Ballot #1 hl7.fhir.core#4.1.0 generated on Thu, Mar 11, 2021 17:09+1100.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change