Study JSON v2
Jump to navigation
Jump to search
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://ecrin.org/json_schemas/mdrstudy/v2.json",
"title": "XDC Study definition",
"description": "ECRIN Metadata Repository for clinical research objects, Study JSON definition, version 2 February 2019",
"type": "object",
"required": ["id", "scientific_title"],
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Internal accession number of the study within MDR database"
},
"scientific_title": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The full scientific title, as used on the protocol document"
},
"lang_code": {
"$ref": "#/definitions/lang_code"
}
}
},
"study_identifiers": {
"type": "array",
"items": {
"type": "object",
"description": "A composite object that indicates the value and type of the identifier, and optionally its date and organisation of origin",
"required": ["id", "value", "type"],
"properties": {
"id": {
"type": "integer",
"description": "study identifier record primary key, generated automatically in database"
},
"value": {
"type": "string",
"description": "the identifier value, in a standardised format (for each identifier type)"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "An integer referencing the relevant record in the identifier_types enumeration / lookup table"
},
"name": {
"type": "string",
"description": "One of the allowed types, from the identifier_types enumeration, e.g. 'Trial Registry ID', or 'Sponsor ID'"
}
}
},
"date": {
"type": "string",
"format": "date",
"description": "The date the identifier was allocated, if known"
},
"organisation": {
"$ref": "#/definitions/organisation"
}
}
}
},
"study_topics": {
"type": "array",
"items": {
"type": "object",
"description": "A composite object that indicates the topic name or keyword, and - if applicable - how it was classified in the source data, the controlled terminology system used, and the code for the topic in that system",
"required": ["id", "value"],
"properties": {
"id": {
"type": "integer",
"description": "Study topic record primary key, generated automatically in database"
},
"value": {
"type": "string",
"description": "The topic name, as provided in the source data"
},
"topic_source_type": {
"type": "object",
"description": "How the topic was categorised in the source documentation, or using the controlled terminology, or using a category matching service"
"properties": {
"id": {
"type": "integer",
"description": "An integer referencing the relevant record in the topic_source_types enumeration / lookup table"
},
"name": {
"type": "string",
"description": "One of the allowed types, from the topic_source_types enumeration, e.g. 'Condition', or 'Organism'"
}
}
},
"topic_ct": {
"type": "object",
"description": "If applicable, the controlled terminology system from which the topic name was taken",
"properties": {
"id": {
"type": "integer",
"description": "An integer referencing the relevant record in the topic_controlled_terminologies enumeration / lookup table"
},
"name": {
"type": "string",
"description": "One of the allowed types, from the topic_controlled_terminologies enumeration, e.g. 'MESH', or 'Cochrane PICO terminology'"
}
}
},
"topic_ct_code": {
"type": "string",
"description": "The code for the topic within the designated controlled terminology scheme"
},
}
}
},
"study_other_titles": {
"type": "array",
"items": {
"type": "object",
"description": "A composite object that indicates the type and value of the 'other title'",
"required": ["id", "title_type", "title_text"],
"properties": {
"id": {
"type": "integer",
"description": "Other title record primary key, generated automatically in database"
},
"title_type": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "An integer referencing the relevant record in the title_types enumeration / lookup table"
},
"name": {
"type": "string",
"description": "One of the allowed types, from the title_types enumeration, e.g. 'Abbreviation or Acronym', or 'Translated Title'"
}
}
},
"title_text": {
"type": "string"
},
"lang_code": {
"$ref": "#/definitions/lang_code"
}
}
}
},
"study_type": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "An integer referencing the relevant record in the study_types enumeration / lookup table"
},
"name": {
"type": "string",
"description": "One of the allowed types, from the study_types enumeration, e.g. 'Interventional', or 'Observational'"
}
}
},
"study_status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "An integer referencing the relevant record in the study_statuses enumeration / lookup table"
},
"name": {
"type": "string",
"description": "One of the allowed types, from the study_statuses enumeration, e.g. 'Active, not recruiting', or 'Completed'"
}
}
},
"linked_data_objects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id, i.e. internal accession number, of the linked data object"
}
}
}
}
},
"definitions": {
"lang_code": {
"type": "string",
"minLength" = 2,
"maxLength" = 2,
"description": "A two letter ISO 369-1 code indicating the language of the study",
"default": "en"
},
"organisation": {
"type": "object",
"required": ["name"],
"properties": {
"id": {
"type": "integer",
"description": "The id of the organisation within the ECRIN contextual database, if that id exists"
}
"name": {
"type": "array",
"description": "Either the name of the organisation as supplied by the source data, or the names (may be multiple) of the organisation within the ECRIN contextual database",
"minItems" = 1,
"items": {
"type": "string"
}
}
}
}
}
}
