001package ca.uhn.fhir.rest.server.provider;
002
003/*-
004 * #%L
005 * HAPI FHIR - Server Framework
006 * %%
007 * Copyright (C) 2014 - 2021 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        public static final String PARTITION_MANAGEMENT_PARTITION_ID = "id";
048        public static final String PARTITION_MANAGEMENT_PARTITION_NAME = "name";
049        public static final String PARTITION_MANAGEMENT_PARTITION_DESC = "description";
050
051        /**
052         * Operation name: diff
053         */
054        public static final String DIFF_OPERATION_NAME = "$diff";
055        public static final String DIFF_FROM_VERSION_PARAMETER = "fromVersion";
056
057        public static final String DIFF_FROM_PARAMETER = "from";
058        public static final String DIFF_TO_PARAMETER = "to";
059        public static final String DIFF_INCLUDE_META_PARAMETER = "includeMeta";
060
061        /**
062         * EMPI Operations
063         */
064        public static final String EMPI_MATCH = "$match";
065        public static final String MDM_MATCH = "$mdm-match";
066        public static final String MDM_MATCH_RESOURCE = "resource";
067        public static final String MDM_RESOURCE_TYPE = "resourceType";
068        public static final String MDM_MERGE_GOLDEN_RESOURCES = "$mdm-merge-golden-resources";
069        public static final String MDM_MERGE_GR_FROM_GOLDEN_RESOURCE_ID = "fromGoldenResourceId";
070        public static final String MDM_MERGE_GR_TO_GOLDEN_RESOURCE_ID = "toGoldenResourceId";
071        public static final String MDM_MERGE_RESOURCE = "resource";
072
073        public static final String MDM_UPDATE_LINK = "$mdm-update-link";
074        public static final String MDM_UPDATE_LINK_GOLDEN_RESOURCE_ID = "goldenResourceId";
075        public static final String MDM_UPDATE_LINK_RESOURCE_ID = "resourceId";
076        public static final String MDM_UPDATE_LINK_MATCH_RESULT = "matchResult";
077
078        public static final String MDM_QUERY_LINKS = "$mdm-query-links";
079        public static final String MDM_QUERY_LINKS_GOLDEN_RESOURCE_ID = "goldenResourceId";
080        public static final String MDM_QUERY_LINKS_RESOURCE_ID = "resourceId";
081        public static final String MDM_QUERY_LINKS_MATCH_RESULT = "matchResult";
082        public static final String MDM_QUERY_LINKS_LINK_SOURCE = "linkSource";
083
084        public static final String MDM_DUPLICATE_GOLDEN_RESOURCES = "$mdm-duplicate-golden-resources";
085        public static final String MDM_NOT_DUPLICATE = "$mdm-not-duplicate";
086
087        public static final String OPERATION_MDM_CLEAR = "$mdm-clear";
088        public static final String OPERATION_MDM_CLEAR_RESOURCE_NAME = "resourceType";
089        public static final String OPERATION_MDM_CLEAR_BATCH_SIZE = "batchSize";
090        public static final String OPERATION_MDM_SUBMIT = "$mdm-submit";
091        public static final String MDM_BATCH_RUN_CRITERIA = "criteria";
092        public static final String MDM_BATCH_RUN_RESOURCE_TYPE = "resourceType";
093        /**
094         * CQL Operations
095         */
096        public static final String CQL_EVALUATE_MEASURE = "$evaluate-measure";
097
098        /**
099         * Operation name for the $meta operation
100         */
101        public static final String OPERATION_META = "$meta";
102
103        /**
104         *  Operation name for the $expunge operation
105         */
106        public static final String OPERATION_EXPUNGE = "$expunge";
107
108        /**
109         * Parameter name for the $expunge operation
110         */
111        public static final String OPERATION_EXPUNGE_PARAM_LIMIT = "limit";
112        /**
113         * Parameter name for the $expunge operation
114         */
115        public static final String OPERATION_EXPUNGE_PARAM_EXPUNGE_DELETED_RESOURCES = "expungeDeletedResources";
116        /**
117         * Parameter name for the $expunge operation
118         */
119        public static final String OPERATION_EXPUNGE_PARAM_EXPUNGE_PREVIOUS_VERSIONS = "expungePreviousVersions";
120        /**
121         * Parameter name for the $expunge operation
122         */
123        public static final String OPERATION_EXPUNGE_PARAM_EXPUNGE_EVERYTHING = "expungeEverything";
124        /**
125         * Output parameter name for the $expunge operation
126         */
127        public static final String OPERATION_EXPUNGE_OUT_PARAM_EXPUNGE_COUNT = "count";
128
129        /**
130         * Operation name for the $delete-expunge operation
131         */
132        public static final String OPERATION_DELETE_EXPUNGE = "$delete-expunge";
133
134        /**
135         * url of resources to delete for the $delete-expunge operation
136         */
137        public static final String OPERATION_DELETE_EXPUNGE_URL = "url";
138
139        /**
140         * Number of resources to delete at a time for the $delete-expunge operation
141         */
142        public static final String OPERATION_DELETE_BATCH_SIZE = "batchSize";
143
144        /**
145         * The Spring Batch job id of the delete expunge job created by a $delete-expunge operation
146         */
147        public static final String OPERATION_BATCH_RESPONSE_JOB_ID = "jobId";
148
149        /**
150         * Operation name for the $delete-expunge operation
151         */
152        public static final String OPERATION_REINDEX = "$reindex";
153
154        /**
155         * url of resources to delete for the $delete-expunge operation
156         */
157        public static final String OPERATION_REINDEX_PARAM_URL = "url";
158
159        /**
160         * Number of resources to delete at a time for the $delete-expunge operation
161         */
162        public static final String OPERATION_REINDEX_PARAM_BATCH_SIZE = "batchSize";
163
164        /**
165         * Whether all resource types should be reindexed
166         */
167        public static final String OPERATION_REINDEX_PARAM_EVERYTHING = "everything";
168
169        /**
170         * The Spring Batch job id of the delete expunge job created by a $delete-expunge operation
171         */
172        public static final String OPERATION_REINDEX_RESPONSE_JOB_ID = "jobId";
173}