clinicaltrialsgov-mcp-server
Version:
ClinicalTrials.gov Model Context Protocol (MCP) Server that provides a suite of tools for interacting with the official ClinicalTrials.gov v2 API. Enables AI agents and LLMs to programmatically search, retrieve, and analyze clinical trial data.
1,545 lines • 56.9 kB
TypeScript
/**
* @fileoverview Defines the TypeScript types for the ClinicalTrials.gov API.
* These types are based on the API's OpenAPI specification and are used
* throughout the server for type safety and data consistency.
* @module src/services/clinical-trials-gov/types
*/
import { z } from "zod";
/**
* Zod schema for a single clinical study, mirroring the ClinicalTrials.gov API structure.
* This provides runtime validation and serves as the single source of truth for the Study type.
*/
export declare const StudySchema: z.ZodObject<{
protocolSection: z.ZodOptional<z.ZodObject<{
identificationModule: z.ZodOptional<z.ZodObject<{
nctId: z.ZodString;
orgStudyIdInfo: z.ZodOptional<z.ZodObject<{
id: z.ZodString;
}, "strip", z.ZodTypeAny, {
id: string;
}, {
id: string;
}>>;
organization: z.ZodOptional<z.ZodObject<{
fullName: z.ZodString;
class: z.ZodString;
}, "strip", z.ZodTypeAny, {
class: string;
fullName: string;
}, {
class: string;
fullName: string;
}>>;
briefTitle: z.ZodOptional<z.ZodString>;
officialTitle: z.ZodOptional<z.ZodString>;
acronym: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
}, {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
}>>;
statusModule: z.ZodOptional<z.ZodObject<{
overallStatus: z.ZodOptional<z.ZodString>;
lastKnownStatus: z.ZodOptional<z.ZodString>;
startDateStruct: z.ZodOptional<z.ZodObject<{
date: z.ZodString;
type: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
date: string;
type?: string | undefined;
}, {
date: string;
type?: string | undefined;
}>>;
primaryCompletionDateStruct: z.ZodOptional<z.ZodObject<{
date: z.ZodString;
type: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
date: string;
type?: string | undefined;
}, {
date: string;
type?: string | undefined;
}>>;
completionDateStruct: z.ZodOptional<z.ZodObject<{
date: z.ZodString;
type: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
date: string;
type?: string | undefined;
}, {
date: string;
type?: string | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
}, {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
}>>;
sponsorCollaboratorsModule: z.ZodOptional<z.ZodObject<{
responsibleParty: z.ZodOptional<z.ZodObject<{
type: z.ZodString;
}, "strip", z.ZodTypeAny, {
type: string;
}, {
type: string;
}>>;
leadSponsor: z.ZodOptional<z.ZodObject<{
name: z.ZodString;
class: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
class: string;
}, {
name: string;
class: string;
}>>;
collaborators: z.ZodOptional<z.ZodArray<z.ZodObject<{
name: z.ZodString;
class: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
class: string;
}, {
name: string;
class: string;
}>, "many">>;
}, "strip", z.ZodTypeAny, {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
}, {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
}>>;
descriptionModule: z.ZodOptional<z.ZodObject<{
briefSummary: z.ZodOptional<z.ZodString>;
detailedDescription: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
}, {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
}>>;
conditionsModule: z.ZodOptional<z.ZodObject<{
conditions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
}, "strip", z.ZodTypeAny, {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
}, {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
}>>;
armsInterventionsModule: z.ZodOptional<z.ZodObject<{
arms: z.ZodOptional<z.ZodArray<z.ZodObject<{
name: z.ZodString;
type: z.ZodString;
description: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
type: string;
name: string;
description?: string | undefined;
}, {
type: string;
name: string;
description?: string | undefined;
}>, "many">>;
interventions: z.ZodOptional<z.ZodArray<z.ZodObject<{
type: z.ZodString;
name: z.ZodString;
description: z.ZodOptional<z.ZodString>;
armNames: z.ZodArray<z.ZodString, "many">;
}, "strip", z.ZodTypeAny, {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}, {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}>, "many">>;
}, "strip", z.ZodTypeAny, {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
}, {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
}>>;
designModule: z.ZodOptional<z.ZodObject<{
studyType: z.ZodOptional<z.ZodString>;
phases: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
designInfo: z.ZodOptional<z.ZodObject<{
allocation: z.ZodOptional<z.ZodString>;
interventionModel: z.ZodOptional<z.ZodString>;
primaryPurpose: z.ZodOptional<z.ZodString>;
maskingInfo: z.ZodOptional<z.ZodObject<{
masking: z.ZodString;
}, "strip", z.ZodTypeAny, {
masking: string;
}, {
masking: string;
}>>;
}, "strip", z.ZodTypeAny, {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
}, {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
}, {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
}>>;
contactsLocationsModule: z.ZodOptional<z.ZodObject<{
locations: z.ZodOptional<z.ZodArray<z.ZodObject<{
city: z.ZodOptional<z.ZodString>;
state: z.ZodOptional<z.ZodString>;
country: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}, {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}>, "many">>;
}, "strip", z.ZodTypeAny, {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
}, {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
identificationModule?: {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
} | undefined;
statusModule?: {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
} | undefined;
sponsorCollaboratorsModule?: {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
} | undefined;
descriptionModule?: {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
} | undefined;
conditionsModule?: {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
} | undefined;
armsInterventionsModule?: {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
} | undefined;
designModule?: {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
} | undefined;
contactsLocationsModule?: {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
} | undefined;
}, {
identificationModule?: {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
} | undefined;
statusModule?: {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
} | undefined;
sponsorCollaboratorsModule?: {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
} | undefined;
descriptionModule?: {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
} | undefined;
conditionsModule?: {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
} | undefined;
armsInterventionsModule?: {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
} | undefined;
designModule?: {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
} | undefined;
contactsLocationsModule?: {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
} | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
protocolSection?: {
identificationModule?: {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
} | undefined;
statusModule?: {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
} | undefined;
sponsorCollaboratorsModule?: {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
} | undefined;
descriptionModule?: {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
} | undefined;
conditionsModule?: {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
} | undefined;
armsInterventionsModule?: {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
} | undefined;
designModule?: {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
} | undefined;
contactsLocationsModule?: {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
} | undefined;
} | undefined;
}, {
protocolSection?: {
identificationModule?: {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
} | undefined;
statusModule?: {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
} | undefined;
sponsorCollaboratorsModule?: {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
} | undefined;
descriptionModule?: {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
} | undefined;
conditionsModule?: {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
} | undefined;
armsInterventionsModule?: {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
} | undefined;
designModule?: {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
} | undefined;
contactsLocationsModule?: {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
} | undefined;
} | undefined;
}>;
/**
* Represents a single clinical study, based on the ClinicalTrials.gov API structure.
* This type is inferred from the StudySchema to ensure consistency.
*/
export type Study = z.infer<typeof StudySchema>;
/**
* Zod schema for a paged list of studies.
*/
export declare const PagedStudiesSchema: z.ZodObject<{
studies: z.ZodArray<z.ZodObject<{
protocolSection: z.ZodOptional<z.ZodObject<{
identificationModule: z.ZodOptional<z.ZodObject<{
nctId: z.ZodString;
orgStudyIdInfo: z.ZodOptional<z.ZodObject<{
id: z.ZodString;
}, "strip", z.ZodTypeAny, {
id: string;
}, {
id: string;
}>>;
organization: z.ZodOptional<z.ZodObject<{
fullName: z.ZodString;
class: z.ZodString;
}, "strip", z.ZodTypeAny, {
class: string;
fullName: string;
}, {
class: string;
fullName: string;
}>>;
briefTitle: z.ZodOptional<z.ZodString>;
officialTitle: z.ZodOptional<z.ZodString>;
acronym: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
}, {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
}>>;
statusModule: z.ZodOptional<z.ZodObject<{
overallStatus: z.ZodOptional<z.ZodString>;
lastKnownStatus: z.ZodOptional<z.ZodString>;
startDateStruct: z.ZodOptional<z.ZodObject<{
date: z.ZodString;
type: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
date: string;
type?: string | undefined;
}, {
date: string;
type?: string | undefined;
}>>;
primaryCompletionDateStruct: z.ZodOptional<z.ZodObject<{
date: z.ZodString;
type: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
date: string;
type?: string | undefined;
}, {
date: string;
type?: string | undefined;
}>>;
completionDateStruct: z.ZodOptional<z.ZodObject<{
date: z.ZodString;
type: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
date: string;
type?: string | undefined;
}, {
date: string;
type?: string | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
}, {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
}>>;
sponsorCollaboratorsModule: z.ZodOptional<z.ZodObject<{
responsibleParty: z.ZodOptional<z.ZodObject<{
type: z.ZodString;
}, "strip", z.ZodTypeAny, {
type: string;
}, {
type: string;
}>>;
leadSponsor: z.ZodOptional<z.ZodObject<{
name: z.ZodString;
class: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
class: string;
}, {
name: string;
class: string;
}>>;
collaborators: z.ZodOptional<z.ZodArray<z.ZodObject<{
name: z.ZodString;
class: z.ZodString;
}, "strip", z.ZodTypeAny, {
name: string;
class: string;
}, {
name: string;
class: string;
}>, "many">>;
}, "strip", z.ZodTypeAny, {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
}, {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
}>>;
descriptionModule: z.ZodOptional<z.ZodObject<{
briefSummary: z.ZodOptional<z.ZodString>;
detailedDescription: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
}, {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
}>>;
conditionsModule: z.ZodOptional<z.ZodObject<{
conditions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
}, "strip", z.ZodTypeAny, {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
}, {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
}>>;
armsInterventionsModule: z.ZodOptional<z.ZodObject<{
arms: z.ZodOptional<z.ZodArray<z.ZodObject<{
name: z.ZodString;
type: z.ZodString;
description: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
type: string;
name: string;
description?: string | undefined;
}, {
type: string;
name: string;
description?: string | undefined;
}>, "many">>;
interventions: z.ZodOptional<z.ZodArray<z.ZodObject<{
type: z.ZodString;
name: z.ZodString;
description: z.ZodOptional<z.ZodString>;
armNames: z.ZodArray<z.ZodString, "many">;
}, "strip", z.ZodTypeAny, {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}, {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}>, "many">>;
}, "strip", z.ZodTypeAny, {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
}, {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
}>>;
designModule: z.ZodOptional<z.ZodObject<{
studyType: z.ZodOptional<z.ZodString>;
phases: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
designInfo: z.ZodOptional<z.ZodObject<{
allocation: z.ZodOptional<z.ZodString>;
interventionModel: z.ZodOptional<z.ZodString>;
primaryPurpose: z.ZodOptional<z.ZodString>;
maskingInfo: z.ZodOptional<z.ZodObject<{
masking: z.ZodString;
}, "strip", z.ZodTypeAny, {
masking: string;
}, {
masking: string;
}>>;
}, "strip", z.ZodTypeAny, {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
}, {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
}, {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
}>>;
contactsLocationsModule: z.ZodOptional<z.ZodObject<{
locations: z.ZodOptional<z.ZodArray<z.ZodObject<{
city: z.ZodOptional<z.ZodString>;
state: z.ZodOptional<z.ZodString>;
country: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}, {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}>, "many">>;
}, "strip", z.ZodTypeAny, {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
}, {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
identificationModule?: {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
} | undefined;
statusModule?: {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
} | undefined;
sponsorCollaboratorsModule?: {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
} | undefined;
descriptionModule?: {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
} | undefined;
conditionsModule?: {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
} | undefined;
armsInterventionsModule?: {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
} | undefined;
designModule?: {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
} | undefined;
contactsLocationsModule?: {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
} | undefined;
}, {
identificationModule?: {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
} | undefined;
statusModule?: {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
} | undefined;
sponsorCollaboratorsModule?: {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
} | undefined;
descriptionModule?: {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
} | undefined;
conditionsModule?: {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
} | undefined;
armsInterventionsModule?: {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
} | undefined;
designModule?: {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
} | undefined;
contactsLocationsModule?: {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
} | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
protocolSection?: {
identificationModule?: {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
} | undefined;
statusModule?: {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
} | undefined;
sponsorCollaboratorsModule?: {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
} | undefined;
descriptionModule?: {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
} | undefined;
conditionsModule?: {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
} | undefined;
armsInterventionsModule?: {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
} | undefined;
designModule?: {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
} | undefined;
contactsLocationsModule?: {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
} | undefined;
} | undefined;
}, {
protocolSection?: {
identificationModule?: {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
} | undefined;
statusModule?: {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
} | undefined;
sponsorCollaboratorsModule?: {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
} | undefined;
descriptionModule?: {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
} | undefined;
conditionsModule?: {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
} | undefined;
armsInterventionsModule?: {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
} | undefined;
designModule?: {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
} | undefined;
contactsLocationsModule?: {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
} | undefined;
} | undefined;
}>, "many">;
nextPageToken: z.ZodOptional<z.ZodString>;
totalCount: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
studies: {
protocolSection?: {
identificationModule?: {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
} | undefined;
statusModule?: {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
} | undefined;
sponsorCollaboratorsModule?: {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
} | undefined;
descriptionModule?: {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
} | undefined;
conditionsModule?: {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
} | undefined;
armsInterventionsModule?: {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
} | undefined;
designModule?: {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
} | undefined;
contactsLocationsModule?: {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
} | undefined;
} | undefined;
}[];
nextPageToken?: string | undefined;
totalCount?: number | undefined;
}, {
studies: {
protocolSection?: {
identificationModule?: {
nctId: string;
orgStudyIdInfo?: {
id: string;
} | undefined;
organization?: {
class: string;
fullName: string;
} | undefined;
briefTitle?: string | undefined;
officialTitle?: string | undefined;
acronym?: string | undefined;
} | undefined;
statusModule?: {
overallStatus?: string | undefined;
lastKnownStatus?: string | undefined;
startDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
primaryCompletionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
completionDateStruct?: {
date: string;
type?: string | undefined;
} | undefined;
} | undefined;
sponsorCollaboratorsModule?: {
responsibleParty?: {
type: string;
} | undefined;
leadSponsor?: {
name: string;
class: string;
} | undefined;
collaborators?: {
name: string;
class: string;
}[] | undefined;
} | undefined;
descriptionModule?: {
briefSummary?: string | undefined;
detailedDescription?: string | undefined;
} | undefined;
conditionsModule?: {
conditions?: string[] | undefined;
keywords?: string[] | undefined;
} | undefined;
armsInterventionsModule?: {
arms?: {
type: string;
name: string;
description?: string | undefined;
}[] | undefined;
interventions?: {
type: string;
name: string;
armNames: string[];
description?: string | undefined;
}[] | undefined;
} | undefined;
designModule?: {
studyType?: string | undefined;
phases?: string[] | undefined;
designInfo?: {
allocation?: string | undefined;
interventionModel?: string | undefined;
primaryPurpose?: string | undefined;
maskingInfo?: {
masking: string;
} | undefined;
} | undefined;
} | undefined;
contactsLocationsModule?: {
locations?: {
city?: string | undefined;
state?: string | undefined;
country?: string | undefined;
}[] | undefined;
} | undefined;
} | undefined;
}[];
nextPageToken?: string | undefined;
totalCount?: number | undefined;
}>;
/**
* Represents a paged list of studies.
*/
export type PagedStudies = z.infer<typeof PagedStudiesSchema>;
/**
* Represents a node in the study data model tree.
*/
export interface FieldNode {
name: string;
type: string;
description: string;
children?: FieldNode[];
}
/**
* Represents the possible status values for a study.
*/
export declare enum Status {
ActiveNotRecruiting = "ACTIVE_NOT_RECRUITING",
Completed = "COMPLETED",
EnrollingByInvitation = "ENROLLING_BY_INVITATION",
NotYetRecruiting = "NOT_YET_RECRUITING",
Recruiting = "RECRUITING",
Suspended = "SUSPENDED",
Terminated = "TERMINATED",
Withdrawn = "WITHDRAWN",
Unknown = "UNKNOWN"
}