Package org.hl7.fhir.r4.model
Enum OperationOutcome.IssueType
- java.lang.Object
-
- java.lang.Enum<OperationOutcome.IssueType>
-
- org.hl7.fhir.r4.model.OperationOutcome.IssueType
-
- All Implemented Interfaces:
Serializable,Comparable<OperationOutcome.IssueType>
- Enclosing class:
- OperationOutcome
public static enum OperationOutcome.IssueType extends Enum<OperationOutcome.IssueType>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BUSINESSRULEThe content/operation failed to pass some business rule and so could not proceed.CODEINVALIDThe code or system could not be understood, or it was not valid in the context of a particular ValueSet.code.CONFLICTContent could not be accepted because of an edit conflict (i.e.DELETEDThe reference pointed to content (usually a resource) that has been deleted.DUPLICATEAn attempt was made to create a duplicate record.EXCEPTIONAn unexpected internal error has occurred.EXPIREDUser session expired; a login may be required.EXTENSIONAn extension was found that was not acceptable, could not be resolved, or a modifierExtension was not recognized.FORBIDDENThe user does not have the rights to perform this action.INCOMPLETENot 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).INFORMATIONALA 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.).INVALIDContent invalid against the specification or a profile.INVARIANTA content validation rule failed - e.g.LOCKERRORA resource/record locking failure (usually in an underlying database).LOGINThe client needs to initiate an authentication process.MULTIPLEMATCHESMultiple matching records were found when the operation required only one match.NOSTOREThe persistent store is unavailable; e.g.NOTFOUNDThe reference provided was not found.NOTSUPPORTEDThe interaction, operation, resource or profile is not supported.NULLadded to help the parsers with the generic typesPROCESSINGProcessing issues.REQUIREDA required element is missing.SECURITYAn authentication/authorization/permissions issue of some kind.STRUCTUREA structural issue in the content such as wrong namespace, unable to parse the content completely, invalid syntax, etc.SUPPRESSEDSome information was not or might not have been returned due to business rules, consent or privacy rules, or access permission constraints.THROTTLEDThe system is not prepared to handle this request due to load management.TIMEOUTAn internal timeout has occurred.TOOCOSTLYThe operation was stopped to protect server resources; e.g.TOOLONGProvided content is too long (typically, this is a denial of service protection type of error).TRANSIENTTransient processing issues.UNKNOWNThe user or system was not able to be authenticated (either there is no process, or the proferred token is unacceptable).VALUEAn element or header value is invalid.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static OperationOutcome.IssueTypefromCode(String codeString)StringgetDefinition()StringgetDisplay()StringgetSystem()StringtoCode()static OperationOutcome.IssueTypevalueOf(String name)Returns the enum constant of this type with the specified name.static OperationOutcome.IssueType[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
INVALID
public static final OperationOutcome.IssueType INVALID
Content invalid against the specification or a profile.
-
STRUCTURE
public static final OperationOutcome.IssueType STRUCTURE
A structural issue in the content such as wrong namespace, unable to parse the content completely, invalid syntax, etc.
-
REQUIRED
public static final OperationOutcome.IssueType REQUIRED
A required element is missing.
-
VALUE
public static final OperationOutcome.IssueType VALUE
An element or header value is invalid.
-
INVARIANT
public static final OperationOutcome.IssueType INVARIANT
A content validation rule failed - e.g. a schematron rule.
-
SECURITY
public static final OperationOutcome.IssueType SECURITY
An authentication/authorization/permissions issue of some kind.
-
LOGIN
public static final OperationOutcome.IssueType LOGIN
The client needs to initiate an authentication process.
-
UNKNOWN
public static final OperationOutcome.IssueType UNKNOWN
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 OperationOutcome.IssueType EXPIRED
User session expired; a login may be required.
-
FORBIDDEN
public static final OperationOutcome.IssueType FORBIDDEN
The user does not have the rights to perform this action.
-
SUPPRESSED
public static final OperationOutcome.IssueType 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 OperationOutcome.IssueType PROCESSING
Processing issues. These are expected to be final e.g. there is no point resubmitting the same content unchanged.
-
NOTSUPPORTED
public static final OperationOutcome.IssueType NOTSUPPORTED
The interaction, operation, resource or profile is not supported.
-
DUPLICATE
public static final OperationOutcome.IssueType DUPLICATE
An attempt was made to create a duplicate record.
-
MULTIPLEMATCHES
public static final OperationOutcome.IssueType MULTIPLEMATCHES
Multiple matching records were found when the operation required only one match.
-
NOTFOUND
public static final OperationOutcome.IssueType NOTFOUND
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 OperationOutcome.IssueType DELETED
The reference pointed to content (usually a resource) that has been deleted.
-
TOOLONG
public static final OperationOutcome.IssueType TOOLONG
Provided content is too long (typically, this is a denial of service protection type of error).
-
CODEINVALID
public static final OperationOutcome.IssueType CODEINVALID
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 OperationOutcome.IssueType EXTENSION
An extension was found that was not acceptable, could not be resolved, or a modifierExtension was not recognized.
-
TOOCOSTLY
public static final OperationOutcome.IssueType TOOCOSTLY
The operation was stopped to protect server resources; e.g. a request for a value set expansion on all of SNOMED CT.
-
BUSINESSRULE
public static final OperationOutcome.IssueType BUSINESSRULE
The content/operation failed to pass some business rule and so could not proceed.
-
CONFLICT
public static final OperationOutcome.IssueType 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 OperationOutcome.IssueType TRANSIENT
Transient processing issues. The system receiving the message may be able to resubmit the same content once an underlying issue is resolved.
-
LOCKERROR
public static final OperationOutcome.IssueType LOCKERROR
A resource/record locking failure (usually in an underlying database).
-
NOSTORE
public static final OperationOutcome.IssueType NOSTORE
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 OperationOutcome.IssueType EXCEPTION
An unexpected internal error has occurred.
-
TIMEOUT
public static final OperationOutcome.IssueType TIMEOUT
An internal timeout has occurred.
-
INCOMPLETE
public static final OperationOutcome.IssueType INCOMPLETE
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 OperationOutcome.IssueType THROTTLED
The system is not prepared to handle this request due to load management.
-
INFORMATIONAL
public static final OperationOutcome.IssueType INFORMATIONAL
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.).
-
NULL
public static final OperationOutcome.IssueType NULL
added to help the parsers with the generic types
-
-
Method Detail
-
values
public static OperationOutcome.IssueType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (OperationOutcome.IssueType c : OperationOutcome.IssueType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static OperationOutcome.IssueType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
fromCode
public static OperationOutcome.IssueType fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getDefinition
public String getDefinition()
-
getDisplay
public String getDisplay()
-
-