Data Model Libraries
    Preparing search index...

    Class MessageDefinitionAllowedResponseComponent

    MessageDefinitionAllowedResponseComponent Class

    FHIR Specification

    • Short: Responses to this message
    • Definition: Indicates what types of messages may be sent as an application-level response to this message.
    • Comment: This indicates an application level response to "close" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    message: null | CanonicalType

    MessageDefinition.allowedResponse.message Element

    FHIR Specification

    • Short: Reference to allowed message definition response
    • Definition: A reference to the message definition that must be adhered to by this supported response.
    • FHIR Type: canonical
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    situation?: MarkdownType

    MessageDefinition.allowedResponse.situation Element

    FHIR Specification

    • Short: When should this response be used
    • Definition: Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MessageDefinitionAllowedResponseComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MessageDefinitionAllowedResponseComponent

      MessageDefinitionAllowedResponseComponent data model or undefined for MessageDefinitionAllowedResponseComponent

      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