Data Model Libraries
    Preparing search index...

    OperationOutcomeIssueComponent Class

    FHIR Specification

    • Short: A single issue associated with the action
    • Definition: An error, warning, or information message that results from a system action.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    issueSeverityEnum: IssueSeverityEnum

    FHIR CodeSystem: IssueSeverity

    severity: null | EnumCodeType

    OperationOutcome.issue.severity Element

    FHIR Specification

    • Short: fatal | error | warning | information
    • Definition: Indicates whether the issue indicates a variation from successful processing.
    • Comment: This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors.
    • Requirements: Indicates how relevant the issue is to the overall success of the action.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: IssueSeverityEnum

    issueTypeEnum: IssueTypeEnum

    FHIR CodeSystem: IssueType

    code: null | EnumCodeType

    OperationOutcome.issue.code Element

    FHIR Specification

    • Short: Error or warning code
    • Definition: Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.
    • Requirements: Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue. The required element provides a base level of computable interoperability across all systems for processing an outcome, allowing systems to respond appropriately regardless of the internal system error codes returned.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: IssueTypeEnum

    details?: CodeableConcept

    OperationOutcome.issue.details Element

    FHIR Specification

    • Short: Additional details about the error
    • Definition: Additional details about the error. This may be a text description of the error or a system code that identifies the error.
    • Comment: A human readable description of the error issue SHOULD be placed in details.text.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    diagnostics?: StringType

    OperationOutcome.issue.diagnostics Element

    FHIR Specification

    • Short: Additional diagnostic information about the issue
    • Definition: Additional diagnostic information about the issue.
    • Comment: This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    location?: StringType[]

    OperationOutcome.issue.location Element

    FHIR Specification

    • Short: Deprecated: Path of element(s) related to issue
    • Definition: This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name.
    • Comment: The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. This element is deprecated, and is being replaced by expression.
    • Requirements: Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    expression?: StringType[]

    OperationOutcome.issue.expression Element

    FHIR Specification

    • Short: FHIRPath of element(s) related to issue
    • Definition: A simple subset of FHIRPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.
    • Comment: The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.
    • Requirements: Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR OperationOutcomeIssueComponent

      • OptionaloptSourceField: string

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

      Returns undefined | OperationOutcomeIssueComponent

      OperationOutcomeIssueComponent data model or undefined for OperationOutcomeIssueComponent

      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