Home > Class Reference > HSLIB namespace > HS.Message.PatientSearchRequest

HS.Message.PatientSearchRequest

persistent class HS.Message.PatientSearchRequest extends HS.Util.EnsRequest, HS.Types.PatientInfo, HS.Types.RequestInfo

SQL Table Name: HS_Message.PatientSearchRequest

Property Inventory (Including Private)

Parameters

parameter FOUNDATION = 1;
parameter RESPONSECLASSNAME = HS.Message.PatientSearchResponse;
Default response class
parameter XMLIGNORENULL = inputonly;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.

Properties (Including Private)

property AnalyticsID as %String;
For search by Analytics ID - only valid in "user" searchmode, with consent
Property methods: AnalyticsIDDisplayToLogical(), AnalyticsIDGet(), AnalyticsIDGetStored(), AnalyticsIDIsValid(), AnalyticsIDLogicalToDisplay(), AnalyticsIDLogicalToOdbc(), AnalyticsIDNormalize(), AnalyticsIDSet()
property DOBRangeEnd as %Date (FORMAT = 3);
If present, the DOB search range will go from DOB to DOBRangeEnd
Property methods: DOBRangeEndDisplayToLogical(), DOBRangeEndGet(), DOBRangeEndGetStored(), DOBRangeEndIsValid(), DOBRangeEndLogicalToDisplay(), DOBRangeEndLogicalToOdbc(), DOBRangeEndLogicalToXSD(), DOBRangeEndNormalize(), DOBRangeEndOdbcToLogical(), DOBRangeEndSet(), DOBRangeEndXSDToLogical()
property IgnoreSecondaryMPI as %Boolean [ InitialExpression = 0 ];
Once the request gets to the Hub do we also want to query the secondary MPI operations if this is coming in from another system we do not want to query out.
Property methods: IgnoreSecondaryMPIDisplayToLogical(), IgnoreSecondaryMPIGet(), IgnoreSecondaryMPIGetStored(), IgnoreSecondaryMPIIsValid(), IgnoreSecondaryMPILogicalToDisplay(), IgnoreSecondaryMPILogicalToXSD(), IgnoreSecondaryMPINormalize(), IgnoreSecondaryMPISet(), IgnoreSecondaryMPIXSDToLogical()
property InfoTypes as list of %String);
If present, this is used to filter the list of patient records to only those who have one of the specified InfoTypes
Property methods: InfoTypesBuildValueArray(), InfoTypesCollectionToDisplay(), InfoTypesCollectionToOdbc(), InfoTypesDisplayToCollection(), InfoTypesDisplayToLogical(), InfoTypesGet(), InfoTypesGetObject(), InfoTypesGetObjectId(), InfoTypesGetStored(), InfoTypesGetSwizzled(), InfoTypesIsValid(), InfoTypesLogicalToDisplay(), InfoTypesLogicalToOdbc(), InfoTypesNormalize(), InfoTypesOdbcToCollection(), InfoTypesSet(), InfoTypesSetObject(), InfoTypesSetObjectId()
property MPIIDLIST as list of %String;
Property methods: MPIIDLISTBuildValueArray(), MPIIDLISTCollectionToDisplay(), MPIIDLISTCollectionToOdbc(), MPIIDLISTDisplayToCollection(), MPIIDLISTDisplayToLogical(), MPIIDLISTGet(), MPIIDLISTGetObject(), MPIIDLISTGetObjectId(), MPIIDLISTGetStored(), MPIIDLISTGetSwizzled(), MPIIDLISTIsValid(), MPIIDLISTLogicalToDisplay(), MPIIDLISTLogicalToOdbc(), MPIIDLISTNormalize(), MPIIDLISTOdbcToCollection(), MPIIDLISTSet(), MPIIDLISTSetObject(), MPIIDLISTSetObjectId()
property MaxMatches as %Integer;
Maximum number of matches to retrieve
Property methods: MaxMatchesDisplayToLogical(), MaxMatchesGet(), MaxMatchesGetStored(), MaxMatchesIsValid(), MaxMatchesLogicalToDisplay(), MaxMatchesNormalize(), MaxMatchesSet(), MaxMatchesXSDToLogical()
property Membership as %String (MAXLEN = 256, ZENHIDDEN = 1);
For membership maintenance, the cohort whose membership is being maintained This doesn't affect the search, but does affect consent, and causes the results to contain an additional boolean for if the patient is a member of that cohort
Property methods: MembershipDisplayToLogical(), MembershipGet(), MembershipGetStored(), MembershipIsValid(), MembershipLogicalToDisplay(), MembershipLogicalToOdbc(), MembershipNormalize(), MembershipSet()
property MinMatchPercentage as %Integer;
Percentage value 0 - 100 for matches, 0 having a linkage weight of 0 and 100 matching the validateThreshold, only used when the request does not contain a value
Property methods: MinMatchPercentageDisplayToLogical(), MinMatchPercentageGet(), MinMatchPercentageGetStored(), MinMatchPercentageIsValid(), MinMatchPercentageLogicalToDisplay(), MinMatchPercentageNormalize(), MinMatchPercentageSet(), MinMatchPercentageXSDToLogical()
property Program as %String (MAXLEN = 256, ZENHIDDEN = 1);
for search by cohort
Property methods: ProgramDisplayToLogical(), ProgramGet(), ProgramGetStored(), ProgramIsValid(), ProgramLogicalToDisplay(), ProgramLogicalToOdbc(), ProgramNormalize(), ProgramSet()
property Recent as %Boolean;
If present, this will override all other search criteria, and will look instead at the most recently selected MPIIDs for the requesting user, and populate the MPIIDLIST list
Property methods: RecentDisplayToLogical(), RecentGet(), RecentGetStored(), RecentIsValid(), RecentLogicalToDisplay(), RecentLogicalToXSD(), RecentNormalize(), RecentSet(), RecentXSDToLogical()
property Relationship as %String (MAXLEN = 256);
for search by relationship - relationship type ID or "Any"
Property methods: RelationshipClinicianDisplayToLogical(), RelationshipClinicianGet(), RelationshipClinicianGetStored(), RelationshipClinicianIsValid(), RelationshipClinicianLogicalToDisplay(), RelationshipClinicianLogicalToOdbc(), RelationshipClinicianNormalize(), RelationshipClinicianSet(), RelationshipDisplayToLogical(), RelationshipGet(), RelationshipGetStored(), RelationshipIsValid(), RelationshipLogicalToDisplay(), RelationshipLogicalToOdbc(), RelationshipNormalize(), RelationshipSet()
property RelationshipClinician as %String;
The clinician for whom we are looking for a relationship
Property methods: RelationshipClinicianDisplayToLogical(), RelationshipClinicianGet(), RelationshipClinicianGetStored(), RelationshipClinicianIsValid(), RelationshipClinicianLogicalToDisplay(), RelationshipClinicianLogicalToOdbc(), RelationshipClinicianNormalize(), RelationshipClinicianSet()
property SearchMode as %String (DISPLAYLIST = ",User,Admin,Clinician,Participation,AuditReport,PIXPDQ,PIXPDQ_c,ODS", VALUELIST = ",user,admin,clinician,participation,AuditReport,PIXPDQ,PIXPDQ_c,ODS") [ InitialExpression = "user" ];
Search modes user - regular patient lookup, admin - mpi patient lookup no consent applied, clinician -- mpi patient lookup, no consent applied, limited to patients with a pre-existing relationship with the clinician, PIXPDQ - no consent applied, PIXPDQ_c - consent applied ODS - for internal message from ODS to get a list of patients to load
Property methods: SearchModeDisplayToLogical(), SearchModeGet(), SearchModeGetStored(), SearchModeIsValid(), SearchModeLogicalToDisplay(), SearchModeLogicalToOdbc(), SearchModeNormalize(), SearchModeSet()
property Threshold as %Numeric;
Minimum rank to consider a match. If not specified, will use the setting in the MPI Operation. Currently used by Quadramed only.
Property methods: ThresholdDisplayToLogical(), ThresholdGet(), ThresholdGetStored(), ThresholdIsValid(), ThresholdLogicalToDisplay(), ThresholdNormalize(), ThresholdSet(), ThresholdXSDToLogical()

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.MessageBody)

^Ens.MessageBodyD(ID)
=
%%CLASSNAME

Storage Model: Storage (HS.Util.EnsRequest)

^Ens.MessageBodyD(ID,"EnsRequest")
=
HSCoreVersion
HSMinVersion
%ClearFields

Storage Model: Storage (HS.Message.PatientSearchRequest)

^Ens.MessageBodyD(ID,"HS.Message.PatientSearchRequest.AdditionalInfo",n)
=
AdditionalInfo(n)

Storage Model: Storage (HS.Message.PatientSearchRequest)

^Ens.MessageBodyD(ID,"HS.Message.PatientSearchRequest.CustomAuditInfo",n)
=
CustomAuditInfo(n)

Storage Model: Storage (HS.Message.PatientSearchRequest)

^Ens.MessageBodyD(ID,"PatientSearchRequest")
=
City
DOB
Facility
FirstName
Gateway
LastName
MRN
Sex
State
Street
Zip
MPIID
MiddleName
Consent
RequestingFacility
BreakTheGlass
SSN
Telephone
MaxMatches
RequestingUser
RequestingUserRoles
Signature
ClinicalTypes
RequestId
AuthBy
AuthType
AssigningAuthority
SearchMode
RequestingGateway
Type
BTGReason
IgnoreSecondaryMPI
InfoTypes
ControlledIDList
BusinessPhone
Race
CityOfBirth
DriversLicenseNumber
MothersMaidenSurname
BirthOrder
RequestingForProxyUserID
RequestingForProxyID
Recent
MPIIDLIST
Identifiers
Prefix
Suffix
BirthPlace
MaritalStatus
ReligiousAffiliation
EthnicGroup
Language
VIP
Telecoms
Addresses
Relationship
RelationshipClinician
Program
Membership
Names
Threshold
AnalyticsID
SAMLData
MinMatchPercentage
CustomClassName
CustomXMLString
CommunicationPreference
CreatedBy
CreatedOn
LastEnteredBy
LastEnteredOn
DeathTime
FathersName
MothersName
SpousesName
DeathStatus
Extension
DOBRangeEnd
FeedbackOpens in a new window