ResearchElementDefinition

Property	Value
Publisher
Name	ResearchElementDefinition
URL	http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition
Status	draft
Description
Abstract	false

Structure

Path	Cardinality	Type	Description
ResearchElementDefinition	0..*	ResearchElementDefinition	The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
ResearchElementDefinition.id	0..1	http://hl7.org/fhirpath/System.String	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
ResearchElementDefinition.meta	0..1	Meta	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
ResearchElementDefinition.implicitRules	0..1	uri	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
ResearchElementDefinition.language	0..1	code	The base language in which the resource is written.
ResearchElementDefinition.text	0..1	Narrative	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
ResearchElementDefinition.contained	0..*	Resource	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
ResearchElementDefinition.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ResearchElementDefinition.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ResearchElementDefinition.url	0..1	uri	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 servers.
ResearchElementDefinition.identifier	0..*	Identifier	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 instance.
ResearchElementDefinition.version	0..1	string	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 artifacts.
ResearchElementDefinition.name	0..1	string	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 generation.
ResearchElementDefinition.title	0..1	string	A short, descriptive, user-friendly title for the research element definition.
ResearchElementDefinition.shortTitle	0..1	string	The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
ResearchElementDefinition.subtitle	0..1	string	An explanatory or alternate title for the ResearchElementDefinition giving additional information about its content.
ResearchElementDefinition.status	1..1	code	The status of this research element definition. Enables tracking the life-cycle of the content.
ResearchElementDefinition.experimental	0..1	boolean	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 usage.
ResearchElementDefinition.subject[x]	0..1	CodeableConcept	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 anything.
ResearchElementDefinition.date	0..1	dateTime	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 changes.
ResearchElementDefinition.publisher	0..1	string	The name of the organization or individual that published the research element definition.
ResearchElementDefinition.contact	0..*	ContactDetail	Contact details to assist a user in finding and communicating with the publisher.
ResearchElementDefinition.description	0..1	markdown	A free text natural language description of the research element definition from a consumer's perspective.
ResearchElementDefinition.comment	0..*	string	A human-readable string to clarify or explain concepts about the resource.
ResearchElementDefinition.useContext	0..*	UsageContext	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 instances.
ResearchElementDefinition.jurisdiction	0..*	CodeableConcept	A legal or geographic region in which the research element definition is intended to be used.
ResearchElementDefinition.purpose	0..1	markdown	Explanation of why this research element definition is needed and why it has been designed as it has.
ResearchElementDefinition.usage	0..1	string	A detailed description, from a clinical perspective, of how the ResearchElementDefinition is used.
ResearchElementDefinition.copyright	0..1	markdown	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 definition.
ResearchElementDefinition.approvalDate	0..1	date	The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
ResearchElementDefinition.lastReviewDate	0..1	date	The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
ResearchElementDefinition.effectivePeriod	0..1	Period	The period during which the research element definition content was or is planned to be in active use.
ResearchElementDefinition.topic	0..*	CodeableConcept	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 searching.
ResearchElementDefinition.author	0..*	ContactDetail	An individiual or organization primarily involved in the creation and maintenance of the content.
ResearchElementDefinition.editor	0..*	ContactDetail	An individual or organization primarily responsible for internal coherence of the content.
ResearchElementDefinition.reviewer	0..*	ContactDetail	An individual or organization primarily responsible for review of some aspect of the content.
ResearchElementDefinition.endorser	0..*	ContactDetail	An individual or organization responsible for officially endorsing the content for use in some setting.
ResearchElementDefinition.relatedArtifact	0..*	RelatedArtifact	Related artifacts such as additional documentation, justification, or bibliographic references.
ResearchElementDefinition.library	0..*	canonical	A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.
ResearchElementDefinition.type	1..1	code	The type of research element, a population, an exposure, or an outcome.
ResearchElementDefinition.variableType	0..1	code	The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive).
ResearchElementDefinition.characteristic	1..*	BackboneElement	A characteristic that defines the members of the research element. Multiple characteristics are applied with "and" semantics.
ResearchElementDefinition.characteristic.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ResearchElementDefinition.characteristic.extension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ResearchElementDefinition.characteristic.modifierExtension	0..*	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ResearchElementDefinition.characteristic.definition[x]	1..1	CodeableConcept	Define 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).
ResearchElementDefinition.characteristic.usageContext	0..*	UsageContext	Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.
ResearchElementDefinition.characteristic.exclude	0..1	boolean	When true, members with this characteristic are excluded from the element.
ResearchElementDefinition.characteristic.unitOfMeasure	0..1	CodeableConcept	Specifies the UCUM unit for the outcome.
ResearchElementDefinition.characteristic.studyEffectiveDescription	0..1	string	A narrative description of the time period the study covers.
ResearchElementDefinition.characteristic.studyEffective[x]	0..1	dateTime	Indicates what effective period the study covers.
ResearchElementDefinition.characteristic.studyEffectiveTimeFromStart	0..1	Duration	Indicates duration from the study initiation.
ResearchElementDefinition.characteristic.studyEffectiveGroupMeasure	0..1	code	Indicates how elements are aggregated within the study effective period.
ResearchElementDefinition.characteristic.participantEffectiveDescription	0..1	string	A narrative description of the time period the study covers.
ResearchElementDefinition.characteristic.participantEffective[x]	0..1	dateTime	Indicates what effective period the study covers.
ResearchElementDefinition.characteristic.participantEffectiveTimeFromStart	0..1	Duration	Indicates duration from the participant's study entry.
ResearchElementDefinition.characteristic.participantEffectiveGroupMeasure	0..1	code	Indicates how elements are aggregated within the study effective period.

Search Parameters

Name	Type	Description	Expression
_text	string	Search on the narrative of the resource
_content	string	Search on the entire content of the resource
_filter	token	Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_has	string	Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_id	token	Logical id of this artifact	Resource.id
_lastUpdated	date	When the resource version last changed	Resource.meta.lastUpdated
_list	string	All resources in nominated list (by id, Type/id, url or one of the magic List types)
_profile	uri	Profiles this resource claims to conform to	Resource.meta.profile
_query	token	A custom search profile that describes a specific defined query operation
_security	token	Security Labels applied to this resource	Resource.meta.security
_source	uri	Identifies where the resource comes from	Resource.meta.source
_tag	token	Tags applied to this resource	Resource.meta.tag
_text	string	Search on the narrative text (html) of the resource
_type	token	Used when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
composed-of	reference	What resource is being referenced	ResearchElementDefinition.relatedArtifact.where(type='composed-of').resource
context	token	A use context assigned to the research element definition	(ResearchElementDefinition.useContext.value.ofType(CodeableConcept))
context-quantity	quantity	A quantity- or range-valued use context assigned to the research element definition	(ResearchElementDefinition.useContext.value.ofType(Quantity)) / (ResearchElementDefinition.useContext.value.ofType(Range))
context-type	token	A type of use context assigned to the research element definition	ResearchElementDefinition.useContext.code
date	date	The research element definition publication date	ResearchElementDefinition.date
depends-on	reference	What resource is being referenced	ResearchElementDefinition.relatedArtifact.where(type='depends-on').resource / ResearchElementDefinition.library
derived-from	reference	What resource is being referenced	ResearchElementDefinition.relatedArtifact.where(type='derived-from').resource
description	string	The description of the research element definition	ResearchElementDefinition.description
effective	date	The time during which the research element definition is intended to be in use	ResearchElementDefinition.effectivePeriod
identifier	token	External identifier for the research element definition	ResearchElementDefinition.identifier
jurisdiction	token	Intended jurisdiction for the research element definition	ResearchElementDefinition.jurisdiction
name	string	Computationally friendly name of the research element definition	ResearchElementDefinition.name
predecessor	reference	What resource is being referenced	ResearchElementDefinition.relatedArtifact.where(type='predecessor').resource
publisher	string	Name of the publisher of the research element definition	ResearchElementDefinition.publisher
status	token	The current status of the research element definition	ResearchElementDefinition.status
successor	reference	What resource is being referenced	ResearchElementDefinition.relatedArtifact.where(type='successor').resource
title	string	The human-friendly name of the research element definition	ResearchElementDefinition.title
topic	token	Topics associated with the ResearchElementDefinition	ResearchElementDefinition.topic
url	uri	The uri that identifies the research element definition	ResearchElementDefinition.url
version	token	The business version of the research element definition	ResearchElementDefinition.version
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the research element definition	ResearchElementDefinition.useContext
context-type-value	composite	A use context type and value assigned to the research element definition	ResearchElementDefinition.useContext