Data Model Libraries
    Preparing search index...

    Class ImplementationGuideDefinitionGroupingComponent

    ImplementationGuideDefinitionGroupingComponent Class

    FHIR Specification

    • Short: Grouping used to present related resources in the IG
    • Definition: A logical group of resources. Logical groups can be used when building pages.
    • Comment: Groupings are arbitrary sub-divisions of content. Typically, they are used to help build Table of Contents automatically.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    name: null | StringType

    FHIR Specification

    • Short: Descriptive name for the package
    • Definition: The human-readable title to display for the package of resources when rendering the implementation guide.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    description?: StringType

    ImplementationGuide.definition.grouping.description Element

    FHIR Specification

    • Short: Human readable text describing the package
    • Definition: Human readable text describing the package.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImplementationGuideDefinitionGroupingComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ImplementationGuideDefinitionGroupingComponent

      ImplementationGuideDefinitionGroupingComponent data model or undefined for ImplementationGuideDefinitionGroupingComponent

      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