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

HS.Message.IDUpdateNotificationRequest

persistent class HS.Message.IDUpdateNotificationRequest extends HS.Util.EnsRequest, HS.Types.RequestInfo

SQL Table Name: HS_Message.IDUpdateNotificationRequest

Used for updating the MPIID

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 Identifiers as list of HS.Types.Identifier (STORAGEDEFAULT = "list");
A collection of Identifiers (with assigning authority) related to the new MPI ID
Property methods: IdentifiersBuildValueArray(), IdentifiersCollectionToDisplay(), IdentifiersCollectionToOdbc(), IdentifiersDisplayToCollection(), IdentifiersGet(), IdentifiersGetObject(), IdentifiersGetObjectId(), IdentifiersGetStored(), IdentifiersGetSwizzled(), IdentifiersIsValid(), IdentifiersOdbcToCollection(), IdentifiersSet(), IdentifiersSetObject(), IdentifiersSetObjectId()
property MPIID as %String;
The master/patient index id
Property methods: MPIIDDisplayToLogical(), MPIIDGet(), MPIIDGetStored(), MPIIDIsValid(), MPIIDLogicalToDisplay(), MPIIDLogicalToOdbc(), MPIIDNormalize(), MPIIDSet()
property PatientDemographics as HS.Message.PatientSearchMatch;
Property methods: PatientDemographicsGet(), PatientDemographicsGetObject(), PatientDemographicsGetObjectId(), PatientDemographicsGetStored(), PatientDemographicsGetSwizzled(), PatientDemographicsIsValid(), PatientDemographicsNewObject(), PatientDemographicsSet(), PatientDemographicsSetObject(), PatientDemographicsSetObjectId(), PatientDemographicsUnSwizzle()
property PriorIdentifiers as list of HS.Types.Identifier (STORAGEDEFAULT = "list");
A collection of Identifiers (with assigning authority) before the Update. Used to identify systems to send an update. Interested in AA = XXX but the ID for XXX is being removed need to send an update. Used by the patient registry for sending to PIX Manager
Property methods: PriorIdentifiersBuildValueArray(), PriorIdentifiersCollectionToDisplay(), PriorIdentifiersCollectionToOdbc(), PriorIdentifiersDisplayToCollection(), PriorIdentifiersGet(), PriorIdentifiersGetObject(), PriorIdentifiersGetObjectId(), PriorIdentifiersGetStored(), PriorIdentifiersGetSwizzled(), PriorIdentifiersIsValid(), PriorIdentifiersOdbcToCollection(), PriorIdentifiersSet(), PriorIdentifiersSetObject(), PriorIdentifiersSetObjectId()
property PriorMPIID as %String;
The previous master/patient index id
Property methods: PriorMPIIDDisplayToLogical(), PriorMPIIDGet(), PriorMPIIDGetStored(), PriorMPIIDIsValid(), PriorMPIIDLogicalToDisplay(), PriorMPIIDLogicalToOdbc(), PriorMPIIDNormalize(), PriorMPIIDSet()

Inherited Members

Inherited Properties

Inherited Methods

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.IDUpdateNotificationRequest)

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

Storage Model: Storage (HS.Message.IDUpdateNotificationRequest)

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

Storage Model: Storage (HS.Message.IDUpdateNotificationRequest)

^Ens.MessageBodyD(ID,"IDUpdateNotificationRequest")
=
Identifiers
MPIID
PriorMPIID
AuthBy
AuthType
BTGReason
RequestingUser
RequestingUserRoles
RequestingForProxyUserID
RequestingForProxyID
Signature
RequestId
RequestingGateway
Type
BreakTheGlass
ClinicalTypes
Consent
PriorIdentifiers
PatientDemographics
SAMLData