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
Patient Care 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 ConditionDefinition, 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/ConditionDefinition", "$ref": "#/definitions/ConditionDefinition", "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas", "definitions": { "ConditionDefinition": { "description": "A definition of a condition and information relevant to managing it.", "properties": { "resourceType": { "description": "This is a ConditionDefinition resource", "const": "ConditionDefinition" }, "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" }, "url": { "description": "An absolute URI that is used to identify this condition definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this condition definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the condition definition is stored on different servers.", "$ref": "#/definitions/uri" }, "_url": { "description": "Extensions for url", "$ref": "Element.schema.json#/definitions/Element" }, "identifier": { "description": "A formal identifier that is used to identify this condition definition when it is represented in other formats, or referenced in a specification, model, design or an instance.", "items": { "$ref": "Identifier.schema.json#/definitions/Identifier" }, "type": "array" }, "version": { "description": "The identifier that is used to identify this version of the condition definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the condition definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", "$ref": "#/definitions/string" }, "_version": { "description": "Extensions for version", "$ref": "Element.schema.json#/definitions/Element" }, "name": { "description": "A natural language name identifying the condition definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", "$ref": "#/definitions/string" }, "_name": { "description": "Extensions for name", "$ref": "Element.schema.json#/definitions/Element" }, "title": { "description": "A short, descriptive, user-friendly title for the condition definition.", "$ref": "#/definitions/string" }, "_title": { "description": "Extensions for title", "$ref": "Element.schema.json#/definitions/Element" }, "status": { "description": "The status of this condition definition. Enables tracking the life-cycle of the content.", "$ref": "#/definitions/code" }, "_status": { "description": "Extensions for status", "$ref": "Element.schema.json#/definitions/Element" }, "experimental": { "description": "A Boolean value to indicate that this condition definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", "$ref": "#/definitions/boolean" }, "_experimental": { "description": "Extensions for experimental", "$ref": "Element.schema.json#/definitions/Element" }, "date": { "description": "The date (and optionally time) when the condition definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the condition definition changes.", "$ref": "#/definitions/dateTime" }, "_date": { "description": "Extensions for date", "$ref": "Element.schema.json#/definitions/Element" }, "publisher": { "description": "The name of the organization or individual that published the condition definition.", "$ref": "#/definitions/string" }, "_publisher": { "description": "Extensions for publisher", "$ref": "Element.schema.json#/definitions/Element" }, "contact": { "description": "Contact details to assist a user in finding and communicating with the publisher.", "items": { "$ref": "ContactDetail.schema.json#/definitions/ContactDetail" }, "type": "array" }, "description": { "description": "A free text natural language description of the condition definition from a consumer\u0027s perspective.", "$ref": "#/definitions/markdown" }, "_description": { "description": "Extensions for description", "$ref": "Element.schema.json#/definitions/Element" }, "useContext": { "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate condition definition instances.", "items": { "$ref": "UsageContext.schema.json#/definitions/UsageContext" }, "type": "array" }, "jurisdiction": { "description": "A legal or geographic region in which the condition definition is intended to be used.", "items": { "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "type": "array" }, "purpose": { "description": "Explanation of why this {{title}} is needed and why it has been designed as it has.", "$ref": "#/definitions/markdown" }, "_purpose": { "description": "Extensions for purpose", "$ref": "Element.schema.json#/definitions/Element" }, "copyright": { "description": "A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.", "$ref": "#/definitions/markdown" }, "_copyright": { "description": "Extensions for copyright", "$ref": "Element.schema.json#/definitions/Element" }, "approvalDate": { "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", "$ref": "#/definitions/date" }, "_approvalDate": { "description": "Extensions for approvalDate", "$ref": "Element.schema.json#/definitions/Element" }, "lastReviewDate": { "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", "$ref": "#/definitions/date" }, "_lastReviewDate": { "description": "Extensions for lastReviewDate", "$ref": "Element.schema.json#/definitions/Element" }, "effectivePeriod": { "description": "The period during which the {{title}} content was or is planned to be in active use.", "$ref": "Period.schema.json#/definitions/Period" }, "topic": { "description": "Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.", "items": { "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "type": "array" }, "author": { "description": "An individiual or organization primarily involved in the creation and maintenance of the {{title}}.", "items": { "$ref": "ContactDetail.schema.json#/definitions/ContactDetail" }, "type": "array" }, "editor": { "description": "An individual or organization primarily responsible for internal coherence of the {{title}}.", "items": { "$ref": "ContactDetail.schema.json#/definitions/ContactDetail" }, "type": "array" }, "reviewer": { "description": "An individual or organization primarily responsible for review of some aspect of the {{title}}.", "items": { "$ref": "ContactDetail.schema.json#/definitions/ContactDetail" }, "type": "array" }, "endorser": { "description": "An individual or organization responsible for officially endorsing the {{title}} for use in some setting.", "items": { "$ref": "ContactDetail.schema.json#/definitions/ContactDetail" }, "type": "array" }, "relatedArtifact": { "description": "Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.", "items": { "$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact" }, "type": "array" }, "subtitle": { "description": "An explanatory or alternate title for the event definition giving additional information about its content.", "$ref": "#/definitions/string" }, "_subtitle": { "description": "Extensions for subtitle", "$ref": "Element.schema.json#/definitions/Element" }, "code": { "description": "Identification of the condition, problem or diagnosis.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "severity": { "description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "bodySite": { "description": "The anatomical location where this condition manifests itself.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "stage": { "description": "Clinical stage or grade of a condition. May include formal severity assessments.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "hasSeverity": { "description": "Whether Severity is appropriate to collect for this condition.", "$ref": "#/definitions/boolean" }, "_hasSeverity": { "description": "Extensions for hasSeverity", "$ref": "Element.schema.json#/definitions/Element" }, "hasBodySite": { "description": "Whether bodySite is appropriate to collect for this condition.", "$ref": "#/definitions/boolean" }, "_hasBodySite": { "description": "Extensions for hasBodySite", "$ref": "Element.schema.json#/definitions/Element" }, "hasStage": { "description": "Whether stage is appropriate to collect for this condition.", "$ref": "#/definitions/boolean" }, "_hasStage": { "description": "Extensions for hasStage", "$ref": "Element.schema.json#/definitions/Element" }, "definition": { "description": "Formal definitions of the condition. These may be references to ontologies, published clinical protocols or research papers.", "items": { "$ref": "#/definitions/uri" }, "type": "array" }, "_definition": { "description": "Extensions for definition", "items": { "$ref": "Element.schema.json#/definitions/Element" }, "type": "array" }, "observation": { "description": "Observations particularly relevant to this condition.", "items": { "$ref": "#/definitions/ConditionDefinition_Observation" }, "type": "array" }, "medication": { "description": "Medications particularly relevant for this condition.", "items": { "$ref": "#/definitions/ConditionDefinition_Medication" }, "type": "array" }, "precondition": { "description": "An observation that suggests that this condition applies.", "items": { "$ref": "#/definitions/ConditionDefinition_Precondition" }, "type": "array" }, "team": { "description": "Appropriate team for this condition.", "items": { "$ref": "Reference.schema.json#/definitions/Reference" }, "type": "array" }, "questionnaire": { "description": "Questionnaire for this condition.", "items": { "$ref": "#/definitions/ConditionDefinition_Questionnaire" }, "type": "array" }, "plan": { "description": "Plan that is appropriate.", "items": { "$ref": "#/definitions/ConditionDefinition_Plan" }, "type": "array" } }, "additionalProperties": false, "required": [ "code", "resourceType" ] }, "ConditionDefinition_Observation": { "description": "A definition of a condition and information relevant to managing it.", "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" }, "category": { "description": "Category that is relevant.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "code": { "description": "Code for relevant Observation.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" } }, "additionalProperties": false }, "ConditionDefinition_Medication": { "description": "A definition of a condition and information relevant to managing it.", "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" }, "category": { "description": "Category that is relevant.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "code": { "description": "Code for relevant Medication.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" } }, "additionalProperties": false }, "ConditionDefinition_Precondition": { "description": "A definition of a condition and information relevant to managing it.", "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": "Kind of pre-condition.", "$ref": "#/definitions/code" }, "_type": { "description": "Extensions for type", "$ref": "Element.schema.json#/definitions/Element" }, "code": { "description": "Code for relevant Observation.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "valueCodeableConcept": { "description": "Value of Observation.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "valueQuantity": { "description": "Value of Observation.", "$ref": "Quantity.schema.json#/definitions/Quantity" } }, "additionalProperties": false, "required": [ "code" ] }, "ConditionDefinition_Questionnaire": { "description": "A definition of a condition and information relevant to managing it.", "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" }, "purpose": { "description": "Use of the questionnaire.", "$ref": "#/definitions/code" }, "_purpose": { "description": "Extensions for purpose", "$ref": "Element.schema.json#/definitions/Element" }, "reference": { "description": "Specific Questionnaire.", "$ref": "Reference.schema.json#/definitions/Reference" } }, "additionalProperties": false, "required": [ "reference" ] }, "ConditionDefinition_Plan": { "description": "A definition of a condition and information relevant to managing it.", "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" }, "role": { "description": "Use for the plan.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "reference": { "description": "The actual plan.", "$ref": "Reference.schema.json#/definitions/Reference" } }, "additionalProperties": false, "required": [ "reference" ] } } }