ResearchDefinition - FHIR Resource (r4)
This ResearchDefinition Resource uses the
FHIR API standard for access and structure.
Validate an ResearchDefinition FHIR Resource (r4)
Resource Attributes
Attribute | Field is list | Type | Description |
---|
approvalDate | false | date | # When the research definition was approved by publisher |
author | true | ContactDetail | # Who authored the content |
comment | true | string | # Used for footnotes or explanatory notes |
contact | true | ContactDetail | # Contact details for the publisher |
copyright | false | markdown | # Use and/or publishing restrictions |
date | false | dateTime | # Date last changed |
description | false | markdown | # Natural language description of the research definition |
editor | true | ContactDetail | # Who edited the content |
effectivePeriod | false | Period | # When the research definition is expected to be used |
endorser | true | ContactDetail | # Who endorsed the content |
experimental | false | boolean | # For testing purposes, not real usage |
exposure | false | Reference | # What exposure? |
exposureAlternative | false | Reference | # What alternative exposure state? |
identifier | true | Identifier | # Additional identifier for the research definition |
jurisdiction | true | CodeableConcept | # Intended jurisdiction for research definition (if applicable) |
lastReviewDate | false | date | # When the research definition was last reviewed |
library | true | canonical(Library) | # Logic used by the ResearchDefinition |
name | false | string | # C? Name for this research definition (computer friendly) |
outcome | false | Reference | # What outcome? |
population | false | Reference | # What population? |
publisher | false | string | # Name of the publisher (organization or individual) |
purpose | false | markdown | # Why this research definition is defined |
relatedArtifact | true | RelatedArtifact | # Additional documentation, citations, etc. |
reviewer | true | ContactDetail | # Who reviewed the content |
shortTitle | false | string | # Title for use in informal contexts |
status | false | code | # draft | active | retired | unknown |
subject[x] | false | Reference | #undefined |
subtitle | false | string | # Subordinate title of the ResearchDefinition |
title | false | string | # Name for this research definition (human friendly) |
topic | true | CodeableConcept | # The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc. |
url | false | uri | # Canonical identifier for this research definition, represented as a URI (globally unique) |
usage | false | string | # Describes the clinical usage of the ResearchDefinition |
useContext | true | UsageContext | # The context that the content is intended to support |
version | false | string | # Business version of the research definition |
ResearchDefinition Example
{
"resourceType": "ResearchDefinition",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>"
},
"status": "draft",
"population": {
"reference": "ResearchElementDefinition/example"
}
}
ResearchDefinition Structure
{
"resourceType" : "ResearchDefinition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Canonical identifier for this research definition, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // Additional identifier for the research definition
"version" : "<string>", // Business version of the research definition
"name" : "<string>", // C? Name for this research definition (computer friendly)
"title" : "<string>", // Name for this research definition (human friendly)
"shortTitle" : "<string>", // Title for use in informal contexts
"subtitle" : "<string>", // Subordinate title of the ResearchDefinition
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
// subject[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2:
"subjectCodeableConcept" : { CodeableConcept },
"subjectReference" : { Reference(Group) },
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the research definition
"comment" : ["<string>"], // Used for footnotes or explanatory notes
"useContext" : [{ UsageContext }], // The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for research definition (if applicable)
"purpose" : "<markdown>", // Why this research definition is defined
"usage" : "<string>", // Describes the clinical usage of the ResearchDefinition
"copyright" : "<markdown>", // Use and/or publishing restrictions
"approvalDate" : "<date>", // When the research definition was approved by publisher
"lastReviewDate" : "<date>", // When the research definition was last reviewed
"effectivePeriod" : { Period }, // When the research definition is expected to be used
"topic" : [{ CodeableConcept }], // The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
"author" : [{ ContactDetail }], // Who authored the content
"editor" : [{ ContactDetail }], // Who edited the content
"reviewer" : [{ ContactDetail }], // Who reviewed the content
"endorser" : [{ ContactDetail }], // Who endorsed the content
"relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
"library" : [{ canonical(Library) }], // Logic used by the ResearchDefinition
"population" : { Reference(ResearchElementDefinition) }, // R! What population?
"exposure" : { Reference(ResearchElementDefinition) }, // What exposure?
"exposureAlternative" : { Reference(ResearchElementDefinition) }, // What alternative exposure state?
"outcome" : { Reference(ResearchElementDefinition) } // What outcome?
}
ResearchDefinition Search Parameters
The following search parameters can be used to query ResearchDefinition resources. Just submit them like so:
https://api.1up.health/fhir/r4/ResearchDefinition?query-param=queryvalue
Search Parameter | Field Type | Resource Fields Searched |
---|
composed-of | reference | relatedArtifact.where |
context | text | useContext.value |
context-quantity | quantity | useContext.value |
context-type | text | useContext.code |
context-type-quantity | composite | useContext |
context-type-value | composite | useContext |
date | date | date |
depends-on | reference | relatedArtifact.where |
derived-from | reference | relatedArtifact.where |
description | text | description |
effective | date | effectivePeriod |
identifier | text | identifier |
jurisdiction | text | jurisdiction |
name | text | name |
predecessor | reference | relatedArtifact.where |
publisher | text | publisher |
status | text | status |
successor | reference | relatedArtifact.where |
title | text | title |
topic | text | topic |
url | uri | url |
version | text | version |