Data Model Libraries
    Preparing search index...

    Class CapabilityStatementMessagingSupportedMessageComponent

    CapabilityStatementMessagingSupportedMessageComponent Class

    FHIR Specification

    • Short: Messages supported by this system
    • Definition: References to message definitions for messages this system can send or receive.
    • Comment: This is a proposed alternative to the messaging.event structure.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    eventCapabilityModeEnum: EventCapabilityModeEnum

    FHIR CodeSystem: EventCapabilityMode

    mode: null | EnumCodeType

    CapabilityStatement.messaging.supportedMessage.mode Element

    FHIR Specification

    • Short: sender | receiver
    • Definition: The mode of this event declaration - whether application is sender or receiver.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: EventCapabilityModeEnum

    definition: null | CanonicalType

    CapabilityStatement.messaging.supportedMessage.definition Element

    FHIR Specification

    • Short: Message supported by this system
    • Definition: Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.
    • FHIR Type: canonical
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CapabilityStatementMessagingSupportedMessageComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CapabilityStatementMessagingSupportedMessageComponent

      CapabilityStatementMessagingSupportedMessageComponent data model or undefined for CapabilityStatementMessagingSupportedMessageComponent

      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