# ResearchSubject

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

A physical entity which is the primary unit of operational and/or administrative interest in a study.

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/ResearchSubject/[id]` |
| Vread | `GET` | `/fhir/R4/ResearchSubject/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/ResearchSubject/[id]` |
| Patch | `PATCH` | `/fhir/R4/ResearchSubject/[id]` |
| Delete | `DELETE` | `/fhir/R4/ResearchSubject/[id]` |
| Create | `POST` | `/fhir/R4/ResearchSubject` |
| Search | `GET` | `/fhir/R4/ResearchSubject` |
| History | `GET` | `/fhir/R4/ResearchSubject/[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 research subject in a study |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | candidate \| eligible \| follow-up \| ineligible \| not-registered \| off-study \| on-study \| on-study-intervention \| on-study-observation \| pending-on-study \| potential-candidate \| screening \| withdrawn |
| <span id="element-period"></span>`period` | [Period](/fhir-elements/complex/period) | `0..1` | Start and end of participation |
| <span id="element-study"></span>`study` | [Reference](/fhir-elements/complex/reference) | `1..1` | Study subject is part of |
| <span id="element-individual"></span>`individual` | [Reference](/fhir-elements/complex/reference) | `1..1` | Who is part of study |
| <span id="element-assigned-arm"></span>`assignedArm` | [string](/fhir-elements/primitive/string) | `0..1` | What path should be followed |
| <span id="element-actual-arm"></span>`actualArm` | [string](/fhir-elements/primitive/string) | `0..1` | What path was followed |
| <span id="element-consent"></span>`consent` | [Reference](/fhir-elements/complex/reference) | `0..1` | Agreement to participate in study |

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

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `date` | date | Start and end of participation |
| `identifier` | token | Business Identifier for research subject in a study |
| `individual` | reference | Who is part of study |
| `patient` | reference | Who is part of study |
| `status` | token | candidate \| eligible \| follow-up \| ineligible \| not-registered \| off-study \| on-study \| on-study-intervention \| on-study-observation \| pending-on-study \| potential-candidate \| screening \| withdrawn |
| `study` | reference | Study subject is part of |

## Reference [#reference]

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