Effective requirement

Effective requirement used by this schema object.

$defs.effective_requirement · object

Definition JSON

This fragment is shown exactly as published. Use the chevrons to fold objects and arrays; linked $ref values return to their targets in the complete schema.

{    "type": "object",
    "additionalProperties": false,
    "required": [        "kind"    ],
    "properties": {        "kind": {            "enum": [                "property_limit",
                "composition_limit",
                "computed_limit",
                "required_condition",
                "required_test",
                "required_examination",
                "required_heat_treatment",
                "required_product_form",
                "required_manufacturing_route",
                "required_document",
                "required_report_field",
                "required_traceability",
                "required_marking",
                "required_statement",
                "sampling_requirement",
                "test_acceptance",
                "prohibited",
                "allowed_only",
                "reference_compliance",
                "decision_procedure",
                "other"            ]        },
        "property": {            "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/coded_term"        },
        "analyte": {            "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/coded_term"        },
        "operator": {            "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/comparison_operator"        },
        "expected": {            "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/result_value"        },
        "allowed_values": {            "type": "array",
            "minItems": 1,
            "items": {                "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/result_value"            }        },
        "test_type": {            "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/coded_term"        },
        "document_type": {            "type": "string"        },
        "condition": {            "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/coded_term"        },
        "calculation": {            "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/calculation_spec"        },
        "frequency": {            "type": [                "string",
                "object"            ]        },
        "scope": {            "type": [                "string",
                "object",
                "array"            ]        },
        "reporting": {            "type": [                "string",
                "object",
                "array"            ]        },
        "text": {            "type": "string"        },
        "alternatives": {            "type": "array",
            "minItems": 2,
            "items": {                "$ref": "#/$defs/effective_requirement"            }        },
        "notes": {            "type": "array",
            "items": {                "type": "string"            }        }    },
    "anyOf": [        {            "required": [                "expected"            ]        },
        {            "required": [                "allowed_values"            ]        },
        {            "required": [                "test_type"            ]        },
        {            "required": [                "document_type"            ]        },
        {            "required": [                "condition"            ]        },
        {            "required": [                "calculation"            ]        },
        {            "required": [                "text"            ]        },
        {            "required": [                "alternatives"            ]        }    ]}

Fields

FieldTypeStatusMeaning
kindenum — "property_limit", "composition_limit", "computed_limit", "required_condition", "required_test", "required_examination", …RequiredKind used by this schema object.
propertyCoded termOptionalProperty used by this schema object.
analyteCoded termOptionalAnalyte used by this schema object.
operatorComparison operatorOptionalComparison operator used when evaluating the required or reported value.
expectedResult valueOptionalExpected used by this schema object.
allowed_valuesarray — at least 1 item(s)OptionalAllowed values used by this schema object.
test_typeCoded termOptionalTest type used by this schema object.
document_typestringOptionalDocument type used by this schema object.
conditionCoded termOptionalCondition used by this schema object.
calculationCalculation specOptionalCalculation used by this schema object.
frequencystring or objectOptionalSampling or performance frequency for the required activity.
scopestring or object or arrayOptionalBoundary of the requirement or the items covered by it.
reportingstring or object or arrayOptionalInformation that must be recorded, certified, or included in the evidence package.
textstringOptionalText used by this schema object.
alternativesarray — at least 2 item(s)OptionalAlternative ways of satisfying the same requirement. The rule defines whether one or all alternatives are needed.
notesarrayOptionalAdditional explanatory notes that do not replace the structured requirement.