Use this when the user needs a PRISMA 2020 flow diagram for a systematic review and already has the counts per stage (records per database or register, duplicates, screened, excluded, reports sought and assessed, exclusion reasons, studies included). Draws the official template (new or updated review, optionally with the 'other methods' arm) as SVG and PDF, works out duplicates from per-source counts and the number left after deduplication, and checks the arithmetic, returning warnings where the numbers do not add up. It does not search databases, screen records or invent counts: pass only numbers the user gave you, and leave unknown ones out. No account needed.
View input schema
{
"type": "object",
"properties": {
"lang": {
"default": "en",
"description": "Output language (default en).",
"type": "string",
"enum": [
"es",
"en"
]
},
"review_type": {
"default": "new",
"description": "'updated' adds the 'previous version of the review' arm (default new).",
"type": "string",
"enum": [
"new",
"updated"
]
},
"previous": {
"description": "Updated reviews only: studies and reports carried over from the previous version.",
"type": "object",
"properties": {
"studies": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"reports": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"additionalProperties": false
},
"databases_and_registers": {
"type": "object",
"properties": {
"sources": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"n": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"label"
],
"additionalProperties": false
},
"description": "Records per database or register as {label, n}, e.g. {label: 'MEDLINE', n: 812}; leave n out if unknown."
},
"records_after_deduplication": {
"description": "Unique records after deduplication; duplicates_removed is then computed.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"duplicates_removed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"removed_by_automation": {
"description": "Records marked as ineligible by automation tools.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"removed_other_reasons": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"records_screened": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"records_excluded": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"reports_sought": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"reports_not_retrieved": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"reports_assessed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"reports_excluded": {
"description": "One {label: reason, n} per full-text exclusion reason.",
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"n": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"label"
],
"additionalProperties": false
}
}
},
"required": [
"sources"
],
"additionalProperties": false
},
"other_methods": {
"description": "Give it to draw the 'identification via other methods' arm.",
"type": "object",
"properties": {
"sources": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"n": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"label"
],
"additionalProperties": false
},
"description": "e.g. websites, organisations, citation searching."
},
"reports_sought": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"reports_not_retrieved": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"reports_assessed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"reports_excluded": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"n": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"label"
],
"additionalProperties": false
}
}
},
"required": [
"sources"
],
"additionalProperties": false
},
"included": {
"type": "object",
"properties": {
"studies": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"reports": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"additionalProperties": false
},
"include_pdf": {
"default": false,
"description": "Also return a PDF (default false).",
"type": "boolean"
}
},
"required": [
"databases_and_registers",
"included"
],
"additionalProperties": false
}