Schemas / Clinic
rig.clinic.trial
v1.0.0 · stable maturity: draft 3 fields 2 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
identifier |
string | required | NCT or sponsor id as issued |
status |
enumrecruiting · active · completed · withdrawn · suspended | required | recruiting / active / completed / withdrawn / suspended |
phase |
enumphase-1 · phase-2 · phase-3 · phase-4 · na | optional | Optional. phase-1 / phase-2 / phase-3 / phase-4 / na |
A clinical trial. Format when present.
Field meanings follow ClinicalTrials.gov / WHO ICTRP identifiers. This schema is the trial - not a protocol PDF, and not the eligibility rows.
identifier and status are required.
The title is rig.meta.named. Eligibility rows are rig.clinic.criterion entities that point at this trial. The protocol file is rig.media.asset_ref kind document on another entity - do not put protocol text here.
JSON Schema
Resolves at https://rig.works/schemas/rig.clinic.trial.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.clinic.trial.schema.json",
"title": "rig.clinic.trial",
"type": "object",
"additionalProperties": false,
"properties": {
"identifier": {
"$ref": "./_defs.schema.json#/$defs/string"
},
"status": {
"type": "string",
"enum": [
"recruiting",
"active",
"completed",
"withdrawn",
"suspended"
]
},
"phase": {
"type": "string",
"enum": [
"phase-1",
"phase-2",
"phase-3",
"phase-4",
"na"
]
}
},
"required": [
"identifier",
"status"
],
"description": "A clinical trial. Eligibility rows are rig.clinic.criterion entities.",
"x-rig-maturity": "draft"
}