Skip to main content

getStudyById

Get details about a research study given its id. The study must have been added by the caller's organization.

Path Parameters
id string — REQUIRED

Study Id

Responses
200

Study details object

Schema — OPTIONAL
id string
addedByOrganization object
owner object
status string

Possible values: [DRAFT, ACTIVE, COMPLETED, WITHDRAWN]

lastActivity object — OPTIONAL
lastActivityUser object — OPTIONAL
paused object — OPTIONAL
pauseReason object — OPTIONAL
studyVersionId string
versionName object — OPTIONAL
versionStatus string

Possible values: [DRAFT, ACTIVE]

title object — OPTIONAL
studyType string

Possible values: [INTERVENTIONAL, REGISTRY, OTHER]

briefSummary object — OPTIONAL
studyIdentifier object — OPTIONAL
webpageLink object — OPTIONAL
sponsorOrganizationName object — OPTIONAL
sponsorOrganizationCategory object — OPTIONAL
funderType array[] — OPTIONAL
fullRecordWithoutRestrictedData object — OPTIONAL
consentDataResourceScopes array[]
consentDataSensitivityScopes array[]
selectedLanguages array[] — OPTIONAL
description object — OPTIONAL
clinicalTrialPhase object — OPTIONAL
primaryDiseaseOrConditions string[] — OPTIONAL
outcomes object — OPTIONAL
targetNumberOfPatients object — OPTIONAL
inclusionExclusionCriteria object — OPTIONAL
startDate object — OPTIONAL
primaryCompletionDate object — OPTIONAL
completionDate object — OPTIONAL
sponsorPrimaryContactName object — OPTIONAL
sponsorPrimaryContactTitle object — OPTIONAL
sponsorPrimaryContactEmail object — OPTIONAL
sponsorPrimaryContactPhone object — OPTIONAL
sponsorPrimaryContactPhoneExt object — OPTIONAL
investigatorAffiliation object — OPTIONAL
accessData string

Possible values: [FULL_RECORD_IDENTIFIED, FULL_RECORD_DEIDENTIFIED]

isSponsor object — OPTIONAL
importMethod object — OPTIONAL
interventions array[] — OPTIONAL
patientEnrollmentUrl string — OPTIONAL
sitePrimaryContactName object — OPTIONAL
sitePrimaryContactTitle object — OPTIONAL
sitePrimaryContactEmail object — OPTIONAL
sitePrimaryContactPhone object — OPTIONAL
sitePrimaryContactPhoneExt object — OPTIONAL
sitePrimaryContactLink object — OPTIONAL
visitedPages array[] — OPTIONAL
visitedSections array[] — OPTIONAL
protocolNumber object — OPTIONAL
require21CFRPart11ForInformedConsents object — OPTIONAL
patientFriendlyTitle object — OPTIONAL
patientFriendlySummary object — OPTIONAL
purposeOfResearchText object — OPTIONAL
purposeOfResearchEnabled object — OPTIONAL
risksOfEnrollment object — OPTIONAL
benefitsOfEnrollment object — OPTIONAL
proceduresAndInterventionsText object — OPTIONAL
timelineVisitsEnabled object — OPTIONAL
timelineVisits array[] — OPTIONAL
alternativeProceduresAndTreatments object — OPTIONAL
injuryProtocolText object — OPTIONAL
leavingStudyEarlyEnabled object — OPTIONAL
leavingStudyEarlyText object — OPTIONAL
participationTerminationEnabled object — OPTIONAL
participationTerminationText object — OPTIONAL
futureUseOfDataEnabled object — OPTIONAL
futureUseOfData object — OPTIONAL
futureUseOfDataText object — OPTIONAL
confidentialityOfDataText object — OPTIONAL
compensation object — OPTIONAL
compensationText object — OPTIONAL
costOfParticipationEnabled object — OPTIONAL
costOfParticipationText object — OPTIONAL
sharingResultsEnabled object — OPTIONAL
sharingResultsText object — OPTIONAL
rightToBeContactedByResearcher object — OPTIONAL
icfImportMethod object — OPTIONAL
icfFileName object — OPTIONAL
studyProtocolFileName object — OPTIONAL
lastSkippedGenaiInputHash object — OPTIONAL
genaiInputHash object — OPTIONAL
hipaaAuthorizationFormUrl object — OPTIONAL
hipaaAuthorizationTemplateEnabled object — OPTIONAL
hipaaAuthorizationText object — OPTIONAL
patientMRNOnInformedConsent object — OPTIONAL
orgLogoUrlOnInformedConsent object — OPTIONAL
additionalSections object[] — OPTIONAL
studySectionImages object[] — OPTIONAL
informedConsentSectionLocked boolean
informedConsentLockSessionId object — OPTIONAL
isCompletionDateExpired boolean
investigationType string — OPTIONAL

Possible values: [IND, IDE, NEITHER]

healthRecordsUpdatesEnabled object — OPTIONAL
healthRecordsUpdatesOnDemand object — OPTIONAL
healthRecordsUpdatesEvery object — OPTIONAL
healthRecordsUpdatesUnit string — OPTIONAL

Possible values: [DAY, WEEK]

informedConsentPrimaryDiseaseOrConditions string[] — OPTIONAL
informedConsentIRBApprovalStamp object — OPTIONAL
informedConsentStartDate object — OPTIONAL
informedConsentCompletionDate object — OPTIONAL
informedTargetNumberOfPatients object — OPTIONAL
alternativesToParticipation object — OPTIONAL
informedConsentInterested boolean — OPTIONAL
informedConsentPrimaryDiseaseOrConditionsCopied string[] — OPTIONAL
informedConsentStartDateCopied object — OPTIONAL
informedConsentCompletionDateCopied object — OPTIONAL
informedTargetNumberOfPatientsCopied object — OPTIONAL
lengthOfStudyEnabled object — OPTIONAL
informedHealthRecordUpdatesEnabled object — OPTIONAL
injuryProtocolEnabled object — OPTIONAL
interventionsEnabled object — OPTIONAL
confidentialityMeasuresEnabled object — OPTIONAL
hipaaOrganizationLegalNameConfirmed boolean — OPTIONAL
patientMRNOnParticipantSignature object — OPTIONAL
minorParticipantConsentEnabled object — OPTIONAL
additionalParentGuardianEnabled object — OPTIONAL
additionalParentGuardianExemptSignature object — OPTIONAL
minorParticipantExemptFromAssent object — OPTIONAL
larConsentEnabled object — OPTIONAL
larParticipantConsentExemptFromAssent object — OPTIONAL
requirementsUpdatedAt object — OPTIONAL
projectType string

Possible values: [GENERAL_DATA_USE, AI_DATA_USE]

projectColor object — OPTIONAL
projectIcon object — OPTIONAL
originalStudyProtocolUrl object — OPTIONAL
originalInformedConsentDocumentUrl object — OPTIONAL
suppressNotifications boolean
suppressHealthexNudges boolean
organizationIconUrl object — OPTIONAL
organizationRectangularIconUrl object — OPTIONAL
organizationHeaderLogoUrl object — OPTIONAL
hostedRedirectUrls object — OPTIONAL
patientRecordRetrievalRecencyEnabled object — OPTIONAL
patientRecordRetrievalRecencyEvery object — OPTIONAL
patientRecordRetrievalRecencyUnit string — OPTIONAL

Possible values: [DAY, WEEK, MONTH]

loginTitle object — OPTIONAL
loginText object — OPTIONAL
welcomeTitle object — OPTIONAL
welcomeText object — OPTIONAL
dataUpdateWelcomeTitle object — OPTIONAL
dataUpdateWelcomeText object — OPTIONAL
californiaBillOfRightsTitle object — OPTIONAL
californiaBillOfRightsText object — OPTIONAL
studyInformationTitle object — OPTIONAL
enrollmentVideo object — OPTIONAL
deletePrescreenTranscode object — OPTIONAL
deleteEnrollmentTranscode object — OPTIONAL
purposeOfResearchTitle object — OPTIONAL
lengthOfStudyNumberOfParticipantsTitle object — OPTIONAL
lengthOfStudyNumberOfParticipantsText object — OPTIONAL
healthRecordUpdatesTitle object — OPTIONAL
healthRecordUpdatesText object — OPTIONAL
proceduresAndInterventionsTitle object — OPTIONAL
timelineTitle object — OPTIONAL
benefitsTitle object — OPTIONAL
risksTitle object — OPTIONAL
voluntaryParticipationTitle object — OPTIONAL
voluntaryParticipationText object — OPTIONAL
withdrawalImplicationsTitle object — OPTIONAL
injuryProtocolTitle object — OPTIONAL
participationTerminationTitle object — OPTIONAL
dataTypesTitle object — OPTIONAL
sensitiveDataTitle object — OPTIONAL
sensitiveDataText object — OPTIONAL
futureUseOfDataTitle object — OPTIONAL
confidentialityMeasuresTitle object — OPTIONAL
compensationTitle object — OPTIONAL
costTitle object — OPTIONAL
researchResultsTitle object — OPTIONAL
whoToContactTitle object — OPTIONAL
whoToContactText object — OPTIONAL
informedConsentTitle object — OPTIONAL
informedConsentText object — OPTIONAL
informedConsentYesText object — OPTIONAL
informedConsentNoText object — OPTIONAL
informedConsentInterestedText object — OPTIONAL
hipaaTitle object — OPTIONAL
hipaaText object — OPTIONAL
hipaaOrganizationLegalName object — OPTIONAL
thankYouConsentedTitle object — OPTIONAL
thankYouConsentedText object — OPTIONAL
dataUpdateThankYouConsentedTitle object — OPTIONAL
dataUpdateThankYouConsentedText object — OPTIONAL
thankYouDeclinedTitle object — OPTIONAL
thankYouDeclinedText object — OPTIONAL
thankYouImInterestedTitle object — OPTIONAL
thankYouImInterestedText object — OPTIONAL
parentGuardianTitle object — OPTIONAL
parentGuardianInstructions object — OPTIONAL
parentGuardianSignatureTitle object — OPTIONAL
parentGuardianInformedConsentStatement object — OPTIONAL
additionalParentGuardianTitle object — OPTIONAL
additionalParentGuardianInstructions object — OPTIONAL
additionalParentGuardianExemptSignatureText object — OPTIONAL
additionalParentGuardianSignatureTitle object — OPTIONAL
additionalParentGuardianInformedConsentStatement object — OPTIONAL
minorParticipantTitle object — OPTIONAL
minorParticipantInstructions object — OPTIONAL
minorParticipantExemptFromAssentText object — OPTIONAL
minorParticipantAssentTitle object — OPTIONAL
minorParticipantAssentStatement object — OPTIONAL
participantTitle object — OPTIONAL
informedConsentStatement object — OPTIONAL
participantInstructionsForGuidedConsent object — OPTIONAL
larTitle object — OPTIONAL
larInstructions object — OPTIONAL
larSignatureTitle object — OPTIONAL
larInformedConsentStatement object — OPTIONAL
larParticipantTitle object — OPTIONAL
larParticipantInstructions object — OPTIONAL
larParticipantExemptFromAssentText object — OPTIONAL
larParticipantAssentTitle object — OPTIONAL
larParticipantAssentStatement object — OPTIONAL
witnessTitle object — OPTIONAL
witnessInstructions object — OPTIONAL
witnessSignatureTitle object — OPTIONAL
witnessConfirmation object — OPTIONAL
providerTitle object — OPTIONAL
providerInstructions object — OPTIONAL
providerSignatureTitle object — OPTIONAL
providerConfirmation object — OPTIONAL
enrollmentTranscodeId object — OPTIONAL
introTitle object — OPTIONAL
introPurposeOfDisclosure object — OPTIONAL
introBriefEducation object — OPTIONAL
patientHealthRecordRightsTitle object — OPTIONAL
contactDetails object — OPTIONAL
purposeOfDataTitle object — OPTIONAL
purposeOfDataDisclosure array[] — OPTIONAL
purposeOfDataDisclosureOther object — OPTIONAL
purposeOfDataBriefEducation object — OPTIONAL
aiToolName object — OPTIONAL
aiExplanationOfHealthEx object — OPTIONAL
explanationOfDataProtection object — OPTIONAL
aiExplanationOfDataUseByLegalOrg object — OPTIONAL
aiExplanationOfFees object — OPTIONAL
aiAuthToShare object — OPTIONAL
aiAuthToShareExplanation object — OPTIONAL
timeToConnectInformation object — OPTIONAL
aiToolTermsUrl object — OPTIONAL
compositeUpdatedAt object — OPTIONAL
loginTitle object — OPTIONAL
loginText object — OPTIONAL
welcomeTitle object — OPTIONAL
welcomeText object — OPTIONAL
dataUpdateWelcomeTitle object — OPTIONAL
dataUpdateWelcomeText object — OPTIONAL
californiaBillOfRightsTitle object — OPTIONAL
californiaBillOfRightsText object — OPTIONAL
studyInformationTitle object — OPTIONAL
purposeOfResearchTitle object — OPTIONAL
lengthOfStudyNumberOfParticipantsTitle object — OPTIONAL
lengthOfStudyNumberOfParticipantsText object — OPTIONAL
healthRecordUpdatesTitle object — OPTIONAL
healthRecordUpdatesText object — OPTIONAL
proceduresAndInterventionsTitle object — OPTIONAL
timelineTitle object — OPTIONAL
benefitsTitle object — OPTIONAL
risksTitle object — OPTIONAL
voluntaryParticipationTitle object — OPTIONAL
voluntaryParticipationText object — OPTIONAL
withdrawalImplicationsTitle object — OPTIONAL
injuryProtocolTitle object — OPTIONAL
participationTerminationTitle object — OPTIONAL
dataTypesTitle object — OPTIONAL
sensitiveDataTitle object — OPTIONAL
sensitiveDataText object — OPTIONAL
futureUseOfDataTitle object — OPTIONAL
confidentialityMeasuresTitle object — OPTIONAL
compensationTitle object — OPTIONAL
costTitle object — OPTIONAL
researchResultsTitle object — OPTIONAL
whoToContactTitle object — OPTIONAL
whoToContactText object — OPTIONAL
informedConsentTitle object — OPTIONAL
informedConsentText object — OPTIONAL
informedConsentYesText object — OPTIONAL
informedConsentNoText object — OPTIONAL
informedConsentInterestedText object — OPTIONAL
hipaaTitle object — OPTIONAL
hipaaText object — OPTIONAL
hipaaOrganizationLegalName object — OPTIONAL
hipaaAuthorizationText object — OPTIONAL
informedConsentStatement object — OPTIONAL
thankYouConsentedTitle object — OPTIONAL
thankYouConsentedText object — OPTIONAL
dataUpdateThankYouConsentedTitle object — OPTIONAL
dataUpdateThankYouConsentedText object — OPTIONAL
thankYouDeclinedTitle object — OPTIONAL
thankYouDeclinedText object — OPTIONAL
thankYouImInterestedTitle object — OPTIONAL
thankYouImInterestedText object — OPTIONAL
parentGuardianTitle object — OPTIONAL
parentGuardianInstructions object — OPTIONAL
parentGuardianSignatureTitle object — OPTIONAL
parentGuardianInformedConsentStatement object — OPTIONAL
additionalParentGuardianTitle object — OPTIONAL
additionalParentGuardianInstructions object — OPTIONAL
additionalParentGuardianExemptSignatureText object — OPTIONAL
additionalParentGuardianSignatureTitle object — OPTIONAL
additionalParentGuardianInformedConsentStatement object — OPTIONAL
minorParticipantTitle object — OPTIONAL
minorParticipantInstructions object — OPTIONAL
minorParticipantExemptFromAssentText object — OPTIONAL
minorParticipantAssentTitle object — OPTIONAL
minorParticipantAssentStatement object — OPTIONAL
participantTitle object — OPTIONAL
participantInstructionsForGuidedConsent object — OPTIONAL
purposeOfResearchText object — OPTIONAL
larTitle object — OPTIONAL
larInstructions object — OPTIONAL
larSignatureTitle object — OPTIONAL
larInformedConsentStatement object — OPTIONAL
larParticipantTitle object — OPTIONAL
larParticipantInstructions object — OPTIONAL
larParticipantExemptFromAssentText object — OPTIONAL
larParticipantAssentTitle object — OPTIONAL
larParticipantAssentStatement object — OPTIONAL
witnessTitle object — OPTIONAL
witnessInstructions object — OPTIONAL
witnessSignatureTitle object — OPTIONAL
witnessConfirmation object — OPTIONAL
providerTitle object — OPTIONAL
providerInstructions object — OPTIONAL
providerSignatureTitle object — OPTIONAL
providerConfirmation object — OPTIONAL
proceduresAndInterventionsText object — OPTIONAL
informedConsentPrimaryDiseaseOrConditions object — OPTIONAL
patientFriendlyTitle object — OPTIONAL
patientFriendlySummary object — OPTIONAL
informedConsentIRBApprovalStamp object — OPTIONAL
risksOfEnrollment object — OPTIONAL
benefitsOfEnrollment object — OPTIONAL
leavingStudyEarlyText object — OPTIONAL
injuryProtocolText object — OPTIONAL
participationTerminationText object — OPTIONAL
futureUseOfData object — OPTIONAL
futureUseOfDataText object — OPTIONAL
confidentialityOfDataText object — OPTIONAL
compensationText object — OPTIONAL
costOfParticipationText object — OPTIONAL
sharingResultsText object — OPTIONAL
alternativesToParticipation object — OPTIONAL
timelineVisitPeriods object — OPTIONAL
timelineVisitDescriptions object — OPTIONAL
introTitle object — OPTIONAL
introPurposeOfDisclosure object — OPTIONAL
introBriefEducation object — OPTIONAL
patientHealthRecordRightsTitle object — OPTIONAL
contactDetails object — OPTIONAL
purposeOfDataTitle object — OPTIONAL
purposeOfDataBriefEducation object — OPTIONAL
aiToolName object — OPTIONAL
aiExplanationOfHealthEx object — OPTIONAL
explanationOfDataProtection object — OPTIONAL
aiExplanationOfDataUseByLegalOrg object — OPTIONAL
aiExplanationOfFees object — OPTIONAL
aiAuthToShare object — OPTIONAL
aiAuthToShareExplanation object — OPTIONAL
timeToConnectInformation object — OPTIONAL
aiToolTermsUrl object — OPTIONAL
aiToolIcon object — OPTIONAL
productUrl object — OPTIONAL
aiChatbotUrl object — OPTIONAL

Deprecated alias for productUrl.

aiSharingUrl object — OPTIONAL
returnToPartnerLabel object — OPTIONAL
aiToolIcon object — OPTIONAL
productUrl object — OPTIONAL
aiChatbotUrl object — OPTIONAL

Deprecated alias for productUrl.

aiSharingUrl object — OPTIONAL
returnToPartnerLabel object — OPTIONAL
accessibleHealthcareOrganizations array[]
createdAt date-time
lastUpdated object — OPTIONAL
firstActivatedAt object — OPTIONAL
versionLastUpdated object — OPTIONAL
icfTextSegments object[] — OPTIONAL
pdda boolean
hasDraftVersion boolean