Data Model Libraries
    Preparing search index...

    Class ImplementationGuideManifestPageComponent

    ImplementationGuideManifestPageComponent Class

    FHIR Specification

    • Short: HTML page within the parent IG
    • Definition: Information about a page within the IG.
    • Requirements: Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    name: null | StringType

    FHIR Specification

    • Short: HTML page name
    • Definition: Relative path to the page.
    • Comment: Appending 'rendering' + "/" + this should resolve to the page.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    title?: StringType

    ImplementationGuide.manifest.page.title Element

    FHIR Specification

    • Short: Title of the page, for references
    • Definition: Label for the page intended for human display.
    • Requirements: Allows generation of labels for markdown-generated hyperlinks.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    anchor?: StringType[]

    ImplementationGuide.manifest.page.anchor Element

    FHIR Specification

    • Short: Anchor available on the page
    • Definition: The name of an anchor available on the page.
    • Comment: Appending 'rendering' + "/" + page.name + "#" + page.anchor should resolve to the anchor.
    • Requirements: Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImplementationGuideManifestPageComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ImplementationGuideManifestPageComponent

      ImplementationGuideManifestPageComponent data model or undefined for ImplementationGuideManifestPageComponent

      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