This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Clinical Decision Support Work Group | Maturity Level: 0 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
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.
The scope of the EffectEvidenceSynthesis resource is to describe the estimates of an effect of an exposure on an outcome where the effect estimates are derived from the combination of research studies. Effect estimates are a measure of difference between the exposure state and an alternative exposure state (often called the control or comparator state) Expressing effect estimates is done throughout reporting of biomedical research, systematic reviews, and clinical reference across all disciplines.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
EffectEvidenceSynthesis | ITU | DomainResource | A quantified estimate of effect based on a body of evidence + 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..1 | uri | Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the effect evidence synthesis |
version | Σ | 0..1 | string | Business version of the effect evidence synthesis |
name | ΣI | 0..1 | string | Name for this effect evidence synthesis (computer friendly) |
title | Σ | 0..1 | string | Name for this effect evidence synthesis (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | Σ | 0..1 | markdown | Natural language description of the effect evidence synthesis |
note | 0..* | Annotation | Used for footnotes or explanatory notes | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for effect evidence synthesis (if applicable) Jurisdiction (Extensible) |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the effect evidence synthesis was approved by publisher | |
lastReviewDate | 0..1 | date | When the effect evidence synthesis was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the effect evidence synthesis is expected to be used |
topic | 0..* | CodeableConcept | The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc. DefinitionTopic (Example) | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. | |
synthesisType | 0..1 | CodeableConcept | Type of synthesis SynthesisType (Extensible) | |
studyType | 0..1 | CodeableConcept | Type of study StudyType (Extensible) | |
population | Σ | 1..1 | Reference(EvidenceVariable) | What population? |
exposure | Σ | 1..1 | Reference(EvidenceVariable) | What exposure? |
exposureAlternative | Σ | 1..1 | Reference(EvidenceVariable) | What comparison exposure? |
outcome | Σ | 1..1 | Reference(EvidenceVariable) | What outcome? |
sampleSize | 0..1 | BackboneElement | What sample size was involved? | |
description | 0..1 | string | Description of sample size | |
numberOfStudies | 0..1 | integer | How many studies? | |
numberOfParticipants | 0..1 | integer | How many participants? | |
resultsByExposure | 0..* | BackboneElement | What was the result per exposure? | |
description | 0..1 | string | Description of results by exposure | |
exposureState | 0..1 | code | exposure | exposure-alternative ExposureState (Required) | |
variantState | 0..1 | CodeableConcept | Variant exposure states EvidenceVariantState (Extensible) | |
riskEvidenceSynthesis | 1..1 | Reference(RiskEvidenceSynthesis) | Risk evidence synthesis | |
effectEstimate | Σ | 0..* | BackboneElement | What was the estimated effect |
description | 0..1 | string | Description of effect estimate | |
type | 0..1 | CodeableConcept | Type of efffect estimate EffectEstimateType (Extensible) | |
variantState | 0..1 | CodeableConcept | Variant exposure states EvidenceVariantState (Extensible) | |
value | 0..1 | decimal | Point estimate | |
unitOfMeasure | 0..1 | CodeableConcept | What unit is the outcome described in? UCUM Codes (Required) | |
precisionEstimate | 0..* | BackboneElement | How precise the estimate is | |
type | 0..1 | CodeableConcept | Type of precision estimate PrecisionEstimateType (Extensible) | |
level | 0..1 | decimal | Level of confidence interval | |
from | 0..1 | decimal | Lower bound | |
to | 0..1 | decimal | Upper bound | |
certainty | 0..* | BackboneElement | How certain is the effect | |
rating | 0..* | CodeableConcept | Certainty rating QualityOfEvidenceRating (Extensible) | |
note | 0..* | Annotation | Used for footnotes or explanatory notes | |
certaintySubcomponent | 0..* | BackboneElement | A component that contributes to the overall certainty | |
type | 0..1 | CodeableConcept | Type of subcomponent of certainty rating CertaintySubcomponentType (Extensible) | |
rating | 0..* | CodeableConcept | Subcomponent certainty rating CertaintySubcomponentRating (Extensible) | |
note | 0..* | Annotation | Used for footnotes or explanatory notes | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<EffectEvidenceSynthesis xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the effect evidence synthesis --></identifier> <version value="[string]"/><!-- 0..1 Business version of the effect evidence synthesis --> <name value="[string]"/><!-- 0..1 Name for this effect evidence synthesis (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this effect evidence synthesis (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <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 effect evidence synthesis --> <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for effect evidence synthesis (if applicable) --></jurisdiction> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the effect evidence synthesis was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the effect evidence synthesis was last reviewed --> <effectivePeriod><!-- 0..1 Period When the effect evidence synthesis is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept The category of the EffectEvidenceSynthesis, 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> <synthesisType><!-- 0..1 CodeableConcept Type of synthesis --></synthesisType> <studyType><!-- 0..1 CodeableConcept Type of study --></studyType> <population><!-- 1..1 Reference(EvidenceVariable) What population? --></population> <exposure><!-- 1..1 Reference(EvidenceVariable) What exposure? --></exposure> <exposureAlternative><!-- 1..1 Reference(EvidenceVariable) What comparison exposure? --></exposureAlternative> <outcome><!-- 1..1 Reference(EvidenceVariable) What outcome? --></outcome> <sampleSize> <!-- 0..1 What sample size was involved? --> <description value="[string]"/><!-- 0..1 Description of sample size --> <numberOfStudies value="[integer]"/><!-- 0..1 How many studies? --> <numberOfParticipants value="[integer]"/><!-- 0..1 How many participants? --> </sampleSize> <resultsByExposure> <!-- 0..* What was the result per exposure? --> <description value="[string]"/><!-- 0..1 Description of results by exposure --> <exposureState value="[code]"/><!-- 0..1 exposure | exposure-alternative --> <variantState><!-- 0..1 CodeableConcept Variant exposure states --></variantState> <riskEvidenceSynthesis><!-- 1..1 Reference(RiskEvidenceSynthesis) Risk evidence synthesis --></riskEvidenceSynthesis> </resultsByExposure> <effectEstimate> <!-- 0..* What was the estimated effect --> <description value="[string]"/><!-- 0..1 Description of effect estimate --> <type><!-- 0..1 CodeableConcept Type of efffect estimate --></type> <variantState><!-- 0..1 CodeableConcept Variant exposure states --></variantState> <value value="[decimal]"/><!-- 0..1 Point estimate --> <unitOfMeasure><!-- 0..1 CodeableConcept What unit is the outcome described in? --></unitOfMeasure> <precisionEstimate> <!-- 0..* How precise the estimate is --> <type><!-- 0..1 CodeableConcept Type of precision estimate --></type> <level value="[decimal]"/><!-- 0..1 Level of confidence interval --> <from value="[decimal]"/><!-- 0..1 Lower bound --> <to value="[decimal]"/><!-- 0..1 Upper bound --> </precisionEstimate> </effectEstimate> <certainty> <!-- 0..* How certain is the effect --> <rating><!-- 0..* CodeableConcept Certainty rating --></rating> <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note> <certaintySubcomponent> <!-- 0..* A component that contributes to the overall certainty --> <type><!-- 0..1 CodeableConcept Type of subcomponent of certainty rating --></type> <rating><!-- 0..* CodeableConcept Subcomponent certainty rating --></rating> <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note> </certaintySubcomponent> </certainty> </EffectEvidenceSynthesis>
JSON Template
{ "resourceType" : "EffectEvidenceSynthesis", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the effect evidence synthesis "version" : "<string>", // Business version of the effect evidence synthesis "name" : "<string>", // C? Name for this effect evidence synthesis (computer friendly) "title" : "<string>", // Name for this effect evidence synthesis (human friendly) "status" : "<code>", // R! draft | active | retired | unknown "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 effect evidence synthesis "note" : [{ Annotation }], // Used for footnotes or explanatory notes "useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for effect evidence synthesis (if applicable) "copyright" : "<markdown>", // Use and/or publishing restrictions "approvalDate" : "<date>", // When the effect evidence synthesis was approved by publisher "lastReviewDate" : "<date>", // When the effect evidence synthesis was last reviewed "effectivePeriod" : { Period }, // When the effect evidence synthesis is expected to be used "topic" : [{ CodeableConcept }], // The category of the EffectEvidenceSynthesis, 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. "synthesisType" : { CodeableConcept }, // Type of synthesis "studyType" : { CodeableConcept }, // Type of study "population" : { Reference(EvidenceVariable) }, // R! What population? "exposure" : { Reference(EvidenceVariable) }, // R! What exposure? "exposureAlternative" : { Reference(EvidenceVariable) }, // R! What comparison exposure? "outcome" : { Reference(EvidenceVariable) }, // R! What outcome? "sampleSize" : { // What sample size was involved? "description" : "<string>", // Description of sample size "numberOfStudies" : <integer>, // How many studies? "numberOfParticipants" : <integer> // How many participants? }, "resultsByExposure" : [{ // What was the result per exposure? "description" : "<string>", // Description of results by exposure "exposureState" : "<code>", // exposure | exposure-alternative "variantState" : { CodeableConcept }, // Variant exposure states "riskEvidenceSynthesis" : { Reference(RiskEvidenceSynthesis) } // R! Risk evidence synthesis }], "effectEstimate" : [{ // What was the estimated effect "description" : "<string>", // Description of effect estimate "type" : { CodeableConcept }, // Type of efffect estimate "variantState" : { CodeableConcept }, // Variant exposure states "value" : <decimal>, // Point estimate "unitOfMeasure" : { CodeableConcept }, // What unit is the outcome described in? "precisionEstimate" : [{ // How precise the estimate is "type" : { CodeableConcept }, // Type of precision estimate "level" : <decimal>, // Level of confidence interval "from" : <decimal>, // Lower bound "to" : <decimal> // Upper bound }] }], "certainty" : [{ // How certain is the effect "rating" : [{ CodeableConcept }], // Certainty rating "note" : [{ Annotation }], // Used for footnotes or explanatory notes "certaintySubcomponent" : [{ // A component that contributes to the overall certainty "type" : { CodeableConcept }, // Type of subcomponent of certainty rating "rating" : [{ CodeableConcept }], // Subcomponent certainty rating "note" : [{ Annotation }] // Used for footnotes or explanatory notes }] }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:EffectEvidenceSynthesis; 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:EffectEvidenceSynthesis.url [ uri ]; # 0..1 Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique) fhir:EffectEvidenceSynthesis.identifier [ Identifier ], ... ; # 0..* Additional identifier for the effect evidence synthesis fhir:EffectEvidenceSynthesis.version [ string ]; # 0..1 Business version of the effect evidence synthesis fhir:EffectEvidenceSynthesis.name [ string ]; # 0..1 Name for this effect evidence synthesis (computer friendly) fhir:EffectEvidenceSynthesis.title [ string ]; # 0..1 Name for this effect evidence synthesis (human friendly) fhir:EffectEvidenceSynthesis.status [ code ]; # 1..1 draft | active | retired | unknown fhir:EffectEvidenceSynthesis.date [ dateTime ]; # 0..1 Date last changed fhir:EffectEvidenceSynthesis.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:EffectEvidenceSynthesis.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:EffectEvidenceSynthesis.description [ markdown ]; # 0..1 Natural language description of the effect evidence synthesis fhir:EffectEvidenceSynthesis.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes fhir:EffectEvidenceSynthesis.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:EffectEvidenceSynthesis.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for effect evidence synthesis (if applicable) fhir:EffectEvidenceSynthesis.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:EffectEvidenceSynthesis.approvalDate [ date ]; # 0..1 When the effect evidence synthesis was approved by publisher fhir:EffectEvidenceSynthesis.lastReviewDate [ date ]; # 0..1 When the effect evidence synthesis was last reviewed fhir:EffectEvidenceSynthesis.effectivePeriod [ Period ]; # 0..1 When the effect evidence synthesis is expected to be used fhir:EffectEvidenceSynthesis.topic [ CodeableConcept ], ... ; # 0..* The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc. fhir:EffectEvidenceSynthesis.author [ ContactDetail ], ... ; # 0..* Who authored the content fhir:EffectEvidenceSynthesis.editor [ ContactDetail ], ... ; # 0..* Who edited the content fhir:EffectEvidenceSynthesis.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content fhir:EffectEvidenceSynthesis.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content fhir:EffectEvidenceSynthesis.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc. fhir:EffectEvidenceSynthesis.synthesisType [ CodeableConcept ]; # 0..1 Type of synthesis fhir:EffectEvidenceSynthesis.studyType [ CodeableConcept ]; # 0..1 Type of study fhir:EffectEvidenceSynthesis.population [ Reference(EvidenceVariable) ]; # 1..1 What population? fhir:EffectEvidenceSynthesis.exposure [ Reference(EvidenceVariable) ]; # 1..1 What exposure? fhir:EffectEvidenceSynthesis.exposureAlternative [ Reference(EvidenceVariable) ]; # 1..1 What comparison exposure? fhir:EffectEvidenceSynthesis.outcome [ Reference(EvidenceVariable) ]; # 1..1 What outcome? fhir:EffectEvidenceSynthesis.sampleSize [ # 0..1 What sample size was involved? fhir:EffectEvidenceSynthesis.sampleSize.description [ string ]; # 0..1 Description of sample size fhir:EffectEvidenceSynthesis.sampleSize.numberOfStudies [ integer ]; # 0..1 How many studies? fhir:EffectEvidenceSynthesis.sampleSize.numberOfParticipants [ integer ]; # 0..1 How many participants? ]; fhir:EffectEvidenceSynthesis.resultsByExposure [ # 0..* What was the result per exposure? fhir:EffectEvidenceSynthesis.resultsByExposure.description [ string ]; # 0..1 Description of results by exposure fhir:EffectEvidenceSynthesis.resultsByExposure.exposureState [ code ]; # 0..1 exposure | exposure-alternative fhir:EffectEvidenceSynthesis.resultsByExposure.variantState [ CodeableConcept ]; # 0..1 Variant exposure states fhir:EffectEvidenceSynthesis.resultsByExposure.riskEvidenceSynthesis [ Reference(RiskEvidenceSynthesis) ]; # 1..1 Risk evidence synthesis ], ...; fhir:EffectEvidenceSynthesis.effectEstimate [ # 0..* What was the estimated effect fhir:EffectEvidenceSynthesis.effectEstimate.description [ string ]; # 0..1 Description of effect estimate fhir:EffectEvidenceSynthesis.effectEstimate.type [ CodeableConcept ]; # 0..1 Type of efffect estimate fhir:EffectEvidenceSynthesis.effectEstimate.variantState [ CodeableConcept ]; # 0..1 Variant exposure states fhir:EffectEvidenceSynthesis.effectEstimate.value [ decimal ]; # 0..1 Point estimate fhir:EffectEvidenceSynthesis.effectEstimate.unitOfMeasure [ CodeableConcept ]; # 0..1 What unit is the outcome described in? fhir:EffectEvidenceSynthesis.effectEstimate.precisionEstimate [ # 0..* How precise the estimate is fhir:EffectEvidenceSynthesis.effectEstimate.precisionEstimate.type [ CodeableConcept ]; # 0..1 Type of precision estimate fhir:EffectEvidenceSynthesis.effectEstimate.precisionEstimate.level [ decimal ]; # 0..1 Level of confidence interval fhir:EffectEvidenceSynthesis.effectEstimate.precisionEstimate.from [ decimal ]; # 0..1 Lower bound fhir:EffectEvidenceSynthesis.effectEstimate.precisionEstimate.to [ decimal ]; # 0..1 Upper bound ], ...; ], ...; fhir:EffectEvidenceSynthesis.certainty [ # 0..* How certain is the effect fhir:EffectEvidenceSynthesis.certainty.rating [ CodeableConcept ], ... ; # 0..* Certainty rating fhir:EffectEvidenceSynthesis.certainty.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes fhir:EffectEvidenceSynthesis.certainty.certaintySubcomponent [ # 0..* A component that contributes to the overall certainty fhir:EffectEvidenceSynthesis.certainty.certaintySubcomponent.type [ CodeableConcept ]; # 0..1 Type of subcomponent of certainty rating fhir:EffectEvidenceSynthesis.certainty.certaintySubcomponent.rating [ CodeableConcept ], ... ; # 0..* Subcomponent certainty rating fhir:EffectEvidenceSynthesis.certainty.certaintySubcomponent.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes ], ...; ], ...; ]
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
EffectEvidenceSynthesis | ITU | DomainResource | A quantified estimate of effect based on a body of evidence + 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..1 | uri | Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the effect evidence synthesis |
version | Σ | 0..1 | string | Business version of the effect evidence synthesis |
name | ΣI | 0..1 | string | Name for this effect evidence synthesis (computer friendly) |
title | Σ | 0..1 | string | Name for this effect evidence synthesis (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | Σ | 0..1 | markdown | Natural language description of the effect evidence synthesis |
note | 0..* | Annotation | Used for footnotes or explanatory notes | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for effect evidence synthesis (if applicable) Jurisdiction (Extensible) |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the effect evidence synthesis was approved by publisher | |
lastReviewDate | 0..1 | date | When the effect evidence synthesis was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the effect evidence synthesis is expected to be used |
topic | 0..* | CodeableConcept | The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc. DefinitionTopic (Example) | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. | |
synthesisType | 0..1 | CodeableConcept | Type of synthesis SynthesisType (Extensible) | |
studyType | 0..1 | CodeableConcept | Type of study StudyType (Extensible) | |
population | Σ | 1..1 | Reference(EvidenceVariable) | What population? |
exposure | Σ | 1..1 | Reference(EvidenceVariable) | What exposure? |
exposureAlternative | Σ | 1..1 | Reference(EvidenceVariable) | What comparison exposure? |
outcome | Σ | 1..1 | Reference(EvidenceVariable) | What outcome? |
sampleSize | 0..1 | BackboneElement | What sample size was involved? | |
description | 0..1 | string | Description of sample size | |
numberOfStudies | 0..1 | integer | How many studies? | |
numberOfParticipants | 0..1 | integer | How many participants? | |
resultsByExposure | 0..* | BackboneElement | What was the result per exposure? | |
description | 0..1 | string | Description of results by exposure | |
exposureState | 0..1 | code | exposure | exposure-alternative ExposureState (Required) | |
variantState | 0..1 | CodeableConcept | Variant exposure states EvidenceVariantState (Extensible) | |
riskEvidenceSynthesis | 1..1 | Reference(RiskEvidenceSynthesis) | Risk evidence synthesis | |
effectEstimate | Σ | 0..* | BackboneElement | What was the estimated effect |
description | 0..1 | string | Description of effect estimate | |
type | 0..1 | CodeableConcept | Type of efffect estimate EffectEstimateType (Extensible) | |
variantState | 0..1 | CodeableConcept | Variant exposure states EvidenceVariantState (Extensible) | |
value | 0..1 | decimal | Point estimate | |
unitOfMeasure | 0..1 | CodeableConcept | What unit is the outcome described in? UCUM Codes (Required) | |
precisionEstimate | 0..* | BackboneElement | How precise the estimate is | |
type | 0..1 | CodeableConcept | Type of precision estimate PrecisionEstimateType (Extensible) | |
level | 0..1 | decimal | Level of confidence interval | |
from | 0..1 | decimal | Lower bound | |
to | 0..1 | decimal | Upper bound | |
certainty | 0..* | BackboneElement | How certain is the effect | |
rating | 0..* | CodeableConcept | Certainty rating QualityOfEvidenceRating (Extensible) | |
note | 0..* | Annotation | Used for footnotes or explanatory notes | |
certaintySubcomponent | 0..* | BackboneElement | A component that contributes to the overall certainty | |
type | 0..1 | CodeableConcept | Type of subcomponent of certainty rating CertaintySubcomponentType (Extensible) | |
rating | 0..* | CodeableConcept | Subcomponent certainty rating CertaintySubcomponentRating (Extensible) | |
note | 0..* | Annotation | Used for footnotes or explanatory notes | |
Documentation for this format |
XML Template
<EffectEvidenceSynthesis xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the effect evidence synthesis --></identifier> <version value="[string]"/><!-- 0..1 Business version of the effect evidence synthesis --> <name value="[string]"/><!-- 0..1 Name for this effect evidence synthesis (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this effect evidence synthesis (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <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 effect evidence synthesis --> <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for effect evidence synthesis (if applicable) --></jurisdiction> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the effect evidence synthesis was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the effect evidence synthesis was last reviewed --> <effectivePeriod><!-- 0..1 Period When the effect evidence synthesis is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept The category of the EffectEvidenceSynthesis, 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> <synthesisType><!-- 0..1 CodeableConcept Type of synthesis --></synthesisType> <studyType><!-- 0..1 CodeableConcept Type of study --></studyType> <population><!-- 1..1 Reference(EvidenceVariable) What population? --></population> <exposure><!-- 1..1 Reference(EvidenceVariable) What exposure? --></exposure> <exposureAlternative><!-- 1..1 Reference(EvidenceVariable) What comparison exposure? --></exposureAlternative> <outcome><!-- 1..1 Reference(EvidenceVariable) What outcome? --></outcome> <sampleSize> <!-- 0..1 What sample size was involved? --> <description value="[string]"/><!-- 0..1 Description of sample size --> <numberOfStudies value="[integer]"/><!-- 0..1 How many studies? --> <numberOfParticipants value="[integer]"/><!-- 0..1 How many participants? --> </sampleSize> <resultsByExposure> <!-- 0..* What was the result per exposure? --> <description value="[string]"/><!-- 0..1 Description of results by exposure --> <exposureState value="[code]"/><!-- 0..1 exposure | exposure-alternative --> <variantState><!-- 0..1 CodeableConcept Variant exposure states --></variantState> <riskEvidenceSynthesis><!-- 1..1 Reference(RiskEvidenceSynthesis) Risk evidence synthesis --></riskEvidenceSynthesis> </resultsByExposure> <effectEstimate> <!-- 0..* What was the estimated effect --> <description value="[string]"/><!-- 0..1 Description of effect estimate --> <type><!-- 0..1 CodeableConcept Type of efffect estimate --></type> <variantState><!-- 0..1 CodeableConcept Variant exposure states --></variantState> <value value="[decimal]"/><!-- 0..1 Point estimate --> <unitOfMeasure><!-- 0..1 CodeableConcept What unit is the outcome described in? --></unitOfMeasure> <precisionEstimate> <!-- 0..* How precise the estimate is --> <type><!-- 0..1 CodeableConcept Type of precision estimate --></type> <level value="[decimal]"/><!-- 0..1 Level of confidence interval --> <from value="[decimal]"/><!-- 0..1 Lower bound --> <to value="[decimal]"/><!-- 0..1 Upper bound --> </precisionEstimate> </effectEstimate> <certainty> <!-- 0..* How certain is the effect --> <rating><!-- 0..* CodeableConcept Certainty rating --></rating> <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note> <certaintySubcomponent> <!-- 0..* A component that contributes to the overall certainty --> <type><!-- 0..1 CodeableConcept Type of subcomponent of certainty rating --></type> <rating><!-- 0..* CodeableConcept Subcomponent certainty rating --></rating> <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note> </certaintySubcomponent> </certainty> </EffectEvidenceSynthesis>
JSON Template
{ "resourceType" : "EffectEvidenceSynthesis", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the effect evidence synthesis "version" : "<string>", // Business version of the effect evidence synthesis "name" : "<string>", // C? Name for this effect evidence synthesis (computer friendly) "title" : "<string>", // Name for this effect evidence synthesis (human friendly) "status" : "<code>", // R! draft | active | retired | unknown "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 effect evidence synthesis "note" : [{ Annotation }], // Used for footnotes or explanatory notes "useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for effect evidence synthesis (if applicable) "copyright" : "<markdown>", // Use and/or publishing restrictions "approvalDate" : "<date>", // When the effect evidence synthesis was approved by publisher "lastReviewDate" : "<date>", // When the effect evidence synthesis was last reviewed "effectivePeriod" : { Period }, // When the effect evidence synthesis is expected to be used "topic" : [{ CodeableConcept }], // The category of the EffectEvidenceSynthesis, 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. "synthesisType" : { CodeableConcept }, // Type of synthesis "studyType" : { CodeableConcept }, // Type of study "population" : { Reference(EvidenceVariable) }, // R! What population? "exposure" : { Reference(EvidenceVariable) }, // R! What exposure? "exposureAlternative" : { Reference(EvidenceVariable) }, // R! What comparison exposure? "outcome" : { Reference(EvidenceVariable) }, // R! What outcome? "sampleSize" : { // What sample size was involved? "description" : "<string>", // Description of sample size "numberOfStudies" : <integer>, // How many studies? "numberOfParticipants" : <integer> // How many participants? }, "resultsByExposure" : [{ // What was the result per exposure? "description" : "<string>", // Description of results by exposure "exposureState" : "<code>", // exposure | exposure-alternative "variantState" : { CodeableConcept }, // Variant exposure states "riskEvidenceSynthesis" : { Reference(RiskEvidenceSynthesis) } // R! Risk evidence synthesis }], "effectEstimate" : [{ // What was the estimated effect "description" : "<string>", // Description of effect estimate "type" : { CodeableConcept }, // Type of efffect estimate "variantState" : { CodeableConcept }, // Variant exposure states "value" : <decimal>, // Point estimate "unitOfMeasure" : { CodeableConcept }, // What unit is the outcome described in? "precisionEstimate" : [{ // How precise the estimate is "type" : { CodeableConcept }, // Type of precision estimate "level" : <decimal>, // Level of confidence interval "from" : <decimal>, // Lower bound "to" : <decimal> // Upper bound }] }], "certainty" : [{ // How certain is the effect "rating" : [{ CodeableConcept }], // Certainty rating "note" : [{ Annotation }], // Used for footnotes or explanatory notes "certaintySubcomponent" : [{ // A component that contributes to the overall certainty "type" : { CodeableConcept }, // Type of subcomponent of certainty rating "rating" : [{ CodeableConcept }], // Subcomponent certainty rating "note" : [{ Annotation }] // Used for footnotes or explanatory notes }] }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:EffectEvidenceSynthesis; 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:EffectEvidenceSynthesis.url [ uri ]; # 0..1 Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique) fhir:EffectEvidenceSynthesis.identifier [ Identifier ], ... ; # 0..* Additional identifier for the effect evidence synthesis fhir:EffectEvidenceSynthesis.version [ string ]; # 0..1 Business version of the effect evidence synthesis fhir:EffectEvidenceSynthesis.name [ string ]; # 0..1 Name for this effect evidence synthesis (computer friendly) fhir:EffectEvidenceSynthesis.title [ string ]; # 0..1 Name for this effect evidence synthesis (human friendly) fhir:EffectEvidenceSynthesis.status [ code ]; # 1..1 draft | active | retired | unknown fhir:EffectEvidenceSynthesis.date [ dateTime ]; # 0..1 Date last changed fhir:EffectEvidenceSynthesis.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:EffectEvidenceSynthesis.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:EffectEvidenceSynthesis.description [ markdown ]; # 0..1 Natural language description of the effect evidence synthesis fhir:EffectEvidenceSynthesis.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes fhir:EffectEvidenceSynthesis.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:EffectEvidenceSynthesis.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for effect evidence synthesis (if applicable) fhir:EffectEvidenceSynthesis.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:EffectEvidenceSynthesis.approvalDate [ date ]; # 0..1 When the effect evidence synthesis was approved by publisher fhir:EffectEvidenceSynthesis.lastReviewDate [ date ]; # 0..1 When the effect evidence synthesis was last reviewed fhir:EffectEvidenceSynthesis.effectivePeriod [ Period ]; # 0..1 When the effect evidence synthesis is expected to be used fhir:EffectEvidenceSynthesis.topic [ CodeableConcept ], ... ; # 0..* The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc. fhir:EffectEvidenceSynthesis.author [ ContactDetail ], ... ; # 0..* Who authored the content fhir:EffectEvidenceSynthesis.editor [ ContactDetail ], ... ; # 0..* Who edited the content fhir:EffectEvidenceSynthesis.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content fhir:EffectEvidenceSynthesis.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content fhir:EffectEvidenceSynthesis.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc. fhir:EffectEvidenceSynthesis.synthesisType [ CodeableConcept ]; # 0..1 Type of synthesis fhir:EffectEvidenceSynthesis.studyType [ CodeableConcept ]; # 0..1 Type of study fhir:EffectEvidenceSynthesis.population [ Reference(EvidenceVariable) ]; # 1..1 What population? fhir:EffectEvidenceSynthesis.exposure [ Reference(EvidenceVariable) ]; # 1..1 What exposure? fhir:EffectEvidenceSynthesis.exposureAlternative [ Reference(EvidenceVariable) ]; # 1..1 What comparison exposure? fhir:EffectEvidenceSynthesis.outcome [ Reference(EvidenceVariable) ]; # 1..1 What outcome? fhir:EffectEvidenceSynthesis.sampleSize [ # 0..1 What sample size was involved? fhir:EffectEvidenceSynthesis.sampleSize.description [ string ]; # 0..1 Description of sample size fhir:EffectEvidenceSynthesis.sampleSize.numberOfStudies [ integer ]; # 0..1 How many studies? fhir:EffectEvidenceSynthesis.sampleSize.numberOfParticipants [ integer ]; # 0..1 How many participants? ]; fhir:EffectEvidenceSynthesis.resultsByExposure [ # 0..* What was the result per exposure? fhir:EffectEvidenceSynthesis.resultsByExposure.description [ string ]; # 0..1 Description of results by exposure fhir:EffectEvidenceSynthesis.resultsByExposure.exposureState [ code ]; # 0..1 exposure | exposure-alternative fhir:EffectEvidenceSynthesis.resultsByExposure.variantState [ CodeableConcept ]; # 0..1 Variant exposure states fhir:EffectEvidenceSynthesis.resultsByExposure.riskEvidenceSynthesis [ Reference(RiskEvidenceSynthesis) ]; # 1..1 Risk evidence synthesis ], ...; fhir:EffectEvidenceSynthesis.effectEstimate [ # 0..* What was the estimated effect fhir:EffectEvidenceSynthesis.effectEstimate.description [ string ]; # 0..1 Description of effect estimate fhir:EffectEvidenceSynthesis.effectEstimate.type [ CodeableConcept ]; # 0..1 Type of efffect estimate fhir:EffectEvidenceSynthesis.effectEstimate.variantState [ CodeableConcept ]; # 0..1 Variant exposure states fhir:EffectEvidenceSynthesis.effectEstimate.value [ decimal ]; # 0..1 Point estimate fhir:EffectEvidenceSynthesis.effectEstimate.unitOfMeasure [ CodeableConcept ]; # 0..1 What unit is the outcome described in? fhir:EffectEvidenceSynthesis.effectEstimate.precisionEstimate [ # 0..* How precise the estimate is fhir:EffectEvidenceSynthesis.effectEstimate.precisionEstimate.type [ CodeableConcept ]; # 0..1 Type of precision estimate fhir:EffectEvidenceSynthesis.effectEstimate.precisionEstimate.level [ decimal ]; # 0..1 Level of confidence interval fhir:EffectEvidenceSynthesis.effectEstimate.precisionEstimate.from [ decimal ]; # 0..1 Lower bound fhir:EffectEvidenceSynthesis.effectEstimate.precisionEstimate.to [ decimal ]; # 0..1 Upper bound ], ...; ], ...; fhir:EffectEvidenceSynthesis.certainty [ # 0..* How certain is the effect fhir:EffectEvidenceSynthesis.certainty.rating [ CodeableConcept ], ... ; # 0..* Certainty rating fhir:EffectEvidenceSynthesis.certainty.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes fhir:EffectEvidenceSynthesis.certainty.certaintySubcomponent [ # 0..* A component that contributes to the overall certainty fhir:EffectEvidenceSynthesis.certainty.certaintySubcomponent.type [ CodeableConcept ]; # 0..1 Type of subcomponent of certainty rating fhir:EffectEvidenceSynthesis.certainty.certaintySubcomponent.rating [ CodeableConcept ], ... ; # 0..* Subcomponent certainty rating fhir:EffectEvidenceSynthesis.certainty.certaintySubcomponent.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes ], ...; ], ...; ]
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
Path | Definition | Type | Reference |
---|---|---|---|
EffectEvidenceSynthesis.status | The lifecycle status of an artifact. | Required | PublicationStatus |
EffectEvidenceSynthesis.jurisdiction | Countries and regions within which this artifact is targeted for use. | Extensible | Jurisdiction ValueSet |
EffectEvidenceSynthesis.topic | High-level categorization of the definition, used for searching, sorting, and filtering. | Example | DefinitionTopic |
EffectEvidenceSynthesis.synthesisType | Types of combining results from a body of evidence (eg. summary data meta-analysis). | Extensible | SynthesisType |
EffectEvidenceSynthesis.studyType | Types of research studies (types of research methods). | Extensible | StudyType |
EffectEvidenceSynthesis.resultsByExposure.exposureState | Whether the results by exposure is describing the results for the primary exposure of interest (exposure) or the alternative state (exposureAlternative). | Required | ExposureState |
EffectEvidenceSynthesis.resultsByExposure.variantState EffectEvidenceSynthesis.effectEstimate.variantState | Used for results by exposure in variant states such as low-risk, medium-risk and high-risk states. | Extensible | EvidenceVariantState |
EffectEvidenceSynthesis.effectEstimate.type | Whether the effect estimate is an absolute effect estimate (absolute difference) or a relative effect estimate (relative difference), and the specific type of effect estimate (eg relative risk or median difference). | Extensible | EffectEstimateType |
EffectEvidenceSynthesis.effectEstimate.unitOfMeasure | Unified Code for Units of Measure (UCUM). | Required | UCUMCodes |
EffectEvidenceSynthesis.effectEstimate.precisionEstimate.type | Method of reporting variability of estimates, such as confidence intervals, interquartile range or standard deviation. | Extensible | PrecisionEstimateType |
EffectEvidenceSynthesis.certainty.rating | The quality of the evidence described. The code system used specifies the quality scale used to grade this evidence source while the code specifies the actual quality score (represented as a coded value) associated with the evidence. | Extensible | QualityOfEvidenceRating |
EffectEvidenceSynthesis.certainty.certaintySubcomponent.type | The subcomponent classification of quality of evidence rating systems. | Extensible | CertaintySubcomponentType |
EffectEvidenceSynthesis.certainty.certaintySubcomponent.rating | The quality rating of the subcomponent of a quality of evidence rating. | Extensible | CertaintySubcomponentRating |
id | Level | Location | Description | Expression |
ees-0 | Warning | (base) | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
context | token | A use context assigned to the effect evidence synthesis | (EffectEvidenceSynthesis.useContext.value as CodeableConcept) | |
context-quantity | quantity | A quantity- or range-valued use context assigned to the effect evidence synthesis | (EffectEvidenceSynthesis.useContext.value as Quantity) | (EffectEvidenceSynthesis.useContext.value as Range) | |
context-type | token | A type of use context assigned to the effect evidence synthesis | EffectEvidenceSynthesis.useContext.code | |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the effect evidence synthesis | On EffectEvidenceSynthesis.useContext: context-type: code context-quantity: value.as(Quantity) | value.as(Range) | |
context-type-value | composite | A use context type and value assigned to the effect evidence synthesis | On EffectEvidenceSynthesis.useContext: context-type: code context: value.as(CodeableConcept) | |
date | date | The effect evidence synthesis publication date | EffectEvidenceSynthesis.date | |
description | string | The description of the effect evidence synthesis | EffectEvidenceSynthesis.description | |
effective | date | The time during which the effect evidence synthesis is intended to be in use | EffectEvidenceSynthesis.effectivePeriod | |
identifier | token | External identifier for the effect evidence synthesis | EffectEvidenceSynthesis.identifier | |
jurisdiction | token | Intended jurisdiction for the effect evidence synthesis | EffectEvidenceSynthesis.jurisdiction | |
name | string | Computationally friendly name of the effect evidence synthesis | EffectEvidenceSynthesis.name | |
publisher | string | Name of the publisher of the effect evidence synthesis | EffectEvidenceSynthesis.publisher | |
status | token | The current status of the effect evidence synthesis | EffectEvidenceSynthesis.status | |
title | string | The human-friendly name of the effect evidence synthesis | EffectEvidenceSynthesis.title | |
url | uri | The uri that identifies the effect evidence synthesis | EffectEvidenceSynthesis.url | |
version | token | The business version of the effect evidence synthesis | EffectEvidenceSynthesis.version |