# ResearchStudy

Canonical page: https://docs.ovok.com/api/fhir/r4/research-study

A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/ResearchStudy/[id]` |
| Vread | `GET` | `/fhir/R4/ResearchStudy/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/ResearchStudy/[id]` |
| Patch | `PATCH` | `/fhir/R4/ResearchStudy/[id]` |
| Delete | `DELETE` | `/fhir/R4/ResearchStudy/[id]` |
| Create | `POST` | `/fhir/R4/ResearchStudy` |
| Search | `GET` | `/fhir/R4/ResearchStudy` |
| History | `GET` | `/fhir/R4/ResearchStudy/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Business Identifier for study |
| <span id="element-title"></span>`title` | [string](/fhir-elements/primitive/string) | `0..1` | Name for this study |
| <span id="element-protocol"></span>`protocol` | [Reference](/fhir-elements/complex/reference) | `0..*` | Steps followed in executing study |
| <span id="element-part-of"></span>`partOf` | [Reference](/fhir-elements/complex/reference) | `0..*` | Part of larger study |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | 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 |
| <span id="element-primary-purpose-type"></span>`primaryPurposeType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | treatment \| prevention \| diagnostic \| supportive-care \| screening \| health-services-research \| basic-science \| device-feasibility |
| <span id="element-phase"></span>`phase` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | n-a \| early-phase-1 \| phase-1 \| phase-1-phase-2 \| phase-2 \| phase-2-phase-3 \| phase-3 \| phase-4 |
| <span id="element-category"></span>`category` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Classifications for the study |
| <span id="element-focus"></span>`focus` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Drugs, devices, etc. under study |
| <span id="element-condition"></span>`condition` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Condition being studied |
| <span id="element-contact"></span>`contact` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Contact details for the study |
| <span id="element-related-artifact"></span>`relatedArtifact` | [RelatedArtifact](/fhir-elements/complex/related-artifact) | `0..*` | References and dependencies |
| <span id="element-keyword"></span>`keyword` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Used to search for the study |
| <span id="element-location"></span>`location` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Geographic region(s) for study |
| <span id="element-description"></span>`description` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | What this is study doing |
| <span id="element-enrollment"></span>`enrollment` | [Reference](/fhir-elements/complex/reference) | `0..*` | Inclusion & exclusion criteria |
| <span id="element-period"></span>`period` | [Period](/fhir-elements/complex/period) | `0..1` | When the study began and ended |
| <span id="element-sponsor"></span>`sponsor` | [Reference](/fhir-elements/complex/reference) | `0..1` | Organization that initiates and is legally responsible for the study |
| <span id="element-principal-investigator"></span>`principalInvestigator` | [Reference](/fhir-elements/complex/reference) | `0..1` | Researcher who oversees multiple aspects of the study |
| <span id="element-site"></span>`site` | [Reference](/fhir-elements/complex/reference) | `0..*` | Facility where study activities are conducted |
| <span id="element-reason-stopped"></span>`reasonStopped` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | accrual-goal-met \| closed-due-to-toxicity \| closed-due-to-lack-of-study-progress \| temporarily-closed-per-study-design |
| <span id="element-note"></span>`note` | [Annotation](/fhir-elements/complex/annotation) | `0..*` | Comments made about the study |
| <span id="element-arm"></span>`arm` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Defined path through the study for a subject |
| <span id="element-objective"></span>`objective` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | A goal for the study |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `category` | token | Classifications for the study |
| `date` | date | When the study began and ended |
| `focus` | token | Drugs, devices, etc. under study |
| `identifier` | token | Business Identifier for study |
| `keyword` | token | Used to search for the study |
| `location` | token | Geographic region(s) for study |
| `partof` | reference | Part of larger study |
| `principalinvestigator` | reference | Researcher who oversees multiple aspects of the study |
| `protocol` | reference | Steps followed in executing study |
| `site` | reference | Facility where study activities are conducted |
| `sponsor` | reference | Organization that initiates and is legally responsible for the study |
| `status` | token | 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 |
| `title` | string | Name for this study |

## Reference [#reference]

Official FHIR R4 spec: [ResearchStudy](https://hl7.org/fhir/R4/researchstudy.html).  
Maturity: Trial Use 1 (FMM 1).
