Class IssueType

  • All Implemented Interfaces:
    Visitable

    @Generated("com.ibm.fhir.tools.CodeGenerator")
    public class IssueType
    extends Code
    • Field Detail

      • INVALID

        public static final IssueType INVALID
        Invalid Content

        Content invalid against the specification or a profile.

      • STRUCTURE

        public static final IssueType STRUCTURE
        Structural Issue

        A structural issue in the content such as wrong namespace, unable to parse the content completely, invalid syntax, etc.

      • REQUIRED

        public static final IssueType REQUIRED
        Required element missing

        A required element is missing.

      • VALUE

        public static final IssueType VALUE
        Element value invalid

        An element or header value is invalid.

      • INVARIANT

        public static final IssueType INVARIANT
        Validation rule failed

        A content validation rule failed - e.g. a schematron rule.

      • SECURITY

        public static final IssueType SECURITY
        Security Problem

        An authentication/authorization/permissions issue of some kind.

      • LOGIN

        public static final IssueType LOGIN
        Login Required

        The client needs to initiate an authentication process.

      • UNKNOWN

        public static final IssueType UNKNOWN
        Unknown User

        The user or system was not able to be authenticated (either there is no process, or the proferred token is unacceptable).

      • EXPIRED

        public static final IssueType EXPIRED
        Session Expired

        User session expired; a login may be required.

      • FORBIDDEN

        public static final IssueType FORBIDDEN
        Forbidden

        The user does not have the rights to perform this action.

      • SUPPRESSED

        public static final IssueType SUPPRESSED
        Information Suppressed

        Some information was not or might not have been returned due to business rules, consent or privacy rules, or access permission constraints. This information may be accessible through alternate processes.

      • PROCESSING

        public static final IssueType PROCESSING
        Processing Failure

        Processing issues. These are expected to be final e.g. there is no point resubmitting the same content unchanged.

      • NOT_SUPPORTED

        public static final IssueType NOT_SUPPORTED
        Content not supported

        The interaction, operation, resource or profile is not supported.

      • DUPLICATE

        public static final IssueType DUPLICATE
        Duplicate

        An attempt was made to create a duplicate record.

      • MULTIPLE_MATCHES

        public static final IssueType MULTIPLE_MATCHES
        Multiple Matches

        Multiple matching records were found when the operation required only one match.

      • NOT_FOUND

        public static final IssueType NOT_FOUND
        Not Found

        The reference provided was not found. In a pure RESTful environment, this would be an HTTP 404 error, but this code may be used where the content is not found further into the application architecture.

      • DELETED

        public static final IssueType DELETED
        Deleted

        The reference pointed to content (usually a resource) that has been deleted.

      • TOO_LONG

        public static final IssueType TOO_LONG
        Content Too Long

        Provided content is too long (typically, this is a denial of service protection type of error).

      • CODE_INVALID

        public static final IssueType CODE_INVALID
        Invalid Code

        The code or system could not be understood, or it was not valid in the context of a particular ValueSet.code.

      • EXTENSION

        public static final IssueType EXTENSION
        Unacceptable Extension

        An extension was found that was not acceptable, could not be resolved, or a modifierExtension was not recognized.

      • TOO_COSTLY

        public static final IssueType TOO_COSTLY
        Operation Too Costly

        The operation was stopped to protect server resources; e.g. a request for a value set expansion on all of SNOMED CT.

      • BUSINESS_RULE

        public static final IssueType BUSINESS_RULE
        Business Rule Violation

        The content/operation failed to pass some business rule and so could not proceed.

      • CONFLICT

        public static final IssueType CONFLICT
        Edit Version Conflict

        Content could not be accepted because of an edit conflict (i.e. version aware updates). (In a pure RESTful environment, this would be an HTTP 409 error, but this code may be used where the conflict is discovered further into the application architecture.).

      • TRANSIENT

        public static final IssueType TRANSIENT
        Transient Issue

        Transient processing issues. The system receiving the message may be able to resubmit the same content once an underlying issue is resolved.

      • LOCK_ERROR

        public static final IssueType LOCK_ERROR
        Lock Error

        A resource/record locking failure (usually in an underlying database).

      • NO_STORE

        public static final IssueType NO_STORE
        No Store Available

        The persistent store is unavailable; e.g. the database is down for maintenance or similar action, and the interaction or operation cannot be processed.

      • EXCEPTION

        public static final IssueType EXCEPTION
        Exception

        An unexpected internal error has occurred.

      • TIMEOUT

        public static final IssueType TIMEOUT
        Timeout

        An internal timeout has occurred.

      • INCOMPLETE

        public static final IssueType INCOMPLETE
        Incomplete Results

        Not all data sources typically accessed could be reached or responded in time, so the returned information might not be complete (applies to search interactions and some operations).

      • THROTTLED

        public static final IssueType THROTTLED
        Throttled

        The system is not prepared to handle this request due to load management.

      • INFORMATIONAL

        public static final IssueType INFORMATIONAL
        Informational Note

        A message unrelated to the processing success of the completed operation (examples of the latter include things like reminders of password expiry, system maintenance times, etc.).

    • Method Detail

      • of

        public static IssueType of​(IssueType.ValueSet value)
        Factory method for creating IssueType objects from a passed enum value.
      • of

        public static IssueType of​(String value)
        Factory method for creating IssueType objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value
      • string

        public static String string​(String value)
        Inherited factory method for creating IssueType objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value
      • code

        public static Code code​(String value)
        Inherited factory method for creating IssueType objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value
      • equals

        public boolean equals​(Object obj)
        Overrides:
        equals in class Code
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Code