9.11.12 JSON Schema for RiskAssessment

Clinical Decision Support Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Device, Patient, Practitioner

This is a representation of the json schema for RiskAssessment, 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/RiskAssessment",
  "$ref": "#/definitions/RiskAssessment",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "RiskAssessment": {
      "description": "An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.",
      "properties": {
        "resourceType": {
          "description": "This is a RiskAssessment resource",
          "const": "RiskAssessment"
        },
        "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 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 assigned to the risk assessment.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "basedOn": {
          "description": "A reference to the request that is fulfilled by this risk assessment.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "parent": {
          "description": "A reference to a resource that this risk assessment is part of, such as a Procedure.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "status": {
          "description": "The status of the RiskAssessment, using the same statuses as an Observation.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "method": {
          "description": "The algorithm, process or mechanism used to evaluate the risk.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "code": {
          "description": "The type of the risk assessment performed.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "subject": {
          "description": "The patient or group the risk assessment applies to.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "encounter": {
          "description": "The encounter where the assessment was performed.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "occurrenceDateTime": {
          "description": "The date (and possibly time) the risk assessment was performed.",
          "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?$",
          "type": "string"
        },
        "_occurrenceDateTime": {
          "description": "Extensions for occurrenceDateTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "occurrencePeriod": {
          "description": "The date (and possibly time) the risk assessment was performed.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "condition": {
          "description": "For assessments or prognosis specific to a particular condition, indicates the condition being assessed.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "performer": {
          "description": "The provider, patient, related person, or software application that performed the assessment.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "reason": {
          "description": "The reason the risk assessment was performed.",
          "items": {
            "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
          },
          "type": "array"
        },
        "basis": {
          "description": "Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "prediction": {
          "description": "Describes the expected outcome for the subject.",
          "items": {
            "$ref": "#/definitions/RiskAssessment_Prediction"
          },
          "type": "array"
        },
        "mitigation": {
          "description": "A description of the steps that might be taken to reduce the identified risk(s).",
          "$ref": "#/definitions/string"
        },
        "_mitigation": {
          "description": "Extensions for mitigation",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "note": {
          "description": "Additional comments about the risk assessment.",
          "items": {
            "$ref": "Annotation.schema.json#/definitions/Annotation"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "subject",
        "resourceType"
      ]
    },
    "RiskAssessment_Prediction": {
      "description": "An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.",
      "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"
        },
        "outcome": {
          "description": "One of the potential outcomes for the patient (e.g. remission, death,  a particular condition).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "probabilityDecimal": {
          "description": "Indicates how likely the outcome is (in the specified timeframe).",
          "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$",
          "type": "number"
        },
        "_probabilityDecimal": {
          "description": "Extensions for probabilityDecimal",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "probabilityRange": {
          "description": "Indicates how likely the outcome is (in the specified timeframe).",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "qualitativeRisk": {
          "description": "Indicates how likely the outcome is (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, or high).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "relativeRisk": {
          "description": "Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general.  (Numbers greater than 1 \u003d higher risk than the population, numbers less than 1 \u003d lower risk.).",
          "$ref": "#/definitions/decimal"
        },
        "_relativeRisk": {
          "description": "Extensions for relativeRisk",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "whenPeriod": {
          "description": "Indicates the period of time or age range of the subject to which the specified probability applies.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "whenRange": {
          "description": "Indicates the period of time or age range of the subject to which the specified probability applies.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "rationale": {
          "description": "Additional information explaining the basis for the prediction.",
          "$ref": "#/definitions/string"
        },
        "_rationale": {
          "description": "Extensions for rationale",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  }
}