Data Model Libraries
    Preparing search index...

    MessageHeaderSourceComponent Class

    FHIR Specification

    • Short: Message source application
    • Definition: The source application from which this message originated.
    • Requirements: Allows replies, supports audit.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    endpoint?: IDataType

    MessageHeader.source.endpoint[x] Element

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

    FHIR Specification

    • Short: Actual source address or Endpoint resource
    • Definition: Identifies the routing target to send acknowledgements to.
    • Comment: The url may be a non-resolvable URI for systems that do not use standard network-based addresses.
    • Requirements: Identifies where to send responses, may influence security permissions.
    • 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 source system.
    • Requirements: May be used to support audit.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    software?: StringType

    MessageHeader.source.software Element

    FHIR Specification

    • Short: Name of software running the system
    • Definition: May include configuration or other information useful in debugging.
    • Requirements: Supports audit and possibly interface engine behavior.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    version?: StringType

    MessageHeader.source.version Element

    FHIR Specification

    • Short: Version of software running
    • Definition: Can convey versions of multiple systems in situations where a message passes through multiple hands.
    • Requirements: Supports audit and possibly interface engine behavior.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactPoint

    MessageHeader.source.contact Element

    FHIR Specification

    • Short: Human contact for problems
    • Definition: An e-mail, phone, website or other contact point to use to resolve issues with message communications.
    • Requirements: Allows escalation of technical issues.
    • FHIR Type: ContactPoint
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MessageHeaderSourceComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MessageHeaderSourceComponent

      MessageHeaderSourceComponent data model or undefined for MessageHeaderSourceComponent

      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