Data Model Libraries
    Preparing search index...

    Class CitationCitedArtifactContributorshipEntryComponent

    CitationCitedArtifactContributorshipEntryComponent Class

    FHIR Specification

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

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    name?: HumanName

    FHIR Specification

    • Short: A name associated with the person
    • Definition: A name associated with the individual.
    • Comment: humanName.family can match MEDLINE-based lastName (used for surname or single name), humanName.given can match MEDLINE-based forename (used for remainder of name except for suffix), humanName.suffix can match MEDLINE-based suffix (eg 2nd, 3rd, Jr, Sr).
    • FHIR Type: HumanName
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    initials?: StringType

    Citation.citedArtifact.contributorship.entry.initials Element

    FHIR Specification

    • Short: Initials for forename
    • Definition: Initials for forename.
    • Comment: This element is used in Medline based citations, but not supported fully by FHIR HumanName datatype.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    collectiveName?: StringType

    Citation.citedArtifact.contributorship.entry.collectiveName Element

    FHIR Specification

    • Short: Used for collective or corporate name as an author
    • Definition: Used for collective or corporate name as an author.
    • Comment: This element is used in Medline based citations, but not supported fully by FHIR HumanName datatype.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    identifier?: Identifier[]

    Citation.citedArtifact.contributorship.entry.identifier Element

    FHIR Specification

    • Short: Author identifier, eg ORCID
    • Definition: Unique person identifier.
    • Comment: Avoids needing to disambiguate common last names or changes of name. ORCID is commonly used as author identifier.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.contributorship.entry.affiliationInfo Element

    FHIR Specification

    • Short: Organizational affiliation
    • Definition: Organization affiliated with the entity.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    address?: Address[]

    Citation.citedArtifact.contributorship.entry.address Element

    FHIR Specification

    • Short: Physical mailing address
    • Definition: Physical mailing address for the author or contributor.
    • FHIR Type: Address
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    telecom?: ContactPoint[]

    Citation.citedArtifact.contributorship.entry.telecom Element

    FHIR Specification

    • Short: Email or telephone contact methods for the author or contributor
    • Definition: Email or telephone contact methods for the author or contributor.
    • FHIR Type: ContactPoint
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    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 inside article XML files. 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)
    • Definition: The role of the contributor (e.g. author, editor, reviewer).
    • 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: Indication of which contributor is the corresponding contributor for the role
    • Definition: Indication of which contributor is the corresponding contributor for the role.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    listOrder?: PositiveIntType

    Citation.citedArtifact.contributorship.entry.listOrder Element

    FHIR Specification

    • Short: Used to code order of authors
    • Definition: Used to code order of authors.
    • 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

    • 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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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