Data Model Libraries
    Preparing search index...

    MessageHeaderResponseComponent Class

    FHIR Specification

    • Short: If this is a reply to prior message
    • Definition: Information about the message that this message is a response to. Only present if this message is a response.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    identifier: null | Identifier

    MessageHeader.response.identifier Element

    FHIR Specification

    • Short: Bundle.identifier of original message
    • Definition: The Bundle.identifier of the message to which this message is a response.
    • Requirements: Allows receiver to know what message is being responded to.
    • FHIR Type: Identifier
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    responseCodeEnum: ResponseCodeEnum

    FHIR CodeSystem: ResponseCode

    code: null | EnumCodeType

    MessageHeader.response.code Element

    FHIR Specification

    • Short: ok | transient-error | fatal-error
    • Definition: Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.
    • Comment: This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.
    • Requirements: Allows the sender of the acknowledge message to know if the request was successful or if action is needed.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ResponseCodeEnum

    details?: Reference

    MessageHeader.response.details Element

    FHIR Specification

    • Short: Specific list of hints/warnings/errors
    • Definition: Full details of any issues found in the message.
    • Comment: This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.
    • Requirements: Allows the sender of the message to determine what the specific issues are.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MessageHeaderResponseComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MessageHeaderResponseComponent

      MessageHeaderResponseComponent data model or undefined for MessageHeaderResponseComponent

      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