9.6.12 JSON Schema for Goal

Patient Care Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Patient

This is a representation of the json schema for Goal, 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/Goal",
  "$ref": "#/definitions/Goal",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "Goal": {
      "description": "Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.",
      "properties": {
        "resourceType": {
          "description": "This is a Goal resource",
          "const": "Goal"
        },
        "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 identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "lifecycleStatus": {
          "description": "The state of the goal throughout its lifecycle.",
          "$ref": "#/definitions/code"
        },
        "_lifecycleStatus": {
          "description": "Extensions for lifecycleStatus",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "achievementStatus": {
          "description": "Describes the progression, or lack thereof, towards the goal against the target.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "category": {
          "description": "Indicates a category the goal falls within.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "continuous": {
          "description": "After meeting the goal, ongoing activity is needed to sustain the goal objective.",
          "$ref": "#/definitions/boolean"
        },
        "_continuous": {
          "description": "Extensions for continuous",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "priority": {
          "description": "Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "description": {
          "description": "Human-readable and/or coded description of a specific desired objective of care, such as \"control blood pressure\" or \"negotiate an obstacle course\" or \"dance with child at wedding\".",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "subject": {
          "description": "Identifies the patient, group or organization for whom the goal is being established.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "startDate": {
          "description": "The date or event after which the goal should begin being pursued.",
          "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]))?)?$",
          "type": "string"
        },
        "_startDate": {
          "description": "Extensions for startDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "startCodeableConcept": {
          "description": "The date or event after which the goal should begin being pursued.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "target": {
          "description": "Indicates what should be done by when.",
          "items": {
            "$ref": "#/definitions/Goal_Target"
          },
          "type": "array"
        },
        "statusDate": {
          "description": "Identifies when the current status.  I.e. When initially created, when achieved, when cancelled, etc.",
          "$ref": "#/definitions/date"
        },
        "_statusDate": {
          "description": "Extensions for statusDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "statusReason": {
          "description": "Captures the reason for the current status.",
          "$ref": "#/definitions/string"
        },
        "_statusReason": {
          "description": "Extensions for statusReason",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "source": {
          "description": "Indicates whose goal this is - patient goal, practitioner goal, etc.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "addresses": {
          "description": "The identified conditions and other health record elements that are intended to be addressed by the goal.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "note": {
          "description": "Any comments related to the goal.",
          "items": {
            "$ref": "Annotation.schema.json#/definitions/Annotation"
          },
          "type": "array"
        },
        "outcome": {
          "description": "Identifies the change (or lack of change) at the point when the status of the goal is assessed.",
          "items": {
            "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "subject",
        "description",
        "resourceType"
      ]
    },
    "Goal_Target": {
      "description": "Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.",
      "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"
        },
        "measure": {
          "description": "The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "detailQuantity": {
          "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "detailRange": {
          "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "detailCodeableConcept": {
          "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "detailString": {
          "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.",
          "pattern": "^[ \\r\\n\\t\\S]+$",
          "type": "string"
        },
        "_detailString": {
          "description": "Extensions for detailString",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "detailBoolean": {
          "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.",
          "pattern": "^true|false$",
          "type": "boolean"
        },
        "_detailBoolean": {
          "description": "Extensions for detailBoolean",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "detailInteger": {
          "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.",
          "pattern": "^-?([0]|([1-9][0-9]*))$",
          "type": "number"
        },
        "_detailInteger": {
          "description": "Extensions for detailInteger",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "detailRatio": {
          "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.",
          "$ref": "Ratio.schema.json#/definitions/Ratio"
        },
        "dueDate": {
          "description": "Indicates either the date or the duration after start by which the goal should be met.",
          "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]))?)?$",
          "type": "string"
        },
        "_dueDate": {
          "description": "Extensions for dueDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "dueDuration": {
          "description": "Indicates either the date or the duration after start by which the goal should be met.",
          "$ref": "Duration.schema.json#/definitions/Duration"
        }
      },
      "additionalProperties": false
    }
  }
}