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

HS.Message.AddUpdateHubRequest

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

SQL Table Name: HS_Message.AddUpdateHubRequest

Property Inventory

Parameters

parameter FOUNDATION = 1;
parameter RESPONSECLASSNAME = HS.Message.AddUpdateHubResponse;
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 AAUpdateQ as array of %String);
For sending AnalyticsUpdate
Property methods: AAUpdateQBuildValueArray(), AAUpdateQCollectionToDisplay(), AAUpdateQCollectionToOdbc(), AAUpdateQDisplayToCollection(), AAUpdateQDisplayToLogical(), AAUpdateQGet(), AAUpdateQGetObject(), AAUpdateQGetObjectId(), AAUpdateQGetStored(), AAUpdateQGetSwizzled(), AAUpdateQIsValid(), AAUpdateQLogicalToDisplay(), AAUpdateQLogicalToOdbc(), AAUpdateQNormalize(), AAUpdateQOdbcToCollection(), AAUpdateQSet(), AAUpdateQSetObject(), AAUpdateQSetObjectId()
property AddOrUpdate as %String (DISPLAYLIST = ",Add,Update,Force", VALUELIST = ",A,U,F");
Whether to force an add or update. Nil value lets MPI decide. "F"orce also lets the MPI decide, but forces an overwrite of every field
Property methods: AddOrUpdateDisplayToLogical(), AddOrUpdateGet(), AddOrUpdateGetStored(), AddOrUpdateIsValid(), AddOrUpdateLogicalToDisplay(), AddOrUpdateLogicalToOdbc(), AddOrUpdateNormalize(), AddOrUpdateSet()
property DoDelete as %Boolean;
Added so that this message can be used instead of the RemovePatientRequest, to support Push
Property methods: DoDeleteDisplayToLogical(), DoDeleteGet(), DoDeleteGetStored(), DoDeleteIsValid(), DoDeleteLogicalToDisplay(), DoDeleteLogicalToXSD(), DoDeleteNormalize(), DoDeleteSet(), DoDeleteXSDToLogical()
property DoFlash as %Boolean [ InitialExpression = 0 ];
Property methods: DoFlashDisplayToLogical(), DoFlashGet(), DoFlashGetStored(), DoFlashIsValid(), DoFlashLogicalToDisplay(), DoFlashLogicalToXSD(), DoFlashNormalize(), DoFlashSet(), DoFlashXSDToLogical()
property DoMPIUpdate as %Boolean;
Property methods: DoMPIUpdateDisplayToLogical(), DoMPIUpdateGet(), DoMPIUpdateGetStored(), DoMPIUpdateIsValid(), DoMPIUpdateLogicalToDisplay(), DoMPIUpdateLogicalToXSD(), DoMPIUpdateNormalize(), DoMPIUpdateSet(), DoMPIUpdateXSDToLogical()
property DoPush as %Boolean;
Property methods: DoPushDisplayToLogical(), DoPushGet(), DoPushGetStored(), DoPushIsValid(), DoPushLogicalToDisplay(), DoPushLogicalToXSD(), DoPushNormalize(), DoPushSet(), DoPushXSDToLogical()
property EncounterTypes as list of %String;
Property methods: EncounterTypesBuildValueArray(), EncounterTypesCollectionToDisplay(), EncounterTypesCollectionToOdbc(), EncounterTypesDisplayToCollection(), EncounterTypesDisplayToLogical(), EncounterTypesGet(), EncounterTypesGetObject(), EncounterTypesGetObjectId(), EncounterTypesGetStored(), EncounterTypesGetSwizzled(), EncounterTypesIsValid(), EncounterTypesLogicalToDisplay(), EncounterTypesLogicalToOdbc(), EncounterTypesNormalize(), EncounterTypesOdbcToCollection(), EncounterTypesSet(), EncounterTypesSetObject(), EncounterTypesSetObjectId()
property Encounters as list of HS.Message.AddUpdateHubEncounterInfo;
The addupdatehub message needs a small subset of encounter info in order to evaluate relationship inference policies that utilize an Encounter entity
Property methods: EncountersBuildValueArray(), EncountersCollectionToDisplay(), EncountersCollectionToOdbc(), EncountersDisplayToCollection(), EncountersGet(), EncountersGetObject(), EncountersGetObjectId(), EncountersGetStored(), EncountersGetSwizzled(), EncountersIsValid(), EncountersOdbcToCollection(), EncountersSet(), EncountersSetObject(), EncountersSetObjectId()
property EventType as %String;
Property methods: EventTypeDisplayToLogical(), EventTypeGet(), EventTypeGetStored(), EventTypeIsValid(), EventTypeLogicalToDisplay(), EventTypeLogicalToOdbc(), EventTypeNormalize(), EventTypeSet()
property FeedAnalytics as %Boolean [ InitialExpression = 0 ];
Copied in from production setting, because we are now always sending AAUpdateQ info
Property methods: FeedAnalyticsDisplayToLogical(), FeedAnalyticsGet(), FeedAnalyticsGetStored(), FeedAnalyticsIsValid(), FeedAnalyticsLogicalToDisplay(), FeedAnalyticsLogicalToXSD(), FeedAnalyticsNormalize(), FeedAnalyticsSet(), FeedAnalyticsXSDToLogical()
property GatewayName as %String);
Property methods: GatewayNameDisplayToLogical(), GatewayNameGet(), GatewayNameGetStored(), GatewayNameIsValid(), GatewayNameLogicalToDisplay(), GatewayNameLogicalToOdbc(), GatewayNameNormalize(), GatewayNameSet()
property IdentifiedClinicians as list of HS.Types.IdentifiedClinician;
Property methods: IdentifiedCliniciansBuildValueArray(), IdentifiedCliniciansCollectionToDisplay(), IdentifiedCliniciansCollectionToOdbc(), IdentifiedCliniciansDisplayToCollection(), IdentifiedCliniciansGet(), IdentifiedCliniciansGetObject(), IdentifiedCliniciansGetObjectId(), IdentifiedCliniciansGetStored(), IdentifiedCliniciansGetSwizzled(), IdentifiedCliniciansIsValid(), IdentifiedCliniciansOdbcToCollection(), IdentifiedCliniciansSet(), IdentifiedCliniciansSetObject(), IdentifiedCliniciansSetObjectId()
property InfoTypes as list of %String);
Message InfoTypes - this contains the list of InfoTypes found in the message, for use in Push
Property methods: InfoTypesBuildValueArray(), InfoTypesCollectionToDisplay(), InfoTypesCollectionToOdbc(), InfoTypesDisplayToCollection(), InfoTypesDisplayToLogical(), InfoTypesGet(), InfoTypesGetObject(), InfoTypesGetObjectId(), InfoTypesGetStored(), InfoTypesGetSwizzled(), InfoTypesIsValid(), InfoTypesLogicalToDisplay(), InfoTypesLogicalToOdbc(), InfoTypesNormalize(), InfoTypesOdbcToCollection(), InfoTypesSet(), InfoTypesSetObject(), InfoTypesSetObjectId()
property LogReportingEvent as %Boolean;
If true, the MPI Manager on the Registry will use this request to create an entry in HS_IHE_ATNA_Repository.Aggregation which can be used for reporting. The entry will have EventType="InboundMessage" and EventSubType=[MessageType of this request].
Property methods: LogReportingEventDisplayToLogical(), LogReportingEventGet(), LogReportingEventGetStored(), LogReportingEventIsValid(), LogReportingEventLogicalToDisplay(), LogReportingEventLogicalToXSD(), LogReportingEventNormalize(), LogReportingEventSet(), LogReportingEventXSDToLogical()
property MessageType as %String;
Like EventType, this property is meant to describe the event that triggered the update. However this property is intended to be more granular. For example, a vaccination message is distinguished from a regular medication.
Property methods: MessageTypeDisplayToLogical(), MessageTypeGet(), MessageTypeGetStored(), MessageTypeIsValid(), MessageTypeLogicalToDisplay(), MessageTypeLogicalToOdbc(), MessageTypeNormalize(), MessageTypeSet()
property NewEncounterNumber as %String (MAXLEN = 220);
Passed in for A45 and A50 move/change encounter number
Property methods: NewEncounterNumberDisplayToLogical(), NewEncounterNumberGet(), NewEncounterNumberGetStored(), NewEncounterNumberIsValid(), NewEncounterNumberLogicalToDisplay(), NewEncounterNumberLogicalToOdbc(), NewEncounterNumberNormalize(), NewEncounterNumberSet()
property PriorEncounterAA as %String (MAXLEN = 64);
Passed in for A45 and A50 move/change encounter number
Property methods: PriorEncounterAADisplayToLogical(), PriorEncounterAAGet(), PriorEncounterAAGetStored(), PriorEncounterAAIsValid(), PriorEncounterAALogicalToDisplay(), PriorEncounterAALogicalToOdbc(), PriorEncounterAANormalize(), PriorEncounterAASet()
property PriorEncounterMRN as HS.Types.MRN;
Passed in for A45 and A50 move/change encounter number
Property methods: PriorEncounterMRNDisplayToLogical(), PriorEncounterMRNGet(), PriorEncounterMRNGetStored(), PriorEncounterMRNIsValid(), PriorEncounterMRNLogicalToDisplay(), PriorEncounterMRNLogicalToOdbc(), PriorEncounterMRNNormalize(), PriorEncounterMRNSet()
property PriorEncounterNumber as %String (MAXLEN = 220);
Passed in for A45 and A50 move/change encounter number
Property methods: PriorEncounterNumberDisplayToLogical(), PriorEncounterNumberGet(), PriorEncounterNumberGetStored(), PriorEncounterNumberIsValid(), PriorEncounterNumberLogicalToDisplay(), PriorEncounterNumberLogicalToOdbc(), PriorEncounterNumberNormalize(), PriorEncounterNumberSet()

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

^Ens.MessageBodyD(ID,"HS.Message.AddUpdateHubRequest.AAUpdateQ",n)
=
AAUpdateQ(n)

Storage Model: Storage (HS.Message.AddUpdateHubRequest)

^Ens.MessageBodyD(ID,"AddUpdateHubRequest")
=
MPIUpdate
InfoTypes
DoMPIUpdate
Facility
AssigningAuthority
FirstName
MPIID
DOB
Street
City
State
Zip
SSN
Telephone
LastName
MRN
MiddleName
Sex
GatewayName
DoPush
EventType
DeathStatus
EncounterTypes
ControlledIDList
IdentifiedClinicians
BusinessPhone
Race
CityOfBirth
DriversLicenseNumber
MothersMaidenSurname
BirthOrder
Identifiers
BirthPlace
MaritalStatus
ReligiousAffiliation
EthnicGroup
Language
VIP
Telecoms
Addresses
Prefix
Suffix
AddOrUpdate
Names
AuthBy
AuthType
BTGReason
RequestingUser
RequestingUserRoles
RequestingForProxyUserID
RequestingForProxyID
Signature
RequestId
RequestingGateway
Type
BreakTheGlass
ClinicalTypes
Consent
RemovePatient
DoDelete
SAMLData
LogReportingEvent
MessageType
CustomClassName
CustomXMLString
CommunicationPreference
CreatedBy
CreatedOn
LastEnteredBy
LastEnteredOn
DeathTime
FathersName
MothersName
SpousesName
Encounters
PriorEncounterNumber
NewEncounterNumber
PriorEncounterMRN
PriorEncounterAA
Extension
FeedAnalytics
DoFlash

Storage Model: Storage (HS.Message.AddUpdateHubRequest)

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

Storage Model: Storage (HS.Message.AddUpdateHubRequest)

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