OrderConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/karmacheck/json-schema/karmacheck-order-config-schema.json",
  "title": "OrderConfig",
  "description": "Options that describe how to run certain screenings for a case. See [Order configuration](docs/reference/order-configuration.md) for details on all configuration options.\n\nAll properties are optional, but a configuration will be set for all applicable screenings on the package regardless of whether those screenings are ordered. Therefore, aside from the `contacts` object, the default configuration will be used if one is not set.",
  "x-generated": "2026-11-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/karmacheck-cases-api-openapi.yml#/components/schemas/OrderConfig",
  "type": "object",
  "properties": {
    "contacts": {
      "type": "array",
      "description": "A list of people to contact about the case.",
      "items": {
        "$ref": "#/$defs/Contact"
      }
    },
    "aliasNameConfiguration": {
      "$ref": "#/$defs/ConfigValuesAlias"
    },
    "ohsDrugPassportExpirationPolicy": {
      "$ref": "#/$defs/ConfigValuesOhsDrugPassportExpirationPolicy"
    },
    "lostOrIncompleteOHSDrugPolicy": {
      "$ref": "#/$defs/ConfigValuesDrugPolicy"
    },
    "diluteDrugPolicy": {
      "$ref": "#/$defs/ConfigValuesDrugPolicy"
    },
    "serviceConfigs": {
      "type": "object",
      "description": "Services with configuration options.",
      "properties": {
        "9ac65633-b4c4-4062-875c-3556db9d2a08": {
          "type": "object",
          "description": "The configuration for employment verification.",
          "properties": {
            "verificationMethod": {
              "$ref": "#/$defs/ConfigValuesEmploymentVerification",
              "description": "The method for verifying employment."
            }
          }
        },
        "service-employment-income": {
          "type": "object",
          "description": "The configuration for employment income verification.",
          "properties": {
            "verificationMethod": {
              "$ref": "#/$defs/ConfigValuesEmploymentVerification",
              "description": "The method for verifying employment and income."
            }
          }
        },
        "85307784-1f84-471a-8596-c8ea088c3a62": {
          "type": "object",
          "description": "The configuration for education verification.",
          "properties": {
            "verificationMethod": {
              "$ref": "#/$defs/ConfigValuesEducationVerification",
              "description": "The method for verifying education."
            }
          }
        },
        "service-ohs-tb-quantiferon-gold": {
          "type": "object",
          "description": "The configuration for Quantiferon testing.",
          "properties": {
            "substitutionPolicy": {
              "$ref": "#/$defs/ConfigValuesQuantiferon",
              "description": "The policy for Quantiferon testing substitution."
            }
          }
        },
        "service-ohs-tb-tspot-test": {
          "type": "object",
          "description": "The configuration for T-Spot testing.",
          "properties": {
            "substitutionPolicy": {
              "$ref": "#/$defs/ConfigValuesTspot",
              "description": "The policy for T-Spot testing substitution."
            }
          }
        }
      }
    }
  },
  "$defs": {
    "ConfigValuesAlias": {
      "title": "ConfigValuesAlias",
      "type": "string",
      "enum": [
        "no-alias",
        "alias-all",
        "alias-all+hits-only",
        "alias-mnv",
        "alias-mnv+hits-only"
      ],
      "description": "The options for an alias configuration.",
      "default": "no-alias"
    },
    "ConfigValuesDrugPolicy": {
      "title": "ConfigValuesDrugPolicy",
      "type": "string",
      "enum": [
        "company-default",
        "reorder",
        "reorder-and-contact",
        "reorder-once-contact",
        "do-not-reorder"
      ],
      "description": "The configuration options for a drug policy.",
      "default": "company-default"
    },
    "ConfigValuesEducationVerification": {
      "title": "ConfigValuesEducationVerification",
      "type": "string",
      "enum": [
        "docs-acceptable",
        "psv",
        "psv-first"
      ],
      "description": "The configuration options for education verification.",
      "default": "docs-acceptable"
    },
    "ConfigValuesEmploymentVerification": {
      "title": "ConfigValuesEmploymentVerification",
      "type": "string",
      "enum": [
        "docs-acceptable",
        "psv",
        "psv-first"
      ],
      "description": "The configuration options for employment verification.",
      "default": "docs-acceptable"
    },
    "ConfigValuesOhsDrugPassportExpirationPolicy": {
      "title": "ConfigValuesOhsDrugPassportExpirationPolicy",
      "type": "string",
      "enum": [
        "company-default",
        "reissue",
        "reissue-and-contact",
        "reissue-once-contact",
        "contact-customer",
        "do-not-reissue"
      ],
      "description": "The configuration options for an ePassport expiration policy.",
      "default": "company-default"
    },
    "ConfigValuesQuantiferon": {
      "title": "ConfigValuesQuantiferon",
      "type": "string",
      "enum": [
        "company-default",
        "replace-with-t-spot",
        "do-not-replace"
      ],
      "description": "The options for Quantiferon substitution.",
      "default": "company-default"
    },
    "ConfigValuesTspot": {
      "title": "ConfigValuesTspot",
      "type": "string",
      "enum": [
        "company-default",
        "replace-with-quantiferon",
        "do-not-replace"
      ],
      "description": "The options for T-Spot substitution.",
      "default": "company-default"
    },
    "Contact": {
      "title": "Contact",
      "type": "object",
      "description": "Details of a contact.",
      "required": [
        "type",
        "email"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "The name of the contact."
        },
        "type": {
          "type": "string",
          "enum": [
            "default",
            "escalation",
            "authorization"
          ],
          "description": "The role of the contact."
        },
        "email": {
          "type": "string",
          "description": "The email address of the contact.",
          "format": "email"
        },
        "phone": {
          "type": "string",
          "maxLength": 20,
          "description": "The phone number of the contact."
        }
      }
    }
  }
}