Home > Class Reference > HSLIB namespace > HS.Message.IHE.XDSb.ProvideAndRegisterRequest

HS.Message.IHE.XDSb.ProvideAndRegisterRequest

persistent class HS.Message.IHE.XDSb.ProvideAndRegisterRequest extends HS.Util.EnsRequest, HS.Types.RequestInfo, HS.IHE.XDSb.Types.Submission

SQL Table Name: HS_Message_IHE_XDSb.ProvideAndRegisterRequest

Request object which will be used with a transformation to produce valid metadata for the XDSb.Registry Provide and Register Request

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter FOUNDATION = 1;
HealthShare Foundation
parameter RESPONSECLASSNAME = HS.Message.XMLMessage;
Default response class

Properties (Including Private)

property Associations as list of HS.Message.IHE.XDSb.Association;
The system will automatically calculate associations, document to submission, additional associations (folders / signs) can be inserted and will be included
Property methods: AssociationsBuildValueArray(), AssociationsCollectionToDisplay(), AssociationsCollectionToOdbc(), AssociationsDisplayToCollection(), AssociationsGet(), AssociationsGetObject(), AssociationsGetObjectId(), AssociationsGetStored(), AssociationsGetSwizzled(), AssociationsIsValid(), AssociationsOdbcToCollection(), AssociationsSet(), AssociationsSetObject(), AssociationsSetObjectId()
property DirectFrom as %String (MAXLEN = 254);
optional direct from (email) address when sending to a HISP - which will be inserted into the soap header on a P&R request
Property methods: DirectFromDisplayToLogical(), DirectFromGet(), DirectFromGetStored(), DirectFromIsValid(), DirectFromLogicalToDisplay(), DirectFromLogicalToOdbc(), DirectFromNormalize(), DirectFromSet()
property DirectTo as list of %String (MAXLEN = 254);
optional direct to (email) address when sending to a HISP - which will be inserted into the soap header on a P&R request
Property methods: DirectToBuildValueArray(), DirectToCollectionToDisplay(), DirectToCollectionToOdbc(), DirectToDisplayToCollection(), DirectToDisplayToLogical(), DirectToGet(), DirectToGetObject(), DirectToGetObjectId(), DirectToGetStored(), DirectToGetSwizzled(), DirectToIsValid(), DirectToLogicalToDisplay(), DirectToLogicalToOdbc(), DirectToNormalize(), DirectToOdbcToCollection(), DirectToSet(), DirectToSetObject(), DirectToSetObjectId()
property Documents as list of HS.Message.IHE.XDSb.Document;
Property methods: DocumentsBuildValueArray(), DocumentsCollectionToDisplay(), DocumentsCollectionToOdbc(), DocumentsDisplayToCollection(), DocumentsGet(), DocumentsGetObject(), DocumentsGetObjectId(), DocumentsGetStored(), DocumentsGetSwizzled(), DocumentsIsValid(), DocumentsOdbcToCollection(), DocumentsSet(), DocumentsSetObject(), DocumentsSetObjectId()
property Folders as list of HS.Message.IHE.XDSb.Folder;
Any folders inserted will also require associations
Property methods: FoldersBuildValueArray(), FoldersCollectionToDisplay(), FoldersCollectionToOdbc(), FoldersDisplayToCollection(), FoldersGet(), FoldersGetObject(), FoldersGetObjectId(), FoldersGetStored(), FoldersGetSwizzled(), FoldersIsValid(), FoldersOdbcToCollection(), FoldersSet(), FoldersSetObject(), FoldersSetObjectId()
property GenerateProvideAndRegisterOnly as %Boolean [ InitialExpression = 0 ];
One example - when trying to generate a signature, the P&R request is required to generate it and insert as another document
Property methods: GenerateProvideAndRegisterOnlyDisplayToLogical(), GenerateProvideAndRegisterOnlyGet(), GenerateProvideAndRegisterOnlyGetStored(), GenerateProvideAndRegisterOnlyIsValid(), GenerateProvideAndRegisterOnlyLogicalToDisplay(), GenerateProvideAndRegisterOnlyLogicalToXSD(), GenerateProvideAndRegisterOnlyNormalize(), GenerateProvideAndRegisterOnlySet(), GenerateProvideAndRegisterOnlyXSDToLogical()
property Language as %String;
Language used for LocalizedString elements
Property methods: LanguageDisplayToLogical(), LanguageGet(), LanguageGetStored(), LanguageIsValid(), LanguageLogicalToDisplay(), LanguageLogicalToOdbc(), LanguageNormalize(), LanguageSet()

Methods (Including Private)

private method %OnNew(initvalue As %Library.RawString) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

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.IHE.XDSb.ProvideAndRegisterRequest)

^Ens.MessageBodyD(ID,"HS.Message.IHE.XDSb.ProvideAndRegisterRequest.AdditionalInfo",n)
=
AdditionalInfo(n)

Storage Model: Storage (HS.Message.IHE.XDSb.ProvideAndRegisterRequest)

^Ens.MessageBodyD(ID,"HS.Message.IHE.XDSb.ProvideAndRegisterRequest.CustomAuditInfo",n)
=
CustomAuditInfo(n)

Storage Model: Storage (HS.Message.IHE.XDSb.ProvideAndRegisterRequest)

^Ens.MessageBodyD(ID,"ProvideAndRegisterRequest")
=
AuthBy
AuthType
BTGReason
Documents
Body
BodyCharacter
RequestingForProxyID
Author
AvailabilityStatus
ClassCode
Comments
ConfidentialityCode
CreationTime
EventCodeList
FormatCode
Hash
HealthcareFacilityTypeCode
LanguageCode
LegalAuthenticator
MimeType
ObjectType
PracticeSettingCode
RepositoryUniqueId
ServiceStartTime
ServiceStopTime
Size
SourcePatientId
SourcePatientInfo
Title
TypeCode
UniqueId
URI
XOP
BreakTheGlass
ClinicalTypes
Consent
ContentTypeCode
Context
EntryUUID
HomeCommunityId
PatientId
RequestId
RequestingForProxyUserID
RequestingGateway
RequestingUser
RequestingUserRoles
Signature
Snapshot
SourceOID
SubmissionEntryUUID
SubmissionUniqueId
Type
IntendedRecipient
SourceId
SubmissionTime
Submissions
Folders
ObjectRefs
Associations
Errors
GenerateProvideAndRegisterOnly
Language
SAMLData
DirectFrom
DirectTo
SubmissionSlots

Subclasses

Feedback