HS.FHIR.vCommon.ResourceBase
deprecated abstract class HS.FHIR.vCommon.ResourceBase
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.Property Inventory
- CommonSearchTableEntry
- Compartments
- Deleted
- Format
- LastModified
- Resource
- ResourceId
- ResourceObject
- ResourceSchema
- ResourceStream
- ResourceString
- ResourceType
- SearchTableEntry
- Session
- Verb
- VersionId
- XPathDoc
Method Inventory
- AddToSearchTableEntry()
- BuildCompartmentDef()
- CacheSearchParams()
- Collate()
- CollateSession()
- CurrentVersion()
- DecrementDateTime()
- DeleteOrphanedResources()
- DeprecateResource()
- EvalXPathPredicate()
- EvaluatePointer()
- EvaluateXPath()
- EvaluateXPathDynObjPredicate()
- EvaluateXPathDynamicObj()
- FirstInstant()
- FixLastModified()
- GenerateResourceId()
- GetCompartmentSearchParam()
- GetExtensionIndexProp()
- GetFHIRClass()
- GetRefTypeIdsFromSearchParam()
- GetResourceAsStream()
- GetSearchParamType()
- GetStorageClass()
- GetStorageClassFromLogicalId()
- IncrementDateTime()
- IndexAddress()
- IndexCodeableConcept()
- IndexCoding()
- IndexContactPoint()
- IndexDate()
- IndexDateAsPeriod()
- IndexHumanName()
- IndexIdentifier()
- IndexNumber()
- IndexPeriod()
- IndexQuantity()
- IndexReference()
- IndexScalar()
- IndexValues()
- IsCompartment()
- IsStringOrCode()
- KillAllData()
- LastInstant()
- LoadResource()
- NormalizeAccents()
- NormalizeParamName()
- NormalizePhone()
- OnAfterSave()
- OnBeforeMatch()
- OnValidate()
- ParamSearchesPeriod()
- PreviousInstant()
- RebuildClassIndices()
- RebuildSearchIndices()
- RefMatchesSearchParam()
- ResourceExists()
- ResourceIsDeleted()
- ResourceToLogicalId()
- SaveResource()
- SearchCompartment()
- SearchDate()
- SearchNumber()
- SearchQuantity()
- SearchReference()
- SearchString()
- SearchToken()
- SearchURI()
- SetResourceId()
- UpdateMeta()
- ValidateDate()
- VersionExists()
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 COLLATION = 7;
Collation type to use
Corresponds to arguments to $system.Util.Collation()
7 is SQLUPPER
Corresponds to arguments to $system.Util.Collation()
7 is SQLUPPER
parameter COUNTERGLOBAL;
parameter DATAGLOBAL;
parameter DEFAULTCHARSACCENTED = ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖØÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöøùúûüýÿ;
parameter DEFAULTCHARSUNACCENTED = AAAAAACEEEEIIIINOOOOOOUUUUYaaaaaaceeeeiiiinoooooouuuuyy;
parameter EXCLUDEPARAMS;
Comma-delimited list of search params that are defined in the FHIR
standard, but that are not currently supported by HealthShare. Each
subclass will define its list.
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 HSDEPLOY = 1;
parameter INDEXGLOBAL;
The name of the Global used by the subclass (
parameter MAXSEARCHINDEXLEN = 220;
The max length value that can be indexed for search. The indices for values
longer than this will be truncated. The actual resource data will not be
affected though.
parameter MODELPACKAGE;
parameter PERIODENDSUFFIX = End;
parameter PERIODSTARTSUFFIX = Start;
parameter SEARCHTABLEPACKAGE;
parameter STORAGEPKG;
parameter STREAMGLOBAL;
parameter VERSIONKEY;
A key useable for disambiguating version-specific cached data
parameter XMLIGNOREINVALIDTAG = 1;
parameter XMLIGNORENULL = inputonly;
Properties
property CommonSearchTableEntry as %Persistent [ Transient ];
Property methods: CommonSearchTableEntryGet(), CommonSearchTableEntryGetObject(), CommonSearchTableEntryGetObjectId(), CommonSearchTableEntryGetSwizzled(), CommonSearchTableEntryIsValid(), CommonSearchTableEntryNewObject(), CommonSearchTableEntrySet(), CommonSearchTableEntrySetObject(), CommonSearchTableEntrySetObjectId(), CommonSearchTableEntryUnSwizzle()
property Compartments as list of %String;
Property methods: CompartmentsBuildValueArray(), CompartmentsCollectionToDisplay(), CompartmentsCollectionToOdbc(), CompartmentsDisplayToCollection(), CompartmentsDisplayToLogical(), CompartmentsGet(), CompartmentsGetObject(), CompartmentsGetObjectId(), CompartmentsGetSwizzled(), CompartmentsIsValid(), CompartmentsLogicalToDisplay(), CompartmentsLogicalToOdbc(), CompartmentsNormalize(), CompartmentsOdbcToCollection(), CompartmentsSet(), CompartmentsSetObject(), CompartmentsSetObjectId()
property Deleted as %Boolean [ InitialExpression = 0 ];
Property methods: DeletedDisplayToLogical(), DeletedGet(), DeletedIsValid(), DeletedLogicalToDisplay(), DeletedNormalize(), DeletedSet()
property Format as %String (VALUELIST = ",XML,JSON");
Property methods: FormatDisplayToLogical(), FormatGet(), FormatIsValid(), FormatLogicalToDisplay(), FormatLogicalToOdbc(), FormatNormalize(), FormatSet()
property LastModified as %String;
The time that this version of the resource was saved, in UTC.
ie, YYYY-MM-DDThh:mm:ssZ. This gets set in SaveStreamlet().
No other code should set it.
Property methods: LastModifiedDisplayToLogical(), LastModifiedGet(), LastModifiedIsValid(), LastModifiedLogicalToDisplay(), LastModifiedLogicalToOdbc(), LastModifiedNormalize(), LastModifiedSet()
property Resource as %RegisteredObject [ Transient ];
Property methods: ResourceGet(), ResourceGetSwizzled(), ResourceIsValid(), ResourceNewObject(), ResourceSet()
property ResourceId as %String (MAXLEN = 64);
Property methods: ResourceIdDisplayToLogical(), ResourceIdGet(), ResourceIdIsValid(), ResourceIdLogicalToDisplay(), ResourceIdLogicalToOdbc(), ResourceIdNormalize(), ResourceIdSet()
property ResourceObject as %RegisteredObject [ Transient ];
Property methods: ResourceObjectGet(), ResourceObjectGetSwizzled(), ResourceObjectIsValid(), ResourceObjectNewObject(), ResourceObjectSet()
property ResourceSchema as %String;
Property methods: ResourceSchemaDisplayToLogical(), ResourceSchemaGet(), ResourceSchemaIsValid(), ResourceSchemaLogicalToDisplay(), ResourceSchemaLogicalToOdbc(), ResourceSchemaNormalize(), ResourceSchemaSet()
property ResourceStream as %Stream.GlobalCharacter;
Property methods: ResourceStreamDelete(), ResourceStreamGet(), ResourceStreamGetObject(), ResourceStreamGetObjectId(), ResourceStreamGetSwizzled(), ResourceStreamIsValid(), ResourceStreamNewObject(), ResourceStreamOid(), ResourceStreamOpen(), ResourceStreamSet(), ResourceStreamSetObject(), ResourceStreamSetObjectId(), ResourceStreamUnSwizzle()
property ResourceString as %String);
Property methods: ResourceStringDisplayToLogical(), ResourceStringGet(), ResourceStringIsValid(), ResourceStringLogicalToDisplay(), ResourceStringLogicalToOdbc(), ResourceStringNormalize(), ResourceStringSet()
property ResourceType as %String;
Property methods: ResourceTypeDisplayToLogical(), ResourceTypeGet(), ResourceTypeIsValid(), ResourceTypeLogicalToDisplay(), ResourceTypeLogicalToOdbc(), ResourceTypeNormalize(), ResourceTypeSet()
property SearchTableEntry as %Persistent [ Transient ];
Property methods: SearchTableEntryGet(), SearchTableEntryGetObject(), SearchTableEntryGetObjectId(), SearchTableEntryGetSwizzled(), SearchTableEntryIsValid(), SearchTableEntryNewObject(), SearchTableEntrySet(), SearchTableEntrySetObject(), SearchTableEntrySetObjectId(), SearchTableEntryUnSwizzle()
property Session as %String (COLLATION = "EXACT", MAXLEN = 256);
Property methods: SessionDisplayToLogical(), SessionGet(), SessionIsValid(), SessionLogicalToDisplay(), SessionLogicalToOdbc(), SessionNormalize(), SessionSet()
property Verb as %String (VALUELIST = ",POST,PUT,DELETE");
The HTTP verb used in the interaction that created this version of this resource.
Needed because the history interaction requires this to be known, and because the
first version of a resource can be created with either a POST/create or PUT/update,
with no other indication which verb was used.
Property methods: VerbDisplayToLogical(), VerbGet(), VerbIsValid(), VerbLogicalToDisplay(), VerbLogicalToOdbc(), VerbNormalize(), VerbSet()
property VersionId as %Integer;
Property methods: VersionIdDisplayToLogical(), VersionIdGet(), VersionIdIsValid(), VersionIdLogicalToDisplay(), VersionIdNormalize(), VersionIdSet()
property XPathDoc as %XML.XPATH.Document [ Transient ];
Property methods: XPathDocGet(), XPathDocGetSwizzled(), XPathDocIsValid(), XPathDocNewObject(), XPathDocSet()
Methods
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated abstract classmethod BuildCompartmentDef(pFHIRVersion As %String)
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated abstract classmethod CacheSearchParams(pType As %String, pCustomStoragePkg As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod CurrentVersion(pSession As %String, pType As %String, pResourceId As %String) as %String
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Returns the current (most recent) version ID of the resource with the given type and ID in the given session, or "" if there is no such resource.
Returns the current (most recent) version ID of the resource with the given type and ID in the given session, or "" if there is no such resource.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Must be overridden by the subclass 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. Given a date or date-time, decrement it by one of whatever the precision is. For example, "1932" returns "1931". "1985-01" returns "1984-12". "2000-05-25T15:45Z" returns "2000-05-25T15:44Z". Valid input formats are:
YYYY
YYYY-MM
YYYY-MM-DD
YYYY-MM-DDThh:mmZ
YYYY-MM-DDThh:mm:ssZ
pDateTime is assumed to be valid and in UTC when applicable. ie, should have already had ValidateDate() called on it.
Must be overridden by the subclass 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. Given a date or date-time, decrement it by one of whatever the precision is. For example, "1932" returns "1931". "1985-01" returns "1984-12". "2000-05-25T15:45Z" returns "2000-05-25T15:44Z". Valid input formats are:
YYYY
YYYY-MM
YYYY-MM-DD
YYYY-MM-DDThh:mmZ
YYYY-MM-DDThh:mm:ssZ
pDateTime is assumed to be valid and in UTC when applicable. ie, should have already had ValidateDate() called on it.
deprecated abstract classmethod DeleteOrphanedResources() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod DeprecateResource(pSession As %String, pType As %String, pResourceId As %String) as %Status
A resource gets deprecated when a newer version is received to replace it.
To deprecate an exising streamlet remove the entries in the search
tables corresponding to this resource. There will be two, one in the table
corresponding to the type of the resource, and one in the "common" table.
Also clear the Compartments property linking the resource to one or more
compartments and remove any indices on it.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod EvaluatePointer(pObj As %RegisteredObject, pPointer As %String = "", ByRef pVal As %RegisteredObject = "") as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod EvaluateXPath(pObj As %RegisteredObject, pXPath As %String, ByRef pVal As %RegisteredObject = "") 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.
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 EvaluateXPathDynObjPredicate(pOrigData As %Library.DynamicObject, pData As %Library.DynamicObject, pCurrentProp As %String, pPredicate As %String) as %Boolean
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod EvaluateXPathDynamicObj(pData As %Library.DynamicObject, pXPath As %String, ByRef pResults As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Given a date and optionally time in one of the formats:
YYYY
YYYY-MM
YYYY-MM-DD
YYYY-MM-DDThh:mmZ
YYYY-MM-DDThh:mm:ssZ
This method will return the first instant (second) that falls within that date/time.
For example, an input value of "1974" would return "1974-01-01T00:00:00Z". A date/time
that already has second precision will be returned unchanged.
The argument must be in one of the above formats. This method will not validate it.
Given a date and optionally time in one of the formats:
YYYY
YYYY-MM
YYYY-MM-DD
YYYY-MM-DDThh:mmZ
YYYY-MM-DDThh:mm:ssZ
This method will return the first instant (second) that falls within that date/time.
For example, an input value of "1974" would return "1974-01-01T00:00:00Z". A date/time
that already has second precision will be returned unchanged.
The argument must be in one of the above formats. This method will not validate it.
deprecated classmethod FixLastModified() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
API If the resource repository was populated with data on a pre-15.03 version and upgraded to version 15.03 or later, this method must be called manually to fix the format of the LastModified value on resources. While the value of LastModified has always been UTC time, it was not always formatted as such ("YYYY-MM-DD hh:mm:ss" versus "YYYY-MM-DDThh:mm:ssZ"). This method will iterate over every resource in the repository and update and LastModified values stored in the old format.
API If the resource repository was populated with data on a pre-15.03 version and upgraded to version 15.03 or later, this method must be called manually to fix the format of the LastModified value on resources. While the value of LastModified has always been UTC time, it was not always formatted as such ("YYYY-MM-DD hh:mm:ss" versus "YYYY-MM-DDThh:mm:ssZ"). This method will iterate over every resource in the repository and update and LastModified values stored in the old format.
deprecated classmethod GenerateResourceId(pResourceType As %String, pSession As %String = "") as %String
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
GenerateResourceId returns a resource id to use for the specified resource type.
GenerateResourceId returns a resource id to use for the specified resource type.
deprecated classmethod GetCompartmentSearchParam(pCompartment As %String, pResourceType As %String, ByRef pSearchParam As %String, pForceRebuild As %Boolean = 0) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
pCompartment must be either Patient, Encounter, RelatedPerson, Practitioner, or Device. If pCompartment is not one of these values, an error will be returned. pResourceType must be the name of a resource in the given compartment. If the named resource is not in the given compartment, an error will be returned. pSearchParam could either be a single value or a comma-delimited list of values.
pCompartment must be either Patient, Encounter, RelatedPerson, Practitioner, or Device. If pCompartment is not one of these values, an error will be returned. pResourceType must be the name of a resource in the given compartment. If the named resource is not in the given compartment, an error will be returned. pSearchParam could either be a single value or a comma-delimited list of values.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Typically we index the "value" property of a searchable property, however extensions must be handled differently because they have no "value" property, but rather "valueBoolean", "valueInteger", etc. We can look at the URL of the extension to know which to use.
Typically we index the "value" property of a searchable property, however extensions must be handled differently because they have no "value" property, but rather "valueBoolean", "valueInteger", etc. We can look at the URL of the extension to know which to use.
deprecated method GetFHIRClass()
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod GetRefTypeIdsFromSearchParam(pParamName As %String, pParamVals, pSearchResourceType As %String, pReferenceResourceType As %String, ByRef pReturnVals As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
For the specified search parameter name and value(s), if the search parameter is a reference type parameter, gather search parameter id values that unambiguously apply to the specified reference resource type. Return an error if the search parameter is invalid. Return an error if the search parameter value specifies a reference resource type that does not apply to the search parameter.
For the specified search parameter name and value(s), if the search parameter is a reference type parameter, gather search parameter id values that unambiguously apply to the specified reference resource type. Return an error if the search parameter is invalid. Return an error if the search parameter value specifies a reference resource type that does not apply to the search parameter.
deprecated method GetResourceAsStream(ByRef pResourceStream As %Stream.Object)
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
GetResourceAsStream gets the current serialized resource content for the current resource repository object and returns it in a stream object. The resource content may be currently held in either the ResourceString or ResourceStream property.
GetResourceAsStream gets the current serialized resource content for the current resource repository object and returns it in a stream object. The resource content may be currently held in either the ResourceString or ResourceStream property.
deprecated classmethod GetSearchParamType(pResourceType As %String, pParamName As %String, ByRef pPropType As %String) as %String
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Given a resource type and the name of a search parameter, return the type of that parameter (token, string, reference, date, uri, quantity, number, etc.). This will return null if pResourceType is valid but pParamName is not recognized.
Given a resource type and the name of a search parameter, return the type of that parameter (token, string, reference, date, uri, quantity, number, etc.). This will return null if pResourceType is valid but pParamName is not recognized.
deprecated classmethod GetStorageClass(pType As %String, ByRef pSC As %Status, pCustomStoragePkg As %String) as %String
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
GetStorageClass returns the name of the individual resource type storage class that holds the resource type-specific search parameter definitions and resource type-specific indexing logic. The default package of storage classes that ship with the product is specified by STORAGEPKG. A custom storage package to be used instead of STORAGEPKG may be specified by passing in a value for the pCustomStoragePkg input parameter.
GetStorageClass returns the name of the individual resource type storage class that holds the resource type-specific search parameter definitions and resource type-specific indexing logic. The default package of storage classes that ship with the product is specified by STORAGEPKG. A custom storage package to be used instead of STORAGEPKG may be specified by passing in a value for the pCustomStoragePkg input parameter.
deprecated classmethod GetStorageClassFromLogicalId(pLogicalId) as %String
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Given a date or date-time, increment it by one of whatever the precision is. For example, "1932" returns "1933". "1985-12" returns "1986-01". "2000-05-25T15:45Z" returns "2000-05-25T15:46Z". Valid input formats are:
YYYY
YYYY-MM
YYYY-MM-DD
YYYY-MM-DDThh:mmZ
YYYY-MM-DDThh:mm:ssZ
pDateTime is assumed to be valid and in UTC when applicable. ie, should have already had ValidateDate() called on it.
Given a date or date-time, increment it by one of whatever the precision is. For example, "1932" returns "1933". "1985-12" returns "1986-01". "2000-05-25T15:45Z" returns "2000-05-25T15:46Z". Valid input formats are:
YYYY
YYYY-MM
YYYY-MM-DD
YYYY-MM-DDThh:mmZ
YYYY-MM-DDThh:mm:ssZ
pDateTime is assumed to be valid and in UTC when applicable. ie, should have already had ValidateDate() called on it.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
This method differs from DSTU2 to STU3, it must be overridden in the subclass
This method differs from DSTU2 to STU3, it must be overridden in the subclass
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated method IndexValues() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod IsCompartment(pRefType As %String, pResourceType As %String, pSearchParam As %String, pForceRebuild As %Boolean = 0) as %Boolean
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
KillAllData finds all FHIR repository data that is used by the current sub-class of this class and kills it.
KillAllData finds all FHIR repository data that is used by the current sub-class of this class and kills it.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Given a date and optionally time in one of the formats:
YYYY
YYYY-MM
YYYY-MM-DD
YYYY-MM-DDThh:mmZ
YYYY-MM-DDThh:mm:ssZ
This method will return the last instant (second) that falls within that date/time.
For example, an input value of "1974" would return "1974-12-31T23:59:59Z". A date/time
that already has second precision will be returned unchanged.
The argument must be in one of the above formats. This method will not validate it.
Given a date and optionally time in one of the formats:
YYYY
YYYY-MM
YYYY-MM-DD
YYYY-MM-DDThh:mmZ
YYYY-MM-DDThh:mm:ssZ
This method will return the last instant (second) that falls within that date/time.
For example, an input value of "1974" would return "1974-12-31T23:59:59Z". A date/time
that already has second precision will be returned unchanged.
The argument must be in one of the above formats. This method will not validate it.
deprecated method LoadResource() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
LoadResource takes the ResourceString or ResourceStream property - whichever holds the serialized resource - from this FHIR resource repository object instance, de-serializes it into an HS FHIR data model object, and places it into the Resource property.
LoadResource takes the ResourceString or ResourceStream property - whichever holds the serialized resource - from this FHIR resource repository object instance, de-serializes it into an HS FHIR data model object, and places it into the Resource property.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
For every instance of "-" in the given string, convert the following character to uppercase, then strip out the "-". Ex: "address-city" becomes "addressCity".
For every instance of "-" in the given string, convert the following character to uppercase, then strip out the "-". Ex: "address-city" becomes "addressCity".
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Normalize a phone number for indexing and search by stripping out punctuation and whitespace
Normalize a phone number for indexing and search by stripping out punctuation and whitespace
deprecated method OnAfterSave() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Streamlet class can implement this callback to perform some action after the streamlet has been saved. Note that this can't change the streamlet at all as it's already been saved.
Streamlet class can implement this callback to perform some action after the streamlet has been saved. Note that this can't change the streamlet at all as it's already been saved.
deprecated method OnBeforeMatch() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Streamlet class can implement this callback to perform any logic needed to tweak properties, do defaulting, etc., before we attempt to match to a stored streamlet
Streamlet class can implement this callback to perform any logic needed to tweak properties, do defaulting, etc., before we attempt to match to a stored streamlet
deprecated method OnValidate() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Streamlet class can implement this callback to perform validation
This is invoked by the SaveStreamlet method before the streamlet is physically saved.
Streamlet class can implement this callback to perform validation
This is invoked by the SaveStreamlet method before the streamlet is physically saved.
deprecated abstract classmethod ParamSearchesPeriod(pResourceType As %String, pParamName As %String) as %Boolean
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Given a timestamp in YYYY-MM-DDThh:mm:ss format, return the value of the timestamp that is one second prior
Given a timestamp in YYYY-MM-DDThh:mm:ss format, return the value of the timestamp that is one second prior
deprecated classmethod RebuildClassIndices() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
API Rebuild the CompartmentsIdx and VersionIdx indices for each resource type.
API Rebuild the CompartmentsIdx and VersionIdx indices for each resource type.
deprecated classmethod RebuildSearchIndices(pBreakOnError As %Boolean = 0, pType As %String = "", pStorageClass As %String = "") as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
API For every resource stored in the repository, rebuild its search indices.
If pBreakOnError is true, the user will be prompted if:
-the production is running
-there is an error instantiating a resource
-there is an error rebuilding the search indices for a resource
Specify pType if you want to rebuild indices for only a single resource type.
Specify pStorageClass if you want to use a Repository Storage class other than the default for this FHIR version.
API For every resource stored in the repository, rebuild its search indices.
If pBreakOnError is true, the user will be prompted if:
-the production is running
-there is an error instantiating a resource
-there is an error rebuilding the search indices for a resource
Specify pType if you want to rebuild indices for only a single resource type.
Specify pStorageClass if you want to use a Repository Storage class other than the default for this FHIR version.
deprecated classmethod RefMatchesSearchParam(pResourceType As %String, pParamName As %String, pRefType As %String) as %Boolean
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Given a resource type and a search parameter on that resource of type "reference", this method will return "true" if that search parameter references of type pRefType, and false otherwise. For example, the "practitioner" search param on Appointment searches the participant.actor property, which can be a reference to a Patient, Practitioner, RelatedPerson, Device, HealthcareService, or Location. However, the "practitioner" param only searches for values of this property that are of type Practitioner. So calling the method with pResourceType="Appointment", pParamName="practitioner", and pRefType="Practitioner" returns true. However calling it with pResourceType and pParamName and pRefType="Patient" returns false.
Given a resource type and a search parameter on that resource of type "reference", this method will return "true" if that search parameter references of type pRefType, and false otherwise. For example, the "practitioner" search param on Appointment searches the participant.actor property, which can be a reference to a Patient, Practitioner, RelatedPerson, Device, HealthcareService, or Location. However, the "practitioner" param only searches for values of this property that are of type Practitioner. So calling the method with pResourceType="Appointment", pParamName="practitioner", and pRefType="Practitioner" returns true. However calling it with pResourceType and pParamName and pRefType="Patient" returns false.
deprecated classmethod ResourceExists(pSession As %String, pType As %String, pResourceId As %String) as %Boolean
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Returns true if a resource of the given type with the given resource ID (not logical ID) exists in the given session, even if it is currently marked as deleted, and false otherwise.
Returns true if a resource of the given type with the given resource ID (not logical ID) exists in the given session, even if it is currently marked as deleted, and false otherwise.
deprecated classmethod ResourceIsDeleted(pSession As %String, pType As %String, pResourceId As %String, pVersionId="") as %Boolean
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Given a session, resource type, resource ID, and optionally a version ID, this method will return true if that version of the resource is "deleted", and false otherwise. (Not physically deleted, but rather marked deleted with the "delete" interaction.)
pType must be a valid resource type. This method will not validate it.
pResourceId must not be null.
If pVersionId is null, the deleted status of the current version will be returned.
Given a session, resource type, resource ID, and optionally a version ID, this method will return true if that version of the resource is "deleted", and false otherwise. (Not physically deleted, but rather marked deleted with the "delete" interaction.)
pType must be a valid resource type. This method will not validate it.
pResourceId must not be null.
If pVersionId is null, the deleted status of the current version will be returned.
deprecated classmethod ResourceToLogicalId(pSession As %String, pType As %String, pResourceId As %String, pVersionId="") as %String
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Given a session, resource type, resource ID, and optionally a version ID, this method will return the logical (object) ID of that version of the resource in the given session.
pType must be a valid resource type. This method will not validate it.
pResourceId must not be null.
If pVersionId is null, the Logical ID of the current version will be returned.
If there is no resource in the repository with the given type and resource ID in (and
version ID, if given) in the given session, this method will return "" (null).
Given a session, resource type, resource ID, and optionally a version ID, this method will return the logical (object) ID of that version of the resource in the given session.
pType must be a valid resource type. This method will not validate it.
pResourceId must not be null.
If pVersionId is null, the Logical ID of the current version will be returned.
If there is no resource in the repository with the given type and resource ID in (and
version ID, if given) in the given session, this method will return "" (null).
deprecated method SaveResource() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Call this to save the resource
Call this to save the resource
deprecated classmethod SearchCompartment(pType As %String, pCompartment As %String, pCompartmentId As %String, ByRef pQuery As %String, ByRef pSQLParams) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod SearchDate(pType As %String, pParam As %String, pVals, ByRef pQuery As %String, ByRef pSQLParams, pPropType As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod SearchNumber(pParam As %String, pVals, ByRef pQuery As %String, ByRef pSQLParams) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod SearchQuantity(pType As %String, pParam As %String, pVals, ByRef pQuery As %String, ByRef pSQLParams) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod SearchReference(pParam As %String, pVals, ByRef pQuery As %String, ByRef pSQLParams) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod SearchString(pParam As %String, pVals, ByRef pQuery As %String, ByRef pSQLParams) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod SearchToken(pParam As %String, pVals, ByRef pQuery As %String, ByRef pSQLParams, pPropType As %String) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated classmethod SearchURI(pParam As %String, pVals, ByRef pQuery As %String, ByRef pSQLParams) as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
deprecated method SetResourceId() as %Status
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Validate a date param
Param can be in the format:
YYYY
YYYY-MM
YYYY-MM-DD
YYYY-MM-DDThh:mm
YYYY-MM-DDThh:mm:ss
This method will also assert that month, date, hour, minute and second values are valid
pDate will be modified and returned if the precision on it warranted converting to UTC
Validate a date param
Param can be in the format:
YYYY
YYYY-MM
YYYY-MM-DD
YYYY-MM-DDThh:mm
YYYY-MM-DDThh:mm:ss
This method will also assert that month, date, hour, minute and second values are valid
pDate will be modified and returned if the precision on it warranted converting to UTC
deprecated classmethod VersionExists(pSession As %String, pType As %String, pResourceId As %String, pVersion As %Integer) as %Boolean
THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Returns true if the resource with the given type and resource ID has a version with version ID matching pVersion, and false otherwise.
Also, if there is no resource of the given type and resource ID, false will be returned.
Returns true if the resource with the given type and resource ID has a version with version ID matching pVersion, and false otherwise.
Also, if there is no resource of the given type and resource ID, false will be returned.
Indexes
index (CompartmentsIdx on Compartments(ELEMENTS));
index (VersionIdx on Session,ResourceType,ResourceId,VersionId) [Data = Deleted, Unique];