Data Model Libraries
    Preparing search index...

    Class CitationCitedArtifactContributorshipComponent

    CitationCitedArtifactContributorshipComponent Class

    FHIR Specification

    • Short: Attribution of authors and other contributors
    • Definition: This element is used to list authors and other contributors, their contact information, specific contributions, and summary statements.
    • Requirements: Need to support individualized and collective attribution of authorship and contributorship to people and groups.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    complete?: BooleanType

    Citation.citedArtifact.contributorship.complete Element

    FHIR Specification

    • Short: Indicates if the list includes all authors and/or contributors
    • Definition: Indicates if the list includes all authors and/or contributors.
    • Comment: If list is incomplete "et al" can be appended to Contributorship.summary.value for display purposes.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Private Optionalentry

    Citation.citedArtifact.contributorship.entry Element

    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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Citation.citedArtifact.contributorship.summary Element

    FHIR Specification

    • Short: Used to record a display of the author/contributor list without separate coding for each list member
    • Definition: Used to record a display of the author/contributor list without separate coding for each list member.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CitationCitedArtifactContributorshipComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CitationCitedArtifactContributorshipComponent

      CitationCitedArtifactContributorshipComponent data model or undefined for CitationCitedArtifactContributorshipComponent

      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