HS.FHIRServer.Storage.BuiltIn.ListCommon
class HS.FHIRServer.Storage.BuiltIn.ListCommon extends HS.FHIRServer.Storage.BuiltIn.Common
Common methods for HS.FHIRServer.Storage.BuiltIn.Find and HS.FHIRServer.Storage.BuiltIn.UpdateFunctional.Method Inventory
Methods
classmethod FindListResource(pService As HS.FHIRServer.API.Service, pPatient As %String, pListName As %String, pListConfig As %DynamicObject) as %DynamicObject
@API
Return one FHIR List resource object, or empty string, based on the $find inputs.
@Argument pService Instance of FHIRServer Service class.
@Argument pPatient Represents the $find "patient" input parameter, which a resource id (e.g., "123").
@Argument pListName Represents the $find "name" input parameter (e.g., "$current-problems").
@Argument pListConfig %DynamicObject representation of Functional List Configuration for pListName.
@Return FHIR resource as %DynamicObject.
Return one FHIR List resource object, or empty string, based on the $find inputs.
@Argument pService Instance of FHIRServer Service class.
@Argument pPatient Represents the $find "patient" input parameter, which a resource id (e.g., "123").
@Argument pListName Represents the $find "name" input parameter (e.g., "$current-problems").
@Argument pListConfig %DynamicObject representation of Functional List Configuration for pListName.
@Return FHIR resource as %DynamicObject.
classmethod GetListConfig(pListName As %String, pOperationName As %String, pStrategy As HS.FHIRServer.API.InteractionsStrategy) as %DynamicObject
@API
Get the Functional List configuration for the specified list name. This method Throws upon validation error.
@Argument pListName Functional list name (e.g., "$current-problems").
@Argument pOperationName Name of operation currently being processed (e.g., "$find").
@Argument pStrategy Instance of FHIRServer Interactions Strategy class.
@Return %DynamicObject of the configuration. Example:
Get the Functional List configuration for the specified list name. This method Throws upon validation error.
@Argument pListName Functional list name (e.g., "$current-problems").
@Argument pOperationName Name of operation currently being processed (e.g., "$find").
@Argument pStrategy Instance of FHIRServer Interactions Strategy class.
@Return %DynamicObject of the configuration. Example:
{
"$current-problems":{
"list_name":"$current-problems",
"subject_search_param":"patient",
"subject_resource_Type":"Patient"
}
}
classmethod GetListConfigs(pStrategy As HS.FHIRServer.API.InteractionsStrategy) as %DynamicObject
@API
Get the Functional List configurations from their present storage, validate them, and return them as %DynamicObject. This method Throws upon validation error.
@Argument pStrategy Instance of FHIRServer Interactions Strategy class.
@Return %DynamicObject of the configurations. Example:
Get the Functional List configurations from their present storage, validate them, and return them as %DynamicObject. This method Throws upon validation error.
@Argument pStrategy Instance of FHIRServer Interactions Strategy class.
@Return %DynamicObject of the configurations. Example:
{
"$current-problems":{
"list_name":"$current-problems",
"subject_search_param":"patient",
"subject_resource_Type":"Patient"
}
"$current-medications":{
"list_name":"$current-medications",
"subject_search_param":"patient",
"subject_resource_Type":"Patient"
}
}
classmethod ValidateListConfig(pSchema As HS.FHIRMeta.API, pName As %String, pSubjectParam As %String, pSubjectRsrcType As %String, pSC As %Status = $$$OK)
@API
Validate the values from a single Functional List Configuration. This method gathers validation errors into the ByRef pSC status parameter.
@Argument pSchema FHIRMeta API object for an FHIR server's FHIR schema.
@Argument pName Configuration name.
@Argument pSubjectParam FHIR List search parameter to use for determining Functional List subject.
@Argument pSubjectRsrcType FHIR resource type of the subject for this Functional List.
@ByRef pSC %Status object for gathering validation failures.
Validate the values from a single Functional List Configuration. This method gathers validation errors into the ByRef pSC status parameter.
@Argument pSchema FHIRMeta API object for an FHIR server's FHIR schema.
@Argument pName Configuration name.
@Argument pSubjectParam FHIR List search parameter to use for determining Functional List subject.
@Argument pSubjectRsrcType FHIR resource type of the subject for this Functional List.
@ByRef pSC %Status object for gathering validation failures.