Package ca.uhn.fhir.util

Class OperationOutcomeUtil

java.lang.Object

ca.uhn.fhir.util.OperationOutcomeUtil

public class OperationOutcomeUtil
extends Object

Utilities for dealing with OperationOutcome resources across various model versions

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OO_ISSUE_CODE_INFORMATIONAL
static final String	OO_ISSUE_CODE_PROCESSING
static final String	OO_ISSUE_CODE_SUCCESS	Note: This code was added in FHIR R5, so the addIssue methods here will automatically convert it to OO_ISSUE_CODE_INFORMATIONAL for previous versions of FHIR.
static final String	OO_SEVERITY_ERROR
static final String	OO_SEVERITY_INFO
static final String	OO_SEVERITY_WARN

Constructor Summary

Constructors

Constructor	Description
OperationOutcomeUtil()

Method Summary

Modifier and Type	Method	Description
static void	addDetailsToIssue(FhirContext theFhirContext, IBase theIssue, String theSystem, String theCode)
static void	addDetailsToIssue(FhirContext theFhirContext, IBase theIssue, String theSystem, String theCode, String theText)
static void	addExpressionToIssue(FhirContext theContext, IBase theIssue, String theLocationExpression)	Given an instance of OperationOutcome.issue, adds a new instance of OperationOutcome.issue.expression with the given string value.
static IBase	addIssue(FhirContext theCtx, IBaseOperationOutcome theOperationOutcome, String theSeverity, String theDiagnostics, String theLocation, String theCode)	Add an issue to an OperationOutcome
static IBase	addIssue(FhirContext theCtx, IBaseOperationOutcome theOperationOutcome, String theSeverity, String theDiagnostics, String theLocation, String theCode, String theDetailSystem, String theDetailCode, String theDetailDescription)
static void	addIssueColExtensionToIssue(FhirContext theCtx, IBase theIssue, String theColumn)
static void	addIssueLineExtensionToIssue(FhirContext theCtx, IBase theIssue, String theLine)
static IBase	addIssueWithMessageId(FhirContext myCtx, IBaseOperationOutcome theOperationOutcome, String theSeverity, String theMessage, String theMessageId, String theLocation, String theCode)
static void	addLocationToIssue(FhirContext theContext, IBase theIssue, String theLocation)
static void	addMessageIdExtensionToIssue(FhirContext theCtx, IBase theIssue, String theMessageId)
static IBaseOperationOutcome	createOperationOutcome(String theSeverity, String theMessage, String theCode, FhirContext theFhirContext, StorageResponseCodeEnum theStorageResponseCode)
static String	getFirstIssueDetails(FhirContext theCtx, IBaseOperationOutcome theOutcome)	Deprecated, for removal: This API element is subject to removal in a future version. Use getFirstIssueDiagnostics(FhirContext, IBaseOperationOutcome) instead.
static String	getFirstIssueDiagnostics(FhirContext theCtx, IBaseOperationOutcome theOutcome)
static String	getFirstIssueLocation(FhirContext theCtx, IBaseOperationOutcome theOutcome)
static int	getIssueCount(FhirContext theCtx, IBaseOperationOutcome theOutcome)
static String	getIssueDiagnostics(FhirContext theCtx, IBaseOperationOutcome theOutcome, int theIndex)
static boolean	hasIssues(FhirContext theCtx, IBaseOperationOutcome theOutcome)	Returns true if the given OperationOutcome has 1 or more Operation.issue repetitions
static boolean	hasIssuesOfSeverity(FhirContext theCtx, IBaseOperationOutcome theOutcome, String theSeverity)
static IBaseOperationOutcome	newInstance(FhirContext theCtx)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

OO_SEVERITY_ERROR

public static final String OO_SEVERITY_ERROR

See Also:

• Constant Field Values

OO_SEVERITY_INFO

public static final String OO_SEVERITY_INFO

See Also:

• Constant Field Values

OO_SEVERITY_WARN

public static final String OO_SEVERITY_WARN

See Also:

• Constant Field Values

OO_ISSUE_CODE_INFORMATIONAL

public static final String OO_ISSUE_CODE_INFORMATIONAL

See Also:

• Constant Field Values

OO_ISSUE_CODE_SUCCESS

public static final String OO_ISSUE_CODE_SUCCESS

Note: This code was added in FHIR R5, so the addIssue methods here will automatically convert it to OO_ISSUE_CODE_INFORMATIONAL for previous versions of FHIR.

Since:

8.6.0

See Also:

• Constant Field Values

OO_ISSUE_CODE_PROCESSING

public static final String OO_ISSUE_CODE_PROCESSING

Since:

8.6.0

See Also:

• Constant Field Values

Constructor Details

OperationOutcomeUtil

public OperationOutcomeUtil()

Method Details

addIssue

public static IBase addIssue(FhirContext theCtx,
 IBaseOperationOutcome theOperationOutcome,
 String theSeverity,
 String theDiagnostics,
 String theLocation,
 String theCode)

Add an issue to an OperationOutcome

Parameters:

theCtx - The fhir context

theOperationOutcome - The OO resource to add to

theSeverity - The severity (fatal | error | warning | information)

theDiagnostics - The diagnostics string (this was called "details" in FHIR DSTU2 but was renamed to diagnostics in DSTU3)

theCode - A code, such as OO_ISSUE_CODE_INFORMATIONAL or OO_ISSUE_CODE_SUCCESS

Returns:

Returns the newly added issue

addIssue

public static IBase addIssue(FhirContext theCtx,
 IBaseOperationOutcome theOperationOutcome,
 String theSeverity,
 String theDiagnostics,
 String theLocation,
 String theCode,
 @Nullable
 String theDetailSystem,
 @Nullable
 String theDetailCode,
 @Nullable
 String theDetailDescription)

getFirstIssueDetails

@Deprecated(forRemoval=true,
            since="8.2.0")
public static String getFirstIssueDetails(FhirContext theCtx,
 IBaseOperationOutcome theOutcome)

Deprecated, for removal: This API element is subject to removal in a future version.

Use getFirstIssueDiagnostics(FhirContext, IBaseOperationOutcome) instead. This method has always been misnamed for historical reasons.

getFirstIssueDiagnostics

public static String getFirstIssueDiagnostics(FhirContext theCtx,
 IBaseOperationOutcome theOutcome)

getIssueDiagnostics

public static String getIssueDiagnostics(FhirContext theCtx,
 IBaseOperationOutcome theOutcome,
 int theIndex)

getFirstIssueLocation

public static String getFirstIssueLocation(FhirContext theCtx,
 IBaseOperationOutcome theOutcome)

hasIssues

public static boolean hasIssues(FhirContext theCtx,
 IBaseOperationOutcome theOutcome)

Returns true if the given OperationOutcome has 1 or more Operation.issue repetitions

getIssueCount

public static int getIssueCount(FhirContext theCtx,
 IBaseOperationOutcome theOutcome)

hasIssuesOfSeverity

public static boolean hasIssuesOfSeverity(FhirContext theCtx,
 IBaseOperationOutcome theOutcome,
 String theSeverity)

newInstance

public static IBaseOperationOutcome newInstance(FhirContext theCtx)

addLocationToIssue

public static void addLocationToIssue(FhirContext theContext,
 IBase theIssue,
 String theLocation)

addExpressionToIssue

public static void addExpressionToIssue(FhirContext theContext,
 IBase theIssue,
 String theLocationExpression)

Given an instance of OperationOutcome.issue, adds a new instance of OperationOutcome.issue.expression with the given string value.

Parameters:

theContext - The FhirContext for the appropriate FHIR version

theIssue - The OperationOutcome.issue to add to

theLocationExpression - The string to use as content

addIssueWithMessageId

public static IBase addIssueWithMessageId(FhirContext myCtx,
 IBaseOperationOutcome theOperationOutcome,
 String theSeverity,
 String theMessage,
 String theMessageId,
 String theLocation,
 String theCode)

addDetailsToIssue

public static void addDetailsToIssue(FhirContext theFhirContext,
 IBase theIssue,
 String theSystem,
 String theCode)

addDetailsToIssue

public static void addDetailsToIssue(FhirContext theFhirContext,
 IBase theIssue,
 String theSystem,
 String theCode,
 String theText)

addIssueLineExtensionToIssue

public static void addIssueLineExtensionToIssue(FhirContext theCtx,
 IBase theIssue,
 String theLine)

addIssueColExtensionToIssue

public static void addIssueColExtensionToIssue(FhirContext theCtx,
 IBase theIssue,
 String theColumn)

addMessageIdExtensionToIssue

public static void addMessageIdExtensionToIssue(FhirContext theCtx,
 IBase theIssue,
 String theMessageId)

createOperationOutcome

public static IBaseOperationOutcome createOperationOutcome(String theSeverity,
 String theMessage,
 String theCode,
 FhirContext theFhirContext,
 @Nullable
 StorageResponseCodeEnum theStorageResponseCode)