Data Model Libraries
    Preparing search index...

    Class Evidence

    Evidence Class

    The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (eg population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.

    FHIR Specification

    • Short: Single evidence bit
    • Definition: The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (eg population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.
    • FHIR Version: 4.3.0

    FHIR Evidence

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url? identifier? version? title? citeAs? publicationStatusEnum status date? useContext? approvalDate? lastReviewDate? publisher? contact? author? editor? reviewer? endorser? relatedArtifact? description? assertion? note? variableDefinition synthesisType? studyType? statistic? certainty?

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getCiteAs setCiteAs hasCiteAs getCiteAsReference hasCiteAsReference getCiteAsMarkdownType hasCiteAsMarkdownType getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getDateElement setDateElement hasDateElement getDate setDate hasDate getUseContext setUseContext addUseContext hasUseContext getApprovalDateElement setApprovalDateElement hasApprovalDateElement getApprovalDate setApprovalDate hasApprovalDate getLastReviewDateElement setLastReviewDateElement hasLastReviewDateElement getLastReviewDate setLastReviewDate hasLastReviewDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getAuthor setAuthor addAuthor hasAuthor getEditor setEditor addEditor hasEditor getReviewer setReviewer addReviewer hasReviewer getEndorser setEndorser addEndorser hasEndorser getRelatedArtifact setRelatedArtifact addRelatedArtifact hasRelatedArtifact getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getAssertionElement setAssertionElement hasAssertionElement getAssertion setAssertion hasAssertion getNote setNote addNote hasNote getVariableDefinition setVariableDefinition addVariableDefinition hasVariableDefinition getSynthesisType setSynthesisType hasSynthesisType getStudyType setStudyType hasStudyType getStatistic setStatistic addStatistic hasStatistic getCertainty setCertainty addCertainty hasCertainty fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initUseContext initContact initAuthor initEditor initReviewer initEndorser initRelatedArtifact initNote initVariableDefinition initStatistic initCertainty

    Constructors

    Properties

    url?: UriType

    Evidence.url Element

    FHIR Specification

    • Short: Canonical identifier for this evidence, represented as a globally unique URI
    • Definition: An absolute URI that is used to identify this evidence when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.
    • Comment: Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
    • Requirements: Allows the evidence to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    Evidence.identifier Element

    FHIR Specification

    • Short: Additional identifier for the summary
    • Definition: A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance.
    • Comment: Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this summary outside of FHIR, where it is not possible to use the logical URI.
    • Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the module.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    version?: StringType

    Evidence.version Element

    FHIR Specification

    • Short: Business version of this summary
    • Definition: The identifier that is used to identify this version of the summary when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the summary author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • Comment: The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    Evidence.title Element

    FHIR Specification

    • Short: Name for this summary (human friendly)
    • Definition: A short, descriptive, user-friendly title for the summary.
    • Comment: In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    citeAs?: IDataType

    Evidence.citeAs[x] Element

    @ChoiceDataTypesMeta('Evidence.citeAs[x]', ['Reference','markdown',]

    FHIR Specification

    • Short: Citation for this evidence
    • Definition: Citation Resource or display of suggested citation for this evidence.
    • FHIR Types: 'Reference', 'markdown',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    Evidence.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The status of this summary. Enables tracking the life-cycle of the content.
    • Comment: Allows filtering of summarys s that are appropriate for use versus not.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    date?: DateTimeType

    Evidence.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: The date (and optionally time) when the summary was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the summary changes.
    • Comment: Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the summary. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    useContext?: UsageContext[]

    Evidence.useContext Element

    FHIR Specification

    • Short: The context that the content is intended to support
    • Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence instances.
    • Comment: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
    • Requirements: Assist in searching for appropriate content.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    approvalDate?: DateType

    Evidence.approvalDate Element

    FHIR Specification

    • Short: When the summary was approved by publisher
    • Definition: The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • Comment: The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastReviewDate?: DateType

    Evidence.lastReviewDate Element

    FHIR Specification

    • Short: When the summary was last reviewed
    • Definition: The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
    • Comment: If specified, this date follows the original approval date.
    • Requirements: Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    publisher?: StringType

    Evidence.publisher Element

    FHIR Specification

    • Short: Name of the publisher (organization or individual)
    • Definition: The name of the organization or individual that published the evidence.
    • Comment: Usually an organization but may be an individual. The publisher (or steward) of the evidence is the organization or individual primarily responsible for the maintenance and upkeep of the evidence. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the evidence. This item SHOULD be populated unless the information is available from context.
    • Requirements: Helps establish the "authority/credibility" of the evidence. May also allow for contact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    Evidence.contact Element

    FHIR Specification

    • Short: Contact details for the publisher
    • Definition: Contact details to assist a user in finding and communicating with the publisher.
    • Comment: Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (Details at: http://build.fhir.org/https://hl7.org/fhir/clinicalreasoning-module.html).
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    author?: ContactDetail[]

    Evidence.author Element

    FHIR Specification

    • Short: Who authored the content
    • Definition: An individiual, organization, or device primarily involved in the creation and maintenance of the content.
    • Comment: Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (Details at: http://build.fhir.org/https://hl7.org/fhir/clinicalreasoning-module.html).
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    editor?: ContactDetail[]

    Evidence.editor Element

    FHIR Specification

    • Short: Who edited the content
    • Definition: An individiual, organization, or device primarily responsible for internal coherence of the content.
    • Comment: Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (Details at: http://build.fhir.org/https://hl7.org/fhir/clinicalreasoning-module.html).
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reviewer?: ContactDetail[]

    Evidence.reviewer Element

    FHIR Specification

    • Short: Who reviewed the content
    • Definition: An individiual, organization, or device primarily responsible for review of some aspect of the content.
    • Comment: Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (Details at: http://build.fhir.org/https://hl7.org/fhir/clinicalreasoning-module.html).
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endorser?: ContactDetail[]

    Evidence.endorser Element

    FHIR Specification

    • Short: Who endorsed the content
    • Definition: An individiual, organization, or device responsible for officially endorsing the content for use in some setting.
    • Comment: Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (Details at: http://build.fhir.org/https://hl7.org/fhir/clinicalreasoning-module.html).
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    relatedArtifact?: RelatedArtifact[]

    Evidence.relatedArtifact Element

    FHIR Specification

    • Short: Link or citation to artifact associated with the summary
    • Definition: Link or citation to artifact associated with the summary.
    • FHIR Type: RelatedArtifact
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    Evidence.description Element

    FHIR Specification

    • Short: Description of the particular summary
    • Definition: A free text natural language description of the evidence from a consumer's perspective.
    • Comment: This description can be used to capture details such as why the evidence was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the evidence as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the evidence is presumed to be the predominant language in the place the evidence was created).
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    assertion?: MarkdownType

    Evidence.assertion Element

    FHIR Specification

    • Short: Declarative description of the Evidence
    • Definition: Declarative description of the Evidence.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    Evidence.note Element

    FHIR Specification

    • Short: Footnotes and/or explanatory notes
    • Definition: Footnotes and/or explanatory notes.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    variableDefinition: null | EvidenceVariableDefinitionComponent[]

    Evidence.variableDefinition Element

    FHIR Specification

    • Short: Evidence variable such as population, exposure, or outcome
    • Definition: Evidence variable such as population, exposure, or outcome.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: false
    synthesisType?: CodeableConcept

    Evidence.synthesisType Element

    FHIR Specification

    • Short: The method to combine studies
    • Definition: The method to combine studies.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    studyType?: CodeableConcept

    Evidence.studyType Element

    FHIR Specification

    • Short: The type of study that produced this evidence
    • Definition: The type of study that produced this evidence.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    statistic?: EvidenceStatisticComponent[]

    Evidence.statistic Element

    FHIR Specification

    • Short: Values and parameters for a single statistic
    • Definition: Values and parameters for a single statistic.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    certainty?: EvidenceCertaintyComponent[]

    Evidence.certainty Element

    FHIR Specification

    • Short: Certainty or quality of the evidence
    • Definition: Assessment of certainty, confidence in the estimates, or quality of the evidence.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided Evidence JSON to instantiate the Evidence data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Evidence

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Evidence

      Returns undefined | Evidence

      Evidence data model or undefined for Evidence

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetCiteAssetCiteAshasCiteAsgetCiteAsReferencehasCiteAsReferencegetCiteAsMarkdownTypehasCiteAsMarkdownTypegetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetUseContextsetUseContextaddUseContexthasUseContextgetApprovalDateElementsetApprovalDateElementhasApprovalDateElementgetApprovalDatesetApprovalDatehasApprovalDategetLastReviewDateElementsetLastReviewDateElementhasLastReviewDateElementgetLastReviewDatesetLastReviewDatehasLastReviewDategetPublisherElementsetPublisherElementhasPublisherElementgetPublishersetPublisherhasPublishergetContactsetContactaddContacthasContactgetAuthorsetAuthoraddAuthorhasAuthorgetEditorsetEditoraddEditorhasEditorgetReviewersetRevieweraddReviewerhasReviewergetEndorsersetEndorseraddEndorserhasEndorsergetRelatedArtifactsetRelatedArtifactaddRelatedArtifacthasRelatedArtifactgetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetAssertionElementsetAssertionElementhasAssertionElementgetAssertionsetAssertionhasAssertiongetNotesetNoteaddNotehasNotegetVariableDefinitionsetVariableDefinitionaddVariableDefinitionhasVariableDefinitiongetSynthesisTypesetSynthesisTypehasSynthesisTypegetStudyTypesetStudyTypehasStudyTypegetStatisticsetStatisticaddStatistichasStatisticgetCertaintysetCertaintyaddCertaintyhasCertaintyfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitUseContextinitContactinitAuthorinitEditorinitReviewerinitEndorserinitRelatedArtifactinitNoteinitVariableDefinitioninitStatisticinitCertainty