MonitoringResultSet[Expirable]

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/axuall/json-schema/axuall-monitoring-result-set-expirable-schema.json",
  "title": "MonitoringResultSet[Expirable]",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/axuall-monitoring-reports-api-openapi.yml#/components/schemas/MonitoringResultSet_Expirable_",
  "properties": {
    "total_clinicians": {
      "type": "integer",
      "title": "Total Clinicians",
      "description": "The total number of currently active clinicians"
    },
    "filtered_clinicians": {
      "type": "integer",
      "title": "Filtered Clinicians",
      "description": "The total number of active clinicians applicable to the search criteria"
    },
    "total": {
      "type": "integer",
      "title": "Total",
      "description": "The total number of records applicable to the search criteria"
    },
    "results": {
      "items": {
        "$ref": "#/$defs/Expirable"
      },
      "type": "array",
      "title": "Results",
      "description": "The list of records returned by the search criteria"
    }
  },
  "type": "object",
  "required": [
    "total_clinicians",
    "filtered_clinicians",
    "total",
    "results"
  ],
  "$defs": {
    "Expirable": {
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "title": "Id",
          "description": "The ID of the expirable record"
        },
        "dimensions": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object",
          "title": "Dimensions",
          "description": "The dimensions associated with the expirable record"
        },
        "profile": {
          "$ref": "#/$defs/MonitoringProfile"
        },
        "verification": {
          "$ref": "#/$defs/Verification",
          "description": "The verification record associated with the expirable record"
        },
        "license_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "License Number",
          "description": "The license number, if any, associated with the expirable record"
        },
        "expiration_date": {
          "type": "string",
          "format": "date",
          "title": "Expiration Date",
          "description": "The date the credential is set to expire"
        },
        "issue_date": {
          "anyOf": [
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "null"
            }
          ],
          "title": "Issue Date",
          "description": "The date the credential was issued"
        },
        "status": {
          "$ref": "#/$defs/ExpirableStatus",
          "description": "The current status of the credential"
        },
        "reported_at": {
          "type": "string",
          "format": "date-time",
          "title": "Reported At",
          "description": "The date and time the expirable record was recorded by Axuall"
        },
        "artifact_id": {
          "type": "string",
          "format": "uuid",
          "title": "Artifact Id",
          "description": "The ID of the Axuall credential record associated with the expirable"
        }
      },
      "type": "object",
      "required": [
        "id",
        "dimensions",
        "profile",
        "verification",
        "expiration_date",
        "issue_date",
        "status",
        "reported_at",
        "artifact_id"
      ],
      "title": "Expirable"
    },
    "ExpirableStatus": {
      "type": "string",
      "enum": [
        "unknown",
        "active",
        "expired"
      ],
      "title": "ExpirableStatus"
    },
    "MonitoringProfile": {
      "properties": {
        "provider_id": {
          "type": "string",
          "title": "Provider Id",
          "description": "The provider ID of the clinician"
        },
        "first_name": {
          "type": "string",
          "title": "First Name"
        },
        "middle_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Middle Name"
        },
        "last_name": {
          "type": "string",
          "title": "Last Name"
        },
        "degree": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Degree",
          "description": "The short degree name of the clinician",
          "default": ""
        },
        "degree_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Degree Name",
          "description": "The full degree name of the clinician",
          "default": ""
        },
        "holder_id": {
          "type": "string",
          "format": "uuid",
          "title": "Holder Id",
          "description": "The Axuall ID of the clinician"
        },
        "checklist_id": {
          "type": "string",
          "title": "Checklist Id",
          "description": "The ID used to view the checklist of the clinician"
        },
        "checklist_url": {
          "type": "string",
          "title": "Checklist Url",
          "description": "The URL used to view the checklist of the clinician"
        }
      },
      "type": "object",
      "required": [
        "provider_id",
        "first_name",
        "middle_name",
        "last_name",
        "holder_id",
        "checklist_id",
        "checklist_url"
      ],
      "title": "MonitoringProfile"
    },
    "Verification": {
      "properties": {
        "name": {
          "type": "string",
          "title": "Name",
          "description": "The name of the source verification"
        },
        "name_formatted": {
          "type": "string",
          "title": "Name Formatted",
          "description": "The formatted name of the source verification"
        },
        "attributes": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Attributes",
          "description": "Attributes specific to the source verification",
          "default": {}
        },
        "last_revalidated_at": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ],
          "title": "Last Revalidated At",
          "description": "The last time the verification was revalidated"
        },
        "next_verification_at": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ],
          "title": "Next Verification At",
          "description": "The approximate next time the verification should be revalidated"
        }
      },
      "type": "object",
      "required": [
        "name",
        "name_formatted"
      ],
      "title": "Verification"
    }
  }
}