Data Model Libraries
    Preparing search index...

    Class EvidenceVariable

    EvidenceVariable Class

    The EvidenceVariable resource describes an element that knowledge (Evidence) is about.

    Need to be able to define and reuse the definition of individual elements of a research question.

    FHIR Specification

    • Short: A definition of an exposure, outcome, or other variable
    • Definition: The EvidenceVariable resource describes an element that knowledge (Evidence) is about.
    • Comment: The EvidenceVariable may be an exposure variable (intervention, condition, or state), a measured variable (outcome or observed parameter), or other variable (such as confounding factor).
    • FHIR Version: 4.3.0

    FHIR EvidenceVariable

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url? identifier? version? name? title? shortTitle? subtitle? publicationStatusEnum status date? description? note? useContext? publisher? contact? author? editor? reviewer? endorser? relatedArtifact? actual? characteristicCombinationEnum characteristicCombination? characteristic? variableHandlingEnum handling? category?

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getNameElement setNameElement hasNameElement getName setName hasName getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getShortTitleElement setShortTitleElement hasShortTitleElement getShortTitle setShortTitle hasShortTitle getSubtitleElement setSubtitleElement hasSubtitleElement getSubtitle setSubtitle hasSubtitle getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getDateElement setDateElement hasDateElement getDate setDate hasDate getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getNote setNote addNote hasNote getUseContext setUseContext addUseContext hasUseContext 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 getActualElement setActualElement hasActualElement getActual setActual hasActual getCharacteristicCombinationEnumType setCharacteristicCombinationEnumType hasCharacteristicCombinationEnumType getCharacteristicCombinationElement setCharacteristicCombinationElement hasCharacteristicCombinationElement getCharacteristicCombination setCharacteristicCombination hasCharacteristicCombination getCharacteristic setCharacteristic addCharacteristic hasCharacteristic getHandlingEnumType setHandlingEnumType hasHandlingEnumType getHandlingElement setHandlingElement hasHandlingElement getHandling setHandling hasHandling getCategory setCategory addCategory hasCategory 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 initNote initUseContext initContact initAuthor initEditor initReviewer initEndorser initRelatedArtifact initCharacteristic initCategory

    Constructors

    Properties

    url?: UriType

    EvidenceVariable.url Element

    FHIR Specification

    • Short: Canonical identifier for this evidence variable, represented as a URI (globally unique)
    • Definition: An absolute URI that is used to identify this evidence variable 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 evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable 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. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
    • Requirements: Allows the evidence variable to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    EvidenceVariable.identifier Element

    FHIR Specification

    • Short: Additional identifier for the evidence variable
    • Definition: A formal identifier that is used to identify this evidence variable 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 evidence variable 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

    EvidenceVariable.version Element

    FHIR Specification

    • Short: Business version of the evidence variable
    • Definition: The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
    • Comment: There may be different evidence variable instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the evidence variable with the format [url]|[version].
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    EvidenceVariable.name Element

    FHIR Specification

    • Short: Name for this evidence variable (computer friendly)
    • Definition: A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generation.
    • Comment: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
    • Requirements: Support human navigation and code generation.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    EvidenceVariable.title Element

    FHIR Specification

    • Short: Name for this evidence variable (human friendly)
    • Definition: A short, descriptive, user-friendly title for the evidence variable.
    • Comment: This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    shortTitle?: StringType

    EvidenceVariable.shortTitle Element

    FHIR Specification

    • Short: Title for use in informal contexts
    • Definition: The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
    • Requirements: Need to be able to reference the content by a short description, but still provide a longer, more formal title for the content.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subtitle?: StringType

    EvidenceVariable.subtitle Element

    FHIR Specification

    • Short: Subordinate title of the EvidenceVariable
    • Definition: An explanatory or alternate title for the EvidenceVariable giving additional information about its content.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    EvidenceVariable.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The status of this evidence variable. Enables tracking the life-cycle of the content.
    • Comment: Allows filtering of evidence variables 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

    EvidenceVariable.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: The date (and optionally time) when the evidence variable 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 evidence variable 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 evidence variable. 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
    description?: MarkdownType

    EvidenceVariable.description Element

    FHIR Specification

    • Short: Natural language description of the evidence variable
    • Definition: A free text natural language description of the evidence variable from a consumer's perspective.
    • Comment: This description can be used to capture details such as why the evidence variable 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 variable 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 variable is presumed to be the predominant language in the place the evidence variable was created).
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    note?: Annotation[]

    EvidenceVariable.note Element

    FHIR Specification

    • Short: Used for footnotes or explanatory notes
    • Definition: A human-readable string to clarify or explain concepts about the resource.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    useContext?: UsageContext[]

    EvidenceVariable.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 variable 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
    publisher?: StringType

    EvidenceVariable.publisher Element

    FHIR Specification

    • Short: Name of the publisher (organization or individual)
    • Definition: The name of the organization or individual that published the evidence variable.
    • Comment: Usually an organization but may be an individual. The publisher (or steward) of the evidence variable is the organization or individual primarily responsible for the maintenance and upkeep of the evidence variable. 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 variable. This item SHOULD be populated unless the information is available from context.
    • Requirements: Helps establish the "authority/credibility" of the evidence variable. May also allow for contact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    EvidenceVariable.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[]

    EvidenceVariable.author Element

    FHIR Specification

    • Short: Who authored the content
    • Definition: An individiual or organization 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: false
    editor?: ContactDetail[]

    EvidenceVariable.editor Element

    FHIR Specification

    • Short: Who edited the content
    • Definition: An individual or organization 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[]

    EvidenceVariable.reviewer Element

    FHIR Specification

    • Short: Who reviewed the content
    • Definition: An individual or organization 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[]

    EvidenceVariable.endorser Element

    FHIR Specification

    • Short: Who endorsed the content
    • Definition: An individual or organization 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: false
    relatedArtifact?: RelatedArtifact[]

    EvidenceVariable.relatedArtifact Element

    FHIR Specification

    • Short: Additional documentation, citations, etc.
    • Definition: Related artifacts such as additional documentation, justification, or bibliographic references.
    • Comment: Each related artifact is either an attachment, or a reference to another resource, but not both.
    • Requirements: EvidenceVariables must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
    • FHIR Type: RelatedArtifact
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    actual?: BooleanType

    EvidenceVariable.actual Element

    FHIR Specification

    • Short: Actual or conceptual
    • Definition: True if the actual variable measured, false if a conceptual representation of the intended variable.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    characteristicCombinationEnum: CharacteristicCombinationEnum

    FHIR CodeSystem: CharacteristicCombination

    CharacteristicCombinationEnum

    characteristicCombination?: EnumCodeType

    EvidenceVariable.characteristicCombination Element

    FHIR Specification

    • Short: intersection | union
    • Definition: Used to specify if two or more characteristics are combined with OR or AND.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: CharacteristicCombinationEnum

    characteristic?: EvidenceVariableCharacteristicComponent[]

    EvidenceVariable.characteristic Element

    FHIR Specification

    • Short: What defines the members of the evidence element
    • Definition: A characteristic that defines the members of the evidence element. Multiple characteristics are applied with "and" semantics.
    • Comment: Characteristics can be defined flexibly to accommodate different use cases for membership criteria, ranging from simple codes, all the way to using an expression language to express the criteria.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    variableHandlingEnum: VariableHandlingEnum

    FHIR CodeSystem: VariableHandling

    VariableHandlingEnum

    handling?: EnumCodeType

    EvidenceVariable.handling Element

    FHIR Specification

    • Short: continuous | dichotomous | ordinal | polychotomous
    • Definition: Used for an outcome to classify.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: VariableHandlingEnum

    category?: EvidenceVariableCategoryComponent[]

    EvidenceVariable.category Element

    FHIR Specification

    • Short: A grouping for ordinal or polychotomous variables
    • Definition: A grouping (or set of values) described along with other groupings to specify the set of groupings allowed for the variable.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EvidenceVariable

      • OptionaloptSourceField: string

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

      Returns undefined | EvidenceVariable

      EvidenceVariable data model or undefined for EvidenceVariable

      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
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetShortTitleElementsetShortTitleElementhasShortTitleElementgetShortTitlesetShortTitlehasShortTitlegetSubtitleElementsetSubtitleElementhasSubtitleElementgetSubtitlesetSubtitlehasSubtitlegetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetNotesetNoteaddNotehasNotegetUseContextsetUseContextaddUseContexthasUseContextgetPublisherElementsetPublisherElementhasPublisherElementgetPublishersetPublisherhasPublishergetContactsetContactaddContacthasContactgetAuthorsetAuthoraddAuthorhasAuthorgetEditorsetEditoraddEditorhasEditorgetReviewersetRevieweraddReviewerhasReviewergetEndorsersetEndorseraddEndorserhasEndorsergetRelatedArtifactsetRelatedArtifactaddRelatedArtifacthasRelatedArtifactgetActualElementsetActualElementhasActualElementgetActualsetActualhasActualgetCharacteristicCombinationEnumTypesetCharacteristicCombinationEnumTypehasCharacteristicCombinationEnumTypegetCharacteristicCombinationElementsetCharacteristicCombinationElementhasCharacteristicCombinationElementgetCharacteristicCombinationsetCharacteristicCombinationhasCharacteristicCombinationgetCharacteristicsetCharacteristicaddCharacteristichasCharacteristicgetHandlingEnumTypesetHandlingEnumTypehasHandlingEnumTypegetHandlingElementsetHandlingElementhasHandlingElementgetHandlingsetHandlinghasHandlinggetCategorysetCategoryaddCategoryhasCategoryfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitNoteinitUseContextinitContactinitAuthorinitEditorinitReviewerinitEndorserinitRelatedArtifactinitCharacteristicinitCategory