Data Model Libraries
    Preparing search index...

    CitationRelatesToComponent Class

    FHIR Specification

    • Short: Artifact related to the Citation Resource
    • Definition: Artifact related to the Citation Resource.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    relationshipType: null | CodeableConcept

    Citation.relatesTo.relationshipType Element

    FHIR Specification

    • Short: How the Citation resource relates to the target artifact
    • Definition: How the Citation resource relates to the target artifact.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    targetClassifier?: CodeableConcept[]

    Citation.relatesTo.targetClassifier Element

    FHIR Specification

    • Short: The clasification of the related artifact
    • Definition: The clasification of the related artifact.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    target: null | IDataType

    Citation.relatesTo.target[x] Element

    @ChoiceDataTypesMeta('Citation.relatesTo.target[x]', ['uri','Identifier','Reference','Attachment',]

    FHIR Specification

    • Short: The article or artifact that the Citation Resource is related to
    • Definition: The article or artifact that the Citation Resource is related to.
    • FHIR Types: 'uri', 'Identifier', 'Reference', 'Attachment',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CitationRelatesToComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CitationRelatesToComponent

      CitationRelatesToComponent data model or undefined for CitationRelatesToComponent

      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