Data Model Libraries
    Preparing search index...

    Class CapabilityStatementMessagingComponent

    CapabilityStatementMessagingComponent Class

    FHIR Specification

    • Short: If messaging is supported
    • Definition: A description of the messaging capabilities of the solution.
    • Comment: Multiple repetitions allow the documentation of multiple endpoints per solution.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    CapabilityStatement.messaging.endpoint Element

    FHIR Specification

    • Short: Where messages should be sent
    • Definition: An endpoint (network accessible address) to which messages and/or replies are to be sent.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reliableCache?: UnsignedIntType

    CapabilityStatement.messaging.reliableCache Element

    FHIR Specification

    • Short: Reliable Message Cache Length (min)
    • Definition: Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).
    • Comment: If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    documentation?: MarkdownType

    CapabilityStatement.messaging.documentation Element

    FHIR Specification

    • Short: Messaging interface behavior details
    • Definition: Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CapabilityStatement.messaging.supportedMessage Element

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

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CapabilityStatementMessagingComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CapabilityStatementMessagingComponent

      CapabilityStatementMessagingComponent data model or undefined for CapabilityStatementMessagingComponent

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise