JSON schemas

The metadata application profiles have been provided in JSON, a machine readable format. The schemas are conformant with the most recent release of JSON schema specifications, draft 07.

Use the tabs below to explore the schemas, and see a sample output for one of the VaxStats submissions.

Catalog

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "id": "https://github.com/kthrog/VaxStats/blob/master/protocolReport/metadata/catalog.json",
    "title": "Vaccination Deposit Catalog",
    "type": "object",
    "description": "This container describes a catalog of datasets.",
    "required": [
        "title",
        "description",
        "publisher",
        "accessRights",
        "license",
        "langauge",
        "dataset"
    ],
    "properties": {
        "title": {
            "title": "Title",
            "description": "A name given to the catalog.",
            "type": "string",
            "minLength": 1
        },
        "descrption": {
            "title": "Description",
            "description": "A name given to the catalog.",
            "type": "string",
            "minLength": 1
        },
        "conformsTo": {
            "title": "Data standard",
            "description": "An established standard or schema to which the described dataset conforms.",
            "anyOf": [
                {
                    "type": "string",
                    "format": "uri"
                },
                {"type": "null"}
            ]
        },
        "publisher": {
            "title": "Publisher",
            "description": "The entity responsible for making the catalog online.",
            "type": "string",
            "minLength": 1
        },
        "accessRights": {
            "title": "Access Rights",
            "description": "",
            "type": "string",
            "minLength": 1
        },
        "license": {
            "title": "License",
            "description": "This links to the license document under which the catalog is made available and not the datasets. Even if the license of the catalog applies to all of its datasets and distributions, it should be replicated on each distribution.",
            "type": "string",
            "format": "uri"
        },
        "langauge": {
            "title": "Language",
            "description": "The language of the catalog.",
            "type": "string",
            "minLength": 1
        },
        "dataset": {
            "title": "Dataset",
            "type": "array",
            "items": {
                "$ref": "dataset.json",
                "minItems": 1
            }
        }
    }
}

Dataset

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "id": "https://github.com/kthrog/VaxStats/blob/master/protocolReport/metadata/dataset.json",
    "title": "Vaccination Deposit Dataset",
    "type": "object",
    "description": "This container describes a dataset.",
    "required": [
        "title",
        "identifier",
        "contactPoint",
        "description",
        "language",
        "keyword",
        "publisher",
        "issued",
        "distribution"
    ],
    "properties": {
        "@type": {
            "title": "Metadata Context",
            "description": "IRI for the JSON-LD data type.",
            "enum": ["dcat:Dataset"]
        },
        "title": {
            "title": "Title",
            "description": "A name given to the catalog.",
            "type": "string",
            "minLength": 1
        },
        "identifier": {
            "title": "Identifier",
            "description": "An unambiguous reference to the resource within a given context.",
            "type": "string",
            "minLength": 1
        },
        "contactPoint": {
            "type": "array",
            "items": {"$ref": "vcard.json"}
        },
        "descrption": {
            "title": "Description",
            "description": "A name given to the catalog.",
            "type": "string",
            "minLength": 3
        },
        "language": {
            "title": "Language",
            "description": "The language of the catalog.",
            "type": "string",
            "minLength": 3
        },
        "conformsTo": {
            "title": "Data standard",
            "description": "An established standard or schema to which the described dataset conforms.",
            "anyOf": [
                {
                    "type": "string",
                    "format": "uri"
                },
                {"type": "null"}
            ]
        },
        "keyword": {
            "type": "array",
            "enum": [
                "MMR (VACCINE)",
                "Measles virus",
                "Mumps virus",
                "Rubella Virus",
                "DT (VACCINE)",
                "DTaP (VACCINE)",
                "DTP (VACCINE)",
                "Hep A",
                "Hep B",
                "HiB",
                "HPV (VACCINE)",
                "Meningococcal",
                "Immunization",
                "Vaccination",
                "NIS",
                "PCV ",
                "PV",
                "Tdap",
                "Varicella",
                "Varicella (VACCINE)",
                "Polio",
                "IPV (VACCINE)",
                "Diphtheria",
                "Tetanus",
                "Pertussis"
            ],
            "minItems": 1
        },
        "publisher": {
            "title": "Publisher",
            "description": "The entity responsible for making the catalog online.",
            "type": "string",
            "minLength": 1
        },
        "issued": {
            "title": "Issued",
            "description": "Date of formal issuance (e.g., publication) of the dataset.",
            "type": "string",
            "format": "date-time"
        },
        "modified": {
            "title": "Modified",
            "description": "Date on which the dataset was changed, modified, or updated.",
            "anyOf": [
                {
                    "type": "string",
                    "format": "date-time"
                },
                {"type": "null"}
            ]
        },
        "accrualPeriodicity": {
            "title": "Accrual periodicity",
            "description": "The frequency at which dataset is published.",
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "monthly",
                        "yearly",
                        "irregular",
                        "annually"
                    ]
                },
                {"type": "null"}
            ]
        },
        "describedBy": {
            "title": "Described by",
            "description": "URL to data dictionary for the dataset.",
            "anyOf": [
                {
                    "type": "string",
                    "format": "uri"
                },
                {"type": "null"}
            ]
        },
        "spatial": {
            "title": "Spatial coverage",
            "description": "Spatial Coverage of the daataset. If the content covers multiple geographic areas, record encompassing area.",
            "anyOf": [
                {"type": "string"},
                {"type": "null"}
            ]
        },
        "temporal": {
            "title": "Temporal coverage",
            "description": "Temporal Coverage of dataset. If the content covers mutliple time epriods, record an encompassing period.",
            "anyOf": [
                {"type": "string"},
                {"type": "null"}
            ]
        },
        "relation": {
            "title": "Relation",
            "description": "A related resource of the dataset.",
            "anyOf": [
                {
                    "type": "string",
                    "format": "uri"
                },
                {"type": "null"}
            ]
        },
        "distribution": {
            "title": "Distribution",
            "description": "A container for the array of Distribution objects",
            "type": "array",
            "items": [
                {
                    "$ref": "distribution.json",
                    "minItems": 1
                }
            ]
        }
    }
}

Distribution

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "id": "https://github.com/kthrog/VaxStats/blob/master/protocolReport/metadata/distribution.json",
    "title": "Vaccination Deposit Dataset Distribution",
    "type": "object",
    "description": "This container describes a dataset distribution.",
    "required": [
        "title",
        "format",
        "issued",
        "license",
        "accessRights"
    ],
    "properties": {
        "title": {
            "title": "Title",
            "description": "Title or name given to the distribution.",
            "type": "string",
            "minLength": 1
        },
        "descrption": {
            "title": "Description",
            "description": "Description of the distribution.",
            "anyOf": [
                {
                    "type": "string",
                    "minLength": 3
                },
                {"type": "null"}
            ]
        },
        "extent": {
            "title": "Extent",
            "description": "The size or duration of the resource.",
            "type": "string"
        },
        "format": {
            "title": "Format",
            "description": "The material or physical carrier of the distribution.",
            "anyOf": [
                {
                    "type": "string",
                    "minLength": 3
                },
                {"type": "null"}
            ]
        },
        "issued": {
            "title": "Date issued",
            "description": "Date of formal issuance (e.g., publication) of the distribution."
        },
        "modified": {
            "title": "Date modified",
            "description": "Date on which the distrubution was changed, updated, or modified.",
            "anyOf": [
                {
                    "type": "string",
                    "minLength": 3
                },
                {"type": "null"}
            ]
        },
        "license": {
            "title": "License",
            "description": "A legal document giving official permission to do something with the distribution.",
            "type": "string",
            "format": "uri"
        },
        "accessRights": {
            "title": "Access rights",
            "description": "Information about who can access the distribution or an indication of its security status.",
            "anyOf": [
                {
                    "type": "string",
                    "minLength": 3
                },
                {
                    "type": "string",
                    "format": "uri"
                }
            ]
        },
        "accessURL": {
            "title": "",
            "description": "",
            "anyOf": [
                {
                    "type": "string",
                    "format": "uri",
                    "minLength": 3
                },
                {"type": "null"}
            ]
        },
        "downloadURL": {
            "title": "",
            "description": "",
            "anyOf": [
                {
                    "type": "string",
                    "format": "uri",
                    "minLength": 3
                },
                {"type": "null"}
            ]
        }
    }
}

vCard

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "id": "https://github.com/kthrog/VaxStats/edit/master/protocolReport/metadata/vcard.json",
    "title": "Contact Point",
    "description": "Dataset Contact Point as a vCard object",
    "type": "object",
    "required": [
        "name",
        "email"
    ],
    "properties": {
        "@type": {
            "title": "Metadata Context",
            "description": "IRI for the JSON-LD data type. This should be vcard:Contact for contactPoint",
            "enum": ["vcard:Contact"]
        },
        "name": {
            "title": "Contact Name",
            "description": "Full name for the depositor of the dataset.",
            "type": "string",
            "minLength": 1
        },
        "email": {
            "title": "email",
            "description": "Email address for the depositor of the dataset.",
            "type": "string"
        }
    }
}

Sample

{
    "title": "Immunization coverage for kindergartners Washington State",
    "description": "Immunization datasets published by the Washington State Department of Health.",
    "publisher": "Washington State Department of Health, Office of Immunization and Child Profile.",
    "accessRights": "The access rights for this dataset is unspecified",
    "license": "The license for this dataset is unspecified",
    "langauge": "English",
    "dataset": [
        {
            "title": "All students, kindergarten through 12th grade, immunization data by school, 2015-2016",
            "identifier": "DOH 348-550",
            "contactPoint": [
                {
                    "@type": "vcard:Contact",
                    "name": "Eavey, Joanna",
                    "email": "[e-mail]"
                }
            ],
            "description": "Washington student immunization rates by school for 2015-2016",
            "language": "English",
            "keyword": ["immunization, HepB, dtap, polio, mmr, varicella"],
            "publisher": "Washington State Department of Health",
            "issued": "2016-04-13",
            "distribution": [
                {
                    "title": "All students, kindergarten through 12th grade, immunization data by school, 2015-2016",
                    "description": "Washington student immunization rates by school for 2015-2016",
                    "format": "API",
                    "issued": "2016-04-13",
                    "modified": "2016-04-13",
                    "license": "The license for this dataset is unspecified",
                    "accessRights": "The access rights for this dataset is unspecified",
                    "accessURL": "https://dev.socrata.com/foundry/data.wa.gov/ie96-cgrn",
                    "downloadURL": "https://data.wa.gov/resource/ie96-cgrn.json"
                }
            ]
        }
    ]
}