Envelope

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/omnirx-org/json-schema/omnirx-org-envelope-schema.json",
  "title": "Envelope",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/omnirx-org-openapi.yml#/components/schemas/Envelope",
  "type": "object",
  "required": [
    "answer",
    "receipts",
    "as_of",
    "edition",
    "licence",
    "unknown",
    "disclaimer"
  ],
  "properties": {
    "answer": {
      "description": "The result, or null when the edition holds no answer (see unknown)."
    },
    "receipts": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "fact_id",
          "field",
          "entity"
        ],
        "properties": {
          "fact_id": {
            "type": "string"
          },
          "field": {
            "type": "string"
          },
          "entity": {
            "type": "string"
          }
        }
      }
    },
    "as_of": {
      "type": "object",
      "properties": {
        "newest_fact_retrieved_at": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "edition": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "string",
            "null"
          ]
        },
        "merkleRoot": {
          "type": [
            "string",
            "null"
          ]
        },
        "factCount": {
          "type": "integer"
        },
        "manifestPresent": {
          "type": "boolean"
        }
      }
    },
    "licence": {
      "type": "object",
      "properties": {
        "classes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "note": {
          "type": "string"
        }
      }
    },
    "unknown": {
      "type": "array",
      "description": "What the edition cannot say. Never fill these gaps from memory.",
      "items": {
        "type": "object",
        "required": [
          "code",
          "field",
          "reason"
        ],
        "properties": {
          "code": {
            "enum": [
              "NO_DATA",
              "STALE_PERIOD",
              "NOT_PROVIDED",
              "OUT_OF_SCOPE_CLINICAL",
              "AMBIGUOUS"
            ]
          },
          "field": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          }
        }
      }
    },
    "disclaimer": {
      "type": "string"
    }
  }
}