Skip to main content

HS.FHIR.vDSTU2.REST.Handler

deprecated class HS.FHIR.vDSTU2.REST.Handler extends HS.FHIR.vCommon.RestHandlerBase

THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
FHIR REST Handler

Method Inventory

Parameters

parameter CONVERTINPUTSTREAM = 1;
Per the FHIR spec, "FHIR uses UTF-8 for all request and response bodies." (http://www.hl7.org/fhir/http.html#mime-type) Setting this parameter to 1 (the default in %CSP.Page is 0) will cause CSP to convert the request content to internal format before passing it to this handler (The equivalent of doing $ZCVT(val, "I", "UTF8") on the request content).
parameter DefaultContentType = application/xml+fhir;
DefaultContentType specifies the content type to use when no content type is specified in the incoming request. The FHIR spec at http://www.hl7.org/fhir/DSTU2/http.html#mime-type is not clear about defaulting, and defers to the spec for HTTP Content Negotiation and Server-driven Negotiation at http://www.w3.org/Protocols/rfc2616/rfc2616-sec12.html#sec12.
parameter HandleCorsRequest = 1;
This parameter influences the CORS support. The default is an empty string meaning 'not specified'. If set to true (1) then CORS processing is ON. If set to false (0) then CORS processing is OFF. If left unset "" then the decision to process CORS is delegated to the setting on the URL map route.
parameter IGNOREMISSINGCHARSETKEY = \FHIR\IgnoreMissingContentTypeCharset;
Per the FHIR spec, "requests and responses SHALL explicitly set the character encoding to UTF-8 using the charset parameter of the MIME-type in the Content-Type header" (http://www.hl7.org/fhir/http.html#mime-type). However what we have observed working with various FHIR clients is that clients sometimes include a Content-Type header in a request with no charset parameter. Setting the value of this key to 1 in the Configuration Registry in this namespace will cause a missing Content-Type charset to be ignored rather than rejected. A non-null charset that is not "utf8" or "utf-8" (case-insensitive) will still be rejected.

Methods

deprecated classmethod CompartmentSearch(pCompartment As %String, pId As %String, pType As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Compartment-based search and resource instance-level operation that uses the GET method both have variables as the first three items in the URL. The FHIR spec at http://hl7.org/fhir/operations.html says that FHIR operations may use GET as an alternative to POST. This means that the Url and Method combination for an resource instance-level operation can be the same as that for a compartment-based search. If the Type parameter starts with dollar sign ($) then that means that this interaction is an operation rather than a search.
deprecated classmethod ConditionalDelete(pType As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
The conditional delete interaction does not specify a resource id but rather will depend upon its search parameters to determine of the resource exists or not. Based on that, it deletes a an existing resource or returns an error.
deprecated classmethod ConditionalUpdate(pType As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
The conditional update interaction does not specify a resource id but rather will depend upon its search parameters to determine of the resource exists or not. Based on that, it creates a new current version for an existing resource or creates a new resource.
deprecated classmethod Conformance() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
The conformance interaction retrieves the server's conformance statement that defines how it supports resources
deprecated classmethod Create(pType As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
The create interaction creates a new resource in a server assigned location. If the client wishes to have control over the id of a newly submitted resource, it should use the update interaction instead. The Url and Method combination for a system-level operation is the same as that for create. If the Type parameter starts with dollar sign ($) then that means that this interaction is an operation rather than a create.
deprecated classmethod Delete(pType As %String, pId As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
The delete interaction removes an existing resource
deprecated classmethod Document() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod GetUserIDAndRoles(pJWTObj="", Output pUserID As %String, Output pUserRoles As %String)
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod History(pType As %String, pId As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
The history interaction retrieves the history of a particular resource
deprecated classmethod HistoryAll() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
The history interaction retrieves the history of all resources supported by the system
deprecated classmethod HistoryType(pType As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
The history interaction retrieves the history of all resources of a given type
deprecated classmethod Mailbox() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod OnHandleCorsRequest(pUrl As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
OnHandleCorsRequest overrides the same method from %CSP.REST. FHIR CSP config setting DisableCORS provides a way for an implementation to override the HandleCorRequest class parameter.
deprecated classmethod OnPreDispatch(pUrl As %String, pMethod As %String, ByRef pContinue As %Boolean) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
OnPreDispatch overrides the same method from %CSP.Request. If pContinue is set to 0, the request will NOT be dispatched according to the UrlMap. If this case it's the responsibility of the user to return a response.
deprecated classmethod OperationResourceInstance(pType As %String, pId As %String, pOperation As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
When operation is requested then the operation is the interaction.
deprecated classmethod OperationResourceType(pType As %String, pOperation As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
When operation is requested then the operation is the interaction.
deprecated classmethod OperationSystem(pOperation As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
When operation is requested then the operation is the interaction.
deprecated classmethod Read(pType As %String, pId As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Read a specific resource instance. The FHIR spec at http://hl7.org/fhir/operations.html says that FHIR operations may use GET as an alternative to POST. This means that the Url and Method combination for an resource type-level operation can be the same as that for a read. If the Id parameter starts with dollar sign ($) then that means that this interaction is an operation rather than a read
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
This interaction searches a set of resources based on some filter criteria. The FHIR spec at http://hl7.org/fhir/operations.html says that FHIR operations may use GET as an alternative to POST. This means that the Url and Method combination for a system-level operation can be the same as that for a type-level search. If the Type parameter starts with dollar sign ($) then that means that this interaction is an operation rather than a search.
deprecated classmethod SearchAll() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
This interaction searches a set of resources based on some filter criteria
deprecated classmethod SearchAllPost() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
This interaction searches a set of resources based on some filter criteria, using the request Content as the medium for the search parameters.
deprecated classmethod SearchPost(pType As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod Transaction() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
The transaction interaction submits a Bundle of resources to be updated, created or deleted on the server. This class sets the Interaction to "transaction". Processing downstream, presumably by a business process, will examine the Bundle type property to determine proper handling. Possible input Bundle types are: document, message, transaction, batch, and collection.
deprecated classmethod Update(pType As %String, pId As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
The update interaction creates a new current version for an existing resource or creates a new resource if no resource already exists for the given id
deprecated classmethod VRead(pType As %String, pId As %String, pVId As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
The vread interaction preforms a version specific read of the resource
deprecated classmethod Validate(pType As %String, pId As %String = "") as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
The validate interaction checks whether the attached content would be acceptable as an update to an existing resource
deprecated classmethod ValidateOAuthToken(pInteraction As %String, ByRef pOAuthSessionId As %String, ByRef pJWTString As %String, ByRef pJWTObj As %Library.DynamicObject) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod processRequest(pInteraction As %String, pType As %String = "", pId As %String = "", pVersion As %String = "", pCompartment As %String = "", pParamCount As %Integer = -1, pIsPOST As %Boolean = 0) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Process an inbound request. This hands off the incoming request to the business service.

Inherited Members

Inherited Methods

Subclasses

FeedbackOpens in a new tab