PaginatedPulmonaryOrderList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/elation-health/main/json-schema/elation-health-paginated-pulmonary-order-list-schema.json",
  "title": "PaginatedPulmonaryOrderList",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/elation-health-pulmonary-orders-api-openapi.yml#/components/schemas/PaginatedPulmonaryOrderList",
  "properties": {
    "count": {
      "type": "integer"
    },
    "next": {
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "results": {
      "items": {
        "$ref": "#/$defs/PulmonaryOrder"
      },
      "type": "array"
    }
  },
  "required": [
    "results"
  ],
  "type": "object",
  "$defs": {
    "DocumentResolutionState": {
      "properties": {
        "created_date": {
          "description": "The datetime when this resolution state was created.",
          "format": "date-time",
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "deleted_date": {
          "description": "The datetime when this resolution was deleted. Should never be null because we're providing the most updated resolution.",
          "format": "date-time",
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "document": {
          "description": "Will be the same as the id of the lab order.",
          "format": "int64",
          "readOnly": true,
          "type": "integer"
        },
        "id": {
          "description": "Internal id to represent the resolution state.",
          "readOnly": true,
          "type": "integer"
        },
        "note": {
          "description": "Any note that was added to represent why an order was cancelled.",
          "maxLength": 200,
          "type": [
            "string",
            "null"
          ]
        },
        "resolving_document": {
          "description": "If the order is fulfilled will indicate the document referenced. For lab orders will usually be a report. Must be an integer ID or null.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        },
        "state": {
          "allOf": [
            {
              "$ref": "#/$defs/StateEnum"
            }
          ],
          "description": "The resolution state of the order.\n\n* `outstanding` - Outstanding\n* `fulfilled` - Fulfilled\n* `cancelled` - Cancelled"
        }
      },
      "required": [
        "state"
      ],
      "type": "object"
    },
    "ICD10Code": {
      "properties": {
        "code": {
          "maxLength": 50,
          "type": "string"
        },
        "description": {
          "maxLength": 500,
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "code"
      ],
      "type": "object"
    },
    "PulmonaryOrder": {
      "properties": {
        "allergies": {
          "description": "Any allergies the patient has.",
          "type": [
            "string",
            "null"
          ]
        },
        "ancillary_company": {
          "format": "int64",
          "type": "integer"
        },
        "ccs": {
          "description": "Array of Physician IDs to copy for the order.",
          "items": {
            "format": "int64",
            "type": "integer"
          },
          "type": "array"
        },
        "chart_date": {
          "format": "date-time",
          "type": "string"
        },
        "clinical_reason": {
          "description": "The clinical reason for the order.",
          "type": "string"
        },
        "confidential": {
          "type": "boolean"
        },
        "created_date": {
          "format": "date-time",
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "deleted_date": {
          "format": "date-time",
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "document_date": {
          "format": "date-time",
          "type": "string"
        },
        "follow_up_method": {
          "description": "How to notify the patient of the results.",
          "maxLength": 100,
          "type": [
            "string",
            "null"
          ]
        },
        "icd10_codes": {
          "description": "Array of ICD-10 diagnosis codes associated with the order.",
          "items": {
            "allOf": [
              {
                "$ref": "#/$defs/ICD10Code"
              }
            ]
          },
          "type": "array"
        },
        "id": {
          "readOnly": true,
          "type": "integer"
        },
        "patient": {
          "description": "The patient the order is associated with. Patient must belong to the specified practice.",
          "format": "int64",
          "type": "integer"
        },
        "practice": {
          "description": "The practice the order is associated with.",
          "format": "int64",
          "type": "integer"
        },
        "prescribing_user": {
          "description": "The user associated with the order. User ID must tie to a physician in the practice.",
          "type": "integer"
        },
        "pulmonary_center": {
          "description": "The pulmonary center the order is associated with.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        },
        "resolution": {
          "$ref": "#/$defs/DocumentResolutionState"
        },
        "signed_by": {
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        },
        "signed_date": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "test_date": {
          "description": "The date on which the tests should be performed, or were performed. Can be different than document_date, create_date.",
          "format": "date",
          "type": [
            "string",
            "null"
          ]
        },
        "tests": {
          "description": "An array of pulmonary tests associated with the order.",
          "items": {
            "allOf": [
              {
                "$ref": "#/$defs/PulmonaryOrderTest"
              }
            ]
          },
          "type": "array"
        }
      },
      "required": [
        "allergies",
        "ancillary_company",
        "chart_date",
        "clinical_reason",
        "document_date",
        "patient",
        "practice",
        "prescribing_user"
      ],
      "type": "object"
    },
    "PulmonaryOrderTest": {
      "properties": {
        "code": {
          "maxLength": 50,
          "type": [
            "string",
            "null"
          ]
        },
        "created_date": {
          "format": "date-time",
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "deleted_date": {
          "format": "date-time",
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "readOnly": true,
          "type": "integer"
        },
        "name": {
          "maxLength": 255,
          "type": "string"
        },
        "practice": {
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "name",
        "practice"
      ],
      "type": "object"
    },
    "StateEnum": {
      "description": "* `outstanding` - Outstanding\n* `fulfilled` - Fulfilled\n* `cancelled` - Cancelled",
      "enum": [
        "outstanding",
        "fulfilled",
        "cancelled"
      ],
      "type": "string"
    }
  }
}