Data Model Libraries
    Preparing search index...

    Class CitationCitedArtifactContributorshipEntryComponent

    CitationCitedArtifactContributorshipEntryComponent Class

    FHIR Specification

    • Short: An individual entity named as a contributor
    • Definition: An individual entity named as a contributor, for example in the author list or contributor list.
    • Comment: Used to report contributorship in individualized ways.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    contributor: null | Reference

    Citation.citedArtifact.contributorship.entry.contributor Element

    FHIR Specification

    • Short: The identity of the individual contributor
    • Definition: The identity of the individual contributor.
    • Comment: If naming a contributor without additional detail or further structured data, the display element within the Reference datatype may be used for a simple string without referencing another resource.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    forenameInitials?: StringType

    Citation.citedArtifact.contributorship.entry.forenameInitials Element

    FHIR Specification

    • Short: For citation styles that use initials
    • Definition: For citation styles that use initials.
    • Comment: This element is used to support a data element used for citations that is not otherwise supported fully by FHIR HumanName datatype. In some citation summary styles (e.g. Medline), authors are presented with full spelling of their last name (family name) and initials for all forenames (first names, middle names, preceding names, given names). As the FHIR HumanName Datatype does not have a specific element for forename initials and this is common in citation usage, the element is added to contributorship.entry directly.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    affiliation?: Reference[]

    Citation.citedArtifact.contributorship.entry.affiliation Element

    FHIR Specification

    contributionType?: CodeableConcept[]

    Citation.citedArtifact.contributorship.entry.contributionType Element

    FHIR Specification

    • Short: The specific contribution
    • Definition: This element identifies the specific nature of an individual's contribution with respect to the cited work.
    • Comment: The CreDiT taxonomy provides a way to encode contribution information. The purpose of CRediT is to provide transparency in contributions to scholarly published work, to enable improved systems of attribution, credit, and accountability.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.contributorship.entry.role Element

    FHIR Specification

    • Short: The role of the contributor (e.g. author, editor, reviewer, funder)
    • Definition: The role of the contributor (e.g. author, editor, reviewer, funder).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.contributorship.entry.contributionInstance Element

    FHIR Specification

    • Short: Contributions with accounting for time or number
    • Definition: Contributions with accounting for time or number.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    correspondingContact?: BooleanType

    Citation.citedArtifact.contributorship.entry.correspondingContact Element

    FHIR Specification

    • Short: Whether the contributor is the corresponding contributor for the role
    • Definition: Whether the contributor is the corresponding contributor for the role.
    • Comment: If there are multiple authors and one serves as the corresponding author, then that one would have correspondingContact = true.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    rankingOrder?: PositiveIntType

    Citation.citedArtifact.contributorship.entry.rankingOrder Element

    FHIR Specification

    • Short: Ranked order of contribution
    • Definition: Provides a numerical ranking to represent the degree of contributorship relative to other contributors, such as 1 for first author and 2 for second author.
    • Comment: Used to retain order of authorship as structured data
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CitationCitedArtifactContributorshipEntryComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CitationCitedArtifactContributorshipEntryComponent

      CitationCitedArtifactContributorshipEntryComponent data model or undefined for CitationCitedArtifactContributorshipEntryComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Contributor object value to the contributor property.

      Parameters

      • value: undefined | null | Reference

        the contributor object value

      Returns this

      this

      @ReferenceTargets('Citation.citedArtifact.contributorship.entry.contributor', ['Practitioner','Organization',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Reference array value to the affiliation property.

      Parameters

      • value: undefined | Reference[]

        the affiliation array value

      Returns this

      this

      @ReferenceTargets('Citation.citedArtifact.contributorship.entry.affiliation', ['Organization','PractitionerRole',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the affiliation array property.

      Parameters

      • value: undefined | Reference

        the affiliation value

      Returns this

      this

      @ReferenceTargets('Citation.citedArtifact.contributorship.entry.affiliation', ['Organization','PractitionerRole',])

      InvalidTypeError for invalid data type or reference value

    • 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