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 RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.
The scope of the RiskEvidenceSynthesis resource is to describe the likelihood of an outcome in a population with an exposure where the risk estimate is derived from the combination of research studies. Risk estimates are not effects and do not represent a difference between exposure states. Expressing risk estimates is done throughout reporting of biomedical research, systematic reviews, and clinical reference across all disciplines. Risk estimates as a "synthesis" of research studies is a different concept for risk estimation than risk estimates for an individual person.
This resource is referenced by EffectEvidenceSynthesis
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RiskEvidenceSynthesis | ITU | DomainResource | A quantified estimate of risk 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 risk evidence synthesis, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the risk evidence synthesis |
version | Σ | 0..1 | string | Business version of the risk evidence synthesis |
name | ΣI | 0..1 | string | Name for this risk evidence synthesis (computer friendly) |
title | Σ | 0..1 | string | Name for this risk 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 risk 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 risk evidence synthesis (if applicable) Jurisdiction (Extensible) |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the risk evidence synthesis was approved by publisher | |
lastReviewDate | 0..1 | date | When the risk evidence synthesis was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the risk 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 | Σ | 0..1 | Reference(EvidenceVariable) | What 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? | |
riskEstimate | Σ | 0..1 | BackboneElement | What was the estimated risk |
description | 0..1 | string | Description of risk estimate | |
type | 0..1 | CodeableConcept | Type of risk estimate RiskEstimateType (Extensible) | |
value | 0..1 | decimal | Point estimate | |
unitOfMeasure | 0..1 | CodeableConcept | What unit is the outcome described in? UCUM Codes (Required) | |
denominatorCount | 0..1 | integer | Sample size for group measured | |
numeratorCount | 0..1 | integer | Number with the outcome | |
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 risk | |
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
<RiskEvidenceSynthesis 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 risk evidence synthesis, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the risk evidence synthesis --></identifier> <version value="[string]"/><!-- 0..1 Business version of the risk evidence synthesis --> <name value="[string]"/><!-- 0..1 Name for this risk evidence synthesis (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this risk 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 risk 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 risk evidence synthesis (if applicable) --></jurisdiction> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the risk evidence synthesis was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the risk evidence synthesis was last reviewed --> <effectivePeriod><!-- 0..1 Period When the risk 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><!-- 0..1 Reference(EvidenceVariable) What exposure? --></exposure> <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> <riskEstimate> <!-- 0..1 What was the estimated risk --> <description value="[string]"/><!-- 0..1 Description of risk estimate --> <type><!-- 0..1 CodeableConcept Type of risk estimate --></type> <value value="[decimal]"/><!-- 0..1 Point estimate --> <unitOfMeasure><!-- 0..1 CodeableConcept What unit is the outcome described in? --></unitOfMeasure> <denominatorCount value="[integer]"/><!-- 0..1 Sample size for group measured --> <numeratorCount value="[integer]"/><!-- 0..1 Number with the outcome --> <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> </riskEstimate> <certainty> <!-- 0..* How certain is the risk --> <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> </RiskEvidenceSynthesis>
JSON Template
{ "resourceType" : "RiskEvidenceSynthesis", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Canonical identifier for this risk evidence synthesis, represented as a URI (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the risk evidence synthesis "version" : "<string>", // Business version of the risk evidence synthesis "name" : "<string>", // C? Name for this risk evidence synthesis (computer friendly) "title" : "<string>", // Name for this risk 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 risk 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 risk evidence synthesis (if applicable) "copyright" : "<markdown>", // Use and/or publishing restrictions "approvalDate" : "<date>", // When the risk evidence synthesis was approved by publisher "lastReviewDate" : "<date>", // When the risk evidence synthesis was last reviewed "effectivePeriod" : { Period }, // When the risk 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) }, // What 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? }, "riskEstimate" : { // What was the estimated risk "description" : "<string>", // Description of risk estimate "type" : { CodeableConcept }, // Type of risk estimate "value" : <decimal>, // Point estimate "unitOfMeasure" : { CodeableConcept }, // What unit is the outcome described in? "denominatorCount" : <integer>, // Sample size for group measured "numeratorCount" : <integer>, // Number with the outcome "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 risk "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:RiskEvidenceSynthesis; 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:RiskEvidenceSynthesis.url [ uri ]; # 0..1 Canonical identifier for this risk evidence synthesis, represented as a URI (globally unique) fhir:RiskEvidenceSynthesis.identifier [ Identifier ], ... ; # 0..* Additional identifier for the risk evidence synthesis fhir:RiskEvidenceSynthesis.version [ string ]; # 0..1 Business version of the risk evidence synthesis fhir:RiskEvidenceSynthesis.name [ string ]; # 0..1 Name for this risk evidence synthesis (computer friendly) fhir:RiskEvidenceSynthesis.title [ string ]; # 0..1 Name for this risk evidence synthesis (human friendly) fhir:RiskEvidenceSynthesis.status [ code ]; # 1..1 draft | active | retired | unknown fhir:RiskEvidenceSynthesis.date [ dateTime ]; # 0..1 Date last changed fhir:RiskEvidenceSynthesis.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:RiskEvidenceSynthesis.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:RiskEvidenceSynthesis.description [ markdown ]; # 0..1 Natural language description of the risk evidence synthesis fhir:RiskEvidenceSynthesis.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes fhir:RiskEvidenceSynthesis.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:RiskEvidenceSynthesis.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for risk evidence synthesis (if applicable) fhir:RiskEvidenceSynthesis.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:RiskEvidenceSynthesis.approvalDate [ date ]; # 0..1 When the risk evidence synthesis was approved by publisher fhir:RiskEvidenceSynthesis.lastReviewDate [ date ]; # 0..1 When the risk evidence synthesis was last reviewed fhir:RiskEvidenceSynthesis.effectivePeriod [ Period ]; # 0..1 When the risk evidence synthesis is expected to be used fhir:RiskEvidenceSynthesis.topic [ CodeableConcept ], ... ; # 0..* The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc. fhir:RiskEvidenceSynthesis.author [ ContactDetail ], ... ; # 0..* Who authored the content fhir:RiskEvidenceSynthesis.editor [ ContactDetail ], ... ; # 0..* Who edited the content fhir:RiskEvidenceSynthesis.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content fhir:RiskEvidenceSynthesis.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content fhir:RiskEvidenceSynthesis.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc. fhir:RiskEvidenceSynthesis.synthesisType [ CodeableConcept ]; # 0..1 Type of synthesis fhir:RiskEvidenceSynthesis.studyType [ CodeableConcept ]; # 0..1 Type of study fhir:RiskEvidenceSynthesis.population [ Reference(EvidenceVariable) ]; # 1..1 What population? fhir:RiskEvidenceSynthesis.exposure [ Reference(EvidenceVariable) ]; # 0..1 What exposure? fhir:RiskEvidenceSynthesis.outcome [ Reference(EvidenceVariable) ]; # 1..1 What outcome? fhir:RiskEvidenceSynthesis.sampleSize [ # 0..1 What sample size was involved? fhir:RiskEvidenceSynthesis.sampleSize.description [ string ]; # 0..1 Description of sample size fhir:RiskEvidenceSynthesis.sampleSize.numberOfStudies [ integer ]; # 0..1 How many studies? fhir:RiskEvidenceSynthesis.sampleSize.numberOfParticipants [ integer ]; # 0..1 How many participants? ]; fhir:RiskEvidenceSynthesis.riskEstimate [ # 0..1 What was the estimated risk fhir:RiskEvidenceSynthesis.riskEstimate.description [ string ]; # 0..1 Description of risk estimate fhir:RiskEvidenceSynthesis.riskEstimate.type [ CodeableConcept ]; # 0..1 Type of risk estimate fhir:RiskEvidenceSynthesis.riskEstimate.value [ decimal ]; # 0..1 Point estimate fhir:RiskEvidenceSynthesis.riskEstimate.unitOfMeasure [ CodeableConcept ]; # 0..1 What unit is the outcome described in? fhir:RiskEvidenceSynthesis.riskEstimate.denominatorCount [ integer ]; # 0..1 Sample size for group measured fhir:RiskEvidenceSynthesis.riskEstimate.numeratorCount [ integer ]; # 0..1 Number with the outcome fhir:RiskEvidenceSynthesis.riskEstimate.precisionEstimate [ # 0..* How precise the estimate is fhir:RiskEvidenceSynthesis.riskEstimate.precisionEstimate.type [ CodeableConcept ]; # 0..1 Type of precision estimate fhir:RiskEvidenceSynthesis.riskEstimate.precisionEstimate.level [ decimal ]; # 0..1 Level of confidence interval fhir:RiskEvidenceSynthesis.riskEstimate.precisionEstimate.from [ decimal ]; # 0..1 Lower bound fhir:RiskEvidenceSynthesis.riskEstimate.precisionEstimate.to [ decimal ]; # 0..1 Upper bound ], ...; ]; fhir:RiskEvidenceSynthesis.certainty [ # 0..* How certain is the risk fhir:RiskEvidenceSynthesis.certainty.rating [ CodeableConcept ], ... ; # 0..* Certainty rating fhir:RiskEvidenceSynthesis.certainty.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes fhir:RiskEvidenceSynthesis.certainty.certaintySubcomponent [ # 0..* A component that contributes to the overall certainty fhir:RiskEvidenceSynthesis.certainty.certaintySubcomponent.type [ CodeableConcept ]; # 0..1 Type of subcomponent of certainty rating fhir:RiskEvidenceSynthesis.certainty.certaintySubcomponent.rating [ CodeableConcept ], ... ; # 0..* Subcomponent certainty rating fhir:RiskEvidenceSynthesis.certainty.certaintySubcomponent.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes ], ...; ], ...; ]
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RiskEvidenceSynthesis | ITU | DomainResource | A quantified estimate of risk 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 risk evidence synthesis, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the risk evidence synthesis |
version | Σ | 0..1 | string | Business version of the risk evidence synthesis |
name | ΣI | 0..1 | string | Name for this risk evidence synthesis (computer friendly) |
title | Σ | 0..1 | string | Name for this risk 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 risk 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 risk evidence synthesis (if applicable) Jurisdiction (Extensible) |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the risk evidence synthesis was approved by publisher | |
lastReviewDate | 0..1 | date | When the risk evidence synthesis was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the risk 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 | Σ | 0..1 | Reference(EvidenceVariable) | What 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? | |
riskEstimate | Σ | 0..1 | BackboneElement | What was the estimated risk |
description | 0..1 | string | Description of risk estimate | |
type | 0..1 | CodeableConcept | Type of risk estimate RiskEstimateType (Extensible) | |
value | 0..1 | decimal | Point estimate | |
unitOfMeasure | 0..1 | CodeableConcept | What unit is the outcome described in? UCUM Codes (Required) | |
denominatorCount | 0..1 | integer | Sample size for group measured | |
numeratorCount | 0..1 | integer | Number with the outcome | |
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 risk | |
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
<RiskEvidenceSynthesis 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 risk evidence synthesis, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the risk evidence synthesis --></identifier> <version value="[string]"/><!-- 0..1 Business version of the risk evidence synthesis --> <name value="[string]"/><!-- 0..1 Name for this risk evidence synthesis (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this risk 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 risk 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 risk evidence synthesis (if applicable) --></jurisdiction> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the risk evidence synthesis was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the risk evidence synthesis was last reviewed --> <effectivePeriod><!-- 0..1 Period When the risk 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><!-- 0..1 Reference(EvidenceVariable) What exposure? --></exposure> <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> <riskEstimate> <!-- 0..1 What was the estimated risk --> <description value="[string]"/><!-- 0..1 Description of risk estimate --> <type><!-- 0..1 CodeableConcept Type of risk estimate --></type> <value value="[decimal]"/><!-- 0..1 Point estimate --> <unitOfMeasure><!-- 0..1 CodeableConcept What unit is the outcome described in? --></unitOfMeasure> <denominatorCount value="[integer]"/><!-- 0..1 Sample size for group measured --> <numeratorCount value="[integer]"/><!-- 0..1 Number with the outcome --> <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> </riskEstimate> <certainty> <!-- 0..* How certain is the risk --> <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> </RiskEvidenceSynthesis>
JSON Template
{ "resourceType" : "RiskEvidenceSynthesis", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Canonical identifier for this risk evidence synthesis, represented as a URI (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the risk evidence synthesis "version" : "<string>", // Business version of the risk evidence synthesis "name" : "<string>", // C? Name for this risk evidence synthesis (computer friendly) "title" : "<string>", // Name for this risk 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 risk 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 risk evidence synthesis (if applicable) "copyright" : "<markdown>", // Use and/or publishing restrictions "approvalDate" : "<date>", // When the risk evidence synthesis was approved by publisher "lastReviewDate" : "<date>", // When the risk evidence synthesis was last reviewed "effectivePeriod" : { Period }, // When the risk 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) }, // What 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? }, "riskEstimate" : { // What was the estimated risk "description" : "<string>", // Description of risk estimate "type" : { CodeableConcept }, // Type of risk estimate "value" : <decimal>, // Point estimate "unitOfMeasure" : { CodeableConcept }, // What unit is the outcome described in? "denominatorCount" : <integer>, // Sample size for group measured "numeratorCount" : <integer>, // Number with the outcome "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 risk "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:RiskEvidenceSynthesis; 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:RiskEvidenceSynthesis.url [ uri ]; # 0..1 Canonical identifier for this risk evidence synthesis, represented as a URI (globally unique) fhir:RiskEvidenceSynthesis.identifier [ Identifier ], ... ; # 0..* Additional identifier for the risk evidence synthesis fhir:RiskEvidenceSynthesis.version [ string ]; # 0..1 Business version of the risk evidence synthesis fhir:RiskEvidenceSynthesis.name [ string ]; # 0..1 Name for this risk evidence synthesis (computer friendly) fhir:RiskEvidenceSynthesis.title [ string ]; # 0..1 Name for this risk evidence synthesis (human friendly) fhir:RiskEvidenceSynthesis.status [ code ]; # 1..1 draft | active | retired | unknown fhir:RiskEvidenceSynthesis.date [ dateTime ]; # 0..1 Date last changed fhir:RiskEvidenceSynthesis.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:RiskEvidenceSynthesis.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:RiskEvidenceSynthesis.description [ markdown ]; # 0..1 Natural language description of the risk evidence synthesis fhir:RiskEvidenceSynthesis.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes fhir:RiskEvidenceSynthesis.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:RiskEvidenceSynthesis.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for risk evidence synthesis (if applicable) fhir:RiskEvidenceSynthesis.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:RiskEvidenceSynthesis.approvalDate [ date ]; # 0..1 When the risk evidence synthesis was approved by publisher fhir:RiskEvidenceSynthesis.lastReviewDate [ date ]; # 0..1 When the risk evidence synthesis was last reviewed fhir:RiskEvidenceSynthesis.effectivePeriod [ Period ]; # 0..1 When the risk evidence synthesis is expected to be used fhir:RiskEvidenceSynthesis.topic [ CodeableConcept ], ... ; # 0..* The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc. fhir:RiskEvidenceSynthesis.author [ ContactDetail ], ... ; # 0..* Who authored the content fhir:RiskEvidenceSynthesis.editor [ ContactDetail ], ... ; # 0..* Who edited the content fhir:RiskEvidenceSynthesis.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content fhir:RiskEvidenceSynthesis.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content fhir:RiskEvidenceSynthesis.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc. fhir:RiskEvidenceSynthesis.synthesisType [ CodeableConcept ]; # 0..1 Type of synthesis fhir:RiskEvidenceSynthesis.studyType [ CodeableConcept ]; # 0..1 Type of study fhir:RiskEvidenceSynthesis.population [ Reference(EvidenceVariable) ]; # 1..1 What population? fhir:RiskEvidenceSynthesis.exposure [ Reference(EvidenceVariable) ]; # 0..1 What exposure? fhir:RiskEvidenceSynthesis.outcome [ Reference(EvidenceVariable) ]; # 1..1 What outcome? fhir:RiskEvidenceSynthesis.sampleSize [ # 0..1 What sample size was involved? fhir:RiskEvidenceSynthesis.sampleSize.description [ string ]; # 0..1 Description of sample size fhir:RiskEvidenceSynthesis.sampleSize.numberOfStudies [ integer ]; # 0..1 How many studies? fhir:RiskEvidenceSynthesis.sampleSize.numberOfParticipants [ integer ]; # 0..1 How many participants? ]; fhir:RiskEvidenceSynthesis.riskEstimate [ # 0..1 What was the estimated risk fhir:RiskEvidenceSynthesis.riskEstimate.description [ string ]; # 0..1 Description of risk estimate fhir:RiskEvidenceSynthesis.riskEstimate.type [ CodeableConcept ]; # 0..1 Type of risk estimate fhir:RiskEvidenceSynthesis.riskEstimate.value [ decimal ]; # 0..1 Point estimate fhir:RiskEvidenceSynthesis.riskEstimate.unitOfMeasure [ CodeableConcept ]; # 0..1 What unit is the outcome described in? fhir:RiskEvidenceSynthesis.riskEstimate.denominatorCount [ integer ]; # 0..1 Sample size for group measured fhir:RiskEvidenceSynthesis.riskEstimate.numeratorCount [ integer ]; # 0..1 Number with the outcome fhir:RiskEvidenceSynthesis.riskEstimate.precisionEstimate [ # 0..* How precise the estimate is fhir:RiskEvidenceSynthesis.riskEstimate.precisionEstimate.type [ CodeableConcept ]; # 0..1 Type of precision estimate fhir:RiskEvidenceSynthesis.riskEstimate.precisionEstimate.level [ decimal ]; # 0..1 Level of confidence interval fhir:RiskEvidenceSynthesis.riskEstimate.precisionEstimate.from [ decimal ]; # 0..1 Lower bound fhir:RiskEvidenceSynthesis.riskEstimate.precisionEstimate.to [ decimal ]; # 0..1 Upper bound ], ...; ]; fhir:RiskEvidenceSynthesis.certainty [ # 0..* How certain is the risk fhir:RiskEvidenceSynthesis.certainty.rating [ CodeableConcept ], ... ; # 0..* Certainty rating fhir:RiskEvidenceSynthesis.certainty.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes fhir:RiskEvidenceSynthesis.certainty.certaintySubcomponent [ # 0..* A component that contributes to the overall certainty fhir:RiskEvidenceSynthesis.certainty.certaintySubcomponent.type [ CodeableConcept ]; # 0..1 Type of subcomponent of certainty rating fhir:RiskEvidenceSynthesis.certainty.certaintySubcomponent.rating [ CodeableConcept ], ... ; # 0..* Subcomponent certainty rating fhir:RiskEvidenceSynthesis.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 |
---|---|---|---|
RiskEvidenceSynthesis.status | The lifecycle status of an artifact. | Required | PublicationStatus |
RiskEvidenceSynthesis.jurisdiction | Countries and regions within which this artifact is targeted for use. | Extensible | Jurisdiction ValueSet |
RiskEvidenceSynthesis.topic | High-level categorization of the definition, used for searching, sorting, and filtering. | Example | DefinitionTopic |
RiskEvidenceSynthesis.synthesisType | Types of combining results from a body of evidence (eg. summary data meta-analysis). | Extensible | SynthesisType |
RiskEvidenceSynthesis.studyType | Types of research studies (types of research methods). | Extensible | StudyType |
RiskEvidenceSynthesis.riskEstimate.type | Whether the risk estimate is dichotomous, continuous or qualitative and the specific type of risk estimate (eg proportion or median). | Extensible | RiskEstimateType |
RiskEvidenceSynthesis.riskEstimate.unitOfMeasure | Unified Code for Units of Measure (UCUM). | Required | UCUMCodes |
RiskEvidenceSynthesis.riskEstimate.precisionEstimate.type | Method of reporting variability of estimates, such as confidence intervals, interquartile range or standard deviation. | Extensible | PrecisionEstimateType |
RiskEvidenceSynthesis.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 |
RiskEvidenceSynthesis.certainty.certaintySubcomponent.type | The subcomponent classification of quality of evidence rating systems. | Extensible | CertaintySubcomponentType |
RiskEvidenceSynthesis.certainty.certaintySubcomponent.rating | The quality rating of the subcomponent of a quality of evidence rating. | Extensible | CertaintySubcomponentRating |
id | Level | Location | Description | Expression |
rvs-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 risk evidence synthesis | (RiskEvidenceSynthesis.useContext.value as CodeableConcept) | |
context-quantity | quantity | A quantity- or range-valued use context assigned to the risk evidence synthesis | (RiskEvidenceSynthesis.useContext.value as Quantity) | (RiskEvidenceSynthesis.useContext.value as Range) | |
context-type | token | A type of use context assigned to the risk evidence synthesis | RiskEvidenceSynthesis.useContext.code | |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the risk evidence synthesis | On RiskEvidenceSynthesis.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 risk evidence synthesis | On RiskEvidenceSynthesis.useContext: context-type: code context: value.as(CodeableConcept) | |
date | date | The risk evidence synthesis publication date | RiskEvidenceSynthesis.date | |
description | string | The description of the risk evidence synthesis | RiskEvidenceSynthesis.description | |
effective | date | The time during which the risk evidence synthesis is intended to be in use | RiskEvidenceSynthesis.effectivePeriod | |
identifier | token | External identifier for the risk evidence synthesis | RiskEvidenceSynthesis.identifier | |
jurisdiction | token | Intended jurisdiction for the risk evidence synthesis | RiskEvidenceSynthesis.jurisdiction | |
name | string | Computationally friendly name of the risk evidence synthesis | RiskEvidenceSynthesis.name | |
publisher | string | Name of the publisher of the risk evidence synthesis | RiskEvidenceSynthesis.publisher | |
status | token | The current status of the risk evidence synthesis | RiskEvidenceSynthesis.status | |
title | string | The human-friendly name of the risk evidence synthesis | RiskEvidenceSynthesis.title | |
url | uri | The uri that identifies the risk evidence synthesis | RiskEvidenceSynthesis.url | |
version | token | The business version of the risk evidence synthesis | RiskEvidenceSynthesis.version |