HS.Types.IHE.DSUB.Subscription

class HS.Types.IHE.DSUB.Subscription extends %Library.RegisteredObject

Property Inventory

Method Inventory

Properties

property FilterItems as list of HS.Types.IHE.DSUB.SubscriptionItems (XMLNAME = "FilterItems", XMLPROJECTION = "ELEMENT");
A collection of items to filter by in the subscription
Property methods: FilterItemsBuildValueArray(), FilterItemsCollectionToDisplay(), FilterItemsCollectionToOdbc(), FilterItemsDisplayToCollection(), FilterItemsGet(), FilterItemsGetObject(), FilterItemsGetObjectId(), FilterItemsGetSwizzled(), FilterItemsIsValid(), FilterItemsOdbcToCollection(), FilterItemsSet(), FilterItemsSetObject(), FilterItemsSetObjectId()
property PatientID as %String) [ Required ];
ID^^^&oid&ISO
Property methods: PatientIDDisplayToLogical(), PatientIDGet(), PatientIDIsValid(), PatientIDLogicalToDisplay(), PatientIDLogicalToOdbc(), PatientIDNormalize(), PatientIDSet()
property RecipientAddress as %String) [ Required ];
This is the URL where notifications will be sent
Property methods: RecipientAddressDisplayToLogical(), RecipientAddressGet(), RecipientAddressIsValid(), RecipientAddressLogicalToDisplay(), RecipientAddressLogicalToOdbc(), RecipientAddressNormalize(), RecipientAddressSet()
property TerminationTime as %String;
Termination Time (when the subscription will be complete), local time of subscription expiration. Could be a duration in the subscription request (but then converted)
Property methods: TerminationTimeDisplayToLogical(), TerminationTimeGet(), TerminationTimeIsValid(), TerminationTimeLogicalToDisplay(), TerminationTimeLogicalToOdbc(), TerminationTimeNormalize(), TerminationTimeSet()
property Topic as %String (DISPLAYLIST = ",ihe:FullDocumentEntry,ihe:MinimalDocumentEntry,ihe:SubmissionSetMetadata", VALUELIST = ",F,M,S", XMLLISTPARAMETER = "DISPLAYLIST") [ InitialExpression = "M" , Required ];
full notification or minimal (returns a retrieve document request with repo, doc and home community)
Property methods: TopicDisplayToLogical(), TopicGet(), TopicIsValid(), TopicLogicalToDisplay(), TopicLogicalToOdbc(), TopicNormalize(), TopicSet()
property Type as %String (DISPLAYLIST = ",urn:uuid:aa2332d0-f8fe-11e0-be50-0800200c9a66,urn:uuid:9376254e-da05-41f5-9af3-ac56d63d8ebd,urn:uuid:fbede94e-dbdc-4f6b-bc1f-d730e677cece", VALUELIST = ",Document,Folder,Submission", XMLLISTPARAMETER = "DISPLAYLIST") [ Required ];
Document / Folder / Submission
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()

Methods

classmethod GetTerminationTime(pTerminationTime="", pDefaultDuration="", ByRef pAdjustedTerminationTime) as %Status
pTerminationTime (either UTC or UTC+offset, or converted local, or P (coded pattern) pDefaultDuration (maximum time based on coded pattern, ie P1Y - duration is 1 year from now) pAdjustedTerminationTime (new time in UTC) YYYY-MM-DDTHH:MM:SS[.sss]
classmethod GetTerminationTimeDuration(pTerminationTime="", ByRef pAdjustedTerminationTime="") as %Status
pTermination time is a coded pattern P* which may contain Year/Month/Day/Hour/Min/Second offset, Add this offset to the current UTC date/time
classmethod GetTerminationTimeTime(ByRef pTerminationTime="", ByRef pAdjustedTerminationTime="") as %Status
Convert given time to UTC

Inherited Members

Inherited Methods

Subclasses

Feedback