001package ca.uhn.fhir.util;
002
003/*-
004 * #%L
005 * HAPI FHIR - Core Library
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 HapiExtensions {
024
025        /**
026         * <p>
027         * This extension should be of type <code>string</code> and should be
028         * placed on the <code>Subscription.channel</code> element
029         * </p>
030         */
031        public static final String EXT_SUBSCRIPTION_SUBJECT_TEMPLATE = "http://hapifhir.io/fhir/StructureDefinition/subscription-email-subject-template";
032
033        /**
034         * This extension URL indicates whether a REST HOOK delivery should
035         * include the version ID when delivering.
036         * <p>
037         * This extension should be of type <code>boolean</code> and should be
038         * placed on the <code>Subscription.channel</code> element.
039         * </p>
040         */
041        public static final String EXT_SUBSCRIPTION_RESTHOOK_STRIP_VERSION_IDS = "http://hapifhir.io/fhir/StructureDefinition/subscription-resthook-strip-version-ids";
042
043        /**
044         * This extension URL indicates whether a REST HOOK delivery should
045         * reload the resource and deliver the latest version always. This
046         * could be useful for example if a resource which triggers a
047         * subscription gets updated many times in short succession and there
048         * is no value in delivering the older versions.
049         * <p>
050         * Note that if the resource is now deleted, this may cause
051         * the delivery to be cancelled altogether.
052         * </p>
053         *
054         * <p>
055         * This extension should be of type <code>boolean</code> and should be
056         * placed on the <code>Subscription.channel</code> element.
057         * </p>
058         */
059        public static final String EXT_SUBSCRIPTION_RESTHOOK_DELIVER_LATEST_VERSION = "http://hapifhir.io/fhir/StructureDefinition/subscription-resthook-deliver-latest-version";
060
061        /**
062         * Indicate which strategy will be used to match this subscription
063         */
064        public static final String EXT_SUBSCRIPTION_MATCHING_STRATEGY = "http://hapifhir.io/fhir/StructureDefinition/subscription-matching-strategy";
065
066        /**
067         * <p>
068         * This extension should be of type <code>string</code> and should be
069         * placed on the <code>Subscription.channel</code> element
070         * </p>
071         */
072        public static final String EXT_SUBSCRIPTION_EMAIL_FROM = "http://hapifhir.io/fhir/StructureDefinition/subscription-email-from";
073
074        /**
075         * Extension ID for external binary references
076         */
077        public static final String EXT_EXTERNALIZED_BINARY_ID = "http://hapifhir.io/fhir/StructureDefinition/externalized-binary-id";
078
079        /**
080         * For subscription, deliver a bundle containing a search result instead of just a single resource
081         */
082        public static final String EXT_SUBSCRIPTION_PAYLOAD_SEARCH_CRITERIA = "http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria";
083
084        /**
085         * Message added to expansion valueset
086         */
087        public static final String EXT_VALUESET_EXPANSION_MESSAGE = "http://hapifhir.io/fhir/StructureDefinition/valueset-expansion-message";
088
089        /**
090         * Extension URL for extension on a SearchParameter indicating that text values should not be indexed
091         */
092        public static final String EXT_SEARCHPARAM_TOKEN_SUPPRESS_TEXT_INDEXING = "http://hapifhir.io/fhir/StructureDefinition/searchparameter-token-suppress-text-index";
093        /**
094         * <p>
095         * This extension represents the equivalent of the
096         * <code>Resource.meta.source</code> field within R4+ resources, and is for
097         * use in DSTU3 resources. It should contain a value of type <code>uri</code>
098         * and will be located on the Resource.meta
099         * </p>
100         */
101        public static final String EXT_META_SOURCE = "http://hapifhir.io/fhir/StructureDefinition/resource-meta-source";
102        public static final String EXT_SP_UNIQUE = "http://hapifhir.io/fhir/StructureDefinition/sp-unique";
103
104        /**
105         * URL for extension on a Phonetic String SearchParameter indicating that text values should be phonetically indexed with the named encoder
106         */
107        public static final String EXT_SEARCHPARAM_PHONETIC_ENCODER = "http://hapifhir.io/fhir/StructureDefinition/searchparameter-phonetic-encoder";
108
109        /**
110         * URL for boolean extension added to all placeholder resources
111         */
112        public static final String EXT_RESOURCE_PLACEHOLDER = "http://hapifhir.io/fhir/StructureDefinition/resource-placeholder";
113
114        /**
115         * URL for extension in a Group Bulk Export which identifies the golden patient of a given exported resource.
116         */
117    public static final String ASSOCIATED_GOLDEN_RESOURCE_EXTENSION_URL = "https://hapifhir.org/associated-patient-golden-resource/";
118
119        /**
120         * This extension provides an example value for a parameter value for
121         * a REST operation (eg for an OperationDefinition)
122         */
123        public static final String EXT_OP_PARAMETER_EXAMPLE_VALUE = "http://hapifhir.io/fhir/StructureDefinition/op-parameter-example-value";
124
125        /**
126         * Non instantiable
127         */
128        private HapiExtensions() {
129        }
130
131
132}