001package ca.uhn.fhir.rest.gclient;
002
003import org.hl7.fhir.instance.model.api.IIdType;
004
005/*
006 * #%L
007 * HAPI FHIR - Core Library
008 * %%
009 * Copyright (C) 2014 - 2022 Smile CDR, Inc.
010 * %%
011 * Licensed under the Apache License, Version 2.0 (the "License");
012 * you may not use this file except in compliance with the License.
013 * You may obtain a copy of the License at
014 *
015 *      http://www.apache.org/licenses/LICENSE-2.0
016 *
017 * Unless required by applicable law or agreed to in writing, software
018 * distributed under the License is distributed on an "AS IS" BASIS,
019 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
020 * See the License for the specific language governing permissions and
021 * limitations under the License.
022 * #L%
023 */
024public interface IOperation extends IBaseOn<IOperationUnnamed> {
025
026        /**
027         * This operation operates on a specific version of a resource
028         */
029        IOperationUnnamed onInstanceVersion(IIdType theId);
030
031        /**
032         * This operation is called <b><a href="https://www.hl7.org/fhir/messaging.html">$process-message</a></b> as defined by the FHIR
033         * specification.<br><br>
034         * Usage :<br>
035         * <code>
036         * <pre>
037         * Bundle response = client
038         * .operation()
039         * .processMessage()
040         * .synchronous(Bundle.class)
041         * .setResponseUrlParam("http://myserver/fhir")
042         * .setMessageBundle(msgBundle)
043         * .execute();
044         *
045         * //if you want to send an async message
046         *
047         * OperationOutcome response = client
048         * .operation()
049         * .processMessage()
050         * .asynchronous(OperationOutcome.class)
051         * .setResponseUrlParam("http://myserver/fhir")
052         * .setMessageBundle(msgBundle)
053         * .execute();
054         *
055         * </pre>
056         * </code>
057         *
058         * @return An interface that defines the operation related to sending
059         * Messages to a Messaging Server
060         * @see <a href="https://www.hl7.org/fhir/messaging.html">2.4 Messaging
061         * using FHIR Resources</a>
062         */
063        IOperationProcessMsg processMessage();
064
065}