Data Model Libraries
    Preparing search index...

    Class ImplementationGuideDefinitionPageComponent

    ImplementationGuideDefinitionPageComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    source?: IDataType

    ImplementationGuide.definition.page.source[x] Element

    @ChoiceDataTypesMeta('ImplementationGuide.definition.page.source[x]', ['url','string','markdown',]

    FHIR Specification

    • Short: Source for page
    • Definition: Indicates the URL or the actual content to provide for the page.
    • Comment: If absent and the page isn't a generated page, this may be inferred from the page name by checking input locations. String is used for XHTML content - sent as an escaped string. FHIR tooling can't support 'direct' XHTML anywhere other than in narrative.
    • FHIR Types: 'url', 'string', 'markdown',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    name: null | UrlType

    FHIR Specification

    • Short: Name of the page when published
    • Definition: The url by which the page should be known when published.
    • Comment: This SHALL be a local reference, expressed with respect to the root of the IG output folder. No suffix is required. If no suffix is specified, .html will be appended.
    • FHIR Type: url
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    title: null | StringType

    ImplementationGuide.definition.page.title Element

    FHIR Specification

    • Short: Short title shown for navigational assistance
    • Definition: A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    guidePageGenerationEnum: GuidePageGenerationEnum

    FHIR CodeSystem: GuidePageGeneration

    generation: null | EnumCodeType

    ImplementationGuide.definition.page.generation Element

    FHIR Specification

    • Short: html | markdown | xml | generated
    • Definition: A code that indicates how the page is generated.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: GuidePageGenerationEnum

    ImplementationGuide.definition.page.page Element

    FHIR Specification

    • Short: Nested Pages / Sections
    • Definition: Nested Pages/Sections under this page.
    • Comment: The implementation guide breadcrumbs may be generated from this structure.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImplementationGuideDefinitionPageComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ImplementationGuideDefinitionPageComponent

      ImplementationGuideDefinitionPageComponent data model or undefined for ImplementationGuideDefinitionPageComponent

      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