ResearchElementDefinition - FHIR Resource (r4)

This ResearchElementDefinition Resource uses the FHIR API standard for access and structure.

Validate an ResearchElementDefinition FHIR Resource (r4)

Validate this ResearchElementDefinition

Resource Attributes

Attribute	Field is list	Type	Description
approvalDate	false	date	# When the research element definition was approved by publisher
author	true	ContactDetail	# Who authored the content
characteristic	true	Data Type	# What defines the members of the research element
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 element definition
editor	true	ContactDetail	# Who edited the content
effectivePeriod	false	Period	# When the research element definition is expected to be used
endorser	true	ContactDetail	# Who endorsed the content
experimental	false	boolean	# For testing purposes, not real usage
identifier	true	Identifier	# Additional identifier for the research element definition
jurisdiction	true	CodeableConcept	# Intended jurisdiction for research element definition (if applicable)
lastReviewDate	false	date	# When the research element definition was last reviewed
library	true	canonical(Library)	# Logic used by the ResearchElementDefinition
name	false	string	# C? Name for this research element definition (computer friendly)
publisher	false	string	# Name of the publisher (organization or individual)
purpose	false	markdown	# Why this research element 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 ResearchElementDefinition
title	false	string	# Name for this research element definition (human friendly)
topic	true	CodeableConcept	# The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.
type	false	code	# population | exposure | outcome
url	false	uri	# Canonical identifier for this research element definition, represented as a URI (globally unique)
usage	false	string	# Describes the clinical usage of the ResearchElementDefinition
useContext	true	UsageContext	# The context that the content is intended to support
variableType	false	code	# dichotomous | continuous | descriptive
version	false	string	# Business version of the research element definition

ResearchElementDefinition Example

{
  "resourceType": "ResearchElementDefinition",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>"
  },
  "status": "draft",
  "type": "population",
  "characteristic": [
    {
      "definitionCodeableConcept": {
        "text": "Diabetic patients over 65"
      }
    }
  ]
}

ResearchElementDefinition Structure

{
  "resourceType" : "ResearchElementDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this research element definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the research element definition
  "version" : "<string>", // Business version of the research element definition
  "name" : "<string>", // C? Name for this research element definition (computer friendly)
  "title" : "<string>", // Name for this research element definition (human friendly)
  "shortTitle" : "<string>", // Title for use in informal contexts
  "subtitle" : "<string>", // Subordinate title of the ResearchElementDefinition
  "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 element 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 element definition (if applicable)
  "purpose" : "<markdown>", // Why this research element definition is defined
  "usage" : "<string>", // Describes the clinical usage of the ResearchElementDefinition
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the research element definition was approved by publisher
  "lastReviewDate" : "<date>", // When the research element definition was last reviewed
  "effectivePeriod" : { Period }, // When the research element definition is expected to be used
  "topic" : [{ CodeableConcept }], // The category of the ResearchElementDefinition, 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 ResearchElementDefinition
  "type" : "<code>", // R!  population | exposure | outcome
  "variableType" : "<code>", // dichotomous | continuous | descriptive
  "characteristic" : [{ // R!  What defines the members of the research element
    // definition[x]: What code or expression defines members?. One of these 4:
    "definitionCodeableConcept" : { CodeableConcept },
    "definitionCanonical" : { canonical(ValueSet) },
    "definitionExpression" : { Expression },
    "definitionDataRequirement" : { DataRequirement },
    "usageContext" : [{ UsageContext }], // What code/value pairs define members?
    "exclude" : <boolean>, // Whether the characteristic includes or excludes members
    "unitOfMeasure" : { CodeableConcept }, // What unit is the outcome described in?
    "studyEffectiveDescription" : "<string>", // What time period does the study cover
    // studyEffective[x]: What time period does the study cover. One of these 4:
    "studyEffectiveDateTime" : "<dateTime>",
    "studyEffectivePeriod" : { Period },
    "studyEffectiveDuration" : { Duration },
    "studyEffectiveTiming" : { Timing },
    "studyEffectiveTimeFromStart" : { Duration }, // Observation time from study start
    "studyEffectiveGroupMeasure" : "<code>", // mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
    "participantEffectiveDescription" : "<string>", // What time period do participants cover
    // participantEffective[x]: What time period do participants cover. One of these 4:
    "participantEffectiveDateTime" : "<dateTime>",
    "participantEffectivePeriod" : { Period },
    "participantEffectiveDuration" : { Duration },
    "participantEffectiveTiming" : { Timing },
    "participantEffectiveTimeFromStart" : { Duration }, // Observation time from study start
    "participantEffectiveGroupMeasure" : "<code>" // mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  }]
}

ResearchElementDefinition Search Parameters

The following search parameters can be used to query ResearchElementDefinition resources. Just submit them like so:

https://api.1up.health/fhir/r4/ResearchElementDefinition?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