How do the JSON and Object and description table of clinical trial studies API made by Clinical Trials work?

In this article, I will be discussing the object table and JSON output of the Clinical Trials API specifically for clinical trial studies. As someone with programming knowledge, you are likely familiar with these data structures and their role in organizing and representing complex information. However, understanding the nuances of these structures as they relate to clinical trial studies can be challenging. By clarifying the object table and JSON output in the context of clinical trials, I hope to provide a deeper understanding of how these structures are used to represent key data points in the world of clinical research.

Table

1. Rank: Indicates the rank of the clinical trial in the search results.

2. Study: The clinical trial study being conducted.

3. ProtocolSection: The section of the study's protocol document.

4. IdentificationModule: The module containing identification information about the study.

5. NCTId: The unique identifier assigned to the clinical trial by ClinicalTrials.gov.

6. OrgStudyIdInfo: Information about the organization's identifier for the study.

7. OrgStudyId: The organization's identifier for the study.

8. SecondaryIdInfoList: A list of additional identifiers for the study.

9. SecondaryIdInfo: Information about a secondary identifier for the study.

10. SecondaryId: A secondary identifier for the study.

11. SecondaryIdType: The type of the secondary identifier.

12. SecondaryIdDomain: The domain of the secondary identifier.

13. Organization: Information about the organization conducting the study.

14. OrgFullName: The full name of the organization conducting the study.

15. OrgClass: The type of organization conducting the study.

16. BriefTitle: A brief title for the study.

17. OfficialTitle: The official title of the study.

18. Acronym: An acronym for the study.

19. StatusModule: The module containing the status information for the study.

20. StatusVerifiedDate: The date on which the study's status was last verified.

21. etc: Any other object included in the table.

The information presented in the table is useful because it provides a detailed overview of the key objects and their corresponding descriptions that are available in the Clinical Trials API for clinical trial studies. This information can be helpful for developers and researchers who are interested in using the API to access clinical trial data for analysis or other purposes. By understanding the available objects and their descriptions, users can better navigate the API and retrieve the specific data points they need to conduct their research or develop applications. Additionally, this information can help users make informed decisions about which data points to use for their specific use cases and ensure that they are working with the most relevant and accurate data available in the API.

Clarifying JSON output

The JSON output represents a response from the ClinicalTrials.gov API, specifically for the query "heart attack". The response includes various metadata related to the query, such as the API version, data version, number of studies available and found, and the minimum and maximum rank of the studies found. The output also includes the details of one study with the rank of 1. The study information is divided into several sections such as ProtocolSection, StatusModule, OversightModule, DescriptionModule, ConditionsModule, DesignModule, and ArmsInterventionsModule. Each of these sections contains detailed information about the study, including its identifier, title, sponsor, status, start and end dates, study design, interventions, conditions, and so on. The output also includes additional metadata related to the study, such as the version of the API and the date when the status information was last verified. This JSON output can be parsed and processed by a computer program to extract and analyze the information contained in it.

{
"FullStudiesResponse":{
"APIVrs":"1.01.05",
"DataVrs":"2022:11:17 23:33:37.354",
"Expression":"heart attack",
"NStudiesAvail":433955,
"NStudiesFound":9364,
"MinRank":1,
"MaxRank":1,
"NStudiesReturned":1,
"FullStudies":[
{
"Rank":1,
"Study":{
"ProtocolSection":{
"IdentificationModule":{
"NCTId":"NCT01874691",
"OrgStudyIdInfo":{
"OrgStudyId":"2011BAI11B02-A"
},
"SecondaryIdInfoList":{
"SecondaryIdInfo":[
{
"SecondaryId":"2011BAI11B02",
"SecondaryIdType":"Other Grant/Funding Number",
"SecondaryIdDomain":"Chinese Ministry of Science and Technology"
}
]
},
"Organization":{
"OrgFullName":"Chinese Academy of Medical Sciences, Fuwai Hospital",
"OrgClass":"OTHER"
},
"BriefTitle":"China Acute Myocardial Infarction Registry",
"OfficialTitle":"China Acute Myocardial Infarction Registry",
"Acronym":"CAMIRegistry"
},
"StatusModule":{
"StatusVerifiedDate":"May 2022",
"OverallStatus":"Completed",
"ExpandedAccessInfo":{
"HasExpandedAccess":"No"
},
"StartDateStruct":{
"StartDate":"January 2013",
"StartDateType":"Actual"
},
"PrimaryCompletionDateStruct":{
"PrimaryCompletionDate":"December 2016",
"PrimaryCompletionDateType":"Actual"
},
"CompletionDateStruct":{
"CompletionDate":"December 2016",
"CompletionDateType":"Actual"
},
"StudyFirstSubmitDate":"June 4, 2013",
"StudyFirstSubmitQCDate":"June 7, 2013",
"StudyFirstPostDateStruct":{
"StudyFirstPostDate":"June 11, 2013",
"StudyFirstPostDateType":"Estimate"
},
"LastUpdateSubmitDate":"May 7, 2022",
"LastUpdatePostDateStruct":{
"LastUpdatePostDate":"May 12, 2022",
"LastUpdatePostDateType":"Actual"
}
},
"SponsorCollaboratorsModule":{
"ResponsibleParty":{
"ResponsiblePartyType":"Principal Investigator",
"ResponsiblePartyInvestigatorFullName":"Yuejin Yang",
"ResponsiblePartyInvestigatorTitle":"Doctor",
"ResponsiblePartyInvestigatorAffiliation":"Chinese Academy of Medical Sciences, Fuwai Hospital"
},
"LeadSponsor":{
"LeadSponsorName":"Chinese Academy of Medical Sciences, Fuwai Hospital",
"LeadSponsorClass":"OTHER"
}
},
"OversightModule":{
"OversightHasDMC":"Yes"
},
"DescriptionModule":{
"BriefSummary":"This study is to build a Chinese national registry and surveillance system for acute myocardial infarction(AMI) to obtain real-world information about current status of characteristics, risk factors, diagnosis, treatment and outcomes of Chinese AMI patients; And to propose scientific precaution strategies aimed to prevent effectively from the incidence of AMI; And to optimize the management and outcomes of AMI patients through implementation of guideline recommendations in clinical practice, and analysis and development of effective treatment strategies; And to create cost-effective assessment system.",
"DetailedDescription":"The aim of the study is to establish the national platform for surveillance, clinical research and translational medicine in China, designed to facilitate efforts to improve the quality of AMI patient care and thus decrease morbidity and mortality associated with AMI."
},
"ConditionsModule":{
"ConditionList":{
"Condition":[
"Acute Myocardial Infarction"
]
},
"KeywordList":{
"Keyword":[
"acute myocardial infarction",
"China",
"Registry"
]
}
},
"DesignModule":{
"StudyType":"Observational",
"PatientRegistry":"Yes",
"TargetDuration":"2 Years",
"DesignInfo":{
"DesignObservationalModelList":{
"DesignObservationalModel":[
"Case-Only"
]
},
"DesignTimePerspectiveList":{
"DesignTimePerspective":[
"Prospective"
]
}
},
"EnrollmentInfo":{
"EnrollmentCount":"20000",
"EnrollmentType":"Actual"
}
},
"ArmsInterventionsModule":{
"ArmGroupList":{
"ArmGroup":[
{
"ArmGroupLabel":"acute myocardial infarction",
"ArmGroupDescription":"acute myocardial infarction including ST-elevation and non ST-elevation myocardial infarction"
}
]
}
},
"OutcomesModule":{
"PrimaryOutcomeList":{
"PrimaryOutcome":[
{
"PrimaryOutcomeMeasure":"In-hospital mortality of the patients with acute myocardial infarction in different-level hospitals across China",
"PrimaryOutcomeDescription":"Different-level hospitals include Provincial-level, city-level, County-level hospitals from all over China.",
"PrimaryOutcomeTimeFrame":"the duration of hospital stay, an expected average of 2 weeks"
}
]
},
"SecondaryOutcomeList":{
"SecondaryOutcome":[
{
"SecondaryOutcomeMeasure":"The rate of the application of thrombolysis and primary percutaneous coronary intervention for Chinese patients with acute myocardial infarction in different-level hospitals",
"SecondaryOutcomeDescription":"In different-level hospitals, How many patients with acute myocardial infarction receive thrombolysis and/or primary percutaneous coronary intervention within 24 hours from the onset,respectively?",
"SecondaryOutcomeTimeFrame":"24 hours"
},{
"SecondaryOutcomeMeasure":"provoking factors of Chinese patients with AMI across different areas and different population in China",
"SecondaryOutcomeDescription":"The different factors that can provoke the onset of acute myocardial infarction, for example, excess exercise, overload work, heavy smoking, heavy drinking of alcohol and so on.",
"SecondaryOutcomeTimeFrame":"24 hours"
}
]
},
"OtherOutcomeList":{
"OtherOutcome":[
{
"OtherOutcomeMeasure":"the in-hospital cost of Chinese patients with acute myocardial infarction",
"OtherOutcomeTimeFrame":"the duration of hospital stay, an expected average of 2 weeks"
}
]
}
},
"EligibilityModule":{
"EligibilityCriteria":"Inclusion Criteria:\n\nEligible patients must be admitted within 7 days of acute ischemic symptoms and diagnosed acute ST-elevation or non ST-elevation myocardial infarction. Diagnosis criteria must meet Universal Definition for AMI (2012). All participating hospitals are required to enroll consecutive patients with AMI.\n\nExclusion Criteria:\n\nMyocardial infarction related to percutaneous coronary intervention and coronary artery bypass grafting.",
"HealthyVolunteers":"No",
"Gender":"All",
"StdAgeList":{
"StdAge":[
"Child",
"Adult",
"Older Adult"
]
},
"StudyPopulation":"Eligible patients admitted within 7 days of acute ischemic symptoms and diagnosed acute ST-elevation or non ST-elevation myocardial infarction.",
"SamplingMethod":"Probability Sample"
},
"ContactsLocationsModule":{
"OverallOfficialList":{
"OverallOfficial":[
{
"OverallOfficialName":"Yuejin Yang, MD.",
"OverallOfficialAffiliation":"Fuwai Hospital, Chinse Academy of Medical Sciences",
"OverallOfficialRole":"Study Chair"
}
]
},
"LocationList":{
"Location":[
{
"LocationFacility":"Fuwai Hospital",
"LocationCity":"Beijing",
"LocationState":"Beijing",
"LocationZip":"100037",
"LocationCountry":"China"
}
]
}
},
"ReferencesModule":{
"ReferenceList":{
"Reference":[
{
"ReferencePMID":"20031882",
"ReferenceType":"background",
"ReferenceCitation":"Peterson ED, Roe MT, Rumsfeld JS, Shaw RE, Brindis RG, Fonarow GC, Cannon CP. A call to ACTION (acute coronary treatment and intervention outcomes network): a national effort to promote timely clinical feedback and support continuous quality improvement for acute myocardial infarction. Circ Cardiovasc Qual Outcomes. 2009 Sep;2(5):491-9. doi: 10.1161/CIRCOUTCOMES.108.847145."
},{
"ReferencePMID":"35784538",
"ReferenceType":"derived",
"ReferenceCitation":"Cui K, Fu R, Yang J, Xu H, Yin D, Song W, Wang H, Zhu C, Feng L, Wang Z, Wang Q, Lu Y, Dou K, Yang Y. Admission Blood Glucose and 2-Year Mortality After Acute Myocardial Infarction in Patients With Different Glucose Metabolism Status: A Prospective, Nationwide, and Multicenter Registry. Front Endocrinol (Lausanne). 2022 Jun 15;13:898384. doi: 10.3389/fendo.2022.898384. eCollection 2022."
},{
"ReferencePMID":"35772392",
"ReferenceType":"derived",
"ReferenceCitation":"Cui K, Fu R, Yang J, Xu H, Yin D, Song W, Wang H, Zhu C, Feng L, Wang Z, Wang Q, Lu Y, Dou K, Yang Y; CAMI Registry Investigators. Stress hyperglycemia ratio and long-term mortality after acute myocardial infarction in patients with and without diabetes: A prospective, nationwide, and multicentre registry. Diabetes Metab Res Rev. 2022 Oct;38(7):e3562. doi: 10.1002/dmrr.3562. Epub 2022 Jul 13."
},{
"ReferencePMID":"34631809",
"ReferenceType":"derived",
"ReferenceCitation":"Shi W, Ni L, Yang J, Fan X, Yu M, Yang H, Yu M, Yang Y; China Acute Myocardial Infarction (CAMI) Registry study group. The Clinical Impact of Proton Pump Inhibitors When Co-Administered With Dual Antiplatelet Therapy in Patients Having Acute Myocardial Infarction With Low Risk of Gastrointestinal Bleeding: Insights From the China Acute Myocardial Infarction Registry. Front Cardiovasc Med. 2021 Sep 22;8:685072. doi: 10.3389/fcvm.2021.685072. eCollection 2021."
},{
"ReferencePMID":"34493500",
"ReferenceType":"derived",
"ReferenceCitation":"Shi W, Fan X, Yang J, Ni L, Su S, Yu M, Yang H, Yu M, Yang Y; China Acute Myocardial Infarction(CAMI) Registry Study Group. In-hospital gastrointestinal bleeding in patients with acute myocardial infarction: incidence, outcomes and risk factors analysis from China Acute Myocardial Infarction Registry. BMJ Open. 2021 Sep 7;11(9):e044117. doi: 10.1136/bmjopen-2020-044117."
},{
"ReferencePMID":"31567475",
"ReferenceType":"derived",
"ReferenceCitation":"Song CX, Fu R, Yang JG, Xu HY, Gao XJ, Wang CY, Zheng Y, Jia SB, Dou KF, Yang YJ; CAMI Registry study group. Angiographic characteristics and in-hospital mortality among patients with ST-segment elevation myocardial infarction presenting without typical chest pain: an analysis of China Acute Myocardial Infarction registry. Chin Med J (Engl). 2019 Oct 5;132(19):2286-2291. doi: 10.1097/CM9.0000000000000432."
},{
"ReferencePMID":"31515430",
"ReferenceType":"derived",
"ReferenceCitation":"Song C, Fu R, Li S, Yang J, Wang Y, Xu H, Gao X, Liu J, Liu Q, Wang C, Dou K, Yang Y. Simple risk score based on the China Acute Myocardial Infarction registry for predicting in-hospital mortality among patients with non-ST-segment elevation myocardial infarction: results of a prospective observational cohort study. BMJ Open. 2019 Sep 12;9(9):e030772. doi: 10.1136/bmjopen-2019-030772."
},{
"ReferencePMID":"31471442",
"ReferenceType":"derived",
"ReferenceCitation":"Song C, Fu R, Dou K, Yang J, Xu H, Gao X, Wang H, Liu S, Fan X, Yang Y. Association between smoking and in-hospital mortality in patients with acute myocardial infarction: results from a prospective, multicentre, observational study in China. BMJ Open. 2019 Aug 30;9(8):e030252. doi: 10.1136/bmjopen-2019-030252."
},{
"ReferencePMID":"31255895",
"ReferenceType":"derived",
"ReferenceCitation":"Leng W, Yang J, Fan X, Sun Y, Xu H, Gao X, Wang Y, Li W, Xu Y, Han Y, Jia S, Zheng Y, Yang Y; behalf CAMI Registry investigators. Contemporary invasive management and in-hospital outcomes of patients with non-ST-segment elevation myocardial infarction in China: Findings from China Acute Myocardial Infarction (CAMI) Registry. Am Heart J. 2019 Sep;215:1-11. doi: 10.1016/j.ahj.2019.05.015. Epub 2019 Jun 6."
},{
"ReferencePMID":"30807351",
"ReferenceType":"derived",
"ReferenceCitation":"Fu R, Song CX, Dou KF, Yang JG, Xu HY, Gao XJ, Liu QQ, Xu H, Yang YJ. Differences in symptoms and pre-hospital delay among acute myocardial infarction patients according to ST-segment elevation on electrocardiogram: an analysis of China Acute Myocardial Infarction (CAMI) registry. Chin Med J (Engl). 2019 Mar 5;132(5):519-524. doi: 10.1097/CM9.0000000000000122."
},{
"ReferencePMID":"28052755",
"ReferenceType":"derived",
"ReferenceCitation":"Dai Y, Yang J, Gao Z, Xu H, Sun Y, Wu Y, Gao X, Li W, Wang Y, Gao R, Yang Y; CAMI Registry study group. Atrial fibrillation in patients hospitalized with acute myocardial infarction: analysis of the china acute myocardial infarction (CAMI) registry. BMC Cardiovasc Disord. 2017 Jan 4;17(1):2. doi: 10.1186/s12872-016-0442-9."
},{
"ReferencePMID":"27530939",
"ReferenceType":"derived",
"ReferenceCitation":"Sun H, Yang YJ, Xu HY, Yang JG, Gao XJ, Wu Y, Li W, Wang Y, Liu J, Jin C, Song L; CAMI Registry Study Group. [Survey of medical care resources of acute myocardial infarction in different regions and levels of hospitals in China]. Zhonghua Xin Xue Guan Bing Za Zhi. 2016 Jul 24;44(7):565-9. doi: 10.3760/cma.j.issn.0253-3758.2016.07.003. Chinese."
}
]
}
}
},
"DerivedSection":{
"MiscInfoModule":{
"VersionHolder":"November 18, 2022"
},
"ConditionBrowseModule":{
"ConditionMeshList":{
"ConditionMesh":[
{
"ConditionMeshId":"D000009203",
"ConditionMeshTerm":"Myocardial Infarction"
},{
"ConditionMeshId":"D000007238",
"ConditionMeshTerm":"Infarction"
}
]
},
"ConditionAncestorList":{
"ConditionAncestor":[
{
"ConditionAncestorId":"D000007511",
"ConditionAncestorTerm":"Ischemia"
},{
"ConditionAncestorId":"D000010335",
"ConditionAncestorTerm":"Pathologic Processes"
},{
"ConditionAncestorId":"D000009336",
"ConditionAncestorTerm":"Necrosis"
},{
"ConditionAncestorId":"D000017202",
"ConditionAncestorTerm":"Myocardial Ischemia"
},{
"ConditionAncestorId":"D000006331",
"ConditionAncestorTerm":"Heart Diseases"
},{
"ConditionAncestorId":"D000002318",
"ConditionAncestorTerm":"Cardiovascular Diseases"
},{
"ConditionAncestorId":"D000014652",
"ConditionAncestorTerm":"Vascular Diseases"
}
]
},
"ConditionBrowseLeafList":{
"ConditionBrowseLeaf":[
{
"ConditionBrowseLeafId":"M11307",
"ConditionBrowseLeafName":"Myocardial Infarction",
"ConditionBrowseLeafAsFound":"Myocardial Infarction",
"ConditionBrowseLeafRelevance":"high"
},{
"ConditionBrowseLeafId":"M9434",
"ConditionBrowseLeafName":"Infarction",
"ConditionBrowseLeafAsFound":"Infarction",
"ConditionBrowseLeafRelevance":"high"
},{
"ConditionBrowseLeafId":"M9695",
"ConditionBrowseLeafName":"Ischemia",
"ConditionBrowseLeafRelevance":"low"
},{
"ConditionBrowseLeafId":"M11436",
"ConditionBrowseLeafName":"Necrosis",
"ConditionBrowseLeafRelevance":"low"
},{
"ConditionBrowseLeafId":"M5698",
"ConditionBrowseLeafName":"Coronary Artery Disease",
"ConditionBrowseLeafRelevance":"low"
},{
"ConditionBrowseLeafId":"M18658",
"ConditionBrowseLeafName":"Myocardial Ischemia",
"ConditionBrowseLeafRelevance":"low"
},{
"ConditionBrowseLeafId":"M8571",
"ConditionBrowseLeafName":"Heart Diseases",
"ConditionBrowseLeafRelevance":"low"
},{
"ConditionBrowseLeafId":"M16552",
"ConditionBrowseLeafName":"Vascular Diseases",
"ConditionBrowseLeafRelevance":"low"
},{
"ConditionBrowseLeafId":"T170",
"ConditionBrowseLeafName":"Acute Graft Versus Host Disease",
"ConditionBrowseLeafRelevance":"low"
}
]
},
"ConditionBrowseBranchList":{
"ConditionBrowseBranch":[
{
"ConditionBrowseBranchAbbrev":"BC14",
"ConditionBrowseBranchName":"Heart and Blood Diseases"
},{
"ConditionBrowseBranchAbbrev":"BC23",
"ConditionBrowseBranchName":"Symptoms and General Pathology"
},{
"ConditionBrowseBranchAbbrev":"All",
"ConditionBrowseBranchName":"All Conditions"
},{
"ConditionBrowseBranchAbbrev":"Rare",
"ConditionBrowseBranchName":"Rare Diseases"
}
]
}
}
}
}
}
]
}
}

Closing up

In this article, we discussed the ClinicalTrials.gov API and its use in accessing and retrieving information about clinical trials. We looked at the structure of the API and the objects and data it provides, such as the ProtocolSection, StatusModule, and ConditionsModule. We also examined a sample JSON output from the API and discussed how it represents the information about a clinical trial study. Overall, the information provided in this conversation is useful for researchers, programmers, and other professionals who work with clinical trial data and need to access and analyze it through the ClinicalTrials.gov API.

Source

Worldindata provides access to the Clinical Trials clinical trial studies API as a third-party data marketplace. Interested parties can request access through the Worldindata platform and start using the API to access and retrieve clinical trial data. It is important to note that the use of the API may be subject to certain terms and conditions imposed by Worldindata, in addition to the ones set by ClinicalTrials.gov. These terms may include restrictions on the number of requests and the scope of usage. It is recommended that interested parties thoroughly review and understand these terms before requesting access to the Clinical Trials clinical trial studies API through Worldindata.