Document relation

Document relation used by this schema object.

$defs.document_relation · 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,
    "properties": {        "id": {            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$",
            "minLength": 1,
            "description": "Record-local stable identifier. IDs are intended to be unique across the complete MatRecordJSON package."        },
        "subject_document_ref": {            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"        },
        "relation": {            "enum": [                "supplements",
                "source_for",
                "certifies",
                "revises",
                "supersedes",
                "attaches",
                "includes",
                "certified_copy_of",
                "derived_from",
                "review_copy_of",
                "other"            ]        },
        "object_document_ref": {            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"        },
        "note": {            "type": "string"        },
        "evidence_refs": {            "type": "array",
            "items": {                "type": "string",
                "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"            },
            "uniqueItems": true        }    },
    "required": [        "id",
        "subject_document_ref",
        "relation",
        "object_document_ref"    ]}

Fields

FieldTypeStatusMeaning
idstring — pattern ^[A-Za-z][A-Za-z0-9._:-]*$RequiredRecord-local stable identifier. IDs are intended to be unique across the complete MatRecordJSON package.
subject_document_refstring — pattern ^[A-Za-z][A-Za-z0-9._:-]*$RequiredSubject document ref used by this schema object.
relationenum — "supplements", "source_for", "certifies", "revises", "supersedes", "attaches", …RequiredRelation used by this schema object.
object_document_refstring — pattern ^[A-Za-z][A-Za-z0-9._:-]*$RequiredObject document ref used by this schema object.
notestringOptionalNote used by this schema object.
evidence_refsarrayOptionalEvidence refs used by this schema object.