Package ca.uhn.fhir.jpa.patch

Class FhirPatch

java.lang.Object

ca.uhn.fhir.jpa.patch.FhirPatch

public class FhirPatch
extends Object

FhirPatch handler. Patch is defined by the spec: https://hl7.org/fhir/fhirpatch.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FhirPatch.PatchOutcome

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPERATION_ADD
static final String	OPERATION_DELETE
static final String	OPERATION_INSERT
static final String	OPERATION_MOVE
static final String	OPERATION_REPLACE
static final String	PARAMETER_ALLOW_MULTIPLE_MATCHES
static final String	PARAMETER_DESTINATION
static final String	PARAMETER_INDEX
static final String	PARAMETER_NAME
static final String	PARAMETER_OPERATION
static final String	PARAMETER_PATH
static final String	PARAMETER_SOURCE
static final String	PARAMETER_TYPE
static final String	PARAMETER_VALUE

Constructor Summary

Constructors

Constructor	Description
FhirPatch(ca.uhn.fhir.context.FhirContext theContext)

Method Summary

Modifier and Type	Method	Description
void	addIgnorePath(String theIgnorePath)	Adds a path element that will not be included in generated diffs.
void	apply(org.hl7.fhir.instance.model.api.IBaseResource theResource, org.hl7.fhir.instance.model.api.IBaseResource thePatch)	Apply the patch against the given resource.
org.hl7.fhir.instance.model.api.IBaseParameters	diff(org.hl7.fhir.instance.model.api.IBaseResource theOldValue, org.hl7.fhir.instance.model.api.IBaseResource theNewValue)
void	setIncludePreviousValueInDiff(boolean theIncludePreviousValueInDiff)
FhirPatch.PatchOutcome	validate(org.hl7.fhir.instance.model.api.IBaseResource thePatch)	Validates a FHIRPatch Parameters document and throws an InvalidRequestException if it is not valid.

Methods inherited from class java.lang.Object

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

Field Details

OPERATION_ADD

public static final String OPERATION_ADD

See Also:

• Constant Field Values

OPERATION_DELETE

public static final String OPERATION_DELETE

See Also:

• Constant Field Values

OPERATION_INSERT

public static final String OPERATION_INSERT

See Also:

• Constant Field Values

OPERATION_MOVE

public static final String OPERATION_MOVE

See Also:

• Constant Field Values

OPERATION_REPLACE

public static final String OPERATION_REPLACE

See Also:

• Constant Field Values

PARAMETER_DESTINATION

public static final String PARAMETER_DESTINATION

See Also:

• Constant Field Values

PARAMETER_INDEX

public static final String PARAMETER_INDEX

See Also:

• Constant Field Values

PARAMETER_NAME

public static final String PARAMETER_NAME

See Also:

• Constant Field Values

PARAMETER_OPERATION

public static final String PARAMETER_OPERATION

See Also:

• Constant Field Values

PARAMETER_PATH

public static final String PARAMETER_PATH

See Also:

• Constant Field Values

PARAMETER_SOURCE

public static final String PARAMETER_SOURCE

See Also:

• Constant Field Values

PARAMETER_TYPE

public static final String PARAMETER_TYPE

See Also:

• Constant Field Values

PARAMETER_VALUE

public static final String PARAMETER_VALUE

See Also:

• Constant Field Values

PARAMETER_ALLOW_MULTIPLE_MATCHES

public static final String PARAMETER_ALLOW_MULTIPLE_MATCHES

See Also:

• Constant Field Values

Constructor Details

FhirPatch

public FhirPatch(ca.uhn.fhir.context.FhirContext theContext)

Method Details

addIgnorePath

public void addIgnorePath(String theIgnorePath)

Adds a path element that will not be included in generated diffs. Values can take the form ResourceName.fieldName.fieldName and wildcards are supported, such as *.meta.

setIncludePreviousValueInDiff

public void setIncludePreviousValueInDiff(boolean theIncludePreviousValueInDiff)

apply

public void apply(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 org.hl7.fhir.instance.model.api.IBaseResource thePatch)

Apply the patch against the given resource.

Parameters:

theResource - The resourece to patch. This object will be modified in-place.

thePatch - The patch document.

diff

public org.hl7.fhir.instance.model.api.IBaseParameters diff(@Nullable
 org.hl7.fhir.instance.model.api.IBaseResource theOldValue,
 @Nonnull
 org.hl7.fhir.instance.model.api.IBaseResource theNewValue)

validate

public FhirPatch.PatchOutcome validate(org.hl7.fhir.instance.model.api.IBaseResource thePatch)

Validates a FHIRPatch Parameters document and throws an InvalidRequestException if it is not valid. Note, in previous versions of HAPI FHIR this method threw an exception but the full error list is now returned instead.

Parameters:

thePatch - The Parameters resource to validate as a FHIRPatch document

Returns:

Returns a FhirPatch.PatchOutcome containing any errors

Since:

8.4.0