Data Model Libraries
    Preparing search index...

    Class CitationCitedArtifactAbstractComponent

    CitationCitedArtifactAbstractComponent Class

    FHIR Specification

    • Short: Summary of the article or artifact
    • Definition: The abstract may be used to convey article-contained abstracts, externally-created abstracts, or other descriptive summaries.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Citation.citedArtifact.abstract.type Element

    FHIR Specification

    • Short: The kind of abstract
    • Definition: Used to express the reason for or classification of the abstract.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    language?: CodeableConcept

    Citation.citedArtifact.abstract.language Element

    FHIR Specification

    • Short: Used to express the specific language
    • Definition: Used to express the specific language of the abstract.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    text: null | MarkdownType

    Citation.citedArtifact.abstract.text Element

    FHIR Specification

    • Short: Abstract content
    • Definition: Abstract content.
    • FHIR Type: markdown
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    copyright?: MarkdownType

    Citation.citedArtifact.abstract.copyright Element

    FHIR Specification

    • Short: Copyright notice for the abstract
    • Definition: Copyright notice for the abstract.
    • Comment: There is also a copyright element in the publicationForm element, so this copyright element is intended for copyright of the abstract.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CitationCitedArtifactAbstractComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CitationCitedArtifactAbstractComponent

      CitationCitedArtifactAbstractComponent data model or undefined for CitationCitedArtifactAbstractComponent

      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