Skip to main content

HS.Message.ExpirePatientRequest

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

SQL Table Name: HS_Message.ExpirePatientRequest

Property Inventory

Parameters

parameter FOUNDATION = 1;
parameter RESPONSECLASSNAME = HS.Message.ExpirePatientResponse;
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 AssigningAuthority as %String (MAXLEN = 512);
Assigning Authority for the MRN - temporarily updating the MAXLEN to support PIX / PDQ transformation to Request with a post conversion to the code
Property methods: AssigningAuthorityDisplayToLogical(), AssigningAuthorityGet(), AssigningAuthorityGetStored(), AssigningAuthorityIsValid(), AssigningAuthorityLogicalToDisplay(), AssigningAuthorityLogicalToOdbc(), AssigningAuthorityNormalize(), AssigningAuthoritySet()
property Facility as HS.Types.Facility;
Facility for this patient info
Property methods: FacilityDisplayToLogical(), FacilityGet(), FacilityGetStored(), FacilityIsValid(), FacilityLogicalToDisplay(), FacilityLogicalToOdbc(), FacilityNormalize(), FacilitySet()
property GatewayName as %String);
Property methods: GatewayNameDisplayToLogical(), GatewayNameGet(), GatewayNameGetStored(), GatewayNameIsValid(), GatewayNameLogicalToDisplay(), GatewayNameLogicalToOdbc(), GatewayNameNormalize(), GatewayNameSet()
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 MRN as HS.Types.MRN;
This patient's MRN (from the above assigning authority)
Property methods: MRNDisplayToLogical(), MRNGet(), MRNGetStored(), MRNIsValid(), MRNLogicalToDisplay(), MRNLogicalToOdbc(), MRNNormalize(), MRNSet()

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

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

Storage Model: Storage (HS.Message.ExpirePatientRequest)

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

Storage Model: Storage (HS.Message.ExpirePatientRequest)

^Ens.MessageBodyD(ID,"ExpirePatientRequest")
=
Facility
AssigningAuthority
MRN
GatewayName
LogReportingEvent
RequestingGateway
AuthBy
AuthType
BTGReason
RequestingUser
RequestingUserRoles
RequestingForProxyUserID
RequestingForProxyID
Signature
RequestId
Type
SAMLData
BreakTheGlass
ClinicalTypes
Consent
AuthRole
FeedbackOpens in a new tab