ResearchElementDefinition - FHIR Resource (r4)

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

Validate an ResearchElementDefinition FHIR Resource (r4)

ResearchElementDefinition Attributes

AttributeField is listTypeDescription

Description: Canonical identifier for this research element definition, represented as a URI (globally unique)

FHIR Version: r4

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"url":

Learn more about the (ResearchElementDefinition) url FHIR attribute

Description: Additional identifier for the research element definition

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier":

Learn more about the (ResearchElementDefinition) identifier FHIR attribute

Description: Business version of the research element definition

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"version":

Learn more about the (ResearchElementDefinition) version FHIR attribute

Description: C? Name for this research element definition (computer friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name":

Learn more about the (ResearchElementDefinition) name FHIR attribute

Description: Name for this research element definition (human friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"title":

Learn more about the (ResearchElementDefinition) title FHIR attribute

Description: Title for use in informal contexts

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"shortTitle":

Learn more about the (ResearchElementDefinition) shortTitle FHIR attribute

Description: Subordinate title of the ResearchElementDefinition

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"subtitle":

Learn more about the (ResearchElementDefinition) subtitle FHIR attribute

Description: draft | active | retired | unknown

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "draft"

Learn more about the (ResearchElementDefinition) status FHIR attribute

Description: For testing purposes, not real usage

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"experimental":

Learn more about the (ResearchElementDefinition) experimental FHIR attribute

Description:

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"subject[x]":

Learn more about the (ResearchElementDefinition) subject[x] FHIR attribute

Description: Date last changed

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"date":

Learn more about the (ResearchElementDefinition) date FHIR attribute

Description: Name of the publisher (organization or individual)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"publisher":

Learn more about the (ResearchElementDefinition) publisher FHIR attribute

Description: Contact details for the publisher

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact":

Learn more about the (ResearchElementDefinition) contact FHIR attribute

Description: Natural language description of the research element definition

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description":

Learn more about the (ResearchElementDefinition) description FHIR attribute

Description: Used for footnotes or explanatory notes

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"comment":

Learn more about the (ResearchElementDefinition) comment FHIR attribute

Description: The context that the content is intended to support

FHIR Version: r4

Attribute Type : UsageContext

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"useContext":

Learn more about the (ResearchElementDefinition) useContext FHIR attribute

Description: Intended jurisdiction for research element definition (if applicable)

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"jurisdiction":

Learn more about the (ResearchElementDefinition) jurisdiction FHIR attribute

Description: Why this research element definition is defined

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"purpose":

Learn more about the (ResearchElementDefinition) purpose FHIR attribute

Description: Describes the clinical usage of the ResearchElementDefinition

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"usage":

Learn more about the (ResearchElementDefinition) usage FHIR attribute

Description: Use and/or publishing restrictions

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"copyright":

Learn more about the (ResearchElementDefinition) copyright FHIR attribute

Description: When the research element definition was approved by publisher

FHIR Version: r4

Attribute Type : date

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"approvalDate":

Learn more about the (ResearchElementDefinition) approvalDate FHIR attribute

Description: When the research element definition was last reviewed

FHIR Version: r4

Attribute Type : date

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"lastReviewDate":

Learn more about the (ResearchElementDefinition) lastReviewDate FHIR attribute

Description: When the research element definition is expected to be used

FHIR Version: r4

Attribute Type : Period

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"effectivePeriod":

Learn more about the (ResearchElementDefinition) effectivePeriod FHIR attribute

Description: The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"topic":

Learn more about the (ResearchElementDefinition) topic FHIR attribute

Description: Who authored the content

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"author":

Learn more about the (ResearchElementDefinition) author FHIR attribute

Description: Who edited the content

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"editor":

Learn more about the (ResearchElementDefinition) editor FHIR attribute

Description: Who reviewed the content

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"reviewer":

Learn more about the (ResearchElementDefinition) reviewer FHIR attribute

Description: Who endorsed the content

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"endorser":

Learn more about the (ResearchElementDefinition) endorser FHIR attribute

Description: Additional documentation, citations, etc.

FHIR Version: r4

Attribute Type : RelatedArtifact

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"relatedArtifact":

Learn more about the (ResearchElementDefinition) relatedArtifact FHIR attribute

Description: Logic used by the ResearchElementDefinition

FHIR Version: r4

Attribute Type : canonical(Library)

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"library":

Learn more about the (ResearchElementDefinition) library FHIR attribute

Description: population | exposure | outcome

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"type": "population"

Learn more about the (ResearchElementDefinition) type FHIR attribute

Description: dichotomous | continuous | descriptive

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"variableType":

Learn more about the (ResearchElementDefinition) variableType FHIR attribute

Description: What defines the members of the research element

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"characteristic": [
  {
    "definitionCodeableConcept": {
      "text": "Diabetic patients over 65"
    }
  }
]

Learn more about the (ResearchElementDefinition) characteristic FHIR attribute

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`