Data Model Libraries
    Preparing search index...

    Class CitationCitedArtifactClassificationComponent

    CitationCitedArtifactClassificationComponent Class

    FHIR Specification

    • Short: The assignment to an organizing scheme
    • Definition: The assignment to an organizing scheme.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Citation.citedArtifact.classification.type Element

    FHIR Specification

    • Short: The kind of classifier (e.g. publication type, keyword)
    • Definition: The kind of classifier (e.g. publication type, keyword).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    classifier?: CodeableConcept[]

    Citation.citedArtifact.classification.classifier Element

    FHIR Specification

    • Short: The specific classification value
    • Definition: The specific classification value.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    artifactAssessment?: Reference[]

    Citation.citedArtifact.classification.artifactAssessment Element

    FHIR Specification

    • Short: Complex or externally created classification
    • Definition: Complex or externally created classification.
    • Comment: Examples relevant to study citations include MeSH Headings or Keywords that contain qualifier codings or sub-classifications, and include risk of bias assessments created by persons different from the creator of the citation record.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CitationCitedArtifactClassificationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CitationCitedArtifactClassificationComponent

      CitationCitedArtifactClassificationComponent data model or undefined for CitationCitedArtifactClassificationComponent

      JsonError if the provided JSON is not a valid JSON object

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

      Parameters

      • value: undefined | Reference[]

        the artifactAssessment array value

      Returns this

      this

      @ReferenceTargets('Citation.citedArtifact.classification.artifactAssessment', ['ArtifactAssessment',])

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference

        the artifactAssessment value

      Returns this

      this

      @ReferenceTargets('Citation.citedArtifact.classification.artifactAssessment', ['ArtifactAssessment',])

      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 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