Data Model Libraries
    Preparing search index...

    Class CitationCitedArtifactContributorshipSummaryComponent

    CitationCitedArtifactContributorshipSummaryComponent Class

    FHIR Specification

    • Short: Used to record a display of the author/contributor list without separate data element for each list member
    • Definition: Used to record a display of the author/contributor list without separate data element for each list member.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Citation.citedArtifact.contributorship.summary.type Element

    FHIR Specification

    • Short: Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
    • Definition: Used most commonly to express an author list or a contributorship statement.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.contributorship.summary.style Element

    FHIR Specification

    • Short: The format for the display string
    • Definition: The format for the display string, such as author last name with first letter capitalized followed by forename initials.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.contributorship.summary.source Element

    FHIR Specification

    • Short: Used to code the producer or rule for creating the display string
    • Definition: Used to code the producer or rule for creating the display string.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    value: null | MarkdownType

    Citation.citedArtifact.contributorship.summary.value Element

    FHIR Specification

    • Short: The display string for the author list, contributor list, or contributorship statement
    • Definition: The display string for the author list, contributor list, or contributorship statement.
    • FHIR Type: markdown
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CitationCitedArtifactContributorshipSummaryComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CitationCitedArtifactContributorshipSummaryComponent

      CitationCitedArtifactContributorshipSummaryComponent data model or undefined for CitationCitedArtifactContributorshipSummaryComponent

      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