Data Model Libraries
    Preparing search index...

    Class ImplementationGuideDependsOnComponent

    ImplementationGuideDependsOnComponent Class

    FHIR Specification

    • Short: Another Implementation guide this depends on
    • Definition: Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    uri: null | CanonicalType

    ImplementationGuide.dependsOn.uri Element

    FHIR Specification

    • Short: Identity of the IG that this depends on
    • Definition: A canonical reference to the Implementation guide for the dependency.
    • Comment: Usually, A canonical reference to the implementation guide is the same as the master location at which the implementation guide is published.
    • FHIR Type: canonical
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    packageId?: IdType

    ImplementationGuide.dependsOn.packageId Element

    FHIR Specification

    • Short: NPM Package name for IG this depends on
    • Definition: The NPM package name for the Implementation Guide that this IG depends on.
    • FHIR Type: id
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    version?: StringType

    ImplementationGuide.dependsOn.version Element

    FHIR Specification

    • Short: Version of the IG
    • Definition: The version of the IG that is depended on, when the correct version is required to understand the IG correctly.
    • Comment: This follows the syntax of the NPM packaging version field - see [[reference]].
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImplementationGuideDependsOnComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ImplementationGuideDependsOnComponent

      ImplementationGuideDependsOnComponent data model or undefined for ImplementationGuideDependsOnComponent

      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