Skip to main content

HS.Message.Push.CreateClinicalMessageRequest

persistent class HS.Message.Push.CreateClinicalMessageRequest extends HS.Util.EnsRequest

SQL Table Name: HS_Message_Push.CreateClinicalMessageRequest

Not all fields will be available when creating the Clinical Message Request, depending on the source of the information Current uses include HS.IHE.XDR.Direct.Service and HS.Direct.SMTP.Services

Property Inventory

Properties

property Address as HS.Types.Address;
Property methods: AddressGet(), AddressGetObject(), AddressGetObjectId(), AddressGetStored(), AddressGetSwizzled(), AddressIsEmpty(), AddressIsValid(), AddressNewObject(), AddressSet(), AddressSetObject(), AddressSetObjectId(), AddressUnSwizzle()
property AssigningAuthority as %String;
Assigning Authority Code for the MRN
Property methods: AssigningAuthorityDisplayToLogical(), AssigningAuthorityGet(), AssigningAuthorityGetStored(), AssigningAuthorityIsValid(), AssigningAuthorityLogicalToDisplay(), AssigningAuthorityLogicalToOdbc(), AssigningAuthorityNormalize(), AssigningAuthoritySet()
property AssigningAuthorityOID as %String (MAXLEN = 255);
for direct input, we get the AA's OID, and will determine the AA, if needed, later
Property methods: AssigningAuthorityOIDDisplayToLogical(), AssigningAuthorityOIDGet(), AssigningAuthorityOIDGetStored(), AssigningAuthorityOIDIsValid(), AssigningAuthorityOIDLogicalToDisplay(), AssigningAuthorityOIDLogicalToOdbc(), AssigningAuthorityOIDNormalize(), AssigningAuthorityOIDSet()
property Attachments as list of HS.Push.Types.DocumentAttachment;
Property methods: AttachmentsBuildValueArray(), AttachmentsCollectionToDisplay(), AttachmentsCollectionToOdbc(), AttachmentsDisplayToCollection(), AttachmentsGet(), AttachmentsGetObject(), AttachmentsGetObjectId(), AttachmentsGetStored(), AttachmentsGetSwizzled(), AttachmentsIsValid(), AttachmentsOdbcToCollection(), AttachmentsSet(), AttachmentsSetObject(), AttachmentsSetObjectId()
property DOB as %Date (FORMAT = 3);
Property methods: DOBDisplayToLogical(), DOBGet(), DOBGetStored(), DOBIsValid(), DOBLogicalToDisplay(), DOBLogicalToOdbc(), DOBLogicalToXSD(), DOBNormalize(), DOBOdbcToLogical(), DOBSet(), DOBXSDToLogical()
property DemographicsResolved as %Boolean [ InitialExpression = 0 ];
Property methods: DemographicsResolvedDisplayToLogical(), DemographicsResolvedGet(), DemographicsResolvedGetStored(), DemographicsResolvedIsValid(), DemographicsResolvedLogicalToDisplay(), DemographicsResolvedLogicalToXSD(), DemographicsResolvedNormalize(), DemographicsResolvedSet(), DemographicsResolvedXSDToLogical()
property Facility as HS.Types.Facility;
Facility Code for this patient info
Property methods: FacilityDisplayToLogical(), FacilityGet(), FacilityGetStored(), FacilityIsValid(), FacilityLogicalToDisplay(), FacilityLogicalToOdbc(), FacilityNormalize(), FacilitySet()
property FacilityOID as %String (MAXLEN = 255);
for direct input, we get the facility's OID, and will determine the Facility, if needed, later
Property methods: FacilityOIDDisplayToLogical(), FacilityOIDGet(), FacilityOIDGetStored(), FacilityOIDIsValid(), FacilityOIDLogicalToDisplay(), FacilityOIDLogicalToOdbc(), FacilityOIDNormalize(), FacilityOIDSet()
property Gateway as %String (MAXLEN = 500);
Property methods: GatewayDisplayToLogical(), GatewayGet(), GatewayGetStored(), GatewayIsValid(), GatewayLogicalToDisplay(), GatewayLogicalToOdbc(), GatewayNormalize(), GatewaySet()
property Identifiers as %String (MAXLEN = 500);
A string with misc. identifiers. Can be populated from XDR Local ID
Property methods: IdentifiersDisplayToLogical(), IdentifiersGet(), IdentifiersGetStored(), IdentifiersIsValid(), IdentifiersLogicalToDisplay(), IdentifiersLogicalToOdbc(), IdentifiersNormalize(), IdentifiersSet()
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()
property PatientName as %String (MAXLEN = 60);
Patient's name. Preferred format is last,first
Property methods: PatientNameDisplayToLogical(), PatientNameGet(), PatientNameGetStored(), PatientNameIsValid(), PatientNameLogicalToDisplay(), PatientNameLogicalToOdbc(), PatientNameNormalize(), PatientNameSet()
property SecureMessage as %String);
message text
Property methods: SecureMessageDisplayToLogical(), SecureMessageGet(), SecureMessageGetStored(), SecureMessageIsValid(), SecureMessageLogicalToDisplay(), SecureMessageLogicalToOdbc(), SecureMessageNormalize(), SecureMessageSet()
property SenderEmail as %String (MAXLEN = 256);
Property methods: SenderEmailDisplayToLogical(), SenderEmailGet(), SenderEmailGetStored(), SenderEmailIsValid(), SenderEmailLogicalToDisplay(), SenderEmailLogicalToOdbc(), SenderEmailNormalize(), SenderEmailSet()
property SenderName as %String (MAXLEN = 256);
Sender's name. Preferred format is last,first
Property methods: SenderNameDisplayToLogical(), SenderNameGet(), SenderNameGetStored(), SenderNameIsValid(), SenderNameLogicalToDisplay(), SenderNameLogicalToOdbc(), SenderNameNormalize(), SenderNameSet()
property Sent as %TimeStamp;
Property methods: SentDisplayToLogical(), SentGet(), SentGetStored(), SentIsValid(), SentLogicalToDisplay(), SentLogicalToXSD(), SentNormalize(), SentOdbcToLogical(), SentSet(), SentXSDToLogical()
property Sex as %String;
Property methods: SexDisplayToLogical(), SexGet(), SexGetStored(), SexIsValid(), SexLogicalToDisplay(), SexLogicalToOdbc(), SexNormalize(), SexSet()
property Source as %String (MAXLEN = 256);
Used for audit For XDR documents, will indicate some description about the HISP
Property methods: SourceDisplayToLogical(), SourceGet(), SourceGetStored(), SourceIsValid(), SourceLogicalToDisplay(), SourceLogicalToOdbc(), SourceNormalize(), SourceSet()
property Subject as %String (MAXLEN = 256);
Property methods: SubjectDisplayToLogical(), SubjectGet(), SubjectGetStored(), SubjectIsValid(), SubjectLogicalToDisplay(), SubjectLogicalToOdbc(), SubjectNormalize(), SubjectSet()
property To as list of %String (MAXLEN = 256);
Property methods: ToBuildValueArray(), ToCollectionToDisplay(), ToCollectionToOdbc(), ToDisplayToCollection(), ToDisplayToLogical(), ToGet(), ToGetObject(), ToGetObjectId(), ToGetStored(), ToGetSwizzled(), ToIsValid(), ToLogicalToDisplay(), ToLogicalToOdbc(), ToNormalize(), ToOdbcToCollection(), ToSet(), ToSetObject(), ToSetObjectId()

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.Push.CreateClinicalMessageRequest)

^Ens.MessageBodyD(ID,"XDRDocumentCreateAndRegister")
=
SenderEmail
Subject
SecureMessage
Sent
Source
AssigningAuthority
MRN
LastName
FirstName
Identifiers
Address
Sex
DOB
Attachments
To
SenderName
PatientName
Gateway
Facility
FacilityOID
AssigningAuthorityOID
DemographicsResolved
FeedbackOpens in a new tab