{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"/api/v1/schema.json","title":"Human data resource","type":"object","required":["id","name","custodian","countries","categories","description","keywords","access_level","access_route","url","last_verified","status"],"properties":{"id":{"type":"string","pattern":"^[a-z0-9]+(-[a-z0-9]+)*$","description":"Stable slug, never reused. Used in URLs."},"name":{"type":"string","description":"Official name"},"short_names":{"type":"array","items":{"type":"string"},"description":"Acronyms and short names"},"former_names":{"type":"array","items":{"type":"string"},"description":"Previous names, e.g. THIN for IMRD"},"name_original":{"type":"string","description":"Name in the original language"},"description_original":{"type":"string","description":"Description in the original language"},"language":{"type":"string","description":"ISO 639-1 code of the original-language fields"},"custodian":{"type":"string","description":"Organisation responsible"},"countries":{"type":"array","minItems":1,"items":{"type":"string","pattern":"^([A-Z]{2}|INT)$"},"description":"ISO 3166-1 alpha-2 codes, or INT for international"},"regions":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}-[A-Z0-9]{1,3}$"},"description":"ISO 3166-2 subdivision codes"},"categories":{"type":"array","minItems":1,"items":{"enum":["gateways","health-records","biobanks-cohorts","registries","drug-safety-toxicology","social-admin","clinical-trials","lab-computational","directories-standards"]}},"description":{"type":"string","description":"Plain English, max ~80 words"},"data_types":{"type":"array","items":{"enum":["gp-records","hospital-records","prescriptions","claims","registry-records","adverse-event-reports","poisons-enquiries","exposure-data","genomes","genotyping","omics","imaging","biosamples","tissue","questionnaires","wearables","mortality","linked-admin","trial-records","metadata"]}},"population":{"type":"object","properties":{"summary":{"type":"string"},"size":{"type":"integer"},"ages":{"type":"string"},"years":{"type":"string"}}},"population_groups":{"type":"array","items":{"enum":["general","children","pregnancy","older-people","twins-families","workers","patients","rare-disease","cancer"]}},"keywords":{"type":"array","items":{"type":"string"},"description":"Topics and free tags"},"access_level":{"enum":["open","registration","application","commercial"]},"access_route":{"type":"string","description":"How to apply"},"eligibility":{"type":"string"},"cost":{"enum":["free","fee","commercial","varies"]},"cost_note":{"type":"string"},"secure_environment":{"type":"object","properties":{"available":{"type":"boolean"},"name":{"type":"string"}},"required":["available"]},"has_samples":{"type":"boolean"},"has_genetic":{"type":"boolean"},"url":{"type":"string","description":"Home page (https)"},"access_url":{"type":"string","description":"Application page"},"replacement_relevance":{"type":"string","description":"How it can answer questions otherwise studied in animals"},"example_uses":{"type":"array","items":{"type":"string"},"description":"DOIs or PubMed IDs"},"status":{"enum":["active","under-review","moved","closed"]},"last_verified":{"type":["string","null"],"format":"date","description":"ISO 8601 date a curator last checked the entry"},"verified_by":{"type":"string","description":"Curator initials (internal)"},"source_note":{"type":"string"}},"additionalProperties":false}