12.20.11 JSON Schema for VisionPrescription

Financial Management Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Encounter, Patient, Practitioner

This is a representation of the json schema for VisionPrescription, 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/VisionPrescription",
  "$ref": "#/definitions/VisionPrescription",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "VisionPrescription": {
      "description": "An authorization for the provision of glasses and/or contact lenses to a patient.",
      "properties": {
        "resourceType": {
          "description": "This is a VisionPrescription resource",
          "const": "VisionPrescription"
        },
        "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": "A unique identifier assigned to this vision prescription.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "status": {
          "description": "The status of the resource instance.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "created": {
          "description": "The date this resource was created.",
          "$ref": "#/definitions/dateTime"
        },
        "_created": {
          "description": "Extensions for created",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "patient": {
          "description": "A resource reference to the person to whom the vision prescription applies.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "encounter": {
          "description": "A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "dateWritten": {
          "description": "The date (and perhaps time) when the prescription was written.",
          "$ref": "#/definitions/dateTime"
        },
        "_dateWritten": {
          "description": "Extensions for dateWritten",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "prescriber": {
          "description": "The healthcare professional responsible for authorizing the prescription.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "lensSpecification": {
          "description": "Contain the details of  the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.",
          "items": {
            "$ref": "#/definitions/VisionPrescription_LensSpecification"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "prescriber",
        "patient",
        "lensSpecification",
        "resourceType"
      ]
    },
    "VisionPrescription_LensSpecification": {
      "description": "An authorization for the provision of glasses and/or contact lenses to a patient.",
      "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"
        },
        "product": {
          "description": "Identifies the type of vision correction product which is required for the patient.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "eye": {
          "description": "The eye for which the lens specification applies.",
          "$ref": "#/definitions/code"
        },
        "_eye": {
          "description": "Extensions for eye",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "sphere": {
          "description": "Lens power measured in dioptres (0.25 units).",
          "$ref": "#/definitions/decimal"
        },
        "_sphere": {
          "description": "Extensions for sphere",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "cylinder": {
          "description": "Power adjustment for astigmatism measured in dioptres (0.25 units).",
          "$ref": "#/definitions/decimal"
        },
        "_cylinder": {
          "description": "Extensions for cylinder",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "axis": {
          "description": "Adjustment for astigmatism measured in integer degrees.",
          "$ref": "#/definitions/integer"
        },
        "_axis": {
          "description": "Extensions for axis",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "prism": {
          "description": "Allows for adjustment on two axis.",
          "items": {
            "$ref": "#/definitions/VisionPrescription_Prism"
          },
          "type": "array"
        },
        "add": {
          "description": "Power adjustment for multifocal lenses measured in dioptres (0.25 units).",
          "$ref": "#/definitions/decimal"
        },
        "_add": {
          "description": "Extensions for add",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "power": {
          "description": "Contact lens power measured in dioptres (0.25 units).",
          "$ref": "#/definitions/decimal"
        },
        "_power": {
          "description": "Extensions for power",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "backCurve": {
          "description": "Back curvature measured in millimetres.",
          "$ref": "#/definitions/decimal"
        },
        "_backCurve": {
          "description": "Extensions for backCurve",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "diameter": {
          "description": "Contact lens diameter measured in millimetres.",
          "$ref": "#/definitions/decimal"
        },
        "_diameter": {
          "description": "Extensions for diameter",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "duration": {
          "description": "The recommended maximum wear period for the lens.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "color": {
          "description": "Special color or pattern.",
          "$ref": "#/definitions/string"
        },
        "_color": {
          "description": "Extensions for color",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "brand": {
          "description": "Brand recommendations or restrictions.",
          "$ref": "#/definitions/string"
        },
        "_brand": {
          "description": "Extensions for brand",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "note": {
          "description": "Notes for special requirements such as coatings and lens materials.",
          "items": {
            "$ref": "Annotation.schema.json#/definitions/Annotation"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "product"
      ]
    },
    "VisionPrescription_Prism": {
      "description": "An authorization for the provision of glasses and/or contact lenses to a patient.",
      "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"
        },
        "amount": {
          "description": "Amount of prism to compensate for eye alignment in fractional units.",
          "$ref": "#/definitions/decimal"
        },
        "_amount": {
          "description": "Extensions for amount",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "base": {
          "description": "The relative base, or reference lens edge, for the prism.",
          "$ref": "#/definitions/code"
        },
        "_base": {
          "description": "Extensions for base",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    }
  }
}