View Javadoc
1   package ca.uhn.fhir.jpa.util;
2   
3   /*-
4    * #%L
5    * HAPI FHIR JPA Server
6    * %%
7    * Copyright (C) 2014 - 2018 University Health Network
8    * %%
9    * Licensed under the Apache License, Version 2.0 (the "License");
10   * you may not use this file except in compliance with the License.
11   * You may obtain a copy of the License at
12   * 
13   *      http://www.apache.org/licenses/LICENSE-2.0
14   * 
15   * Unless required by applicable law or agreed to in writing, software
16   * distributed under the License is distributed on an "AS IS" BASIS,
17   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18   * See the License for the specific language governing permissions and
19   * limitations under the License.
20   * #L%
21   */
22  
23  import ca.uhn.fhir.rest.api.Constants;
24  
25  public class JpaConstants {
26  
27  	public static final String EXT_SP_UNIQUE = "http://hapifhir.io/fhir/StructureDefinition/sp-unique";
28  
29  	/**
30  	 * <p>
31  	 * This extension should be of type <code>string</code> and should be
32  	 * placed on the <code>Subscription.channel</code> element
33  	 * </p>
34  	 */
35  	public static final String EXT_SUBSCRIPTION_EMAIL_FROM = "http://hapifhir.io/fhir/StructureDefinition/subscription-email-from";
36  
37  	/**
38  	 * <p>
39  	 * This extension should be of type <code>string</code> and should be
40  	 * placed on the <code>Subscription.channel</code> element
41  	 * </p>
42  	 */
43  	public static final String EXT_SUBSCRIPTION_SUBJECT_TEMPLATE = "http://hapifhir.io/fhir/StructureDefinition/subscription-email-subject-template";
44  
45  
46  	/**
47  	 * This extension URL indicates whether a REST HOOK delivery should
48  	 * include the version ID when delivering.
49  	 * <p>
50  	 * This extension should be of type <code>boolean</code> and should be
51  	 * placed on the <code>Subscription.channel</code> element.
52  	 * </p>
53  	 */
54  	public static final String EXT_SUBSCRIPTION_RESTHOOK_STRIP_VERSION_IDS = "http://hapifhir.io/fhir/StructureDefinition/subscription-resthook-strip-version-ids";
55  
56  	/**
57  	 * This extension URL indicates whether a REST HOOK delivery should
58  	 * reload the resource and deliver the latest version always. This
59  	 * could be useful for example if a resource which triggers a
60  	 * subscription gets updated many times in short succession and there
61  	 * is no value in delivering the older versions.
62  	 * <p>
63  	 * Note that if the resource is now deleted, this may cause
64  	 * the delivery to be cancelled altogether.
65  	 * </p>
66  	 *
67  	 * <p>
68  	 * This extension should be of type <code>boolean</code> and should be
69  	 * placed on the <code>Subscription.channel</code> element.
70  	 * </p>
71  	 */
72  	public static final String EXT_SUBSCRIPTION_RESTHOOK_DELIVER_LATEST_VERSION = "http://hapifhir.io/fhir/StructureDefinition/subscription-resthook-deliver-latest-version";
73  	/**
74  	 * Operation name for the $expunge operation
75  	 */
76  	public static final String OPERATION_EXPUNGE = "$expunge";
77  
78  	/**
79  	 * @deprecated Replace with {@link #OPERATION_EXPUNGE}
80  	 */
81  	@Deprecated
82  	public static final String OPERATION_NAME_EXPUNGE = OPERATION_EXPUNGE;
83  
84  	/**
85  	 * Parameter name for the $expunge operation
86  	 */
87  	public static final String OPERATION_EXPUNGE_PARAM_LIMIT = "limit";
88  	/**
89  	 * Parameter name for the $expunge operation
90  	 */
91  	public static final String OPERATION_EXPUNGE_PARAM_EXPUNGE_DELETED_RESOURCES = "expungeDeletedResources";
92  	/**
93  	 * Parameter name for the $expunge operation
94  	 */
95  	public static final String OPERATION_EXPUNGE_PARAM_EXPUNGE_PREVIOUS_VERSIONS = "expungePreviousVersions";
96  	/**
97  	 * Parameter name for the $expunge operation
98  	 */
99  	public static final String OPERATION_EXPUNGE_PARAM_EXPUNGE_EVERYTHING = "expungeEverything";
100 	/**
101 	 * Output parameter name for the $expunge operation
102 	 */
103 	public static final String OPERATION_EXPUNGE_OUT_PARAM_EXPUNGE_COUNT = "count";
104 	/**
105 	 * Header name for the "X-Meta-Snapshot-Mode" header, which
106 	 * specifies that properties in meta (tags, profiles, security labels)
107 	 * should be treated as a snapshot, meaning that these things will
108 	 * be removed if they are nt explicitly included in updates
109 	 */
110 	public static final String HEADER_META_SNAPSHOT_MODE = "X-Meta-Snapshot-Mode";
111 
112 	/**
113 	 * Operation name for the $lookup operation
114 	 */
115 	public static final String OPERATION_LOOKUP = "$lookup";
116 
117 	/**
118 	 * Operation name for the $expand operation
119 	 */
120 	public static final String OPERATION_EXPAND = "$expand";
121 
122 	/**
123 	 * Operation name for the $validate-code operation
124 	 */
125 	public static final String OPERATION_VALIDATE_CODE = "$validate-code";
126 
127 	/**
128 	 * Operation name for the $get-resource-counts operation
129 	 */
130 	public static final String OPERATION_GET_RESOURCE_COUNTS = "$get-resource-counts";
131 
132 	/**
133 	 * Operation name for the $meta operation
134 	 */
135 	public static final String OPERATION_META = "$meta";
136 
137 	/**
138 	 * Operation name for the $validate operation
139 	 */
140 	// NB don't delete this, it's used in Smile as well, even though hapi-fhir-server uses the version from Constants.java
141 	public static final String OPERATION_VALIDATE = Constants.EXTOP_VALIDATE;
142 
143 	/**
144 	 * Operation name for the $suggest-keywords operation
145 	 */
146 	public static final String OPERATION_SUGGEST_KEYWORDS = "$suggest-keywords";
147 
148 	/**
149 	 * Operation name for the $everything operation
150 	 */
151 	public static final String OPERATION_EVERYTHING = "$everything";
152 
153 	/**
154 	 * Operation name for the $process-message operation
155 	 */
156 	public static final String OPERATION_PROCESS_MESSAGE = "$process-message";
157 
158 	/**
159 	 * Operation name for the $meta-delete operation
160 	 */
161 	public static final String OPERATION_META_DELETE = "$meta-delete";
162 
163 	/**
164 	 * Operation name for the $meta-add operation
165 	 */
166 	public static final String OPERATION_META_ADD = "$meta-add";
167 
168 	/**
169 	 * Operation name for the $translate operation
170 	 */
171 	public static final String OPERATION_TRANSLATE = "$translate";
172 
173 	/**
174 	 * Operation name for the $document operation
175 	 */
176 	public static final String OPERATION_DOCUMENT = "$document";
177 
178 	/**
179 	 * Trigger a subscription manually for a given resource
180 	 */
181 	public static final String OPERATION_TRIGGER_SUBSCRIPTION = "$trigger-subscription";
182 }