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

HS.Message.PatientSearchMatch

persistent class HS.Message.PatientSearchMatch extends %Library.Persistent, HS.Types.PatientInfo, HS.Types.RequestInfo

SQL Table Name: HS_Message.PatientSearchMatch

Property Inventory

Parameters

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

property CanFilterInfoTypes as %Boolean [ InitialExpression = 0 ];
Does this match support infotype filtering? The primary MPI always does, since the InfoTypes are stored in the hub Secondary MPIs may or may not supply InfoTypes - if they do, then they can set this to true
Property methods: CanFilterInfoTypesDisplayToLogical(), CanFilterInfoTypesGet(), CanFilterInfoTypesGetStored(), CanFilterInfoTypesIsValid(), CanFilterInfoTypesLogicalToDisplay(), CanFilterInfoTypesLogicalToXSD(), CanFilterInfoTypesNormalize(), CanFilterInfoTypesSet(), CanFilterInfoTypesXSDToLogical()
property Gateway as HS.Types.EndPoint;
The source gateway for this patient match
Property methods: GatewayDisplayToLogical(), GatewayGet(), GatewayGetStored(), GatewayIsValid(), GatewayLogicalToDisplay(), GatewayLogicalToOdbc(), GatewayNormalize(), GatewaySet(), GatewayStatusGet(), GatewayStatusGetStored(), GatewayStatusIsValid(), GatewayStatusLogicalToOdbc(), GatewayStatusLogicalToXSD(), GatewayStatusSet(), GatewayStatusXSDToLogical()
property GatewayStatus as %Status;
The fetch/search status for this gateway
Property methods: GatewayStatusGet(), GatewayStatusGetStored(), GatewayStatusIsValid(), GatewayStatusLogicalToOdbc(), GatewayStatusLogicalToXSD(), GatewayStatusSet(), GatewayStatusXSDToLogical()
property InfoTypes as %String);
The list of information/document types, as a comma separated string
Property methods: InfoTypesDisplayToLogical(), InfoTypesGet(), InfoTypesGetStored(), InfoTypesIsValid(), InfoTypesLogicalToDisplay(), InfoTypesLogicalToOdbc(), InfoTypesNormalize(), InfoTypesSet()
property LookupError as %Boolean [ InitialExpression = 0 ];
Problem with lookup
Property methods: LookupErrorDisplayToLogical(), LookupErrorGet(), LookupErrorGetStored(), LookupErrorIsValid(), LookupErrorLogicalToDisplay(), LookupErrorLogicalToXSD(), LookupErrorNormalize(), LookupErrorSet(), LookupErrorXSDToLogical()
property MPIIDListItem as %Integer;
Back pointer into the MPIIDList item associated with this search match item
Property methods: MPIIDListItemDisplayToLogical(), MPIIDListItemGet(), MPIIDListItemGetStored(), MPIIDListItemIsValid(), MPIIDListItemLogicalToDisplay(), MPIIDListItemNormalize(), MPIIDListItemSet(), MPIIDListItemXSDToLogical()
property RankOrScore as %Numeric;
The match rank or score (optional)
Property methods: RankOrScoreDisplayToLogical(), RankOrScoreGet(), RankOrScoreGetStored(), RankOrScoreIsValid(), RankOrScoreLogicalToDisplay(), RankOrScoreNormalize(), RankOrScoreSet(), RankOrScoreXSDToLogical()
property Sensitive as %Boolean;
THis property is reserved for future use
Property methods: SensitiveDisplayToLogical(), SensitiveGet(), SensitiveGetStored(), SensitiveIsValid(), SensitiveLogicalToDisplay(), SensitiveLogicalToXSD(), SensitiveNormalize(), SensitiveSet(), SensitiveXSDToLogical()

Indexes

index (MPIIDIdx on MPIID);
Index the MPIID for ordering
Index methods: MPIIDIdxExists()

Inherited Members

Inherited Properties

Inherited Methods

Storage

Storage Model: Storage (HS.Message.PatientSearchMatch)

^CacheTemp.HS.PatSearchMatchD($Namespace)(ID,"AdditionalInfo",n)
=
AdditionalInfo(n)

Storage Model: Storage (HS.Message.PatientSearchMatch)

^CacheTemp.HS.PatSearchMatchD($Namespace)(ID,"CustomAuditInfo",n)
=
CustomAuditInfo(n)

Storage Model: Storage (HS.Message.PatientSearchMatch)

^CacheTemp.HS.PatSearchMatchD($Namespace)(ID)
=
%%CLASSNAME
City
DOB
Facility
FirstName
Gateway
LastName
MRN
Sex
State
Street
Zip
MPIID
MiddleName
Consent
Telephone
GatewayStatus
SSN
BreakTheGlass
RequestingFacility
RequestingUser
RequestingUserRoles
Signature
ClinicalTypes
RequestId
AssigningAuthority
Type
Rank
AuthBy
AuthType
BTGReason
RequestingGateway
RankOrScore
InfoTypes
LookupError
CanFilterInfoTypes
ControlledIDList
BusinessPhone
Race
CityOfBirth
DriversLicenseNumber
MothersMaidenSurname
BirthOrder
RequestingForProxyUserID
RequestingForProxyID
MPIIDListItem
Prefix
Suffix
Identifiers
BirthPlace
MaritalStatus
ReligiousAffiliation
EthnicGroup
Language
VIP
Telecoms
Addresses
Names
SAMLData
Sensitive
CustomClassName
CustomXMLString
CommunicationPreference
CreatedBy
CreatedOn
LastEnteredBy
LastEnteredOn
DeathTime
FathersName
MothersName
SpousesName
DeathStatus
Extension

Subclasses