Evidence Based Medicine on FHIR Implementation Guide
2.0.0-ballot - ballot
Evidence Based Medicine on FHIR Implementation Guide
2.0.0-ballot - ballot
Evidence Based Medicine on FHIR Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ebm/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/comparative-participant-flow-evidence | Version: 2.0.0-ballot | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: ComparativeParticipantFlowEvidence | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.44.42.21 | ||||
Profile of Evidence for Evidence Based Medicine IG. The ComparativeParticipantFlowEvidence Profile is used for comparisons of counts of completion and reasons for non-completion of participation in a research study.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ComparativeEvidence
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Evidence |
ComparativeEvidence | |||
  variableDefinition |
3..* | BackboneElement | Evidence variable such as population, exposure, or outcome | |
  intended |
0..0 | |||
 directnessMatch |
0..0 | |||
  Slices for variableDefinition |
Content/Rules for all slices | |||
   variableDefinition:population |
1..* | BackboneElement | Evidence variable such as population, exposure, or outcome | |
  intended |
0..0 | |||
 directnessMatch |
0..0 | |||
| variableDefinition:exposure |
1..1 | BackboneElement | Evidence variable such as population, exposure, or outcome | |
| intended |
0..0 | |||
| directnessMatch |
0..0 | |||
 variableDefinition:outcome |
1..* | BackboneElement | Evidence variable such as population, exposure, or outcome | |
 observed |
0..1 | Reference(ParticipantFlowEvidenceVariable) | Definition of the actual variable related to the statistic(s) | |
| intended |
0..0 | |||
| directnessMatch |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Evidence |
C | 0..* | ComparativeEvidence | Single evidence bit cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| Slices for variableDefinition |
3..* | BackboneElement | Evidence variable such as population, exposure, or outcome Slice: Unordered, Open by value:variableRole | |
| variableDefinition:All Slices |
Content/Rules for all slices | |||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. |
| variableDefinition:population |
1..* | BackboneElement | Evidence variable such as population, exposure, or outcome | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. Required Pattern: population |
| variableDefinition:exposure |
1..1 | BackboneElement | Evidence variable such as population, exposure, or outcome | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. Required Pattern: exposure |
| comparatorCategory |
1..1 | string | The reference value used for comparison | |
| variableDefinition:outcome |
S | 1..* | BackboneElement | Evidence variable such as population, exposure, or outcome |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. Required Pattern: outcome |
| observed |
Σ | 0..1 | Reference(ParticipantFlowEvidenceVariable) | Definition of the actual variable related to the statistic(s) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Evidence.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition.variableRole | required | EvidenceVariableRolehttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition:population.variableRole | required | Pattern: populationhttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition:exposure.variableRole | required | Pattern: exposurehttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition:outcome.variableRole | required | Pattern: outcomehttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Evidence | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Evidence |
C | 0..* | ComparativeEvidence | Single evidence bit cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
ΣC | 0..1 | uri | Canonical identifier for this evidence, represented as a globally unique URI cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the summary | ||||
| version |
Σ | 0..1 | string | Business version of this summary | ||||
 versionAlgorithm[x] |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
| versionAlgorithmString |
string | |||||||
| versionAlgorithmCoding |
Coding | |||||||
| name |
C | 0..1 | string | Name for this summary (machine friendly) | ||||
| title |
Σ | 0..1 | string | Name for this summary (human friendly) | ||||
| citeAs[x] |
0..1 | Citation for this evidence | ||||||
| citeAsReference |
Reference(Citation) | |||||||
| citeAsMarkdown |
markdown | |||||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
0..1 | boolean | For testing purposes, not real usage | |||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| approvalDate |
0..1 | date | When the summary was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the summary was last reviewed by the publisher | |||||
| publisher |
Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| 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 | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| purpose |
0..1 | markdown | Why this Evidence is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| copyrightLabel |
0..1 | string | Copyright holder and year(s) | |||||
| relatedArtifact |
0..* | RelatedArtifact | Link or citation to artifact associated with the summary | |||||
| description |
0..1 | markdown | Description of the particular summary | |||||
| assertion |
0..1 | markdown | Declarative description of the Evidence | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| Slices for variableDefinition |
3..* | BackboneElement | Evidence variable such as population, exposure, or outcome Slice: Unordered, Open by value:variableRole | |||||
| variableDefinition:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | A text description or summary of the variable | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. | ||||
| roleSubtype |
Σ | 0..1 | CodeableConcept | subgroup | variable-A | variable-B | variable-AB | confounder | collider | mediator | effect-modifier Binding: EvidenceVariableRoleSubtype (extensible): The sub-role that the variable plays. | ||||
| comparatorCategory |
0..1 | string | The reference value used for comparison | |||||
| observed |
Σ | 0..1 | Reference(Group | EvidenceVariable) | Definition of the actual variable related to the statistic(s) | ||||
| variableDefinition:population |
1..* | BackboneElement | Evidence variable such as population, exposure, or outcome | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | A text description or summary of the variable | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. Required Pattern: population | ||||
| roleSubtype |
Σ | 0..1 | CodeableConcept | subgroup | variable-A | variable-B | variable-AB | confounder | collider | mediator | effect-modifier Binding: EvidenceVariableRoleSubtype (extensible): The sub-role that the variable plays. | ||||
| comparatorCategory |
0..1 | string | The reference value used for comparison | |||||
| observed |
Σ | 0..1 | Reference(StudyGroup | ExposureGroup | ComparatorGroup | MetaanalysisStudyGroup) | Definition of the actual variable related to the statistic(s) | ||||
| variableDefinition:exposure |
1..1 | BackboneElement | Evidence variable such as population, exposure, or outcome | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | A text description or summary of the variable | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. Required Pattern: exposure | ||||
| roleSubtype |
Σ | 0..1 | CodeableConcept | subgroup | variable-A | variable-B | variable-AB | confounder | collider | mediator | effect-modifier Binding: EvidenceVariableRoleSubtype (extensible): The sub-role that the variable plays. | ||||
| comparatorCategory |
1..1 | string | The reference value used for comparison | |||||
| observed |
Σ | 0..1 | Reference(GroupAssignment) | Definition of the actual variable related to the statistic(s) | ||||
| variableDefinition:outcome |
S | 1..* | BackboneElement | Evidence variable such as population, exposure, or outcome | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | A text description or summary of the variable | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. Required Pattern: outcome | ||||
| roleSubtype |
Σ | 0..1 | CodeableConcept | subgroup | variable-A | variable-B | variable-AB | confounder | collider | mediator | effect-modifier Binding: EvidenceVariableRoleSubtype (extensible): The sub-role that the variable plays. | ||||
| observed |
Σ | 0..1 | Reference(ParticipantFlowEvidenceVariable) | Definition of the actual variable related to the statistic(s) | ||||
| synthesisType |
0..1 | CodeableConcept | The method to combine studies Binding: StatisticSynthesisType (extensible): Types of combining results from a body of evidence (e.g. summary data meta-analysis). | |||||
| studyDesign |
0..* | CodeableConcept | The design of the study that produced this evidence Binding: StudyDesign (extensible): This is a set of terms for study design characteristics. | |||||
| statistic |
0..* | BackboneElement | Values and parameters for a single statistic | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | Description of content | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| statisticType |
0..1 | CodeableConcept | Type of statistic, e.g., relative risk Binding: StatisticType (extensible) | |||||
| category |
0..1 | CodeableConcept | Associated category for categorical variable | |||||
| quantity |
0..1 | Quantity | Statistic value | |||||
| numberOfEvents |
0..1 | unsignedInt | The number of events associated with the statistic | |||||
| numberAffected |
0..1 | unsignedInt | The number of participants affected | |||||
| sampleSize |
0..1 | BackboneElement | Number of samples in the statistic | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | Textual description of sample size for statistic | |||||
| note |
0..* | Annotation | Footnote or explanatory note about the sample size | |||||
| numberOfStudies |
0..1 | unsignedInt | Number of contributing studies | |||||
| numberOfParticipants |
0..1 | unsignedInt | Cumulative number of participants | |||||
| knownDataCount |
0..1 | unsignedInt | Number of participants with known results for measured variables | |||||
| attributeEstimate |
0..* | BackboneElement | An attribute of the Statistic | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | Textual description of the attribute estimate | |||||
| note |
0..* | Annotation | Footnote or explanatory note about the estimate | |||||
| type |
0..1 | CodeableConcept | The type of attribute estimate, e.g., confidence interval or p value Binding: AttributeEstimateType (extensible) | |||||
| quantity |
0..1 | Quantity | The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure | |||||
| level |
0..1 | decimal | Level of confidence interval, e.g., 0.95 for 95% confidence interval | |||||
| range |
0..1 | Range | Lower and upper bound values of the attribute estimate | |||||
| attributeEstimate |
0..* | See attributeEstimate (Evidence) | A nested attribute estimate; which is the attribute estimate of an attribute estimate | |||||
| modelCharacteristic |
0..* | BackboneElement | An aspect of the statistical model | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
1..1 | CodeableConcept | Model specification Binding: StatisticModelCode (extensible) | |||||
| value[x] |
0..1 | The specific value (when paired with code) | ||||||
| valueQuantity |
Quantity(SimpleQuantity) | |||||||
| valueRange |
Range | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| intended |
0..1 | boolean | The plan for analysis | |||||
| applied |
0..1 | boolean | The analysis that was applied | |||||
| variable |
0..* | BackboneElement | A variable adjusted for in the adjusted analysis | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| variableDefinition |
1..1 | Reference(Group | EvidenceVariable) | Description of the variable | |||||
| handling |
0..1 | code | continuous | dichotomous | ordinal | polychotomous Binding: EvidenceVariableHandling (required) | |||||
| valueCategory |
0..* | CodeableConcept | Description for grouping of ordinal or polychotomous variables | |||||
| valueQuantity |
0..* | Quantity | Discrete value for grouping of ordinal or polychotomous variables | |||||
| valueRange |
0..* | Range | Range of values for grouping of ordinal or polychotomous variables | |||||
| attribute |
0..* | See attributeEstimate (Evidence) | An attribute of the statistic used as a model characteristic | |||||
| certainty |
0..* | BackboneElement | Certainty or quality of the evidence | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | Textual description of certainty | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| type |
0..1 | CodeableConcept | Aspect of certainty being rated Binding: EvidenceCertaintyType (extensible): The aspect of quality, confidence, or certainty. | |||||
| rating |
0..1 | CodeableConcept | Assessment or judgement of the aspect Binding: EvidenceCertaintyRating (extensible): The assessment of quality, confidence, or certainty. | |||||
| rater |
0..1 | string | Individual or group who did the rating | |||||
| subcomponent |
0..* | See certainty (Evidence) | A domain or subdomain of certainty | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Evidence.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2from the FHIR Standard | |
| Evidence.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithmfrom the FHIR Standard | |
| Evidence.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition.variableRole | required | EvidenceVariableRolehttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition.roleSubtype | extensible | EvidenceVariableRoleSubtypehttp://hl7.org/fhir/ValueSet/variable-role-subtypefrom the FHIR Standard | |
| Evidence.variableDefinition:population.variableRole | required | Pattern: populationhttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition:population.roleSubtype | extensible | EvidenceVariableRoleSubtypehttp://hl7.org/fhir/ValueSet/variable-role-subtypefrom the FHIR Standard | |
| Evidence.variableDefinition:exposure.variableRole | required | Pattern: exposurehttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition:exposure.roleSubtype | extensible | EvidenceVariableRoleSubtypehttp://hl7.org/fhir/ValueSet/variable-role-subtypefrom the FHIR Standard | |
| Evidence.variableDefinition:outcome.variableRole | required | Pattern: outcomehttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition:outcome.roleSubtype | extensible | EvidenceVariableRoleSubtypehttp://hl7.org/fhir/ValueSet/variable-role-subtypefrom the FHIR Standard | |
| Evidence.synthesisType | extensible | StatisticSynthesisTypehttp://terminology.hl7.org/ValueSet/synthesis-type | |
| Evidence.studyDesign | extensible | StudyDesignhttp://hl7.org/fhir/ValueSet/study-designfrom the FHIR Standard | |
| Evidence.statistic.statisticType | extensible | StatisticTypehttp://hl7.org/fhir/ValueSet/statistic-typefrom the FHIR Standard | |
| Evidence.statistic.attributeEstimate.type | extensible | AttributeEstimateTypehttp://hl7.org/fhir/ValueSet/attribute-estimate-typefrom the FHIR Standard | |
| Evidence.statistic.modelCharacteristic.code | extensible | StatisticModelCodehttp://hl7.org/fhir/ValueSet/statistic-model-codefrom the FHIR Standard | |
| Evidence.statistic.modelCharacteristic.variable.handling | required | EvidenceVariableHandlinghttp://hl7.org/fhir/ValueSet/variable-handling|6.0.0-ballot2from the FHIR Standard | |
| Evidence.certainty.type | extensible | EvidenceCertaintyTypehttp://hl7.org/fhir/ValueSet/certainty-typefrom the FHIR Standard | |
| Evidence.certainty.rating | extensible | EvidenceCertaintyRatinghttp://hl7.org/fhir/ValueSet/certainty-ratingfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Evidence | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| cnl-1 | warning | Evidence.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from ComparativeEvidence
Summary
Prohibited: 8 elements
Structures
This structure refers to these other structures:
Maturity: 1
Differential View
This structure is derived from ComparativeEvidence
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Evidence |
ComparativeEvidence | |||
| variableDefinition |
3..* | BackboneElement | Evidence variable such as population, exposure, or outcome | |
| intended |
0..0 | |||
| directnessMatch |
0..0 | |||
| Slices for variableDefinition |
Content/Rules for all slices | |||
| variableDefinition:population |
1..* | BackboneElement | Evidence variable such as population, exposure, or outcome | |
| intended |
0..0 | |||
| directnessMatch |
0..0 | |||
| variableDefinition:exposure |
1..1 | BackboneElement | Evidence variable such as population, exposure, or outcome | |
| intended |
0..0 | |||
| directnessMatch |
0..0 | |||
| variableDefinition:outcome |
1..* | BackboneElement | Evidence variable such as population, exposure, or outcome | |
| observed |
0..1 | Reference(ParticipantFlowEvidenceVariable) | Definition of the actual variable related to the statistic(s) | |
| intended |
0..0 | |||
| directnessMatch |
0..0 | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Evidence |
C | 0..* | ComparativeEvidence | Single evidence bit cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| Slices for variableDefinition |
3..* | BackboneElement | Evidence variable such as population, exposure, or outcome Slice: Unordered, Open by value:variableRole | |
| variableDefinition:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. |
| variableDefinition:population |
1..* | BackboneElement | Evidence variable such as population, exposure, or outcome | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. Required Pattern: population |
| variableDefinition:exposure |
1..1 | BackboneElement | Evidence variable such as population, exposure, or outcome | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. Required Pattern: exposure |
| comparatorCategory |
1..1 | string | The reference value used for comparison | |
| variableDefinition:outcome |
S | 1..* | BackboneElement | Evidence variable such as population, exposure, or outcome |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. Required Pattern: outcome |
| observed |
Σ | 0..1 | Reference(ParticipantFlowEvidenceVariable) | Definition of the actual variable related to the statistic(s) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Evidence.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition.variableRole | required | EvidenceVariableRolehttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition:population.variableRole | required | Pattern: populationhttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition:exposure.variableRole | required | Pattern: exposurehttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition:outcome.variableRole | required | Pattern: outcomehttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Evidence | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Evidence |
C | 0..* | ComparativeEvidence | Single evidence bit cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
ΣC | 0..1 | uri | Canonical identifier for this evidence, represented as a globally unique URI cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the summary | ||||
| version |
Σ | 0..1 | string | Business version of this summary | ||||
| versionAlgorithm[x] |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
| versionAlgorithmString |
string | |||||||
| versionAlgorithmCoding |
Coding | |||||||
| name |
C | 0..1 | string | Name for this summary (machine friendly) | ||||
| title |
Σ | 0..1 | string | Name for this summary (human friendly) | ||||
| citeAs[x] |
0..1 | Citation for this evidence | ||||||
| citeAsReference |
Reference(Citation) | |||||||
| citeAsMarkdown |
markdown | |||||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
0..1 | boolean | For testing purposes, not real usage | |||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| approvalDate |
0..1 | date | When the summary was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the summary was last reviewed by the publisher | |||||
| publisher |
Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| 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 | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| purpose |
0..1 | markdown | Why this Evidence is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| copyrightLabel |
0..1 | string | Copyright holder and year(s) | |||||
| relatedArtifact |
0..* | RelatedArtifact | Link or citation to artifact associated with the summary | |||||
| description |
0..1 | markdown | Description of the particular summary | |||||
| assertion |
0..1 | markdown | Declarative description of the Evidence | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| Slices for variableDefinition |
3..* | BackboneElement | Evidence variable such as population, exposure, or outcome Slice: Unordered, Open by value:variableRole | |||||
| variableDefinition:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | A text description or summary of the variable | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. | ||||
| roleSubtype |
Σ | 0..1 | CodeableConcept | subgroup | variable-A | variable-B | variable-AB | confounder | collider | mediator | effect-modifier Binding: EvidenceVariableRoleSubtype (extensible): The sub-role that the variable plays. | ||||
| comparatorCategory |
0..1 | string | The reference value used for comparison | |||||
| observed |
Σ | 0..1 | Reference(Group | EvidenceVariable) | Definition of the actual variable related to the statistic(s) | ||||
| variableDefinition:population |
1..* | BackboneElement | Evidence variable such as population, exposure, or outcome | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | A text description or summary of the variable | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. Required Pattern: population | ||||
| roleSubtype |
Σ | 0..1 | CodeableConcept | subgroup | variable-A | variable-B | variable-AB | confounder | collider | mediator | effect-modifier Binding: EvidenceVariableRoleSubtype (extensible): The sub-role that the variable plays. | ||||
| comparatorCategory |
0..1 | string | The reference value used for comparison | |||||
| observed |
Σ | 0..1 | Reference(StudyGroup | ExposureGroup | ComparatorGroup | MetaanalysisStudyGroup) | Definition of the actual variable related to the statistic(s) | ||||
| variableDefinition:exposure |
1..1 | BackboneElement | Evidence variable such as population, exposure, or outcome | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | A text description or summary of the variable | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. Required Pattern: exposure | ||||
| roleSubtype |
Σ | 0..1 | CodeableConcept | subgroup | variable-A | variable-B | variable-AB | confounder | collider | mediator | effect-modifier Binding: EvidenceVariableRoleSubtype (extensible): The sub-role that the variable plays. | ||||
| comparatorCategory |
1..1 | string | The reference value used for comparison | |||||
| observed |
Σ | 0..1 | Reference(GroupAssignment) | Definition of the actual variable related to the statistic(s) | ||||
| variableDefinition:outcome |
S | 1..* | BackboneElement | Evidence variable such as population, exposure, or outcome | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | A text description or summary of the variable | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| variableRole |
Σ | 1..1 | code | population | exposure | outcome | covariate Binding: EvidenceVariableRole (required): The role that the variable plays. Required Pattern: outcome | ||||
| roleSubtype |
Σ | 0..1 | CodeableConcept | subgroup | variable-A | variable-B | variable-AB | confounder | collider | mediator | effect-modifier Binding: EvidenceVariableRoleSubtype (extensible): The sub-role that the variable plays. | ||||
| observed |
Σ | 0..1 | Reference(ParticipantFlowEvidenceVariable) | Definition of the actual variable related to the statistic(s) | ||||
| synthesisType |
0..1 | CodeableConcept | The method to combine studies Binding: StatisticSynthesisType (extensible): Types of combining results from a body of evidence (e.g. summary data meta-analysis). | |||||
| studyDesign |
0..* | CodeableConcept | The design of the study that produced this evidence Binding: StudyDesign (extensible): This is a set of terms for study design characteristics. | |||||
| statistic |
0..* | BackboneElement | Values and parameters for a single statistic | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | Description of content | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| statisticType |
0..1 | CodeableConcept | Type of statistic, e.g., relative risk Binding: StatisticType (extensible) | |||||
| category |
0..1 | CodeableConcept | Associated category for categorical variable | |||||
| quantity |
0..1 | Quantity | Statistic value | |||||
| numberOfEvents |
0..1 | unsignedInt | The number of events associated with the statistic | |||||
| numberAffected |
0..1 | unsignedInt | The number of participants affected | |||||
| sampleSize |
0..1 | BackboneElement | Number of samples in the statistic | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | Textual description of sample size for statistic | |||||
| note |
0..* | Annotation | Footnote or explanatory note about the sample size | |||||
| numberOfStudies |
0..1 | unsignedInt | Number of contributing studies | |||||
| numberOfParticipants |
0..1 | unsignedInt | Cumulative number of participants | |||||
| knownDataCount |
0..1 | unsignedInt | Number of participants with known results for measured variables | |||||
| attributeEstimate |
0..* | BackboneElement | An attribute of the Statistic | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | Textual description of the attribute estimate | |||||
| note |
0..* | Annotation | Footnote or explanatory note about the estimate | |||||
| type |
0..1 | CodeableConcept | The type of attribute estimate, e.g., confidence interval or p value Binding: AttributeEstimateType (extensible) | |||||
| quantity |
0..1 | Quantity | The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure | |||||
| level |
0..1 | decimal | Level of confidence interval, e.g., 0.95 for 95% confidence interval | |||||
| range |
0..1 | Range | Lower and upper bound values of the attribute estimate | |||||
| attributeEstimate |
0..* | See attributeEstimate (Evidence) | A nested attribute estimate; which is the attribute estimate of an attribute estimate | |||||
| modelCharacteristic |
0..* | BackboneElement | An aspect of the statistical model | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
1..1 | CodeableConcept | Model specification Binding: StatisticModelCode (extensible) | |||||
| value[x] |
0..1 | The specific value (when paired with code) | ||||||
| valueQuantity |
Quantity(SimpleQuantity) | |||||||
| valueRange |
Range | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| intended |
0..1 | boolean | The plan for analysis | |||||
| applied |
0..1 | boolean | The analysis that was applied | |||||
| variable |
0..* | BackboneElement | A variable adjusted for in the adjusted analysis | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| variableDefinition |
1..1 | Reference(Group | EvidenceVariable) | Description of the variable | |||||
| handling |
0..1 | code | continuous | dichotomous | ordinal | polychotomous Binding: EvidenceVariableHandling (required) | |||||
| valueCategory |
0..* | CodeableConcept | Description for grouping of ordinal or polychotomous variables | |||||
| valueQuantity |
0..* | Quantity | Discrete value for grouping of ordinal or polychotomous variables | |||||
| valueRange |
0..* | Range | Range of values for grouping of ordinal or polychotomous variables | |||||
| attribute |
0..* | See attributeEstimate (Evidence) | An attribute of the statistic used as a model characteristic | |||||
| certainty |
0..* | BackboneElement | Certainty or quality of the evidence | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
0..1 | markdown | Textual description of certainty | |||||
| note |
0..* | Annotation | Footnotes and/or explanatory notes | |||||
| type |
0..1 | CodeableConcept | Aspect of certainty being rated Binding: EvidenceCertaintyType (extensible): The aspect of quality, confidence, or certainty. | |||||
| rating |
0..1 | CodeableConcept | Assessment or judgement of the aspect Binding: EvidenceCertaintyRating (extensible): The assessment of quality, confidence, or certainty. | |||||
| rater |
0..1 | string | Individual or group who did the rating | |||||
| subcomponent |
0..* | See certainty (Evidence) | A domain or subdomain of certainty | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Evidence.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2from the FHIR Standard | |
| Evidence.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithmfrom the FHIR Standard | |
| Evidence.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition.variableRole | required | EvidenceVariableRolehttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition.roleSubtype | extensible | EvidenceVariableRoleSubtypehttp://hl7.org/fhir/ValueSet/variable-role-subtypefrom the FHIR Standard | |
| Evidence.variableDefinition:population.variableRole | required | Pattern: populationhttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition:population.roleSubtype | extensible | EvidenceVariableRoleSubtypehttp://hl7.org/fhir/ValueSet/variable-role-subtypefrom the FHIR Standard | |
| Evidence.variableDefinition:exposure.variableRole | required | Pattern: exposurehttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition:exposure.roleSubtype | extensible | EvidenceVariableRoleSubtypehttp://hl7.org/fhir/ValueSet/variable-role-subtypefrom the FHIR Standard | |
| Evidence.variableDefinition:outcome.variableRole | required | Pattern: outcomehttp://hl7.org/fhir/ValueSet/variable-role|6.0.0-ballot2from the FHIR Standard | |
| Evidence.variableDefinition:outcome.roleSubtype | extensible | EvidenceVariableRoleSubtypehttp://hl7.org/fhir/ValueSet/variable-role-subtypefrom the FHIR Standard | |
| Evidence.synthesisType | extensible | StatisticSynthesisTypehttp://terminology.hl7.org/ValueSet/synthesis-type | |
| Evidence.studyDesign | extensible | StudyDesignhttp://hl7.org/fhir/ValueSet/study-designfrom the FHIR Standard | |
| Evidence.statistic.statisticType | extensible | StatisticTypehttp://hl7.org/fhir/ValueSet/statistic-typefrom the FHIR Standard | |
| Evidence.statistic.attributeEstimate.type | extensible | AttributeEstimateTypehttp://hl7.org/fhir/ValueSet/attribute-estimate-typefrom the FHIR Standard | |
| Evidence.statistic.modelCharacteristic.code | extensible | StatisticModelCodehttp://hl7.org/fhir/ValueSet/statistic-model-codefrom the FHIR Standard | |
| Evidence.statistic.modelCharacteristic.variable.handling | required | EvidenceVariableHandlinghttp://hl7.org/fhir/ValueSet/variable-handling|6.0.0-ballot2from the FHIR Standard | |
| Evidence.certainty.type | extensible | EvidenceCertaintyTypehttp://hl7.org/fhir/ValueSet/certainty-typefrom the FHIR Standard | |
| Evidence.certainty.rating | extensible | EvidenceCertaintyRatinghttp://hl7.org/fhir/ValueSet/certainty-ratingfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Evidence | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| cnl-1 | warning | Evidence.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from ComparativeEvidence
Summary
Prohibited: 8 elements
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.ebm#2.0.0-ballot based on FHIR 6.0.0-ballot2. Generated 2024-11-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change