Data Model Libraries
    Preparing search index...

    Class EvidenceReport

    EvidenceReport Class

    The EvidenceReport Resource is a specialized container for a collection of resources and codeable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts.

    FHIR Specification

    • Short: A EvidenceReport
    • Definition: The EvidenceReport Resource is a specialized container for a collection of resources and codeable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts.
    • FHIR Version: 5.0.0

    FHIR EvidenceReport

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url? publicationStatusEnum status useContext? identifier? relatedIdentifier? citeAs? type_? note? relatedArtifact? subject publisher? contact? author? editor? reviewer? endorser? relatesTo? section?

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getUseContext setUseContext addUseContext hasUseContext getIdentifier setIdentifier addIdentifier hasIdentifier getRelatedIdentifier setRelatedIdentifier addRelatedIdentifier hasRelatedIdentifier getCiteAs setCiteAs hasCiteAs getCiteAsReference hasCiteAsReference getCiteAsMarkdownType hasCiteAsMarkdownType getType setType hasType getNote setNote addNote hasNote getRelatedArtifact setRelatedArtifact addRelatedArtifact hasRelatedArtifact getSubject setSubject hasSubject 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 getRelatesTo setRelatesTo addRelatesTo hasRelatesTo getSection setSection addSection hasSection 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 initUseContext initIdentifier initRelatedIdentifier initNote initRelatedArtifact initContact initAuthor initEditor initReviewer initEndorser initRelatesTo initSection

    Constructors

    Properties

    url?: UriType

    EvidenceReport.url Element

    FHIR Specification

    • Short: Canonical identifier for this EvidenceReport, represented as a globally unique URI
    • Definition: An absolute URI that is used to identify this EvidenceReport 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 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 EvidenceReport to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    EvidenceReport.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 summaries that are appropriate for use versus not. See guidance around (not) making local changes to elements here.
    • Requirements: Allows filtering of EvidenceReports 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

    useContext?: UsageContext[]

    EvidenceReport.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 report 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
    identifier?: Identifier[]

    EvidenceReport.identifier Element

    FHIR Specification

    • Short: Unique identifier for the evidence report
    • Definition: A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instance.
    • Comment: This element will contain unique identifiers that support de-duplication of EvidenceReports. This identifier can be valid for only one EvidenceReport resource.
    • Requirements: Allows externally provided and/or usable identifiers to be associated with this EvidenceReport.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    relatedIdentifier?: Identifier[]

    EvidenceReport.relatedIdentifier Element

    FHIR Specification

    • Short: Identifiers for articles that may relate to more than one evidence report
    • Definition: A formal identifier that is used to identify things closely related to this EvidenceReport.
    • Comment: May include trial registry identifiers, e.g. NCT04372602 from clinicaltrials.gov. This identifier can be valid for multiple EvidenceReport resources.
    • Requirements: Allows externally provided and/or usable identifiers to be associated with this EvidenceReport.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    citeAs?: IDataType

    EvidenceReport.citeAs[x] Element

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

    FHIR Specification

    • Short: Citation for this report
    • Definition: Citation Resource or display of suggested citation for this report.
    • Comment: used for reports for which external citation is expected, such as use in support of scholarly publications.
    • FHIR Types: 'Reference', 'markdown',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Private Optionaltype_

    type_?: CodeableConcept

    EvidenceReport.type Element

    FHIR Specification

    • Short: Kind of report
    • Definition: Specifies the kind of report, such as grouping of classifiers, search results, or human-compiled expression.
    • Requirements: May be used in searching and filtering.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    EvidenceReport.note Element

    FHIR Specification

    • Short: Used for footnotes and annotations
    • Definition: Used for footnotes and annotations.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    relatedArtifact?: RelatedArtifact[]

    EvidenceReport.relatedArtifact Element

    FHIR Specification

    • Short: Link, description or reference to artifact associated with the report
    • Definition: Link, description or reference to artifact associated with the report.
    • FHIR Type: RelatedArtifact
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    subject: null | EvidenceReportSubjectComponent

    EvidenceReport.subject Element

    FHIR Specification

    • Short: Focus of the report
    • Definition: Specifies the subject or focus of the report. Answers "What is this report about?".
    • Comment: May be used as an expression for search queries and search results
    • FHIR Type: BackboneElement
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    publisher?: StringType

    EvidenceReport.publisher Element

    FHIR Specification

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

    EvidenceReport.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 (see Clinical Reasoning Module). See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    author?: ContactDetail[]

    EvidenceReport.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 (see Clinical Reasoning Module).
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    editor?: ContactDetail[]

    EvidenceReport.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 (see Clinical Reasoning Module).
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reviewer?: ContactDetail[]

    EvidenceReport.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 (see Clinical Reasoning Module). See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endorser?: ContactDetail[]

    EvidenceReport.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 (see Clinical Reasoning Module). See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    relatesTo?: EvidenceReportRelatesToComponent[]

    EvidenceReport.relatesTo Element

    FHIR Specification

    • Short: Relationships to other compositions/documents
    • Definition: Relationships that this composition has with other compositions or documents that already exist.
    • Comment: A document is a version specific composition.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    section?: EvidenceReportSectionComponent[]

    EvidenceReport.section Element

    FHIR Specification

    • Short: Composition is broken into sections
    • Definition: The root of the sections that make up the composition.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EvidenceReport

      • OptionaloptSourceField: string

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

      Returns undefined | EvidenceReport

      EvidenceReport data model or undefined for EvidenceReport

      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
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetUseContextsetUseContextaddUseContexthasUseContextgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetRelatedIdentifiersetRelatedIdentifieraddRelatedIdentifierhasRelatedIdentifiergetCiteAssetCiteAshasCiteAsgetCiteAsReferencehasCiteAsReferencegetCiteAsMarkdownTypehasCiteAsMarkdownTypegetTypesetTypehasTypegetNotesetNoteaddNotehasNotegetRelatedArtifactsetRelatedArtifactaddRelatedArtifacthasRelatedArtifactgetSubjectsetSubjecthasSubjectgetPublisherElementsetPublisherElementhasPublisherElementgetPublishersetPublisherhasPublishergetContactsetContactaddContacthasContactgetAuthorsetAuthoraddAuthorhasAuthorgetEditorsetEditoraddEditorhasEditorgetReviewersetRevieweraddReviewerhasReviewergetEndorsersetEndorseraddEndorserhasEndorsergetRelatesTosetRelatesToaddRelatesTohasRelatesTogetSectionsetSectionaddSectionhasSectionfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitUseContextinitIdentifierinitRelatedIdentifierinitNoteinitRelatedArtifactinitContactinitAuthorinitEditorinitReviewerinitEndorserinitRelatesToinitSection