{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/elation-health/main/json-schema/elation-health-patched-vitals-collection-schema.json",
  "title": "PatchedVitalsCollection",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/elation-health-vitals-api-openapi.yml#/components/schemas/PatchedVitalsCollection",
  "properties": {
    "bmi": {
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "bmi_percentile": {
      "description": "The BMI percentile of the patient. Optional. Will be automatically calculated from height and weight otherwise.",
      "readOnly": true,
      "type": [
        "integer",
        "null"
      ]
    },
    "bp": {
      "description": "The blood pressure of the patient. Will allow multiple items in array.",
      "items": {
        "$ref": "#/$defs/VitalBP"
      },
      "type": "array"
    },
    "chart_date": {
      "format": "date-time",
      "type": "string"
    },
    "created_date": {
      "format": "date-time",
      "readOnly": true,
      "type": [
        "string",
        "null"
      ]
    },
    "custom_observations": {
      "additionalProperties": {
        "properties": {
          "label": {
            "type": "string"
          },
          "note": {
            "type": [
              "string",
              "null"
            ]
          },
          "units": {
            "type": [
              "string",
              "null"
            ]
          },
          "value": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "object"
    },
    "deleted_date": {
      "format": "date-time",
      "readOnly": true,
      "type": [
        "string",
        "null"
      ]
    },
    "document_date": {
      "format": "date-time",
      "type": "string"
    },
    "hc": {
      "description": "The head circumference of the patient. Will only allow array of one.",
      "items": {
        "$ref": "#/$defs/VitalHC"
      },
      "type": "array"
    },
    "height": {
      "description": "The height of the patient. Will only allow array of one.",
      "items": {
        "$ref": "#/$defs/VitalHeight"
      },
      "type": "array"
    },
    "hr": {
      "description": "The heart rate of the patient. Will only allow array of one.",
      "items": {
        "$ref": "#/$defs/VitalHR"
      },
      "type": "array"
    },
    "id": {
      "readOnly": true,
      "type": "integer"
    },
    "length_for_weight_percentile": {
      "description": "The length for weight percentile for the patient.",
      "format": "double",
      "readOnly": true,
      "type": [
        "number",
        "null"
      ]
    },
    "non_visit_note": {
      "description": "The non-visit note that the vital belongs to. Will only allow unsigned non-visit notes.",
      "format": "int64",
      "type": [
        "integer",
        "null"
      ]
    },
    "oxygen": {
      "description": "The oxygen saturation of the patient. Will only allow array of one.",
      "items": {
        "$ref": "#/$defs/VitalOxygen"
      },
      "type": "array"
    },
    "pain": {
      "description": "The pain of the patient. Will only allow array of one.",
      "items": {
        "$ref": "#/$defs/VitalPain"
      },
      "type": "array"
    },
    "patient": {
      "format": "int64",
      "type": "integer"
    },
    "practice": {
      "format": "int64",
      "type": "integer"
    },
    "rr": {
      "description": "The respiratory rate of the patient. Will only allow array of one.",
      "items": {
        "$ref": "#/$defs/VitalRR"
      },
      "type": "array"
    },
    "signed_by": {
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "signed_date": {
      "format": "date-time",
      "readOnly": true,
      "type": [
        "string",
        "null"
      ]
    },
    "temperature": {
      "description": "The temperature of the patient. Will only allow array of one.",
      "items": {
        "$ref": "#/$defs/VitalTemperature"
      },
      "type": "array"
    },
    "visit_note": {
      "description": "The visit note that the vital belongs to. Will only allow unsigned visit notes.",
      "format": "int64",
      "type": [
        "integer",
        "null"
      ]
    },
    "weight": {
      "description": "The weight of the patient. Will only allow array of one.",
      "items": {
        "$ref": "#/$defs/VitalWeight"
      },
      "type": "array"
    }
  },
  "type": "object",
  "$defs": {
    "VitalBP": {
      "properties": {
        "diastolic": {
          "type": [
            "string",
            "null"
          ]
        },
        "note": {
          "type": [
            "string",
            "null"
          ]
        },
        "systolic": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "VitalHC": {
      "properties": {
        "note": {
          "type": [
            "string",
            "null"
          ]
        },
        "percentile": {
          "readOnly": true,
          "type": [
            "integer",
            "null"
          ]
        },
        "units": {
          "allOf": [
            {
              "$ref": "#/$defs/VitalHCUnitsEnum"
            }
          ],
          "readOnly": true
        },
        "value": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "VitalHCUnitsEnum": {
      "enum": [
        "cm"
      ],
      "type": "string"
    },
    "VitalHR": {
      "properties": {
        "note": {
          "type": [
            "string",
            "null"
          ]
        },
        "units": {
          "allOf": [
            {
              "$ref": "#/$defs/VitalHRUnits"
            }
          ],
          "readOnly": true
        },
        "value": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "VitalHRUnits": {
      "enum": [
        "bpm"
      ],
      "type": "string"
    },
    "VitalHeight": {
      "properties": {
        "note": {
          "type": [
            "string",
            "null"
          ]
        },
        "units": {
          "allOf": [
            {
              "$ref": "#/$defs/VitalHeightUnitsEnum"
            }
          ],
          "readOnly": true
        },
        "value": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "VitalHeightUnitsEnum": {
      "enum": [
        "inches"
      ],
      "type": "string"
    },
    "VitalOxygen": {
      "properties": {
        "note": {
          "type": [
            "string",
            "null"
          ]
        },
        "units": {
          "allOf": [
            {
              "$ref": "#/$defs/VitalOxygenUnitsEnum"
            }
          ],
          "readOnly": true
        },
        "value": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "VitalOxygenUnitsEnum": {
      "enum": [
        "%"
      ],
      "type": "string"
    },
    "VitalPain": {
      "properties": {
        "note": {
          "type": [
            "string",
            "null"
          ]
        },
        "value": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "VitalRR": {
      "properties": {
        "note": {
          "type": [
            "string",
            "null"
          ]
        },
        "units": {
          "allOf": [
            {
              "$ref": "#/$defs/VitalHRUnits"
            }
          ],
          "readOnly": true
        },
        "value": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "VitalTemperature": {
      "properties": {
        "note": {
          "type": [
            "string",
            "null"
          ]
        },
        "units": {
          "allOf": [
            {
              "$ref": "#/$defs/VitalTemperatureUnitsEnum"
            }
          ],
          "readOnly": true
        },
        "value": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "VitalTemperatureUnitsEnum": {
      "enum": [
        "celsius",
        "fahrenheit"
      ],
      "type": "string"
    },
    "VitalWeight": {
      "properties": {
        "note": {
          "type": [
            "string",
            "null"
          ]
        },
        "units": {
          "allOf": [
            {
              "$ref": "#/$defs/VitalWeightUnitsEnum"
            }
          ],
          "readOnly": true
        },
        "value": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "VitalWeightUnitsEnum": {
      "enum": [
        "lbs"
      ],
      "type": "string"
    }
  }
}