Data Model Libraries
    Preparing search index...

    EffectEvidenceSynthesis Class

    The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.

    FHIR Specification

    • Short: A quantified estimate of effect based on a body of evidence
    • Definition: The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.
    • FHIR Version: 4.0.1

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    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 getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getDateElement setDateElement hasDateElement getDate setDate hasDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getNote setNote addNote hasNote getUseContext setUseContext addUseContext hasUseContext getJurisdiction setJurisdiction addJurisdiction hasJurisdiction getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright getApprovalDateElement setApprovalDateElement hasApprovalDateElement getApprovalDate setApprovalDate hasApprovalDate getLastReviewDateElement setLastReviewDateElement hasLastReviewDateElement getLastReviewDate setLastReviewDate hasLastReviewDate getEffectivePeriod setEffectivePeriod hasEffectivePeriod getTopic setTopic addTopic hasTopic getAuthor setAuthor addAuthor hasAuthor getEditor setEditor addEditor hasEditor getReviewer setReviewer addReviewer hasReviewer getEndorser setEndorser addEndorser hasEndorser getRelatedArtifact setRelatedArtifact addRelatedArtifact hasRelatedArtifact getSynthesisType setSynthesisType hasSynthesisType getStudyType setStudyType hasStudyType getPopulation setPopulation hasPopulation getExposure setExposure hasExposure getExposureAlternative setExposureAlternative hasExposureAlternative getOutcome setOutcome hasOutcome getSampleSize setSampleSize hasSampleSize getResultsByExposure setResultsByExposure addResultsByExposure hasResultsByExposure getEffectEstimate setEffectEstimate addEffectEstimate hasEffectEstimate 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 initContact initNote initUseContext initJurisdiction initTopic initAuthor initEditor initReviewer initEndorser initRelatedArtifact initResultsByExposure initEffectEstimate initCertainty

    Constructors

    Properties

    url?: UriType

    EffectEvidenceSynthesis.url Element

    FHIR Specification

    • Short: Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique)
    • Definition: An absolute URI that is used to identify this effect evidence synthesis 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 effect evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the effect evidence synthesis 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 effect evidence synthesis to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    EffectEvidenceSynthesis.identifier Element

    FHIR Specification

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

    EffectEvidenceSynthesis.version Element

    FHIR Specification

    • Short: Business version of the effect evidence synthesis
    • Definition: The identifier that is used to identify this version of the effect evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the effect evidence synthesis 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: There may be different effect evidence synthesis 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 effect evidence synthesis with the format [url]|[version].
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    FHIR Specification

    • Short: Name for this effect evidence synthesis (computer friendly)
    • Definition: A natural language name identifying the effect evidence synthesis. 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

    EffectEvidenceSynthesis.title Element

    FHIR Specification

    • Short: Name for this effect evidence synthesis (human friendly)
    • Definition: A short, descriptive, user-friendly title for the effect evidence synthesis.
    • 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
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    status: null | EnumCodeType

    EffectEvidenceSynthesis.status Element

    FHIR Specification

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

    EffectEvidenceSynthesis.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: The date (and optionally time) when the effect evidence synthesis 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 effect evidence synthesis 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 effect evidence synthesis. 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
    publisher?: StringType

    EffectEvidenceSynthesis.publisher Element

    FHIR Specification

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

    EffectEvidenceSynthesis.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: May be a web site, an email address, a telephone number, etc.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    EffectEvidenceSynthesis.description Element

    FHIR Specification

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

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

    EffectEvidenceSynthesis.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 effect evidence synthesis 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
    jurisdiction?: CodeableConcept[]

    EffectEvidenceSynthesis.jurisdiction Element

    FHIR Specification

    • Short: Intended jurisdiction for effect evidence synthesis (if applicable)
    • Definition: A legal or geographic region in which the effect evidence synthesis is intended to be used.
    • Comment: It may be possible for the effect evidence synthesis to be used in jurisdictions other than those for which it was originally designed or intended.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    copyright?: MarkdownType

    EffectEvidenceSynthesis.copyright Element

    FHIR Specification

    • Short: Use and/or publishing restrictions
    • Definition: A copyright statement relating to the effect evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the effect evidence synthesis.
    • Requirements: Consumers must be able to determine any legal restrictions on the use of the effect evidence synthesis and/or its content.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    approvalDate?: DateType

    EffectEvidenceSynthesis.approvalDate Element

    FHIR Specification

    • Short: When the effect evidence synthesis 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

    EffectEvidenceSynthesis.lastReviewDate Element

    FHIR Specification

    • Short: When the effect evidence synthesis 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
    effectivePeriod?: Period

    EffectEvidenceSynthesis.effectivePeriod Element

    FHIR Specification

    • Short: When the effect evidence synthesis is expected to be used
    • Definition: The period during which the effect evidence synthesis content was or is planned to be in active use.
    • Comment: The effective period for a effect evidence synthesis determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
    • Requirements: Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the effect evidence synthesis are or are expected to be used instead.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    topic?: CodeableConcept[]

    EffectEvidenceSynthesis.topic Element

    FHIR Specification

    • Short: The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc.
    • Definition: Descriptive topics related to the content of the EffectEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.
    • Requirements: Repositories must be able to determine how to categorize the EffectEvidenceSynthesis so that it can be found by topical searches.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    author?: ContactDetail[]

    EffectEvidenceSynthesis.author Element

    FHIR Specification

    • Short: Who authored the content
    • Definition: An individiual or organization primarily involved in the creation and maintenance of the content.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    editor?: ContactDetail[]

    EffectEvidenceSynthesis.editor Element

    FHIR Specification

    • Short: Who edited the content
    • Definition: An individual or organization primarily responsible for internal coherence of the content.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reviewer?: ContactDetail[]

    EffectEvidenceSynthesis.reviewer Element

    FHIR Specification

    • Short: Who reviewed the content
    • Definition: An individual or organization primarily responsible for review of some aspect of the content.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endorser?: ContactDetail[]

    EffectEvidenceSynthesis.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.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    relatedArtifact?: RelatedArtifact[]

    EffectEvidenceSynthesis.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: EffectEvidenceSynthesiss 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
    synthesisType?: CodeableConcept

    EffectEvidenceSynthesis.synthesisType Element

    FHIR Specification

    • Short: Type of synthesis
    • Definition: Type of synthesis eg meta-analysis.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    studyType?: CodeableConcept

    EffectEvidenceSynthesis.studyType Element

    FHIR Specification

    • Short: Type of study
    • Definition: Type of study eg randomized trial.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    population: null | Reference

    EffectEvidenceSynthesis.population Element

    FHIR Specification

    exposure: null | Reference

    EffectEvidenceSynthesis.exposure Element

    FHIR Specification

    exposureAlternative: null | Reference

    EffectEvidenceSynthesis.exposureAlternative Element

    FHIR Specification

    • Short: What comparison exposure?
    • Definition: A reference to a EvidenceVariable resource that defines the comparison exposure for the research.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    outcome: null | Reference

    EffectEvidenceSynthesis.outcome Element

    FHIR Specification

    EffectEvidenceSynthesis.sampleSize Element

    FHIR Specification

    • Short: What sample size was involved?
    • Definition: A description of the size of the sample involved in the synthesis.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    EffectEvidenceSynthesis.resultsByExposure Element

    FHIR Specification

    • Short: What was the result per exposure?
    • Definition: A description of the results for each exposure considered in the effect estimate.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    EffectEvidenceSynthesis.effectEstimate Element

    FHIR Specification

    • Short: What was the estimated effect
    • Definition: The estimated effect of the exposure variant.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    EffectEvidenceSynthesis.certainty Element

    FHIR Specification

    • Short: How certain is the effect
    • Definition: A description of the certainty of the effect estimate.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EffectEvidenceSynthesis

      • OptionaloptSourceField: string

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

      Returns undefined | EffectEvidenceSynthesis

      EffectEvidenceSynthesis data model or undefined for EffectEvidenceSynthesis

      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