Data Model Libraries
    Preparing search index...

    Class CitationCitedArtifactWebLocationComponent

    CitationCitedArtifactWebLocationComponent Class

    FHIR Specification

    • Short: Used for any URL for the article or artifact cited
    • Definition: Used for any URL for the article or artifact cited.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    classifier?: CodeableConcept[]

    Citation.citedArtifact.webLocation.classifier Element

    FHIR Specification

    • Short: Code the reason for different URLs, e.g. abstract and full-text
    • Definition: A characterization of the object expected at the web location.
    • Comment: Categories that may be frequently used for study citations may include abstract, full-text, supplement, webpage, and doi-based.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    url?: UriType

    Citation.citedArtifact.webLocation.url Element

    FHIR Specification

    • Short: The specific URL
    • Definition: The specific URL.
    • Comment: Persistent URLs, like doi, are preferred.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CitationCitedArtifactWebLocationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CitationCitedArtifactWebLocationComponent

      CitationCitedArtifactWebLocationComponent data model or undefined for CitationCitedArtifactWebLocationComponent

      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