Data Model Libraries
    Preparing search index...

    Class ImplementationGuideDefinitionComponent

    ImplementationGuideDefinitionComponent Class

    FHIR Specification

    • Short: Information needed to build the IG
    • Definition: The information needed by an IG publisher tool to publish the whole implementation guide.
    • Comment: Principally, this consists of information abuot source resource and file locations, and build parameters and templates.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    ImplementationGuide.definition.grouping Element

    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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    ImplementationGuide.definition.resource Element

    FHIR Specification

    • Short: Resource in the implementation guide
    • Definition: A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: false

    ImplementationGuide.definition.page Element

    FHIR Specification

    • Short: Page/Section in the Guide
    • Definition: A page / section in the implementation guide. The root page is the implementation guide home page.
    • Comment: Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ImplementationGuide.definition.parameter Element

    FHIR Specification

    • Short: Defines how IG is built by tools
    • Definition: Defines how IG is built by tools.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    ImplementationGuide.definition.template Element

    FHIR Specification

    • Short: A template for building resources
    • Definition: A template for building resources.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImplementationGuideDefinitionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ImplementationGuideDefinitionComponent

      ImplementationGuideDefinitionComponent data model or undefined for ImplementationGuideDefinitionComponent

      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