ResearchDefinition
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
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
url | uri | 0..1 | Canonical identifier for this research definition, represented as a URI (globally unique) |
identifier | Identifier | 0..* | Additional identifier for the research definition |
version | string | 0..1 | Business version of the research definition |
name | string | 0..1 | Name for this research definition (computer friendly) |
title | string | 0..1 | Name for this research definition (human friendly) |
shortTitle | string | 0..1 | Title for use in informal contexts |
subtitle | string | 0..1 | Subordinate title of the ResearchDefinition |
status | code | 1..1 | draft | active | retired | unknown |
experimental | boolean | 0..1 | For testing purposes, not real usage |
subject[x] | CodeableConcept, Reference | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device |
date | dateTime | 0..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
description | markdown | 0..1 | Natural language description of the research definition |
comment | string | 0..* | Used for footnotes or explanatory notes |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for research definition (if applicable) |
purpose | markdown | 0..1 | Why this research definition is defined |
usage | string | 0..1 | Describes the clinical usage of the ResearchDefinition |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
approvalDate | date | 0..1 | When the research definition was approved by publisher |
lastReviewDate | date | 0..1 | When the research definition was last reviewed |
effectivePeriod | Period | 0..1 | When the research definition is expected to be used |
topic | CodeableConcept | 0..* | The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc. |
author | ContactDetail | 0..* | Who authored the content |
editor | ContactDetail | 0..* | Who edited the content |
reviewer | ContactDetail | 0..* | Who reviewed the content |
endorser | ContactDetail | 0..* | Who endorsed the content |
relatedArtifact | RelatedArtifact | 0..* | Additional documentation, citations, etc. |
library | canonical | 0..* | Logic used by the ResearchDefinition |
population | Reference | 1..1 | What population? |
exposure | Reference | 0..1 | What exposure? |
exposureAlternative | Reference | 0..1 | What alternative exposure state? |
outcome | Reference | 0..1 | What outcome? |
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
Official FHIR R4 spec: ResearchDefinition.
Maturity: Draft (FMM 0).