Release 4

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

Detailed Descriptions for the elements in the EffectEvidenceSynthesis resource.

EffectEvidenceSynthesis
Element IdEffectEvidenceSynthesis
Definition

The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.

Cardinality0..*
TypeDomainResource
Invariants
Defined on this element
ees-0Warning 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}')
EffectEvidenceSynthesis.url
Element IdEffectEvidenceSynthesis.url
Definition

An absolute URI that is used to identify this effect evidence synthesis 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 effect evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the effect evidence synthesis is stored on different servers.

Cardinality0..1
Typeuri
Requirements

Allows the effect evidence synthesis to be referenced by a single globally unique identifier.

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

EffectEvidenceSynthesis.identifier
Element IdEffectEvidenceSynthesis.identifier
Definition

A formal identifier that is used to identify this effect evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this effect evidence synthesis outside of FHIR, where it is not possible to use the logical URI.

EffectEvidenceSynthesis.version
Element IdEffectEvidenceSynthesis.version
Definition

The identifier that is used to identify this version of the effect evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the effect evidence synthesis 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.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

There may be different effect evidence synthesis instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the effect evidence synthesis with the format [url]|[version].

EffectEvidenceSynthesis.name
Element IdEffectEvidenceSynthesis.name
Definition

A natural language name identifying the effect evidence synthesis. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
inv-0Warning 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}')
To DoNote: This was added back in because this is a metadata resource and it's a required element for metadata resource searching.
EffectEvidenceSynthesis.title
Element IdEffectEvidenceSynthesis.title
Definition

A short, descriptive, user-friendly title for the effect evidence synthesis.

Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

To DoNote: This was added back in because this is a metadata resource and it's a required element for metadata resource searching.
EffectEvidenceSynthesis.status
Element IdEffectEvidenceSynthesis.status
Definition

The status of this effect evidence synthesis. Enables tracking the life-cycle of the content.

Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of effect evidence synthesiss that are appropriate for use versus not.

EffectEvidenceSynthesis.date
Element IdEffectEvidenceSynthesis.date
Definition

The date (and optionally time) when the effect evidence synthesis 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 effect evidence synthesis changes.

Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the effect evidence synthesis. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

EffectEvidenceSynthesis.publisher
Element IdEffectEvidenceSynthesis.publisher
Definition

The name of the organization or individual that published the effect evidence synthesis.

Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the effect evidence synthesis. May also allow for contact.

Summarytrue
Comments

Usually an organization but may be an individual. The publisher (or steward) of the effect evidence synthesis is the organization or individual primarily responsible for the maintenance and upkeep of the effect evidence synthesis. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the effect evidence synthesis. This item SHOULD be populated unless the information is available from context.

EffectEvidenceSynthesis.contact
Element IdEffectEvidenceSynthesis.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

EffectEvidenceSynthesis.description
Element IdEffectEvidenceSynthesis.description
Definition

A free text natural language description of the effect evidence synthesis from a consumer's perspective.

Cardinality0..1
Typemarkdown
Summarytrue
Comments

This description can be used to capture details such as why the effect evidence synthesis was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the effect evidence synthesis as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the effect evidence synthesis is presumed to be the predominant language in the place the effect evidence synthesis was created).

EffectEvidenceSynthesis.note
Element IdEffectEvidenceSynthesis.note
Definition

A human-readable string to clarify or explain concepts about the resource.

Cardinality0..*
TypeAnnotation
EffectEvidenceSynthesis.useContext
Element IdEffectEvidenceSynthesis.useContext
Definition

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 effect evidence synthesis instances.

Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

To DoNote: This was added back in because this is a metadata resource and it's a required element for metadata resource searching.
EffectEvidenceSynthesis.jurisdiction
Element IdEffectEvidenceSynthesis.jurisdiction
Definition

A legal or geographic region in which the effect evidence synthesis is intended to be used.

Cardinality0..*
Terminology BindingJurisdiction (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the effect evidence synthesis to be used in jurisdictions other than those for which it was originally designed or intended.

To DoNote: This was added back in because this is a metadata resource and it's a required element for metadata resource searching.
EffectEvidenceSynthesis.copyright
Element IdEffectEvidenceSynthesis.copyright
Definition

A copyright statement relating to the effect evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the effect evidence synthesis.

Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the effect evidence synthesis and/or its content.

Alternate NamesLicense; Restrictions
EffectEvidenceSynthesis.approvalDate
Element IdEffectEvidenceSynthesis.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Cardinality0..1
Typedate
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

EffectEvidenceSynthesis.lastReviewDate
Element IdEffectEvidenceSynthesis.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Cardinality0..1
Typedate
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this date follows the original approval date.

EffectEvidenceSynthesis.effectivePeriod
Element IdEffectEvidenceSynthesis.effectivePeriod
Definition

The period during which the effect evidence synthesis content was or is planned to be in active use.

Cardinality0..1
TypePeriod
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the effect evidence synthesis are or are expected to be used instead.

Summarytrue
Comments

The effective period for a effect evidence synthesis determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

EffectEvidenceSynthesis.topic
Element IdEffectEvidenceSynthesis.topic
Definition

Descriptive topics related to the content of the EffectEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.

Cardinality0..*
Terminology BindingDefinitionTopic (Example)
TypeCodeableConcept
Requirements

Repositories must be able to determine how to categorize the EffectEvidenceSynthesis so that it can be found by topical searches.

EffectEvidenceSynthesis.author
Element IdEffectEvidenceSynthesis.author
Definition

An individiual or organization primarily involved in the creation and maintenance of the content.

Cardinality0..*
TypeContactDetail
EffectEvidenceSynthesis.editor
Element IdEffectEvidenceSynthesis.editor
Definition

An individual or organization primarily responsible for internal coherence of the content.

Cardinality0..*
TypeContactDetail
EffectEvidenceSynthesis.reviewer
Element IdEffectEvidenceSynthesis.reviewer
Definition

An individual or organization primarily responsible for review of some aspect of the content.

Cardinality0..*
TypeContactDetail
EffectEvidenceSynthesis.endorser
Element IdEffectEvidenceSynthesis.endorser
Definition

An individual or organization responsible for officially endorsing the content for use in some setting.

Cardinality0..*
TypeContactDetail
EffectEvidenceSynthesis.relatedArtifact
Element IdEffectEvidenceSynthesis.relatedArtifact
Definition

Related artifacts such as additional documentation, justification, or bibliographic references.

Cardinality0..*
TypeRelatedArtifact
Requirements

EffectEvidenceSynthesiss must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

EffectEvidenceSynthesis.synthesisType
Element IdEffectEvidenceSynthesis.synthesisType
Definition

Type of synthesis eg meta-analysis.

Cardinality0..1
Terminology BindingSynthesisType (Extensible)
TypeCodeableConcept
EffectEvidenceSynthesis.studyType
Element IdEffectEvidenceSynthesis.studyType
Definition

Type of study eg randomized trial.

Cardinality0..1
Terminology BindingStudyType (Extensible)
TypeCodeableConcept
EffectEvidenceSynthesis.population
Element IdEffectEvidenceSynthesis.population
Definition

A reference to a EvidenceVariable resource that defines the population for the research.

Cardinality1..1
TypeReference(EvidenceVariable)
Summarytrue
EffectEvidenceSynthesis.exposure
Element IdEffectEvidenceSynthesis.exposure
Definition

A reference to a EvidenceVariable resource that defines the exposure for the research.

Cardinality1..1
TypeReference(EvidenceVariable)
Summarytrue
EffectEvidenceSynthesis.exposureAlternative
Element IdEffectEvidenceSynthesis.exposureAlternative
Definition

A reference to a EvidenceVariable resource that defines the comparison exposure for the research.

Cardinality1..1
TypeReference(EvidenceVariable)
Summarytrue
EffectEvidenceSynthesis.outcome
Element IdEffectEvidenceSynthesis.outcome
Definition

A reference to a EvidenceVariable resomece that defines the outcome for the research.

Cardinality1..1
TypeReference(EvidenceVariable)
Summarytrue
EffectEvidenceSynthesis.sampleSize
Element IdEffectEvidenceSynthesis.sampleSize
Definition

A description of the size of the sample involved in the synthesis.

Cardinality0..1
EffectEvidenceSynthesis.sampleSize.description
Element IdEffectEvidenceSynthesis.sampleSize.description
Definition

Human-readable summary of sample size.

Cardinality0..1
Typestring
EffectEvidenceSynthesis.sampleSize.numberOfStudies
Element IdEffectEvidenceSynthesis.sampleSize.numberOfStudies
Definition

Number of studies included in this evidence synthesis.

Cardinality0..1
Typeinteger
EffectEvidenceSynthesis.sampleSize.numberOfParticipants
Element IdEffectEvidenceSynthesis.sampleSize.numberOfParticipants
Definition

Number of participants included in this evidence synthesis.

Cardinality0..1
Typeinteger
EffectEvidenceSynthesis.resultsByExposure
Element IdEffectEvidenceSynthesis.resultsByExposure
Definition

A description of the results for each exposure considered in the effect estimate.

Cardinality0..*
EffectEvidenceSynthesis.resultsByExposure.description
Element IdEffectEvidenceSynthesis.resultsByExposure.description
Definition

Human-readable summary of results by exposure state.

Cardinality0..1
Typestring
EffectEvidenceSynthesis.resultsByExposure.exposureState
Element IdEffectEvidenceSynthesis.resultsByExposure.exposureState
Definition

Whether these results are for the exposure state or alternative exposure state.

Cardinality0..1
Terminology BindingExposureState (Required)
Typecode
EffectEvidenceSynthesis.resultsByExposure.variantState
Element IdEffectEvidenceSynthesis.resultsByExposure.variantState
Definition

Used to define variant exposure states such as low-risk state.

Cardinality0..1
Terminology BindingEvidenceVariantState (Extensible)
TypeCodeableConcept
EffectEvidenceSynthesis.resultsByExposure.riskEvidenceSynthesis
Element IdEffectEvidenceSynthesis.resultsByExposure.riskEvidenceSynthesis
Definition

Reference to a RiskEvidenceSynthesis resource.

Cardinality1..1
TypeReference(RiskEvidenceSynthesis)
EffectEvidenceSynthesis.effectEstimate
Element IdEffectEvidenceSynthesis.effectEstimate
Definition

The estimated effect of the exposure variant.

Cardinality0..*
Summarytrue
To DoNote: Cardinality was relaxed to 0..* to get the initial draft building.
EffectEvidenceSynthesis.effectEstimate.description
Element IdEffectEvidenceSynthesis.effectEstimate.description
Definition

Human-readable summary of effect estimate.

Cardinality0..1
Typestring
EffectEvidenceSynthesis.effectEstimate.type
Element IdEffectEvidenceSynthesis.effectEstimate.type
Definition

Examples include relative risk and mean difference.

Cardinality0..1
Terminology BindingEffectEstimateType (Extensible)
TypeCodeableConcept
EffectEvidenceSynthesis.effectEstimate.variantState
Element IdEffectEvidenceSynthesis.effectEstimate.variantState
Definition

Used to define variant exposure states such as low-risk state.

Cardinality0..1
Terminology BindingEvidenceVariantState (Extensible)
TypeCodeableConcept
EffectEvidenceSynthesis.effectEstimate.value
Element IdEffectEvidenceSynthesis.effectEstimate.value
Definition

The point estimate of the effect estimate.

Cardinality0..1
Typedecimal
EffectEvidenceSynthesis.effectEstimate.unitOfMeasure
Element IdEffectEvidenceSynthesis.effectEstimate.unitOfMeasure
Definition

Specifies the UCUM unit for the outcome.

Cardinality0..1
Terminology BindingUCUM Codes (Required)
TypeCodeableConcept
EffectEvidenceSynthesis.effectEstimate.precisionEstimate
Element IdEffectEvidenceSynthesis.effectEstimate.precisionEstimate
Definition

A description of the precision of the estimate for the effect.

Cardinality0..*
EffectEvidenceSynthesis.effectEstimate.precisionEstimate.type
Element IdEffectEvidenceSynthesis.effectEstimate.precisionEstimate.type
Definition

Examples include confidence interval and interquartile range.

Cardinality0..1
Terminology BindingPrecisionEstimateType (Extensible)
TypeCodeableConcept
EffectEvidenceSynthesis.effectEstimate.precisionEstimate.level
Element IdEffectEvidenceSynthesis.effectEstimate.precisionEstimate.level
Definition

Use 95 for a 95% confidence interval.

Cardinality0..1
Typedecimal
EffectEvidenceSynthesis.effectEstimate.precisionEstimate.from
Element IdEffectEvidenceSynthesis.effectEstimate.precisionEstimate.from
Definition

Lower bound of confidence interval.

Cardinality0..1
Typedecimal
EffectEvidenceSynthesis.effectEstimate.precisionEstimate.to
Element IdEffectEvidenceSynthesis.effectEstimate.precisionEstimate.to
Definition

Upper bound of confidence interval.

Cardinality0..1
Typedecimal
EffectEvidenceSynthesis.certainty
Element IdEffectEvidenceSynthesis.certainty
Definition

A description of the certainty of the effect estimate.

Cardinality0..*
EffectEvidenceSynthesis.certainty.rating
Element IdEffectEvidenceSynthesis.certainty.rating
Definition

A rating of the certainty of the effect estimate.

Cardinality0..*
Terminology BindingQualityOfEvidenceRating (Extensible)
TypeCodeableConcept
EffectEvidenceSynthesis.certainty.note
Element IdEffectEvidenceSynthesis.certainty.note
Definition

A human-readable string to clarify or explain concepts about the resource.

Cardinality0..*
TypeAnnotation
EffectEvidenceSynthesis.certainty.certaintySubcomponent
Element IdEffectEvidenceSynthesis.certainty.certaintySubcomponent
Definition

A description of a component of the overall certainty.

Cardinality0..*
EffectEvidenceSynthesis.certainty.certaintySubcomponent.type
Element IdEffectEvidenceSynthesis.certainty.certaintySubcomponent.type
Definition

Type of subcomponent of certainty rating.

Cardinality0..1
Terminology BindingCertaintySubcomponentType (Extensible)
TypeCodeableConcept
EffectEvidenceSynthesis.certainty.certaintySubcomponent.rating
Element IdEffectEvidenceSynthesis.certainty.certaintySubcomponent.rating
Definition

A rating of a subcomponent of rating certainty.

Cardinality0..*
Terminology BindingCertaintySubcomponentRating (Extensible)
TypeCodeableConcept
EffectEvidenceSynthesis.certainty.certaintySubcomponent.note
Element IdEffectEvidenceSynthesis.certainty.certaintySubcomponent.note
Definition

A human-readable string to clarify or explain concepts about the resource.

Cardinality0..*
TypeAnnotation