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

HS.Message.IHE.XDSb.Metadata

persistent class HS.Message.IHE.XDSb.Metadata extends HS.Message.XMLMessage, HS.Util.EnsRequest, HS.Types.RequestInfo

SQL Table Name: HS_Message_IHE_XDSb.Metadata

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

Property Inventory

Parameters

parameter RESPONSECLASSNAME = HS.Message.IHE.XDSb.Metadata;
Default response class
parameter XMLIGNORENULL = inputonly;
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.

Properties

property Associations as list of HS.Types.IHE.XDSb.Association (XMLNAME = "Association", XMLPROJECTION = "ELEMENT");
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);
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 DirectMetadataLevel as %String;
Property methods: DirectMetadataLevelDisplayToLogical(), DirectMetadataLevelGet(), DirectMetadataLevelGetStored(), DirectMetadataLevelIsValid(), DirectMetadataLevelLogicalToDisplay(), DirectMetadataLevelLogicalToOdbc(), DirectMetadataLevelNormalize(), DirectMetadataLevelSet()
property DirectTo as list of %String);
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.Types.IHE.XDSb.Document (XMLNAME = "Document", XMLPROJECTION = "ELEMENT");
Property methods: DocumentsBuildValueArray(), DocumentsCollectionToDisplay(), DocumentsCollectionToOdbc(), DocumentsDisplayToCollection(), DocumentsGet(), DocumentsGetObject(), DocumentsGetObjectId(), DocumentsGetStored(), DocumentsGetSwizzled(), DocumentsIsValid(), DocumentsOdbcToCollection(), DocumentsSet(), DocumentsSetObject(), DocumentsSetObjectId()
property Errors as HS.Types.IHE.Errors;
Property methods: ErrorsGet(), ErrorsGetObject(), ErrorsGetObjectId(), ErrorsGetStored(), ErrorsGetSwizzled(), ErrorsIsEmpty(), ErrorsIsValid(), ErrorsNewObject(), ErrorsSet(), ErrorsSetObject(), ErrorsSetObjectId(), ErrorsUnSwizzle()
property Folders as list of HS.Types.IHE.XDSb.Folder (XMLNAME = "Folder", XMLPROJECTION = "ELEMENT");
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()
property ObjectRefs as list of HS.Message.IHE.XDSb.ObjectRef (XMLNAME = "ObjectRef", XMLPROJECTION = "ELEMENT");
Property methods: ObjectRefsBuildValueArray(), ObjectRefsCollectionToDisplay(), ObjectRefsCollectionToOdbc(), ObjectRefsDisplayToCollection(), ObjectRefsGet(), ObjectRefsGetObject(), ObjectRefsGetObjectId(), ObjectRefsGetStored(), ObjectRefsGetSwizzled(), ObjectRefsIsValid(), ObjectRefsOdbcToCollection(), ObjectRefsSet(), ObjectRefsSetObject(), ObjectRefsSetObjectId()
property RelatedDocuments as list of HS.Types.IHE.XDSb.Document (XMLNAME = "RelatedDocument", XMLPROJECTION = "ELEMENT");
Property methods: RelatedDocumentsBuildValueArray(), RelatedDocumentsCollectionToDisplay(), RelatedDocumentsCollectionToOdbc(), RelatedDocumentsDisplayToCollection(), RelatedDocumentsGet(), RelatedDocumentsGetObject(), RelatedDocumentsGetObjectId(), RelatedDocumentsGetStored(), RelatedDocumentsGetSwizzled(), RelatedDocumentsIsValid(), RelatedDocumentsOdbcToCollection(), RelatedDocumentsSet(), RelatedDocumentsSetObject(), RelatedDocumentsSetObjectId()
property Status as %String (MAXLEN = 255);
Upper level status value for some responses
Property methods: StatusDisplayToLogical(), StatusGet(), StatusGetStored(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
property Submissions as list of HS.Types.IHE.XDSb.Submission (XMLNAME = "Submission", XMLPROJECTION = "ELEMENT");
Used for converting Message to Provide & Register - could be multiple submissions (in error)
Property methods: SubmissionsBuildValueArray(), SubmissionsCollectionToDisplay(), SubmissionsCollectionToOdbc(), SubmissionsDisplayToCollection(), SubmissionsGet(), SubmissionsGetObject(), SubmissionsGetObjectId(), SubmissionsGetStored(), SubmissionsGetSwizzled(), SubmissionsIsValid(), SubmissionsOdbcToCollection(), SubmissionsSet(), SubmissionsSetObject(), SubmissionsSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (HS.Message.XMLMessage)

^HS.Message.XMLMessageD(ID,"AdditionalInfo",n)
=
AdditionalInfo(n)

Storage Model: Storage (HS.Message.XMLMessage)

^HS.Message.XMLMessageD(ID,"CustomAuditInfo",n)
=
CustomAuditInfo(n)

Storage Model: Storage (HS.Message.XMLMessage)

^HS.Message.XMLMessageD(ID,"HS.Message.XMLMessage.Values",n)
=
Values(n)

Storage Model: Storage (HS.Message.XMLMessage)

^HS.Message.XMLMessageD(ID,"XMLMessage")
=
Content
DocType
Name
Source
Action
ContentStream
%%CLASSNAME
StreamCollection
SOAPFault
SAMLData
UseQuickStream

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

^HS.Message.XMLMessageD(ID,"HS.Message.IHE.XDSb.Metadata.AdditionalInfo",n)
=
AdditionalInfo(n)

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

^HS.Message.XMLMessageD(ID,"Metadata")
=
BreakTheGlass
Consent
Associations
AuthType
BTGReason
RequestingForProxyUserID
GenerateProvideAndRegisterOnly
Language
DirectFrom
DirectTo
Type
SAMLData
AuthBy
ClinicalTypes
Documents
Folders
RequestId
RequestingForProxyID
RequestingGateway
RequestingUser
RequestingUserRoles
Signature
Submissions
RelatedDocuments
HSCoreVersion
HSMinVersion
ObjectRefs
Errors
Status
DirectMetadataLevel
%ClearFields
FeedbackOpens in a new window