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.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 20 of 22 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
urlΣ | 0..1 | uri | Canonical identifier for this research definition, represented as a URI (globally unique) |
identifierΣ | 0..* | Identifier | Additional identifier for the research definition |
versionΣ | 0..1 | string | Business version of the research definition |
nameΣ | 0..1 | string | Name for this research definition (computer friendly) |
titleΣ | 0..1 | string | Name for this research definition (human friendly) |
shortTitle | 0..1 | string | Title for use in informal contexts |
subtitle | 0..1 | string | Subordinate title of the ResearchDefinition |
statusRequired?!Σ | 1..1 | code | draft | active | retired | unknownBinding (required): publication-status |
experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
subject[x] | 0..1 | CodeableConcept | Reference(Group) | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, DeviceBinding (extensible): subject-type |
dateΣ | 0..1 | dateTime | Date last changed |
publisherΣ | 0..1 | string | Name of the publisher (organization or individual) |
contactΣ | 0..* | ContactDetail | Contact details for the publisher |
descriptionΣ | 0..1 | markdown | Natural language description of the research definition |
comment | 0..* | string | Used for footnotes or explanatory notes |
useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for research definition (if applicable)Binding (extensible): jurisdiction |
purpose | 0..1 | markdown | Why this research definition is defined |
usage | 0..1 | string | Describes the clinical usage of the ResearchDefinition |
copyright | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | 0..1 | date | When the research definition was approved by publisher |
lastReviewDate | 0..1 | date | When the research definition was last reviewed |
effectivePeriodΣ | 0..1 | Period | When the research definition is expected to be used |
topic | 0..* | CodeableConcept | The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.Binding (example): definition-topic |
author | 0..* | ContactDetail | Who authored the content |
editor | 0..* | ContactDetail | Who edited the content |
reviewer | 0..* | ContactDetail | Who reviewed the content |
endorser | 0..* | ContactDetail | Who endorsed the content |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
library | 0..* | canonical(Library) | Logic used by the ResearchDefinition |
populationRequiredΣ | 1..1 | Reference(ResearchElementDefinition) | What population? |
exposureΣ | 0..1 | Reference(ResearchElementDefinition) | What exposure? |
exposureAlternativeΣ | 0..1 | Reference(ResearchElementDefinition) | What alternative exposure state? |
outcomeΣ | 0..1 | Reference(ResearchElementDefinition) | What outcome? |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/ResearchDefinition?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
composed-of | reference | What resource is being referenced ResearchDefinition.relatedArtifact.where(type='composed-of').resource | ||
context | token | A use context assigned to the research definition (ResearchDefinition.useContext.value.ofType(CodeableConcept)) | ||
context-quantity | quantity | A quantity- or range-valued use context assigned to the research definition (ResearchDefinition.useContext.value.ofType(Quantity)) | (ResearchDefinition.useContext.value.ofType(Range)) | ||
context-type | token | A type of use context assigned to the research definition ResearchDefinition.useContext.code | ||
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the research definition ResearchDefinition.useContext | ||
context-type-value | composite | A use context type and value assigned to the research definition ResearchDefinition.useContext | ||
date | date | The research definition publication date ResearchDefinition.date | ||
depends-on | reference | What resource is being referenced ResearchDefinition.relatedArtifact.where(type='depends-on').resource | ResearchDefinition.library | ||
derived-from | reference | What resource is being referenced ResearchDefinition.relatedArtifact.where(type='derived-from').resource | ||
description | string | The description of the research definition ResearchDefinition.description | ||
effective | date | The time during which the research definition is intended to be in use ResearchDefinition.effectivePeriod | ||
identifier | token | External identifier for the research definition ResearchDefinition.identifier | ||
jurisdiction | token | Intended jurisdiction for the research definition ResearchDefinition.jurisdiction | ||
name | string | Computationally friendly name of the research definition ResearchDefinition.name | ||
predecessor | reference | What resource is being referenced ResearchDefinition.relatedArtifact.where(type='predecessor').resource | ||
publisher | string | Name of the publisher of the research definition ResearchDefinition.publisher | ||
status | token | The current status of the research definition ResearchDefinition.status | ||
successor | reference | What resource is being referenced ResearchDefinition.relatedArtifact.where(type='successor').resource | ||
title | string | The human-friendly name of the research definition ResearchDefinition.title | ||
topic | token | Topics associated with the ResearchDefinition ResearchDefinition.topic | ||
url | uri | The uri that identifies the research definition ResearchDefinition.url | ||
version | token | The business version of the research definition ResearchDefinition.version |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken