Skip to main content

HS.FHIR.vDSTU2.Repository.Resource.Abstract

deprecated abstract persistent class HS.FHIR.vDSTU2.Repository.Resource.Abstract extends HS.FHIR.vCommon.ResourceBase

SQL Table Name: HS_FHIR_vDSTU2_Repository_Resource.Abstract

THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.

Method Inventory

Parameters

parameter BASERESOURCE = Resource;
The name of the table in the search package that will store the searchable values common to all resource types, which will be searched in a "search-all" interaction. Also, the name of the class in the storage package (HS.FHIR.vDSTU2.Repository.Resource) that contains the definitions of the search parameters common to all types in its SearchParams XData block.
parameter COUNTERGLOBAL;
parameter DATAGLOBAL;
parameter EXCLUDEPARAMS;
Comma-delimited list of search params that are defined in the FHIR standard (DSTU2), but that are not currently supported by HealthShare. The parameter value should start and end with commas. Note that all composite type params are currently not supported and do not need to be included here.
parameter INDEXGLOBAL;
Inherited description: The name of the Global used by the subclass (
parameter MODELPACKAGE = HS.FHIR.vDSTU2.Model;
parameter SEARCHTABLEPACKAGE = NSLocal.FHIR.Search.vDSTU2;
parameter STORAGEPKG = HS.FHIR.vDSTU2.Repository.Resource.;
The Package for the Resource Subclasses of this class
parameter STREAMGLOBAL;
parameter VERSIONKEY = DSTU2;
A key useable for disambiguating version-specific cached data

Methods

deprecated classmethod BuildCompartmentDef(pFHIRVersion As %String)
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Based on definitions as seen at:
  • http://hl7.org/fhir/DSTU2/compartmentdefinition.html
  • http://hl7.org/fhir/DSTU2/compartmentdefinition-patient.html
  • http://hl7.org/fhir/DSTU2/compartmentdefinition-encounter.html
  • http://hl7.org/fhir/DSTU2/compartmentdefinition-relatedperson.html
  • http://hl7.org/fhir/DSTU2/compartmentdefinition-practitioner.html
  • http://hl7.org/fhir/DSTU2/compartmentdefinition-device.html
  • deprecated classmethod CacheSearchParams(pType As %String, pCustomStoragePkg As %String) as %Status
    THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
    pType must be either null ("") or a valid resource type with a storage class that will be returned by a call to GetStorageClass().
    This method caches search parameters defined in the SearchParams XData of the HS.FHIR.vDSTU2.Repository.Resource.[type] class in %HSFHIRSearchParams, if not already cached, as well as the search params common to all resource types, which are defined in HS.FHIR.vDSTU2.Repository.Resource.Resource, if not already cached. If the input value is null or ..#BASERESOURCE ("Resource"), only the common search params will be cached. If the given type is already cached in %HSFHIRSearchParams, then this method is effectively a no-op.
    The format of %HSFHIRSearchParams is:
    %HSFHIRSearchParams(..#VERSIONKEY, resourceType,0) = resource type includes an XPath with complex predicate (0 or 1)
    An XPath is considered to have a "complex predicate" if either the predicate is not in the last piece of the XPath, or there are multiple predicates.
    %HSFHIRSearchParams(..#VERSIONKEY, resourceType,searchParam) = paramType^xpath^refType1~refType2~...~^custom
    %HSFHIRSearchParams(..#VERSIONKEY, "Patient","deceased") = "token^f:Patient/f:deceasedBoolean | f:Patient/f:deceasedDateTime^^1"
    %HSFHIRSearchParams(..#VERSIONKEY, "Patient","given") = "string~f:Patient/f:name/f:given~~0"
    %HSFHIRSearchParams(..#VERSIONKEY, "MedicationAdministration","effectivetime") = "date^f:MedicationAdministration/f:effectiveDateTime | f:MedicationAdministration/f:effectivePeriod^^0"
    %HSFHIRSearchParams(..#VERSIONKEY, "Appointment","practitioner") = "reference^f:Appointment/f:participant/f:actor^Practitioner^0"
    %HSFHIRSearchParams(..#VERSIONKEY, "Resource","_lastUpdated") = "date^f:Resource/f:meta/f:lastUpdated^^0"
    • resourceType: The type of resource being searched
    • searchParam: The name of the search param, as is appears in the spec (ie, not normalized via NormalizeParamName())
    • paramType: The type of the search param. Currently we support token, date, string, reference, quantity, number, and uri.
    • xpath: The xpath value the describes the location of the value to be indexed/searched. This value will be XML-unescaped from the original SearchParameter resource, in case the original value contains any XML escape sequences, like ' for example.
    • refType[x]: If paramType="reference", this field may be used to constrain the types of references that this search param indexes. For example, the Appointment practitioner search param searches the participant.actor property, but only references of type Practitioner. refTypes is "~"-delimited, and begins and ends with "~". A value of "*" may be used to indicate that this search param indexes and searches all reference types.
    • custom: If custom=1, then the search indices for this param are created by a method in the storage class for this type. The name of the method is the param name normalized via NormalizeParamName(), so the method for param onset-info is onsetInfo(), for example. This is needed when the indices for a certain search parameter are more complex than simply "the value at [xpath]". If custom=1, the other fields technically aren't needed, since the method should handle all the details of indexing, but can be included for reference.
    deprecated classmethod DeleteOrphanedResources() as %Status
    THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
    API In this context, "orphaned" means the resource references a non-existent session.
    There *should* never be orphaned resources. The deletion of the referenced session should trigger the delete of the resource. Still, this utility is provided in case something goes wrong and orphaned resources are left in the repository.
    deprecated classmethod DeleteSessionResources(pSession As %String) as %Status
    THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
    deprecated method IndexHumanName(pParamName As %String, pXPath As %String) as %Status
    THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
    deprecated classmethod ParamSearchesPeriod(pResourceType As %String, pParamName As %String) as %Boolean
    THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
    Returns true if the given search parameter on the given resource type searches of property of type Period, and false otherwise. pParamName must be the name of the search parameter as it appears in the parameter definition, *not* the param name normalized via NormalizeParamName(). ie, "date-recorded", not "dateRecorded". If a search parameter searches more than one property, this will return true if any of them is a Period. For example, the "date" parameter on Procedure searches two properties, performedDateTime and performedPeriod. performedPeriod is a Period, so this method returns true for that parameter.

    Indexes

    index (IDKEY on ) [IdKey, Type = key];
    Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

    Inherited Members

    Inherited Properties

    Inherited Methods

    Storage

    Gray indicates storage defined by superclasses.

    Storage Model: Storage (HS.FHIR.vDSTU2.Repository.Resource.Abstract)

    ^HS.FHIR.RepositorF719.AbstractD(ID)
    =
    %%CLASSNAME
    ResourceType
    ResourceId
    VersionId
    Deleted
    LastModified
    Format
    Verb
    Session
    Compartments
    ResourceStream
    ResourceSchema

    Storage Model: Storage (HS.FHIR.vDSTU2.Repository.Resource.Abstract)

    ^HS.FHIR.RepositorF719.AbstractD(ID,"Resource")
    =
    ResourceString

    Subclasses

    FeedbackOpens in a new tab