001package ca.uhn.fhir.rest.server.provider;
002
003/*-
004 * #%L
005 * HAPI FHIR - Server Framework
006 * %%
007 * Copyright (C) 2014 - 2022 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023public class ProviderConstants {
024        public static final String SUBSCRIPTION_TRIGGERING_PARAM_RESOURCE_ID = "resourceId";
025        public static final String SUBSCRIPTION_TRIGGERING_PARAM_SEARCH_URL = "searchUrl";
026
027        /**
028         * Operation name: add partition
029         */
030        public static final String PARTITION_MANAGEMENT_CREATE_PARTITION = "$partition-management-create-partition";
031
032        /**
033         * Operation name: update partition
034         */
035        public static final String PARTITION_MANAGEMENT_UPDATE_PARTITION = "$partition-management-update-partition";
036
037        /**
038         * Operation name: update partition
039         */
040        public static final String PARTITION_MANAGEMENT_DELETE_PARTITION = "$partition-management-delete-partition";
041
042        /**
043         * Operation name: read partition
044         */
045        public static final String PARTITION_MANAGEMENT_READ_PARTITION = "$partition-management-read-partition";
046
047        /**
048         * Operation name: list partitions
049         */
050        public static final String PARTITION_MANAGEMENT_LIST_PARTITIONS = "$partition-management-list-partitions";
051
052        public static final String PARTITION_MANAGEMENT_PARTITION_ID = "id";
053        public static final String PARTITION_MANAGEMENT_PARTITION_NAME = "name";
054        public static final String PARTITION_MANAGEMENT_PARTITION_DESC = "description";
055
056        /**
057         * Operation name: diff
058         */
059        public static final String DIFF_OPERATION_NAME = "$diff";
060        public static final String DIFF_FROM_VERSION_PARAMETER = "fromVersion";
061
062        public static final String DIFF_FROM_PARAMETER = "from";
063        public static final String DIFF_TO_PARAMETER = "to";
064        public static final String DIFF_INCLUDE_META_PARAMETER = "includeMeta";
065
066        /**
067         * EMPI Operations
068         */
069        public static final String EMPI_MATCH = "$match";
070        public static final String MDM_MATCH = "$mdm-match";
071        public static final String MDM_MATCH_RESOURCE = "resource";
072        public static final String MDM_RESOURCE_TYPE = "resourceType";
073        public static final String MDM_MERGE_GOLDEN_RESOURCES = "$mdm-merge-golden-resources";
074        public static final String MDM_MERGE_GR_FROM_GOLDEN_RESOURCE_ID = "fromGoldenResourceId";
075        public static final String MDM_MERGE_GR_TO_GOLDEN_RESOURCE_ID = "toGoldenResourceId";
076        public static final String MDM_MERGE_RESOURCE = "resource";
077
078        public static final String MDM_UPDATE_LINK = "$mdm-update-link";
079        public static final String MDM_UPDATE_LINK_GOLDEN_RESOURCE_ID = "goldenResourceId";
080        public static final String MDM_UPDATE_LINK_RESOURCE_ID = "resourceId";
081        public static final String MDM_UPDATE_LINK_MATCH_RESULT = "matchResult";
082
083        public static final String MDM_CREATE_LINK = "$mdm-create-link";
084        public static final String MDM_CREATE_LINK_GOLDEN_RESOURCE_ID = "goldenResourceId";
085        public static final String MDM_CREATE_LINK_RESOURCE_ID = "resourceId";
086        public static final String MDM_CREATE_LINK_MATCH_RESULT = "matchResult";
087
088        public static final String MDM_QUERY_LINKS = "$mdm-query-links";
089        public static final String MDM_QUERY_LINKS_GOLDEN_RESOURCE_ID = "goldenResourceId";
090        public static final String MDM_QUERY_LINKS_RESOURCE_ID = "resourceId";
091        public static final String MDM_QUERY_PARTITION_IDS = "partitionIds";
092        public static final String MDM_QUERY_LINKS_MATCH_RESULT = "matchResult";
093        public static final String MDM_QUERY_LINKS_LINK_SOURCE = "linkSource";
094
095        public static final String MDM_DUPLICATE_GOLDEN_RESOURCES = "$mdm-duplicate-golden-resources";
096        public static final String MDM_NOT_DUPLICATE = "$mdm-not-duplicate";
097
098        public static final String OPERATION_MDM_CLEAR = "$mdm-clear";
099        public static final String OPERATION_MDM_CLEAR_RESOURCE_NAME = "resourceType";
100        public static final String OPERATION_MDM_CLEAR_BATCH_SIZE = "batchSize";
101        public static final String OPERATION_MDM_SUBMIT = "$mdm-submit";
102        public static final String MDM_BATCH_RUN_CRITERIA = "criteria";
103        public static final String MDM_BATCH_RUN_RESOURCE_TYPE = "resourceType";
104        /**
105         * CQL Operations
106         */
107        public static final String CQL_EVALUATE_MEASURE = "$evaluate-measure";
108
109        /**
110         * Operation name for the $meta operation
111         */
112        public static final String OPERATION_META = "$meta";
113
114        /**
115         *  Operation name for the $expunge operation
116         */
117        public static final String OPERATION_EXPUNGE = "$expunge";
118
119        /**
120         * Parameter name for the $expunge operation
121         */
122        public static final String OPERATION_EXPUNGE_PARAM_LIMIT = "limit";
123        /**
124         * Parameter name for the $expunge operation
125         */
126        public static final String OPERATION_EXPUNGE_PARAM_EXPUNGE_DELETED_RESOURCES = "expungeDeletedResources";
127        /**
128         * Parameter name for the $expunge operation
129         */
130        public static final String OPERATION_EXPUNGE_PARAM_EXPUNGE_PREVIOUS_VERSIONS = "expungePreviousVersions";
131        /**
132         * Parameter name for the $expunge operation
133         */
134        public static final String OPERATION_EXPUNGE_PARAM_EXPUNGE_EVERYTHING = "expungeEverything";
135        /**
136         * Output parameter name for the $expunge operation
137         */
138        public static final String OPERATION_EXPUNGE_OUT_PARAM_EXPUNGE_COUNT = "count";
139
140        /**
141         * Operation name for the $delete-expunge operation
142         */
143        public static final String OPERATION_DELETE_EXPUNGE = "$delete-expunge";
144
145        /**
146         * url of resources to delete for the $delete-expunge operation
147         */
148        public static final String OPERATION_DELETE_EXPUNGE_URL = "url";
149
150        /**
151         * Number of resources to delete at a time for the $delete-expunge operation
152         */
153        public static final String OPERATION_DELETE_BATCH_SIZE = "batchSize";
154
155        /**
156         * The Spring Batch job id of the delete expunge job created by a $delete-expunge operation
157         */
158        public static final String OPERATION_BATCH_RESPONSE_JOB_ID = "jobId";
159
160        /**
161         * Operation name for the $reindex operation
162         */
163        public static final String OPERATION_REINDEX = "$reindex";
164
165        /**
166         * Operation name for the $invalidate-expansion operation
167         */
168        public static final String OPERATION_INVALIDATE_EXPANSION = "$invalidate-expansion";
169
170        /**
171         * url of resources to delete for the $delete-expunge operation
172         */
173        public static final String OPERATION_REINDEX_PARAM_URL = "url";
174
175        /**
176         * Number of resources to delete at a time for the $delete-expunge operation
177         */
178        public static final String OPERATION_REINDEX_PARAM_BATCH_SIZE = "batchSize";
179
180        /**
181         * Whether all resource types should be reindexed
182         */
183        public static final String OPERATION_REINDEX_PARAM_EVERYTHING = "everything";
184
185        /**
186         * The Spring Batch job id of the delete expunge job created by a $delete-expunge operation
187         */
188        public static final String OPERATION_REINDEX_RESPONSE_JOB_ID = "jobId";
189
190        /**
191         * Operation name for the $member-match operation
192         */
193        public static final String OPERATION_MEMBER_MATCH = "$member-match";
194
195        /**
196         * Operation name for the $reindex-terminology operation
197         */
198        public static final String OPERATION_REINDEX_TERMINOLOGY = "$reindex-terminology";
199
200        @Deprecated
201        public static final String MARK_ALL_RESOURCES_FOR_REINDEXING = "$mark-all-resources-for-reindexing";
202        /**
203         * @see ProviderConstants#OPERATION_REINDEX
204         * @deprecated
205         */
206        @Deprecated
207        public static final String PERFORM_REINDEXING_PASS = "$perform-reindexing-pass";
208}