Package ca.uhn.fhir.util

Class HapiExtensions

java.lang.Object

ca.uhn.fhir.util.HapiExtensions

public class HapiExtensions
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ASSOCIATED_GOLDEN_RESOURCE_EXTENSION_URL	URL for extension in a Group Bulk Export which identifies the golden patient of a given exported resource.
static final String	EX_RETRY_COUNT	This extension provides a way for subscribers to provide a "retry-count".
static final String	EX_SEND_DELETE_MESSAGES	This extension provides a way for subscribers to indicate if DELETE messages must be sent (default is ignoring them)
static final String	EXT_EXTERNALIZED_BINARY_ID	Extension ID for external binary references
static final String	EXT_META_SOURCE	This extension represents the equivalent of the Resource.meta.source field within R4+ resources, and is for use in DSTU3 resources.
static final String	EXT_OP_PARAMETER_EXAMPLE_VALUE	This extension provides an example value for a parameter value for a REST operation (eg for an OperationDefinition)
static final String	EXT_RESOURCE_PLACEHOLDER	URL for boolean extension added to all placeholder resources
static final String	EXT_SEARCHPARAM_ENABLED_FOR_SEARCHING	URL for extension on a Search Parameter which determines whether it should be enabled for searching for resources
static final String	EXT_SEARCHPARAM_PHONETIC_ENCODER	URL for extension on a Phonetic String SearchParameter indicating that text values should be phonetically indexed with the named encoder
static final String	EXT_SEARCHPARAM_TOKEN_SUPPRESS_TEXT_INDEXING	Extension URL for extension on a SearchParameter indicating that text values should not be indexed
static final String	EXT_SP_UNIQUE
static final String	EXT_SUBSCRIPTION_EMAIL_FROM	This extension should be of type string and should be placed on the Subscription.channel element
static final String	EXT_SUBSCRIPTION_MATCHING_STRATEGY	Indicate which strategy will be used to match this subscription
static final String	EXT_SUBSCRIPTION_PAYLOAD_SEARCH_CRITERIA	For subscription, deliver a bundle containing a search result instead of just a single resource
static final String	EXT_SUBSCRIPTION_RESTHOOK_DELIVER_LATEST_VERSION	This extension URL indicates whether a REST HOOK delivery should reload the resource and deliver the latest version always.
static final String	EXT_SUBSCRIPTION_RESTHOOK_STRIP_VERSION_IDS	This extension URL indicates whether a REST HOOK delivery should include the version ID when delivering.
static final String	EXT_SUBSCRIPTION_SUBJECT_TEMPLATE	This extension should be of type string and should be placed on the Subscription.channel element
static final String	EXT_VALUESET_EXPANSION_MESSAGE	Message added to expansion valueset
static final String	EXTENSION_AUTO_VERSION_REFERENCES_AT_PATH	This extension is used to enable auto version references at path for resource instances.
static final String	EXTENSION_PLACEHOLDER_ID	When an OperationOutcome returned by the JPA server includes a declaration that a placeholder reference was automatically created, this extension indicates the ID of the placeholder.
static final String	EXTENSION_REPLACED_BY	When a resource is replaced by another resource, this extension can be added to include a reference to the resource that is replacing it.
static final String	EXTENSION_REPLACES	When a resource is replacing another resource, this extension can be added to include a reference to the resource that is being replaced.
static final String	EXTENSION_SEARCHPARAM_CUSTOM_BASE_RESOURCE
static final String	EXTENSION_SEARCHPARAM_CUSTOM_TARGET_RESOURCE
static final String	EXTENSION_SEARCHPARAM_UPLIFT_REFCHAIN	This extension is used for "uplifted refchains" on search parameters.
static final String	EXTENSION_SEARCHPARAM_UPLIFT_REFCHAIN_ELEMENT_NAME	This extension is used for "uplifted refchains" on search parameters.
static final String	EXTENSION_SEARCHPARAM_UPLIFT_REFCHAIN_PARAM_CODE	This extension is used for "uplifted refchains" on search parameters.
static final String	EXTENSION_SUBSCRIPTION_CROSS_PARTITION	This entension allows subscriptions to be marked as cross partition and with correct settings, listen to incoming resources from all partitions.
static final String	EXTENSION_TRANSACTION_ENTRY_PARTITION_IDS	This extension is to specify the partition IDs for a request entry in a transaction bundle.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

EXT_SUBSCRIPTION_SUBJECT_TEMPLATE

public static final String EXT_SUBSCRIPTION_SUBJECT_TEMPLATE

This extension should be of type string and should be placed on the Subscription.channel element

See Also:

• Constant Field Values

EXT_SUBSCRIPTION_RESTHOOK_STRIP_VERSION_IDS

public static final String EXT_SUBSCRIPTION_RESTHOOK_STRIP_VERSION_IDS

This extension URL indicates whether a REST HOOK delivery should include the version ID when delivering.

This extension should be of type boolean and should be placed on the Subscription.channel element.

See Also:

• Constant Field Values

EXT_SUBSCRIPTION_RESTHOOK_DELIVER_LATEST_VERSION

public static final String EXT_SUBSCRIPTION_RESTHOOK_DELIVER_LATEST_VERSION

This extension URL indicates whether a REST HOOK delivery should reload the resource and deliver the latest version always. This could be useful for example if a resource which triggers a subscription gets updated many times in short succession and there is no value in delivering the older versions.

Note that if the resource is now deleted, this may cause the delivery to be cancelled altogether.

This extension should be of type boolean and should be placed on the Subscription.channel element.

See Also:

• Constant Field Values

EXT_SUBSCRIPTION_MATCHING_STRATEGY

public static final String EXT_SUBSCRIPTION_MATCHING_STRATEGY

Indicate which strategy will be used to match this subscription

See Also:

• Constant Field Values

EXT_SUBSCRIPTION_EMAIL_FROM

public static final String EXT_SUBSCRIPTION_EMAIL_FROM

This extension should be of type string and should be placed on the Subscription.channel element

See Also:

• Constant Field Values

EXT_EXTERNALIZED_BINARY_ID

public static final String EXT_EXTERNALIZED_BINARY_ID

Extension ID for external binary references

See Also:

• Constant Field Values

EXT_SUBSCRIPTION_PAYLOAD_SEARCH_CRITERIA

public static final String EXT_SUBSCRIPTION_PAYLOAD_SEARCH_CRITERIA

For subscription, deliver a bundle containing a search result instead of just a single resource

See Also:

• Constant Field Values

EXT_VALUESET_EXPANSION_MESSAGE

public static final String EXT_VALUESET_EXPANSION_MESSAGE

Message added to expansion valueset

See Also:

• Constant Field Values

EXT_SEARCHPARAM_TOKEN_SUPPRESS_TEXT_INDEXING

public static final String EXT_SEARCHPARAM_TOKEN_SUPPRESS_TEXT_INDEXING

Extension URL for extension on a SearchParameter indicating that text values should not be indexed

See Also:

• Constant Field Values

EXT_META_SOURCE

public static final String EXT_META_SOURCE

This extension represents the equivalent of the Resource.meta.source field within R4+ resources, and is for use in DSTU3 resources. It should contain a value of type uri and will be located on the Resource.meta

See Also:

• Constant Field Values

EXT_SP_UNIQUE

public static final String EXT_SP_UNIQUE

See Also:

• Constant Field Values

EXT_SEARCHPARAM_ENABLED_FOR_SEARCHING

public static final String EXT_SEARCHPARAM_ENABLED_FOR_SEARCHING

URL for extension on a Search Parameter which determines whether it should be enabled for searching for resources

See Also:

• Constant Field Values

EXT_SEARCHPARAM_PHONETIC_ENCODER

public static final String EXT_SEARCHPARAM_PHONETIC_ENCODER

URL for extension on a Phonetic String SearchParameter indicating that text values should be phonetically indexed with the named encoder

See Also:

• Constant Field Values

EXT_RESOURCE_PLACEHOLDER

public static final String EXT_RESOURCE_PLACEHOLDER

URL for boolean extension added to all placeholder resources

See Also:

• Constant Field Values

ASSOCIATED_GOLDEN_RESOURCE_EXTENSION_URL

public static final String ASSOCIATED_GOLDEN_RESOURCE_EXTENSION_URL

URL for extension in a Group Bulk Export which identifies the golden patient of a given exported resource.

See Also:

• Constant Field Values

EXT_OP_PARAMETER_EXAMPLE_VALUE

public static final String EXT_OP_PARAMETER_EXAMPLE_VALUE

This extension provides an example value for a parameter value for a REST operation (eg for an OperationDefinition)

See Also:

• Constant Field Values

EX_RETRY_COUNT

public static final String EX_RETRY_COUNT

This extension provides a way for subscribers to provide a "retry-count". If provided, subscriptions will be retried this many times (to a total of retry-count + 1 (for original attempt)

See Also:

• Constant Field Values

EX_SEND_DELETE_MESSAGES

public static final String EX_SEND_DELETE_MESSAGES

This extension provides a way for subscribers to indicate if DELETE messages must be sent (default is ignoring them)

See Also:

• Constant Field Values

EXTENSION_SUBSCRIPTION_CROSS_PARTITION

public static final String EXTENSION_SUBSCRIPTION_CROSS_PARTITION

This entension allows subscriptions to be marked as cross partition and with correct settings, listen to incoming resources from all partitions.

See Also:

• Constant Field Values

EXTENSION_SEARCHPARAM_UPLIFT_REFCHAIN

public static final String EXTENSION_SEARCHPARAM_UPLIFT_REFCHAIN

This extension is used for "uplifted refchains" on search parameters. See the HAPI FHIR documentation for an explanation of how these work.

See Also:

• Constant Field Values

EXTENSION_AUTO_VERSION_REFERENCES_AT_PATH

public static final String EXTENSION_AUTO_VERSION_REFERENCES_AT_PATH

This extension is used to enable auto version references at path for resource instances. This extension should be of type string and should be placed on the Resource.meta element. It is allowed to add multiple extensions with different paths.

See Also:

• Constant Field Values

EXTENSION_SEARCHPARAM_UPLIFT_REFCHAIN_PARAM_CODE

public static final String EXTENSION_SEARCHPARAM_UPLIFT_REFCHAIN_PARAM_CODE

This extension is used for "uplifted refchains" on search parameters. See the HAPI FHIR documentation for an explanation of how these work.

See Also:

• Constant Field Values

EXTENSION_SEARCHPARAM_UPLIFT_REFCHAIN_ELEMENT_NAME

public static final String EXTENSION_SEARCHPARAM_UPLIFT_REFCHAIN_ELEMENT_NAME

This extension is used for "uplifted refchains" on search parameters. See the HAPI FHIR documentation for an explanation of how these work.

See Also:

• Constant Field Values

EXTENSION_SEARCHPARAM_CUSTOM_BASE_RESOURCE

public static final String EXTENSION_SEARCHPARAM_CUSTOM_BASE_RESOURCE

See Also:

• Constant Field Values

EXTENSION_SEARCHPARAM_CUSTOM_TARGET_RESOURCE

public static final String EXTENSION_SEARCHPARAM_CUSTOM_TARGET_RESOURCE

See Also:

• Constant Field Values

EXTENSION_PLACEHOLDER_ID

public static final String EXTENSION_PLACEHOLDER_ID

When an OperationOutcome returned by the JPA server includes a declaration that a placeholder reference was automatically created, this extension indicates the ID of the placeholder.

See Also:

• Constant Field Values

EXTENSION_REPLACES

public static final String EXTENSION_REPLACES

When a resource is replacing another resource, this extension can be added to include a reference to the resource that is being replaced.

See Also:

• Constant Field Values

EXTENSION_REPLACED_BY

public static final String EXTENSION_REPLACED_BY

When a resource is replaced by another resource, this extension can be added to include a reference to the resource that is replacing it.

See Also:

• Constant Field Values

EXTENSION_TRANSACTION_ENTRY_PARTITION_IDS

public static final String EXTENSION_TRANSACTION_ENTRY_PARTITION_IDS

This extension is to specify the partition IDs for a request entry in a transaction bundle. This allows overriding partition id for a request entry in a transaction bundle so that a single transaction can have entries destined for different storage partitions. The expected value is a comma-separated string of partition IDs.

See Also:

• Constant Field Values