Release 4B Ballot #1

This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

14.20 Resource ResearchElementDefinition - Content

Clinical Decision Support Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

14.20.1 Scope and Usage

This resource is a definition resource from a FHIR workflow perspective - see Workflow, specifically Definition.

TODO

14.20.2 Boundaries and Relationships

TODO

14.20.3 References

This resource is referenced by ResearchDefinition.

This resource implements the Definition pattern.

14.20.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchElementDefinition TUDomainResourceA population, intervention, or exposure definition
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriCanonical identifier for this research element definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the research element definition
... version Σ0..1stringBusiness version of the research element definition
... name Σ0..1stringName for this research element definition (computer friendly)
... title Σ0..1stringName for this research element definition (human friendly)
... shortTitle Σ0..1stringTitle for use in informal contexts
... subtitle 0..1stringSubordinate title of the ResearchElementDefinition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Subject type (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the research element definition
... comment 0..*stringUsed for footnotes or explanatory notes
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for research element definition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this research element definition is defined
... usage 0..1stringDescribes the clinical usage of the ResearchElementDefinition
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the research element definition was approved by publisher
... lastReviewDate 0..1dateWhen the research element definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the research element definition is expected to be used
... topic 0..*CodeableConceptThe category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.
DefinitionTopic (Example)
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... library 0..*canonical(Library)Logic used by the ResearchElementDefinition
... type Σ1..1codepopulation | exposure | outcome
ResearchElementType (Required)
... variableType 0..1codedichotomous | continuous | descriptive
VariableType (Required)
... characteristic Σ1..*BackboneElementWhat defines the members of the research element
.... definition[x] Σ1..1What code or expression defines members?
..... definitionCodeableConceptCodeableConcept
..... definitionCanonicalcanonical(ValueSet)
..... definitionExpressionExpression
..... definitionDataRequirementDataRequirement
.... usageContext 0..*UsageContextWhat code/value pairs define members?
.... exclude 0..1booleanWhether the characteristic includes or excludes members
.... unitOfMeasure 0..1CodeableConceptWhat unit is the outcome described in?
UCUM Codes (Required)
.... studyEffectiveDescription 0..1stringWhat time period does the study cover
.... studyEffective[x] 0..1What time period does the study cover
..... studyEffectiveDateTimedateTime
..... studyEffectivePeriodPeriod
..... studyEffectiveDurationDuration
..... studyEffectiveTimingTiming
.... studyEffectiveTimeFromStart 0..1DurationObservation time from study start
.... studyEffectiveGroupMeasure 0..1codemean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
GroupMeasure (Required)
.... participantEffectiveDescription 0..1stringWhat time period do participants cover
.... participantEffective[x] 0..1What time period do participants cover
..... participantEffectiveDateTimedateTime
..... participantEffectivePeriodPeriod
..... participantEffectiveDurationDuration
..... participantEffectiveTimingTiming
.... participantEffectiveTimeFromStart 0..1DurationObservation time from study start
.... participantEffectiveGroupMeasure 0..1codemean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
GroupMeasure (Required)

doco Documentation for this format

UML Diagram (Legend)

ResearchElementDefinition (DomainResource)An absolute URI that is used to identify this research element definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research element definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research element definition is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the research element definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research element definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifactsversion : string [0..1]A natural language name identifying the research element definition. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the research element definitiontitle : string [0..1]The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessaryshortTitle : string [0..1]An explanatory or alternate title for the ResearchElementDefinition giving additional information about its contentsubtitle : string [0..1]The status of this research element definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anythingsubject[x] : Element [0..1] « CodeableConcept|Reference(Group); The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType+ »The date (and optionally time) when the research element definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research element definition changesdate : dateTime [0..1]The name of the organization or individual that published the research element definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the research element definition from a consumer's perspectivedescription : markdown [0..1]A human-readable string to clarify or explain concepts about the resourcecomment : string [0..*]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research element definition instancesuseContext : UsageContext [0..*]A legal or geographic region in which the research element definition is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this research element definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description, from a clinical perspective, of how the ResearchElementDefinition is usedusage : string [0..1]A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definitioncopyright : markdown [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the research element definition content was or is planned to be in active useeffectivePeriod : Period [0..1]Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering. (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]A reference to a Library resource containing the formal logic used by the ResearchElementDefinitionlibrary : canonical [0..*] « Library »The type of research element, a population, an exposure, or an outcometype : code [1..1] « The possible types of research elements (E.g. Population, Exposure, Outcome). (Strength=Required)ResearchElementType! »The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive)variableType : code [0..1] « The possible types of variables for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive). (Strength=Required)VariableType! »CharacteristicDefine members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year)definition[x] : Element [1..1] « CodeableConcept|canonical(ValueSet)| Expression|DataRequirement »Use UsageContext to define the members of the population, such as Age Ranges, Genders, SettingsusageContext : UsageContext [0..*]When true, members with this characteristic are excluded from the elementexclude : boolean [0..1]Specifies the UCUM unit for the outcomeunitOfMeasure : CodeableConcept [0..1] « Unified Code for Units of Measure (UCUM). (Strength=Required)UCUMCodes! »A narrative description of the time period the study coversstudyEffectiveDescription : string [0..1]Indicates what effective period the study coversstudyEffective[x] : Element [0..1] « dateTime|Period|Duration|Timing »Indicates duration from the study initiationstudyEffectiveTimeFromStart : Duration [0..1]Indicates how elements are aggregated within the study effective periodstudyEffectiveGroupMeasure : code [0..1] « Possible group measure aggregates (E.g. Mean, Median). (Strength=Required)GroupMeasure! »A narrative description of the time period the study coversparticipantEffectiveDescription : string [0..1]Indicates what effective period the study coversparticipantEffective[x] : Element [0..1] « dateTime|Period|Duration| Timing »Indicates duration from the participant's study entryparticipantEffectiveTimeFromStart : Duration [0..1]Indicates how elements are aggregated within the study effective periodparticipantEffectiveGroupMeasure : code [0..1] « Possible group measure aggregates (E.g. Mean, Median). (Strength=Required)GroupMeasure! »A characteristic that defines the members of the research element. Multiple characteristics are applied with "and" semanticscharacteristic[1..*]

XML Template

<ResearchElementDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this research element definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the research element definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the research element definition -->
 <name value="[string]"/><!-- 0..1 Name for this research element definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this research element definition (human friendly) -->
 <shortTitle value="[string]"/><!-- 0..1 Title for use in informal contexts -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the ResearchElementDefinition -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the research element definition -->
 <comment value="[string]"/><!-- 0..* Used for footnotes or explanatory notes -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for research element definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this research element definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the ResearchElementDefinition -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the research element definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the research element definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the research element definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <library><!-- 0..* canonical(Library) Logic used by the ResearchElementDefinition --></library>
 <type value="[code]"/><!-- 1..1 population | exposure | outcome -->
 <variableType value="[code]"/><!-- 0..1 dichotomous | continuous | descriptive -->
 <characteristic>  <!-- 1..* What defines the members of the research element -->
  <definition[x]><!-- 1..1 CodeableConcept|canonical(ValueSet)|Expression|
    DataRequirement What code or expression defines members? --></definition[x]>
  <usageContext><!-- 0..* UsageContext What code/value pairs define members? --></usageContext>
  <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic includes or excludes members -->
  <unitOfMeasure><!-- 0..1 CodeableConcept What unit is the outcome described in? --></unitOfMeasure>
  <studyEffectiveDescription value="[string]"/><!-- 0..1 What time period does the study cover -->
  <studyEffective[x]><!-- 0..1 dateTime|Period|Duration|Timing What time period does the study cover --></studyEffective[x]>
  <studyEffectiveTimeFromStart><!-- 0..1 Duration Observation time from study start --></studyEffectiveTimeFromStart>
  <studyEffectiveGroupMeasure value="[code]"/><!-- 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median -->
  <participantEffectiveDescription value="[string]"/><!-- 0..1 What time period do participants cover -->
  <participantEffective[x]><!-- 0..1 dateTime|Period|Duration|Timing What time period do participants cover --></participantEffective[x]>
  <participantEffectiveTimeFromStart><!-- 0..1 Duration Observation time from study start --></participantEffectiveTimeFromStart>
  <participantEffectiveGroupMeasure value="[code]"/><!-- 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median -->
 </characteristic>
</ResearchElementDefinition>

JSON Template

{doco
  "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>", // 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
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ResearchElementDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ResearchElementDefinition.url [ uri ]; # 0..1 Canonical identifier for this research element definition, represented as a URI (globally unique)
  fhir:ResearchElementDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the research element definition
  fhir:ResearchElementDefinition.version [ string ]; # 0..1 Business version of the research element definition
  fhir:ResearchElementDefinition.name [ string ]; # 0..1 Name for this research element definition (computer friendly)
  fhir:ResearchElementDefinition.title [ string ]; # 0..1 Name for this research element definition (human friendly)
  fhir:ResearchElementDefinition.shortTitle [ string ]; # 0..1 Title for use in informal contexts
  fhir:ResearchElementDefinition.subtitle [ string ]; # 0..1 Subordinate title of the ResearchElementDefinition
  fhir:ResearchElementDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ResearchElementDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  # ResearchElementDefinition.subject[x] : 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2
    fhir:ResearchElementDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:ResearchElementDefinition.subjectReference [ Reference(Group) ]
  fhir:ResearchElementDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:ResearchElementDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ResearchElementDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ResearchElementDefinition.description [ markdown ]; # 0..1 Natural language description of the research element definition
  fhir:ResearchElementDefinition.comment [ string ], ... ; # 0..* Used for footnotes or explanatory notes
  fhir:ResearchElementDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ResearchElementDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for research element definition (if applicable)
  fhir:ResearchElementDefinition.purpose [ markdown ]; # 0..1 Why this research element definition is defined
  fhir:ResearchElementDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the ResearchElementDefinition
  fhir:ResearchElementDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ResearchElementDefinition.approvalDate [ date ]; # 0..1 When the research element definition was approved by publisher
  fhir:ResearchElementDefinition.lastReviewDate [ date ]; # 0..1 When the research element definition was last reviewed
  fhir:ResearchElementDefinition.effectivePeriod [ Period ]; # 0..1 When the research element definition is expected to be used
  fhir:ResearchElementDefinition.topic [ CodeableConcept ], ... ; # 0..* The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.
  fhir:ResearchElementDefinition.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:ResearchElementDefinition.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:ResearchElementDefinition.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:ResearchElementDefinition.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:ResearchElementDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:ResearchElementDefinition.library [ canonical(Library) ], ... ; # 0..* Logic used by the ResearchElementDefinition
  fhir:ResearchElementDefinition.type [ code ]; # 1..1 population | exposure | outcome
  fhir:ResearchElementDefinition.variableType [ code ]; # 0..1 dichotomous | continuous | descriptive
  fhir:ResearchElementDefinition.characteristic [ # 1..* What defines the members of the research element
    # ResearchElementDefinition.characteristic.definition[x] : 1..1 What code or expression defines members?. One of these 4
      fhir:ResearchElementDefinition.characteristic.definitionCodeableConcept [ CodeableConcept ]
      fhir:ResearchElementDefinition.characteristic.definitionCanonical [ canonical(ValueSet) ]
      fhir:ResearchElementDefinition.characteristic.definitionExpression [ Expression ]
      fhir:ResearchElementDefinition.characteristic.definitionDataRequirement [ DataRequirement ]
    fhir:ResearchElementDefinition.characteristic.usageContext [ UsageContext ], ... ; # 0..* What code/value pairs define members?
    fhir:ResearchElementDefinition.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic includes or excludes members
    fhir:ResearchElementDefinition.characteristic.unitOfMeasure [ CodeableConcept ]; # 0..1 What unit is the outcome described in?
    fhir:ResearchElementDefinition.characteristic.studyEffectiveDescription [ string ]; # 0..1 What time period does the study cover
    # ResearchElementDefinition.characteristic.studyEffective[x] : 0..1 What time period does the study cover. One of these 4
      fhir:ResearchElementDefinition.characteristic.studyEffectiveDateTime [ dateTime ]
      fhir:ResearchElementDefinition.characteristic.studyEffectivePeriod [ Period ]
      fhir:ResearchElementDefinition.characteristic.studyEffectiveDuration [ Duration ]
      fhir:ResearchElementDefinition.characteristic.studyEffectiveTiming [ Timing ]
    fhir:ResearchElementDefinition.characteristic.studyEffectiveTimeFromStart [ Duration ]; # 0..1 Observation time from study start
    fhir:ResearchElementDefinition.characteristic.studyEffectiveGroupMeasure [ code ]; # 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
    fhir:ResearchElementDefinition.characteristic.participantEffectiveDescription [ string ]; # 0..1 What time period do participants cover
    # ResearchElementDefinition.characteristic.participantEffective[x] : 0..1 What time period do participants cover. One of these 4
      fhir:ResearchElementDefinition.characteristic.participantEffectiveDateTime [ dateTime ]
      fhir:ResearchElementDefinition.characteristic.participantEffectivePeriod [ Period ]
      fhir:ResearchElementDefinition.characteristic.participantEffectiveDuration [ Duration ]
      fhir:ResearchElementDefinition.characteristic.participantEffectiveTiming [ Timing ]
    fhir:ResearchElementDefinition.characteristic.participantEffectiveTimeFromStart [ Duration ]; # 0..1 Observation time from study start
    fhir:ResearchElementDefinition.characteristic.participantEffectiveGroupMeasure [ code ]; # 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  ], ...;
]

Changes since R3

ResearchElementDefinition
ResearchElementDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.1.0
ResearchElementDefinition.type
  • Change value set from http://hl7.org/fhir/ValueSet/research-element-type|4.0.0 to http://hl7.org/fhir/ValueSet/research-element-type|4.1.0
ResearchElementDefinition.variableType
  • Change value set from http://hl7.org/fhir/ValueSet/variable-type|4.0.0 to http://hl7.org/fhir/ValueSet/variable-type|4.1.0
ResearchElementDefinition.characteristic.unitOfMeasure
  • Change value set from http://hl7.org/fhir/ValueSet/ucum-units|4.0.0 to http://hl7.org/fhir/ValueSet/ucum-units|4.1.0
ResearchElementDefinition.characteristic.studyEffectiveGroupMeasure
  • Change value set from http://hl7.org/fhir/ValueSet/group-measure|4.0.0 to http://hl7.org/fhir/ValueSet/group-measure|4.1.0
ResearchElementDefinition.characteristic.participantEffectiveGroupMeasure
  • Change value set from http://hl7.org/fhir/ValueSet/group-measure|4.0.0 to http://hl7.org/fhir/ValueSet/group-measure|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchElementDefinition TUDomainResourceA population, intervention, or exposure definition
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriCanonical identifier for this research element definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the research element definition
... version Σ0..1stringBusiness version of the research element definition
... name Σ0..1stringName for this research element definition (computer friendly)
... title Σ0..1stringName for this research element definition (human friendly)
... shortTitle Σ0..1stringTitle for use in informal contexts
... subtitle 0..1stringSubordinate title of the ResearchElementDefinition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Subject type (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the research element definition
... comment 0..*stringUsed for footnotes or explanatory notes
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for research element definition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this research element definition is defined
... usage 0..1stringDescribes the clinical usage of the ResearchElementDefinition
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the research element definition was approved by publisher
... lastReviewDate 0..1dateWhen the research element definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the research element definition is expected to be used
... topic 0..*CodeableConceptThe category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.
DefinitionTopic (Example)
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... library 0..*canonical(Library)Logic used by the ResearchElementDefinition
... type Σ1..1codepopulation | exposure | outcome
ResearchElementType (Required)
... variableType 0..1codedichotomous | continuous | descriptive
VariableType (Required)
... characteristic Σ1..*BackboneElementWhat defines the members of the research element
.... definition[x] Σ1..1What code or expression defines members?
..... definitionCodeableConceptCodeableConcept
..... definitionCanonicalcanonical(ValueSet)
..... definitionExpressionExpression
..... definitionDataRequirementDataRequirement
.... usageContext 0..*UsageContextWhat code/value pairs define members?
.... exclude 0..1booleanWhether the characteristic includes or excludes members
.... unitOfMeasure 0..1CodeableConceptWhat unit is the outcome described in?
UCUM Codes (Required)
.... studyEffectiveDescription 0..1stringWhat time period does the study cover
.... studyEffective[x] 0..1What time period does the study cover
..... studyEffectiveDateTimedateTime
..... studyEffectivePeriodPeriod
..... studyEffectiveDurationDuration
..... studyEffectiveTimingTiming
.... studyEffectiveTimeFromStart 0..1DurationObservation time from study start
.... studyEffectiveGroupMeasure 0..1codemean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
GroupMeasure (Required)
.... participantEffectiveDescription 0..1stringWhat time period do participants cover
.... participantEffective[x] 0..1What time period do participants cover
..... participantEffectiveDateTimedateTime
..... participantEffectivePeriodPeriod
..... participantEffectiveDurationDuration
..... participantEffectiveTimingTiming
.... participantEffectiveTimeFromStart 0..1DurationObservation time from study start
.... participantEffectiveGroupMeasure 0..1codemean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
GroupMeasure (Required)

doco Documentation for this format

UML Diagram (Legend)

ResearchElementDefinition (DomainResource)An absolute URI that is used to identify this research element definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research element definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research element definition is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the research element definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research element definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifactsversion : string [0..1]A natural language name identifying the research element definition. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the research element definitiontitle : string [0..1]The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessaryshortTitle : string [0..1]An explanatory or alternate title for the ResearchElementDefinition giving additional information about its contentsubtitle : string [0..1]The status of this research element definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anythingsubject[x] : Element [0..1] « CodeableConcept|Reference(Group); The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType+ »The date (and optionally time) when the research element definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research element definition changesdate : dateTime [0..1]The name of the organization or individual that published the research element definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the research element definition from a consumer's perspectivedescription : markdown [0..1]A human-readable string to clarify or explain concepts about the resourcecomment : string [0..*]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research element definition instancesuseContext : UsageContext [0..*]A legal or geographic region in which the research element definition is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this research element definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description, from a clinical perspective, of how the ResearchElementDefinition is usedusage : string [0..1]A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definitioncopyright : markdown [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the research element definition content was or is planned to be in active useeffectivePeriod : Period [0..1]Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering. (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]A reference to a Library resource containing the formal logic used by the ResearchElementDefinitionlibrary : canonical [0..*] « Library »The type of research element, a population, an exposure, or an outcometype : code [1..1] « The possible types of research elements (E.g. Population, Exposure, Outcome). (Strength=Required)ResearchElementType! »The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive)variableType : code [0..1] « The possible types of variables for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive). (Strength=Required)VariableType! »CharacteristicDefine members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year)definition[x] : Element [1..1] « CodeableConcept|canonical(ValueSet)| Expression|DataRequirement »Use UsageContext to define the members of the population, such as Age Ranges, Genders, SettingsusageContext : UsageContext [0..*]When true, members with this characteristic are excluded from the elementexclude : boolean [0..1]Specifies the UCUM unit for the outcomeunitOfMeasure : CodeableConcept [0..1] « Unified Code for Units of Measure (UCUM). (Strength=Required)UCUMCodes! »A narrative description of the time period the study coversstudyEffectiveDescription : string [0..1]Indicates what effective period the study coversstudyEffective[x] : Element [0..1] « dateTime|Period|Duration|Timing »Indicates duration from the study initiationstudyEffectiveTimeFromStart : Duration [0..1]Indicates how elements are aggregated within the study effective periodstudyEffectiveGroupMeasure : code [0..1] « Possible group measure aggregates (E.g. Mean, Median). (Strength=Required)GroupMeasure! »A narrative description of the time period the study coversparticipantEffectiveDescription : string [0..1]Indicates what effective period the study coversparticipantEffective[x] : Element [0..1] « dateTime|Period|Duration| Timing »Indicates duration from the participant's study entryparticipantEffectiveTimeFromStart : Duration [0..1]Indicates how elements are aggregated within the study effective periodparticipantEffectiveGroupMeasure : code [0..1] « Possible group measure aggregates (E.g. Mean, Median). (Strength=Required)GroupMeasure! »A characteristic that defines the members of the research element. Multiple characteristics are applied with "and" semanticscharacteristic[1..*]

XML Template

<ResearchElementDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this research element definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the research element definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the research element definition -->
 <name value="[string]"/><!-- 0..1 Name for this research element definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this research element definition (human friendly) -->
 <shortTitle value="[string]"/><!-- 0..1 Title for use in informal contexts -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the ResearchElementDefinition -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the research element definition -->
 <comment value="[string]"/><!-- 0..* Used for footnotes or explanatory notes -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for research element definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this research element definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the ResearchElementDefinition -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the research element definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the research element definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the research element definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <library><!-- 0..* canonical(Library) Logic used by the ResearchElementDefinition --></library>
 <type value="[code]"/><!-- 1..1 population | exposure | outcome -->
 <variableType value="[code]"/><!-- 0..1 dichotomous | continuous | descriptive -->
 <characteristic>  <!-- 1..* What defines the members of the research element -->
  <definition[x]><!-- 1..1 CodeableConcept|canonical(ValueSet)|Expression|
    DataRequirement What code or expression defines members? --></definition[x]>
  <usageContext><!-- 0..* UsageContext What code/value pairs define members? --></usageContext>
  <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic includes or excludes members -->
  <unitOfMeasure><!-- 0..1 CodeableConcept What unit is the outcome described in? --></unitOfMeasure>
  <studyEffectiveDescription value="[string]"/><!-- 0..1 What time period does the study cover -->
  <studyEffective[x]><!-- 0..1 dateTime|Period|Duration|Timing What time period does the study cover --></studyEffective[x]>
  <studyEffectiveTimeFromStart><!-- 0..1 Duration Observation time from study start --></studyEffectiveTimeFromStart>
  <studyEffectiveGroupMeasure value="[code]"/><!-- 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median -->
  <participantEffectiveDescription value="[string]"/><!-- 0..1 What time period do participants cover -->
  <participantEffective[x]><!-- 0..1 dateTime|Period|Duration|Timing What time period do participants cover --></participantEffective[x]>
  <participantEffectiveTimeFromStart><!-- 0..1 Duration Observation time from study start --></participantEffectiveTimeFromStart>
  <participantEffectiveGroupMeasure value="[code]"/><!-- 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median -->
 </characteristic>
</ResearchElementDefinition>

JSON Template

{doco
  "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>", // 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
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ResearchElementDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ResearchElementDefinition.url [ uri ]; # 0..1 Canonical identifier for this research element definition, represented as a URI (globally unique)
  fhir:ResearchElementDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the research element definition
  fhir:ResearchElementDefinition.version [ string ]; # 0..1 Business version of the research element definition
  fhir:ResearchElementDefinition.name [ string ]; # 0..1 Name for this research element definition (computer friendly)
  fhir:ResearchElementDefinition.title [ string ]; # 0..1 Name for this research element definition (human friendly)
  fhir:ResearchElementDefinition.shortTitle [ string ]; # 0..1 Title for use in informal contexts
  fhir:ResearchElementDefinition.subtitle [ string ]; # 0..1 Subordinate title of the ResearchElementDefinition
  fhir:ResearchElementDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ResearchElementDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  # ResearchElementDefinition.subject[x] : 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2
    fhir:ResearchElementDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:ResearchElementDefinition.subjectReference [ Reference(Group) ]
  fhir:ResearchElementDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:ResearchElementDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ResearchElementDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ResearchElementDefinition.description [ markdown ]; # 0..1 Natural language description of the research element definition
  fhir:ResearchElementDefinition.comment [ string ], ... ; # 0..* Used for footnotes or explanatory notes
  fhir:ResearchElementDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ResearchElementDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for research element definition (if applicable)
  fhir:ResearchElementDefinition.purpose [ markdown ]; # 0..1 Why this research element definition is defined
  fhir:ResearchElementDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the ResearchElementDefinition
  fhir:ResearchElementDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ResearchElementDefinition.approvalDate [ date ]; # 0..1 When the research element definition was approved by publisher
  fhir:ResearchElementDefinition.lastReviewDate [ date ]; # 0..1 When the research element definition was last reviewed
  fhir:ResearchElementDefinition.effectivePeriod [ Period ]; # 0..1 When the research element definition is expected to be used
  fhir:ResearchElementDefinition.topic [ CodeableConcept ], ... ; # 0..* The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.
  fhir:ResearchElementDefinition.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:ResearchElementDefinition.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:ResearchElementDefinition.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:ResearchElementDefinition.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:ResearchElementDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:ResearchElementDefinition.library [ canonical(Library) ], ... ; # 0..* Logic used by the ResearchElementDefinition
  fhir:ResearchElementDefinition.type [ code ]; # 1..1 population | exposure | outcome
  fhir:ResearchElementDefinition.variableType [ code ]; # 0..1 dichotomous | continuous | descriptive
  fhir:ResearchElementDefinition.characteristic [ # 1..* What defines the members of the research element
    # ResearchElementDefinition.characteristic.definition[x] : 1..1 What code or expression defines members?. One of these 4
      fhir:ResearchElementDefinition.characteristic.definitionCodeableConcept [ CodeableConcept ]
      fhir:ResearchElementDefinition.characteristic.definitionCanonical [ canonical(ValueSet) ]
      fhir:ResearchElementDefinition.characteristic.definitionExpression [ Expression ]
      fhir:ResearchElementDefinition.characteristic.definitionDataRequirement [ DataRequirement ]
    fhir:ResearchElementDefinition.characteristic.usageContext [ UsageContext ], ... ; # 0..* What code/value pairs define members?
    fhir:ResearchElementDefinition.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic includes or excludes members
    fhir:ResearchElementDefinition.characteristic.unitOfMeasure [ CodeableConcept ]; # 0..1 What unit is the outcome described in?
    fhir:ResearchElementDefinition.characteristic.studyEffectiveDescription [ string ]; # 0..1 What time period does the study cover
    # ResearchElementDefinition.characteristic.studyEffective[x] : 0..1 What time period does the study cover. One of these 4
      fhir:ResearchElementDefinition.characteristic.studyEffectiveDateTime [ dateTime ]
      fhir:ResearchElementDefinition.characteristic.studyEffectivePeriod [ Period ]
      fhir:ResearchElementDefinition.characteristic.studyEffectiveDuration [ Duration ]
      fhir:ResearchElementDefinition.characteristic.studyEffectiveTiming [ Timing ]
    fhir:ResearchElementDefinition.characteristic.studyEffectiveTimeFromStart [ Duration ]; # 0..1 Observation time from study start
    fhir:ResearchElementDefinition.characteristic.studyEffectiveGroupMeasure [ code ]; # 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
    fhir:ResearchElementDefinition.characteristic.participantEffectiveDescription [ string ]; # 0..1 What time period do participants cover
    # ResearchElementDefinition.characteristic.participantEffective[x] : 0..1 What time period do participants cover. One of these 4
      fhir:ResearchElementDefinition.characteristic.participantEffectiveDateTime [ dateTime ]
      fhir:ResearchElementDefinition.characteristic.participantEffectivePeriod [ Period ]
      fhir:ResearchElementDefinition.characteristic.participantEffectiveDuration [ Duration ]
      fhir:ResearchElementDefinition.characteristic.participantEffectiveTiming [ Timing ]
    fhir:ResearchElementDefinition.characteristic.participantEffectiveTimeFromStart [ Duration ]; # 0..1 Observation time from study start
    fhir:ResearchElementDefinition.characteristic.participantEffectiveGroupMeasure [ code ]; # 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  ], ...;
]

Changes since Release 3

ResearchElementDefinition
ResearchElementDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.1.0
ResearchElementDefinition.type
  • Change value set from http://hl7.org/fhir/ValueSet/research-element-type|4.0.0 to http://hl7.org/fhir/ValueSet/research-element-type|4.1.0
ResearchElementDefinition.variableType
  • Change value set from http://hl7.org/fhir/ValueSet/variable-type|4.0.0 to http://hl7.org/fhir/ValueSet/variable-type|4.1.0
ResearchElementDefinition.characteristic.unitOfMeasure
  • Change value set from http://hl7.org/fhir/ValueSet/ucum-units|4.0.0 to http://hl7.org/fhir/ValueSet/ucum-units|4.1.0
ResearchElementDefinition.characteristic.studyEffectiveGroupMeasure
  • Change value set from http://hl7.org/fhir/ValueSet/group-measure|4.0.0 to http://hl7.org/fhir/ValueSet/group-measure|4.1.0
ResearchElementDefinition.characteristic.participantEffectiveGroupMeasure
  • Change value set from http://hl7.org/fhir/ValueSet/group-measure|4.0.0 to http://hl7.org/fhir/ValueSet/group-measure|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

14.20.4.1 Terminology Bindings

PathDefinitionTypeReference
ResearchElementDefinition.status The lifecycle status of an artifact.RequiredPublicationStatus
ResearchElementDefinition.subject[x] The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).ExtensibleSubjectType
ResearchElementDefinition.jurisdiction Countries and regions within which this artifact is targeted for use.ExtensibleJurisdiction ValueSet
ResearchElementDefinition.topic High-level categorization of the definition, used for searching, sorting, and filtering.ExampleDefinitionTopic
ResearchElementDefinition.type The possible types of research elements (E.g. Population, Exposure, Outcome).RequiredResearchElementType
ResearchElementDefinition.variableType The possible types of variables for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive).RequiredVariableType
ResearchElementDefinition.characteristic.unitOfMeasure Unified Code for Units of Measure (UCUM).RequiredUCUMCodes
ResearchElementDefinition.characteristic.studyEffectiveGroupMeasure Possible group measure aggregates (E.g. Mean, Median).RequiredGroupMeasure
ResearchElementDefinition.characteristic.participantEffectiveGroupMeasure Possible group measure aggregates (E.g. Mean, Median).RequiredGroupMeasure

14.20.4.2 Constraints

idLevelLocationDescriptionExpression
red-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')

14.20.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
composed-ofreferenceWhat resource is being referencedResearchElementDefinition.relatedArtifact.where(type='composed-of').resource
(Any)
contexttokenA use context assigned to the research element definition(ResearchElementDefinition.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the research element definition(ResearchElementDefinition.useContext.value as Quantity) | (ResearchElementDefinition.useContext.value as Range)
context-typetokenA type of use context assigned to the research element definitionResearchElementDefinition.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the research element definitionOn ResearchElementDefinition.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-valuecompositeA use context type and value assigned to the research element definitionOn ResearchElementDefinition.useContext:
  context-type: code
  context: value.as(CodeableConcept)
datedateThe research element definition publication dateResearchElementDefinition.date
depends-onreferenceWhat resource is being referencedResearchElementDefinition.relatedArtifact.where(type='depends-on').resource | ResearchElementDefinition.library
(Library, Any)
derived-fromreferenceWhat resource is being referencedResearchElementDefinition.relatedArtifact.where(type='derived-from').resource
(Any)
descriptionstringThe description of the research element definitionResearchElementDefinition.description
effectivedateThe time during which the research element definition is intended to be in useResearchElementDefinition.effectivePeriod
identifiertokenExternal identifier for the research element definitionResearchElementDefinition.identifier
jurisdictiontokenIntended jurisdiction for the research element definitionResearchElementDefinition.jurisdiction
namestringComputationally friendly name of the research element definitionResearchElementDefinition.name
predecessorreferenceWhat resource is being referencedResearchElementDefinition.relatedArtifact.where(type='predecessor').resource
(Any)
publisherstringName of the publisher of the research element definitionResearchElementDefinition.publisher
statustokenThe current status of the research element definitionResearchElementDefinition.status
successorreferenceWhat resource is being referencedResearchElementDefinition.relatedArtifact.where(type='successor').resource
(Any)
titlestringThe human-friendly name of the research element definitionResearchElementDefinition.title
topictokenTopics associated with the ResearchElementDefinitionResearchElementDefinition.topic
urluriThe uri that identifies the research element definitionResearchElementDefinition.url
versiontokenThe business version of the research element definitionResearchElementDefinition.version