HS.HC.FHIRExplorer.API.REST.v1.impl
class HS.HC.FHIRExplorer.API.REST.v1.impl extends %REST.Impl
Business logic class defined by OpenAPI in HS.HC.FHIRExplorer.API.REST.v1.specUpdated Oct 20, 2026 11:45:52
Method Inventory
- BuildServerResponse()
- CreateTarget()
- Discover()
- GenerateTargetInstance()
- GetCapabilityStatement()
- GetTargets()
- ParseHeaders()
- Read()
- Search()
- TargetDelete()
- TargetGet()
- TargetPatch()
- TargetPut()
Parameters
parameter ExposeServerExceptions = 0;
If ExposeServerExceptions is true, then details of internal errors will be exposed.
Methods
classmethod BuildServerResponse(pResponse As HS.FHIRServer.API.Data.RestClient.Response) as %DynamicObject
Build a dynamic object with the status code, data, and headers from `pResponse`.
classmethod CreateTarget(RequestBody As %DynamicObject) as %DynamicObject
Create a `Target` resource for a valid FHIR server. (If the `url` doesn't return a valid capability statement, the resource won't get created and this endpoint will return a 400 Bad Request.)
The method arguments hold values for:
Request Body
The method arguments hold values for:
Request Body
classmethod Discover(targetID As %Integer) as %DynamicObject
Calls the `/metadata` endpoint of the FHIR server configured at `/target/{targetID}` and returns the response. (Ideally, this response is a capability statement.)
The method arguments hold values for:
targetID
The method arguments hold values for:
targetID
classmethod GenerateTargetInstance(targetID As %Integer, RequestBody As %DynamicObject) as HS.FHIRServer.RestClient.HTTP
Helper function that generates a FHIR RestClient instance from the target server `{targetID}`
along with both the authentication `{auth}` and strict handling preference `{strictHandling}`
provided in the `RequestBody`.
classmethod GetCapabilityStatement(target As HS.HC.FHIRExplorer.Data.Targets) as %DynamicObject
classmethod GetTargets() as %DynamicObject
Retrieve a list of all previously configured FHIR servers.
classmethod ParseHeaders(pResponse As HS.FHIRServer.API.Data.RestClient.Response) as %DynamicObject
Parse the headers from a FHIR server response into a %DynamicObject.
whose keys are header names and whose values are the corresponding header values.
whose keys are header names and whose values are the corresponding header values.
classmethod Read(targetID As %Integer, RequestBody As %DynamicObject) as %DynamicObject
Runs a FHIR read request against the target server `{targetID}` with the authentication configured in `{auth}` and returns the results. If `strictHandling` is true, a `Prefer: handling=strict` header is added to the request. Otherwise, a `Prefer: handling=lenient` header is added to the request.
The method arguments hold values for:
targetID
Request Body
The method arguments hold values for:
targetID
Request Body
classmethod Search(targetID As %Integer, RequestBody As %DynamicObject) as %DynamicObject
Runs a FHIR search request against the target server `{targetID}` with the authentication configured in `{auth}` and returns the results. If `strictHandling` is true, a `Prefer: handling=strict` header is added to the request. Otherwise, a `Prefer: handling=lenient` header is added to the request.
The method arguments hold values for:
targetID
Request Body
The method arguments hold values for:
targetID
Request Body
classmethod TargetDelete(targetID As %Integer) as %DynamicObject
Remove the server configuration of ID `{targetID}`.
The method arguments hold values for:
targetID
The method arguments hold values for:
targetID
classmethod TargetGet(targetID As %Integer) as %DynamicObject
Retrieve the server configuration of ID `{targetID}`.
The method arguments hold values for:
targetID
The method arguments hold values for:
targetID
classmethod TargetPatch(targetID As %Integer, RequestBody As %DynamicObject) as %DynamicObject
Patch the `target` resource with ID `{targetID}`. The `url` of a `target` resource cannot be changed. Attempting to change this will result in a 409 Conflict.
The method arguments hold values for:
targetID
Request Body
The method arguments hold values for:
targetID
Request Body
classmethod TargetPut(targetID As %Integer, RequestBody As %DynamicObject) as %DynamicObject
Update the `target` resource with ID `{targetID}`. The `url` of a `target` resource cannot be changed. Attempting to change this will result in a 409 Conflict.
The method arguments hold values for:
targetID
Request Body
The method arguments hold values for:
targetID
Request Body
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %CheckAccepts()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DeleteHeader()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetContentType()
- %GetHeader()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %ReportRESTError()
- %SerializeObject()
- %SetContentType()
- %SetCookieFromHeader()
- %SetHeader()
- %SetHeaderIfEmpty()
- %SetModified()
- %SetStatusCode()
- %ValidateObject()
- %WriteResponse()