ResearchStudy - FHIR Resource (r4)


This ResearchStudy Resource uses the FHIR API standard for access and structure.

Validate an ResearchStudy FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
armtrueData Type# Defined path through the study for a subject
categorytrueCodeableConcept# Classifications for the study
conditiontrueCodeableConcept# Condition being studied
contacttrueContactDetail# Contact details for the study
descriptionfalsemarkdown# What this is study doing
enrollmenttrueReference# Inclusion & exclusion criteria
focustrueCodeableConcept# Drugs, devices, etc. under study
identifiertrueIdentifier# Business Identifier for study
keywordtrueCodeableConcept# Used to search for the study
locationtrueCodeableConcept# Geographic region(s) for study
notetrueAnnotation# Comments made about the study
objectivetrueData Type# A goal for the study
partOftrueReference# Part of larger study
periodfalsePeriod# When the study began and ended
phasefalseCodeableConcept# n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4
primaryPurposeTypefalseCodeableConcept# treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility
principalInvestigatorfalseReference# Researcher who oversees multiple aspects of the study
protocoltrueReference# Steps followed in executing study
reasonStoppedfalseCodeableConcept# accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design
relatedArtifacttrueRelatedArtifact# References and dependencies
sitetrueReference# Facility where study activities are conducted
sponsorfalseReference# Organization that initiates and is legally responsible for the study
statusfalsecode# active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn
titlefalsestring# Name for this study

ResearchStudy Example

{
  "resourceType": "ResearchStudy",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>"
  },
  "status": "completed"
}

ResearchStudy Structure

{
  "resourceType" : "ResearchStudy",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier for study
  "title" : "<string>", // Name for this study
  "protocol" : [{ Reference(PlanDefinition) }], // Steps followed in executing study
  "partOf" : [{ Reference(ResearchStudy) }], // Part of larger study
  "status" : "<code>", // R!  active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn
  "primaryPurposeType" : { CodeableConcept }, // treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility
  "phase" : { CodeableConcept }, // n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4
  "category" : [{ CodeableConcept }], // Classifications for the study
  "focus" : [{ CodeableConcept }], // Drugs, devices, etc. under study
  "condition" : [{ CodeableConcept }], // Condition being studied
  "contact" : [{ ContactDetail }], // Contact details for the study
  "relatedArtifact" : [{ RelatedArtifact }], // References and dependencies
  "keyword" : [{ CodeableConcept }], // Used to search for the study
  "location" : [{ CodeableConcept }], // Geographic region(s) for study
  "description" : "<markdown>", // What this is study doing
  "enrollment" : [{ Reference(Group) }], // Inclusion & exclusion criteria
  "period" : { Period }, // When the study began and ended
  "sponsor" : { Reference(Organization) }, // Organization that initiates and is legally responsible for the study
  "principalInvestigator" : { Reference(Practitioner|PractitionerRole) }, // Researcher who oversees multiple aspects of the study
  "site" : [{ Reference(Location) }], // Facility where study activities are conducted
  "reasonStopped" : { CodeableConcept }, // accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design
  "note" : [{ Annotation }], // Comments made about the study
  "arm" : [{ // Defined path through the study for a subject
    "name" : "<string>", // R!  Label for study arm
    "type" : { CodeableConcept }, // Categorization of study arm
    "description" : "<string>" // Short explanation of study path
  }],
  "objective" : [{ // A goal for the study
    "name" : "<string>", // Label for the objective
    "type" : { CodeableConcept } // primary | secondary | exploratory
  }]
}

ResearchStudy Search Parameters

The following search parameters can be used to query ResearchStudy resources. Just submit them like so:

https://api.1up.health/fhir/r4/ResearchStudy?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
categorytextcategory
datedateperiod
focustextfocus
identifiertextidentifier
keywordtextkeyword
locationtextlocation
partofreferencepartOf
principalinvestigatorreferenceprincipalInvestigator
protocolreferenceprotocol
sitereferencesite
sponsorreferencesponsor
statustextstatus
titletexttitle