Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

DeepSee.Study.Patient

persistent class DeepSee.Study.Patient extends %Library.Persistent

SQL Table Name: DeepSee_Study.Patient

This class is part of the DeepSee Patients sample, whose purpose is to provide sample data for use with DeepSee.

Property Inventory

Method Inventory

Parameters

parameter DSTIME = AUTO;
This parameter setting enables the DSTIME feature for DeepSee II

Properties

property Age as %Integer;
Property methods: AgeDisplayToLogical(), AgeGet(), AgeGetStored(), AgeIsValid(), AgeLogicalToDisplay(), AgeNormalize(), AgeSet()
property Allergies as list of DeepSee.Study.PatientAllergy;
Property methods: AllergiesBuildValueArray(), AllergiesCollectionToDisplay(), AllergiesCollectionToOdbc(), AllergiesDisplayToCollection(), AllergiesGet(), AllergiesGetObject(), AllergiesGetObjectId(), AllergiesGetStored(), AllergiesGetSwizzled(), AllergiesIsValid(), AllergiesOdbcToCollection(), AllergiesSet(), AllergiesSetObject(), AllergiesSetObjectId()
property BirthDate as %Date;
%Date version of the birth date. This property contains same data as the BirthDateTimeStamp property. This class contains multiple birth date properties so that you can try the supported data types.
Property methods: BirthDateDisplayToLogical(), BirthDateGet(), BirthDateGetStored(), BirthDateIsValid(), BirthDateLogicalToDisplay(), BirthDateLogicalToOdbc(), BirthDateNormalize(), BirthDateOdbcToLogical(), BirthDateSet()
property BirthDateMV as %MV.Date;
%MV.Date version of the birth date. This property contains same date as the BirthDateTimeStamp property.
Property methods: BirthDateMVDateToLogical(), BirthDateMVDisplayToLogical(), BirthDateMVGet(), BirthDateMVGetStored(), BirthDateMVIsValid(), BirthDateMVLogicalToDate(), BirthDateMVLogicalToDisplay(), BirthDateMVLogicalToOdbc(), BirthDateMVNormalize(), BirthDateMVOdbcToLogical(), BirthDateMVSet()
property BirthDateTimeStamp as %TimeStamp;
%TimeStamp version of the birth date. This property contains same date as the BirthDate property. Also see BirthTime.
Property methods: BirthDateTimeStampDisplayToLogical(), BirthDateTimeStampGet(), BirthDateTimeStampGetStored(), BirthDateTimeStampIsValid(), BirthDateTimeStampLogicalToDisplay(), BirthDateTimeStampNormalize(), BirthDateTimeStampOdbcToLogical(), BirthDateTimeStampSet()
property BirthTime as %Time;
Birth time as %Time. This class contains the birth time data in two properties (this property and BirthDateTimeStamp) so that you can try the time data in both formats.
Property methods: BirthTimeDisplayToLogical(), BirthTimeGet(), BirthTimeGetStored(), BirthTimeIsValid(), BirthTimeLogicalToDisplay(), BirthTimeLogicalToOdbc(), BirthTimeNormalize(), BirthTimeOdbcToLogical(), BirthTimeSet()
property Diagnoses as list of DeepSee.Study.PatientDiagnosis;
Diagnoses of this patient. This class contains multiple versions of this property each of which contains the same general diagnosis data. These versions enable you to create DeepSee dimensions on a variety of types of collections. Use this variation to see how DeepSee handles lists of objects.
Property methods: DiagnosesBuildValueArray(), DiagnosesCollectionToDisplay(), DiagnosesCollectionToOdbc(), DiagnosesDisplayToCollection(), DiagnosesGet(), DiagnosesGetObject(), DiagnosesGetObjectId(), DiagnosesGetStored(), DiagnosesGetSwizzled(), DiagnosesIsValid(), DiagnosesOdbcToCollection(), DiagnosesSet(), DiagnosesSetObject(), DiagnosesSetObjectId()
property DiagnosesAsArray as array of %String;
Use this variation to see how DeepSee handles arrays. See comments for the Diagnoses property.
Property methods: DiagnosesAsArrayBuildValueArray(), DiagnosesAsArrayCollectionToDisplay(), DiagnosesAsArrayCollectionToOdbc(), DiagnosesAsArrayDisplayToCollection(), DiagnosesAsArrayDisplayToLogical(), DiagnosesAsArrayGet(), DiagnosesAsArrayGetObject(), DiagnosesAsArrayGetObjectId(), DiagnosesAsArrayGetStored(), DiagnosesAsArrayGetSwizzled(), DiagnosesAsArrayIsValid(), DiagnosesAsArrayLogicalToDisplay(), DiagnosesAsArrayLogicalToOdbc(), DiagnosesAsArrayNormalize(), DiagnosesAsArrayOdbcToCollection(), DiagnosesAsArraySet(), DiagnosesAsArraySetObject(), DiagnosesAsArraySetObjectId()
relationship DiagnosesAsChildren as array of DeepSee.Study.PatientDiagnosis1 [ InitialExpression = $listbuild("DeepSee.Study.PatientDiagnosis1","Patient",+$this,"children",1,1) , Transient , Inverse = Patient , Cardinality = children ];
Use this variation to see how DeepSee handles parent-child relationships See comments for the Diagnoses property.
Property methods: DiagnosesAsChildrenGet(), DiagnosesAsChildrenGetObject(), DiagnosesAsChildrenGetObjectId(), DiagnosesAsChildrenGetSwizzled(), DiagnosesAsChildrenIsEmpty(), DiagnosesAsChildrenIsValid(), DiagnosesAsChildrenNewObject(), DiagnosesAsChildrenRClose(), DiagnosesAsChildrenRExec(), DiagnosesAsChildrenRFetch(), DiagnosesAsChildrenRelate(), DiagnosesAsChildrenSQLCompute(), DiagnosesAsChildrenSet(), DiagnosesAsChildrenUnRelate()
property DiagnosesAsLB as %List;
Use this variation to see how DeepSee handles $LB lists of strings. See comments for the Diagnoses property.
Property methods: DiagnosesAsLBGet(), DiagnosesAsLBGetStored(), DiagnosesAsLBIsValid(), DiagnosesAsLBLogicalToOdbc(), DiagnosesAsLBOdbcToLogical(), DiagnosesAsLBSet()
relationship DiagnosesAsMany as array of DeepSee.Study.PatientDiagnosis2 [ InitialExpression = $listbuild("DeepSee.Study.PatientDiagnosis2","Patient",+$this,"many",1,1) , Transient , Inverse = Patient , Cardinality = many ];
Use this variation to see how DeepSee handles one-to-many relationships See comments for the Diagnoses property.
Property methods: DiagnosesAsManyGet(), DiagnosesAsManyGetObject(), DiagnosesAsManyGetObjectId(), DiagnosesAsManyGetSwizzled(), DiagnosesAsManyIsEmpty(), DiagnosesAsManyIsValid(), DiagnosesAsManyNewObject(), DiagnosesAsManyRClose(), DiagnosesAsManyRExec(), DiagnosesAsManyRFetch(), DiagnosesAsManyRelate(), DiagnosesAsManySQLCompute(), DiagnosesAsManySet(), DiagnosesAsManyUnRelate()
property DiagnosesAsString as %String;
Use this variation to see how DeepSee handles pieced strings. See comments for the Diagnoses property.
Property methods: DiagnosesAsStringDisplayToLogical(), DiagnosesAsStringGet(), DiagnosesAsStringGetStored(), DiagnosesAsStringIsValid(), DiagnosesAsStringLogicalToDisplay(), DiagnosesAsStringLogicalToOdbc(), DiagnosesAsStringNormalize(), DiagnosesAsStringSet()
property Gender as %String (DISPLAYLIST = ",Female,Male", VALUELIST = ",F,M");
Property methods: GenderDisplayToLogical(), GenderGet(), GenderGetStored(), GenderIsValid(), GenderLogicalToDisplay(), GenderLogicalToOdbc(), GenderNormalize(), GenderSet()
property HomeCity as DeepSee.Study.City;
Property methods: HomeCityGet(), HomeCityGetObject(), HomeCityGetObjectId(), HomeCityGetStored(), HomeCityGetSwizzled(), HomeCityIsValid(), HomeCityNewObject(), HomeCitySet(), HomeCitySetObject(), HomeCitySetObjectId(), HomeCityUnSwizzle()
property PatientGroup as %String;
This property represents some grouping of the patients in this fictitious study. Use this as a DeepSee dimension.
Property methods: PatientGroupDisplayToLogical(), PatientGroupGet(), PatientGroupGetStored(), PatientGroupIsValid(), PatientGroupLogicalToDisplay(), PatientGroupLogicalToOdbc(), PatientGroupNormalize(), PatientGroupSet()
property PatientID as %String;
ID of this patient, as assigned within this fictitious study; useful as a detail listing field.
Property methods: PatientIDDisplayToLogical(), PatientIDGet(), PatientIDGetStored(), PatientIDIsValid(), PatientIDLogicalToDisplay(), PatientIDLogicalToOdbc(), PatientIDNormalize(), PatientIDSet()
property PrimaryCarePhysician as DeepSee.Study.Doctor;
Property methods: PrimaryCarePhysicianGet(), PrimaryCarePhysicianGetObject(), PrimaryCarePhysicianGetObjectId(), PrimaryCarePhysicianGetStored(), PrimaryCarePhysicianGetSwizzled(), PrimaryCarePhysicianIsValid(), PrimaryCarePhysicianNewObject(), PrimaryCarePhysicianSet(), PrimaryCarePhysicianSetObject(), PrimaryCarePhysicianSetObjectId(), PrimaryCarePhysicianUnSwizzle()
property TestScore as %Integer;
Value of some fictitious test; will use this as a measure; can be null. When using as a measure, probably more suitable to average across the patients.
Property methods: TestScoreDisplayToLogical(), TestScoreGet(), TestScoreGetStored(), TestScoreIsValid(), TestScoreLogicalToDisplay(), TestScoreNormalize(), TestScoreSet()

Methods

classmethod AddPatients(patCount As %Integer = 100, options As %String = "ADT", genNulls As %Boolean = 1, initSetup As %Boolean = 0, genNullDates As %Boolean = 0) as %Status
Called by GenerateData(); see the comments for that method. Can also be called directly to add patients after the initial setup.
classmethod ChangePatientGroups(percent As %Numeric = 10)
Randomly reassign some patients to different patient groups.
classmethod ChangeSomePatients(percent As %Numeric = 20, rebuild As %Boolean = 1)
Changes some patient data in various tables. If rebuild is 1, this method updates the DeepSee indices (I and II) for each patient affected by these changes. For DeepSee I, use this option only if you have enabled incremental updates (otherwise, you needlessly slow down the method).
classmethod DeletePatient(patid As %String) as %Status
Deletes a patient, given its ID.
classmethod DeleteSomePatients(percent As %Numeric = 1) as %Status
Delete a few patients randomly.
classmethod GenerateData(patCount As %Integer = 500, options As %String = "ADET", genNulls As %Boolean = 1, genNullDates As %Boolean = 0) as %Status
Called by DeepSee.Populate:GenerateData(); see the comments for that method.
classmethod GetHighestPatientID() as %String

Indexes

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

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (DeepSee.Study.Patient)

^DeepSee.Study.PatientD(ID,"DiagnosesAsArray",n)
=
DiagnosesAsArray(n)

Storage Model: CacheStorage (DeepSee.Study.Patient)

^DeepSee.Study.PatientD(ID)
=
%%CLASSNAME
PatientID
Gender
Age
BirthDate
BirthTime
BirthDateTimeStamp
BirthDateMV
PrimaryCarePhysician
Allergies
Diagnoses
DiagnosesAsLB
DiagnosesAsString
HomeCity
PatientGroup
TestScore
FeedbackOpens in a new tab