Data Model Libraries
    Preparing search index...

    MessageHeaderDestinationComponent Class

    FHIR Specification

    • Short: Message destination application(s)
    • Definition: The destination application which the message is intended for.
    • Comment: There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.
    • Requirements: Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    endpoint?: IDataType

    MessageHeader.destination.endpoint[x] Element

    @ChoiceDataTypesMeta('MessageHeader.destination.endpoint[x]', ['url','Reference',]

    FHIR Specification

    • Short: Actual destination address or Endpoint resource
    • Definition: Indicates where the message should be routed.
    • Comment: The url may be a non-resolvable URI for systems that do not use standard network-based addresses.
    • Requirements: Identifies where to route the message.
    • FHIR Types: 'url', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    FHIR Specification

    • Short: Name of system
    • Definition: Human-readable name for the target system.
    • Requirements: May be used for routing of response and/or to support audit.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    target?: Reference

    MessageHeader.destination.target Element

    FHIR Specification

    • Short: Particular delivery destination within the destination
    • Definition: Identifies the target end system in situations where the initial message transmission is to an intermediary system.
    • Requirements: Supports multi-hop routing.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    receiver?: Reference

    MessageHeader.destination.receiver Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MessageHeaderDestinationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MessageHeaderDestinationComponent

      MessageHeaderDestinationComponent data model or undefined for MessageHeaderDestinationComponent

      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