Data Model Libraries
    Preparing search index...

    Class ImplementationGuideDefinitionParameterComponent

    ImplementationGuideDefinitionParameterComponent Class

    FHIR Specification

    • Short: Defines how IG is built by tools
    • Definition: Defines how IG is built by tools.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    guideParameterCodeEnum: GuideParameterCodeEnum

    FHIR CodeSystem: GuideParameterCode

    code: null | EnumCodeType

    ImplementationGuide.definition.parameter.code Element

    FHIR Specification

    • Short: apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template
    • Definition: apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: GuideParameterCodeEnum

    value: null | StringType

    ImplementationGuide.definition.parameter.value Element

    FHIR Specification

    • Short: Value for named type
    • Definition: Value for named type.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImplementationGuideDefinitionParameterComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ImplementationGuideDefinitionParameterComponent

      ImplementationGuideDefinitionParameterComponent data model or undefined for ImplementationGuideDefinitionParameterComponent

      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