Data Model Libraries
    Preparing search index...

    Class ImplementationGuideManifestResourceComponent

    ImplementationGuideManifestResourceComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    reference: null | Reference

    ImplementationGuide.manifest.resource.reference Element

    FHIR Specification

    • Short: Location of the resource
    • Definition: Where this resource is found.
    • Comment: Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    example?: IDataType

    ImplementationGuide.manifest.resource.example[x] Element

    @ChoiceDataTypesMeta('ImplementationGuide.manifest.resource.example[x]', ['boolean','canonical',]

    FHIR Specification

    • Short: Is an example/What is this an example of?
    • Definition: If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.
    • Comment: Typically, conformance resources and knowledge resources are directly part of the implementation guide, with their normal meaning, and patient linked resources are usually examples. However this is not always true.
    • FHIR Types: 'boolean', 'canonical',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    relativePath?: UrlType

    ImplementationGuide.manifest.resource.relativePath Element

    FHIR Specification

    • Short: Relative path for page in IG
    • Definition: The relative path for primary page for this resource within the IG.
    • Comment: Appending 'rendering' + "/" + this should resolve to the resource page.
    • FHIR Type: url
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImplementationGuideManifestResourceComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ImplementationGuideManifestResourceComponent

      ImplementationGuideManifestResourceComponent data model or undefined for ImplementationGuideManifestResourceComponent

      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