HS.FHIRServer.API.RestClient

abstract class HS.FHIRServer.API.RestClient extends %Library.RegisteredObject

This class is the API spec for a FHIR REST client object. API properties are those that have very little to no expectation to change during the life of an instance of this class. All interaction methods return an HS.FHIRServer.API.Data.RestClient.Response object.

Property Inventory

Method Inventory

Parameters

parameter FHIRMimeTypeJSON = application/fhir+json;
parameter FHIRMimeTypeXML = application/fhir+xml;
parameter MimeTypeForm = application/x-www-form-urlencoded;
parameter MimeTypeJPatch = application/json-patch+json;
parameter MimeTypeXPatch = application/xml-patch+xml;

Properties

property OAuthClientName as %String (MAXLEN = 128) [ Calculated ];
OAuth 2.0 client name. Used in conjunction with SessionId for retrieving an OAuth 2.0 access token to add to the request.
Property methods: OAuthClientNameDisplayToLogical(), OAuthClientNameIsValid(), OAuthClientNameLogicalToDisplay(), OAuthClientNameLogicalToOdbc(), OAuthClientNameNormalize()
property OAuthToken as %String) [ Calculated ];
OAuth 2.0 access token, provided directly as opposed to retrieving via SessionId+OAuthClientName. If OAuthToken is specified then OAuthClientName must also be specified.
Property methods: OAuthTokenDisplayToLogical(), OAuthTokenIsValid(), OAuthTokenLogicalToDisplay(), OAuthTokenLogicalToOdbc(), OAuthTokenNormalize()
property Prefer as %String (MAXLEN = 128) [ Calculated ];
Prefer header value to apply to requests.
Property methods: PreferDisplayToLogical(), PreferIsValid(), PreferLogicalToDisplay(), PreferLogicalToOdbc(), PreferNormalize()
property RequestFormat as %String (MAXLEN = 255) [ Calculated ];
Indicator for the format of request payloads.
Property methods: RequestFormatDisplayToLogical(), RequestFormatIsValid(), RequestFormatLogicalToDisplay(), RequestFormatLogicalToOdbc(), RequestFormatNormalize()
property ResponseFormat as %String (MAXLEN = 255) [ Calculated ];
Indicator for the format of response payloads.
Property methods: ResponseFormatDisplayToLogical(), ResponseFormatIsValid(), ResponseFormatLogicalToDisplay(), ResponseFormatLogicalToOdbc(), ResponseFormatNormalize()
property ServiceName as %String [ Calculated ];
Name of service (e.g., HTTP service, FHIRServer service) to which to send requests.
Property methods: ServiceNameDisplayToLogical(), ServiceNameIsValid(), ServiceNameLogicalToDisplay(), ServiceNameLogicalToOdbc(), ServiceNameNormalize()
property SessionId as %String (MAXLEN = 2048) [ Calculated ];
Session id, typically a CSP session id. Used in conjunction with OAuthClientName for retrieving an established OAuth 2.0 access token to add to the request.
Property methods: SessionIdDisplayToLogical(), SessionIdIsValid(), SessionIdLogicalToDisplay(), SessionIdLogicalToOdbc(), SessionIdNormalize()

Methods

abstract method Batch(pResource, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR batch / transaction interaction request.
@Input pResource (required) FHIR resource content. Supported type(s) of this input is implementation-specific.
@Input pQueryString Query string for the common query parameters _format, _pretty, _summary, _elements.
FHIR specification: http://hl7.org/fhir/http.html#transaction, http://hl7.org/fhir/bundle.html#transaction
abstract method ConditionalCreate(pResourceType As %String, pResource, pIfNoneExist As %String, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR conditional create (create request with If-None-Exist value included) interaction request.
@Input pResourceType (required) FHIR resource type.
@Input pResource (required) FHIR resource content. Supported type(s) of this input is implementation-specific.
@Input pIfNoneExist (required) Search parameters in URL query string format.
@Input pQueryString Query string for the common query parameters _format, _pretty, _summary, _elements.
FHIR specification: http://hl7.org/fhir/http.html#ccreate
abstract method ConditionalDelete(pResourceType As %String, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR conditional delete (delete request with search parameters included) interaction request.
@Input pResourceType (required) FHIR resource type.
@Input pQueryString (required) Query parameters string, for required search parameters, and for the common query parameters _format, _pretty, _summary, _elements.
FHIR specification: http://hl7.org/fhir/http.html#delete
abstract method ConditionalPatch(pResourceType As %String, pPatchStream As %Stream.Object, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR conditional patch (patch request with search query parameters included) interaction request.
@Input pResourceType (required) FHIR resource type.
@Input pPatchStream (required) Stream of XML Patch or JSON Patch or FHIRPath Patch operations.
@Input pQueryString (required) Query parameters string, for specifying required search parameters and/or the common query parameters _format, _pretty, _summary, _elements.
FHIR specification: http://hl7.org/fhir/http.html#patch
abstract method ConditionalRead(pRequestMethod As %String, pResourceType As %String, pResourceId As %String, pIfNoneMatch As %String, pIfModifiedSince As %String, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR conditional read interaction request.
@Input pRequestMethod (required) HTTP verb, must be "HEAD" or "GET".
@Input pResourceType (required) FHIR resource type.
@Input pResourceId (required) FHIR resource id.
@Input pIfNoneMatch (required if pIfModifiedSince not specified) Search parameters in URL query string format.
@Input pIfModifiedSince (required if pIfNoneMatch not specified) DateTime value.
@Input pQueryString Query string for the common query parameters _format, _pretty, _summary, _elements.
FHIR specification: http://hl7.org/fhir/http.html#cread
abstract method ConditionalUpdate(pResourceType As %String, pResource, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR conditional update (update request with search parameters included) interaction request.
@Input pResourceType (required) FHIR resource type.
@Input pResource (required) FHIR resource content. Supported type(s) of this input is implementation-specific.
@Input pQueryString (required) Query parameters string, for conditional update search parameters and the common query parameters _format, _pretty, _summary, _elements.
FHIR specification: http://hl7.org/fhir/http.html#cond-update
abstract method Create(pResourceType As %String, pResource, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR create interaction request.
@Input pResourceType (required) FHIR resource type.
@Input pResource (required) FHIR resource content. Supported type(s) of this input is implementation-specific.
@Input pQueryString Query string for the common query parameters _format, _pretty, _summary, _elements.
FHIR specification: http://hl7.org/fhir/http.html#create
abstract method Delete(pResourceType As %String, pResourceId As %String, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR delete interaction request.
@Input pResourceType (required) FHIR resource type.
@Input pResourceId (required) FHIR resource id.
@Input pQueryString Query string for the common query parameters _format, _pretty, _summary, _elements.
FHIR specification: http://hl7.org/fhir/http.html#delete
abstract method History(pRequestMethod As %String, pResourceType As %String, pResourceId As %String, pSince As %String, pAt As %String, pList As %String, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR history interaction request.
@Input pRequestMethod (required) HTTP verb, must be "HEAD" or "GET".
@Input pResourceType FHIR resource type.
@Input pResourceId FHIR resource id.
@Input pSince The instant value for the _since URL parameter. @Input pAt The date-time value for the _at URL parameter. @Input pList The value for the _list URL parameter. @Input pQueryString Query parameters string, for specifying non-history-specific parameters like _summary, _elements, _count, _format, etc. parameters.
FHIR specification: http://hl7.org/fhir/http.html#history
abstract method Metadata(pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR capabilities (aka metdata) interaction request.
@Input pQueryString Query parameters string, for specifying mode, _format, _summary, _elements, etc.
FHIR specification: http://hl7.org/fhir/http.html#capabilities.
abstract method Operation(pRequestMethod As %String, pOperationName As %String, pResourceType As %String, pResourceId As %String, pResource, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR operation interaction request.
@Input pRequestMethod (required) HTTP verb, can be "HEAD" or "GET" or "POST", depending on the operation.
@Input pOperationName (required) Operation name.
@Input pResourceType FHIR resource type.
@Input pResourceId FHIR resource id.
@Input pResource FHIR resource content. Supported type(s) of this input is implementation-specific.
@Input pQueryString Query parameters string.
FHIR specification: http://hl7.org/fhir/operations.html
abstract method Patch(pResourceType As %String, pResourceId As %String, pPatchStream As %Stream.Object, pIfMatch As %String, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR patch interaction request.
@Input pResourceType (required) FHIR resource type.
@Input pResourceId (required) FHIR resource id.
@Input pPatchStream (required) Stream of XML Patch or JSON Patch or FHIRPath Patch operations.
@Input pIfMatch ETag-style value, for example W/"23".
@Input pQueryString Query string for the common query parameters _format, _pretty, _summary, _elements.
FHIR specification: http://hl7.org/fhir/http.html#patch, http://hl7.org/fhir/http.html#concurrency
abstract method Read(pRequestMethod As %String, pResourceType As %String, pResourceId As %String, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR read interaction request.
@Input pRequestMethod (required) HTTP verb, must be "HEAD" or "GET".
@Input pResourceType (required) FHIR resource type.
@Input pResourceId (required) FHIR resource id.
@Input pQueryString Query string for the common query parameters _format, _pretty, _summary, _elements.
FHIR specification: http://hl7.org/fhir/http.html#read
@API
Handle a FHIR search interaction request.
@Input pRequestMethod (required) HTTP verb, must be "HEAD" or "GET" or "POST".
@Input pResourceType FHIR resource type.
@Input pCompartment Compartment name for compartment-based search.
@Input pResourceId FHIR resource id.
@Input pQueryString Query parameters string.
FHIR specification: http://hl7.org/fhir/http.html#search, http://hl7.org/fhir/search.html
abstract method Update(pResourceType As %String, pResourceId As %String, pResource, pIfMatch As %String, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR update interaction request.
@Input pResourceType (required) FHIR resource type.
@Input pResourceId (required) FHIR resource id.
@Input pResource (required) FHIR resource content. Supported type(s) of this input is implementation-specific.
@Input pIfMatch ETag-style value, for example W/"23".
@Input pQueryString Query string for the common query parameters _format, _pretty, _summary, _elements.
FHIR specification: http://hl7.org/fhir/http.html#update, http://hl7.org/fhir/http.html#concurrency
abstract method VRead(pRequestMethod As %String, pResourceType As %String, pResourceId As %String, pResourceVId As %String, pQueryString As %String) as HS.FHIRServer.API.Data.RestClient.Response [ Language = objectscript ]
@API
Handle a FHIR vread (read request with a resource version id included) interaction request.
@Input pRequestMethod (required) HTTP verb, must be "HEAD" or "GET".
@Input pResourceType (required) FHIR resource type.
@Input pResourceId (required) FHIR resource id.
@Input pResourceVId (required) FHIR resource version id.
@Input pQueryString Query string for the common query parameters _format, _pretty, _summary, _elements.
FHIR specification: http://hl7.org/fhir/http.html#vread

Inherited Members

Inherited Methods

Subclasses

Feedback