Data Model Libraries
    Preparing search index...

    EvidenceReportRelatesToComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    reportRelationTypeEnum: ReportRelationTypeEnum

    FHIR CodeSystem: ReportRelationType

    code: null | EnumCodeType

    EvidenceReport.relatesTo.code Element

    FHIR Specification

    • Short: replaces | amends | appends | transforms | replacedWith | amendedWith | appendedWith | transformedWith
    • Definition: The type of relationship that this composition has with anther composition or document.
    • Comment: If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ReportRelationTypeEnum

    target: null | IDataType

    EvidenceReport.relatesTo.target[x] Element

    @ChoiceDataTypesMeta('EvidenceReport.relatesTo.target[x]', ['Identifier','Reference',]

    FHIR Specification

    • Short: Target of the relationship
    • Definition: The target composition/document of this relationship.
    • FHIR Types: 'Identifier', 'Reference',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EvidenceReportRelatesToComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EvidenceReportRelatesToComponent

      EvidenceReportRelatesToComponent data model or undefined for EvidenceReportRelatesToComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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; 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • 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

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having 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 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

    • Returns boolean

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