# ResearchDefinition

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

The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.

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/ResearchDefinition/[id]` |
| Vread | `GET` | `/fhir/R4/ResearchDefinition/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/ResearchDefinition/[id]` |
| Patch | `PATCH` | `/fhir/R4/ResearchDefinition/[id]` |
| Delete | `DELETE` | `/fhir/R4/ResearchDefinition/[id]` |
| Create | `POST` | `/fhir/R4/ResearchDefinition` |
| Search | `GET` | `/fhir/R4/ResearchDefinition` |
| History | `GET` | `/fhir/R4/ResearchDefinition/[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-url"></span>`url` | [uri](/fhir-elements/primitive/uri) | `0..1` | Canonical identifier for this research definition, represented as a URI (globally unique) |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Additional identifier for the research definition |
| <span id="element-version"></span>`version` | [string](/fhir-elements/primitive/string) | `0..1` | Business version of the research definition |
| <span id="element-name"></span>`name` | [string](/fhir-elements/primitive/string) | `0..1` | Name for this research definition (computer friendly) |
| <span id="element-title"></span>`title` | [string](/fhir-elements/primitive/string) | `0..1` | Name for this research definition (human friendly) |
| <span id="element-short-title"></span>`shortTitle` | [string](/fhir-elements/primitive/string) | `0..1` | Title for use in informal contexts |
| <span id="element-subtitle"></span>`subtitle` | [string](/fhir-elements/primitive/string) | `0..1` | Subordinate title of the ResearchDefinition |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | draft \| active \| retired \| unknown |
| <span id="element-experimental"></span>`experimental` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | For testing purposes, not real usage |
| <span id="element-subject-x"></span>`subject[x]` | [CodeableConcept](/fhir-elements/complex/codeable-concept), [Reference](/fhir-elements/complex/reference) | `0..1` | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device |
| <span id="element-date"></span>`date` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Date last changed |
| <span id="element-publisher"></span>`publisher` | [string](/fhir-elements/primitive/string) | `0..1` | Name of the publisher (organization or individual) |
| <span id="element-contact"></span>`contact` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Contact details for the publisher |
| <span id="element-description"></span>`description` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Natural language description of the research definition |
| <span id="element-comment"></span>`comment` | [string](/fhir-elements/primitive/string) | `0..*` | Used for footnotes or explanatory notes |
| <span id="element-use-context"></span>`useContext` | [UsageContext](/fhir-elements/complex/usage-context) | `0..*` | The context that the content is intended to support |
| <span id="element-jurisdiction"></span>`jurisdiction` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Intended jurisdiction for research definition (if applicable) |
| <span id="element-purpose"></span>`purpose` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Why this research definition is defined |
| <span id="element-usage"></span>`usage` | [string](/fhir-elements/primitive/string) | `0..1` | Describes the clinical usage of the ResearchDefinition |
| <span id="element-copyright"></span>`copyright` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Use and/or publishing restrictions |
| <span id="element-approval-date"></span>`approvalDate` | [date](/fhir-elements/primitive/date) | `0..1` | When the research definition was approved by publisher |
| <span id="element-last-review-date"></span>`lastReviewDate` | [date](/fhir-elements/primitive/date) | `0..1` | When the research definition was last reviewed |
| <span id="element-effective-period"></span>`effectivePeriod` | [Period](/fhir-elements/complex/period) | `0..1` | When the research definition is expected to be used |
| <span id="element-topic"></span>`topic` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc. |
| <span id="element-author"></span>`author` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who authored the content |
| <span id="element-editor"></span>`editor` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who edited the content |
| <span id="element-reviewer"></span>`reviewer` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who reviewed the content |
| <span id="element-endorser"></span>`endorser` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who endorsed the content |
| <span id="element-related-artifact"></span>`relatedArtifact` | [RelatedArtifact](/fhir-elements/complex/related-artifact) | `0..*` | Additional documentation, citations, etc. |
| <span id="element-library"></span>`library` | [canonical](/fhir-elements/primitive/canonical) | `0..*` | Logic used by the ResearchDefinition |
| <span id="element-population"></span>`population` | [Reference](/fhir-elements/complex/reference) | `1..1` | What population? |
| <span id="element-exposure"></span>`exposure` | [Reference](/fhir-elements/complex/reference) | `0..1` | What exposure? |
| <span id="element-exposure-alternative"></span>`exposureAlternative` | [Reference](/fhir-elements/complex/reference) | `0..1` | What alternative exposure state? |
| <span id="element-outcome"></span>`outcome` | [Reference](/fhir-elements/complex/reference) | `0..1` | What outcome? |

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

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `composed-of` | reference | What resource is being referenced |
| `context` | token | A use context assigned to the research definition |
| `context-quantity` | quantity | A quantity- or range-valued use context assigned to the research definition |
| `context-type` | token | A type of use context assigned to the research definition |
| `context-type-quantity` | composite | A use context type and quantity- or range-based value assigned to the research definition |
| `context-type-value` | composite | A use context type and value assigned to the research definition |
| `date` | date | The research definition publication date |
| `depends-on` | reference | What resource is being referenced |
| `derived-from` | reference | What resource is being referenced |
| `description` | string | The description of the research definition |
| `effective` | date | The time during which the research definition is intended to be in use |
| `identifier` | token | External identifier for the research definition |
| `jurisdiction` | token | Intended jurisdiction for the research definition |
| `name` | string | Computationally friendly name of the research definition |
| `predecessor` | reference | What resource is being referenced |
| `publisher` | string | Name of the publisher of the research definition |
| `status` | token | The current status of the research definition |
| `successor` | reference | What resource is being referenced |
| `title` | string | The human-friendly name of the research definition |
| `topic` | token | Topics associated with the ResearchDefinition |
| `url` | uri | The uri that identifies the research definition |
| `version` | token | The business version of the research definition |

## Reference [#reference]

Official FHIR R4 spec: [ResearchDefinition](https://hl7.org/fhir/R4/researchdefinition.html).  
Maturity: Draft (FMM 0).
