Skip to main content

HS.Message.IHE.XDSb.Document

serial class HS.Message.IHE.XDSb.Document extends %Library.SerialObject, HS.IHE.XDSb.Types.Document

Property Inventory

Parameters

parameter FOUNDATION = 1;
HealthShare Foundation
parameter XMLTYPE = ProvidedDocument;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property EntryUUID as %String) [ InitialExpression = ##class(HS.Util.XSLTHelper).createUUID() ];
calculated UUID for the document
Property methods: EntryUUIDDisplayToLogical(), EntryUUIDGet(), EntryUUIDIsValid(), EntryUUIDLogicalToDisplay(), EntryUUIDLogicalToOdbc(), EntryUUIDNormalize(), EntryUUIDSet()
property LogicalUUID as %String);
logicalUUID is the common id for documents when using metadata update - no default
Property methods: LogicalUUIDDisplayToLogical(), LogicalUUIDGet(), LogicalUUIDIsValid(), LogicalUUIDLogicalToDisplay(), LogicalUUIDLogicalToOdbc(), LogicalUUIDNormalize(), LogicalUUIDSet()
property ReplaceSource as %String (MAXLEN = 75);
if the document uuid is known assign it to the ReplaceSource, otherwise the ReplacementContext can be used to locate the document
Property methods: ReplaceSourceDisplayToLogical(), ReplaceSourceGet(), ReplaceSourceIsValid(), ReplaceSourceLogicalToDisplay(), ReplaceSourceLogicalToOdbc(), ReplaceSourceNormalize(), ReplaceSourceSet()
property ReplacementContext as list of HS.Message.IHE.XDSb.QueryItem;
Key Value pair of items to locate the existing document Valid values include $XDSDocumentEntryEntryUUID $XDSDocumentEntryUniqueId $XDSDocumentEntryPracticeSettingCode $XDSDocumentEntryClassificationNode $XDSDocumentEntryClassCode $XDSDocumentEntryConfidentialityCode $XDSDocumentEntryEventCodeList $XDSDocumentEntryFormatCode $XDSDocumentEntryHealthcareFacilityTypeCode $XDSDocumentEntryTypeCode $XDSDocumentEntryType $XDSDocumentEntryPatientId $XDSDocumentEntryAuthorPerson $XDSDocumentEntryServiceStartTimeFrom $XDSDocumentEntryServiceStartTimeTo $XDSDocumentEntryServiceStopTimeFrom $XDSDocumentEntryServiceStopTimeTo $XDSDocumentEntryStatus (will default to Approved)
Property methods: ReplacementContextBuildValueArray(), ReplacementContextCollectionToDisplay(), ReplacementContextCollectionToOdbc(), ReplacementContextDisplayToCollection(), ReplacementContextGet(), ReplacementContextGetObject(), ReplacementContextGetObjectId(), ReplacementContextGetSwizzled(), ReplacementContextIsValid(), ReplacementContextOdbcToCollection(), ReplacementContextSet(), ReplacementContextSetObject(), ReplacementContextSetObjectId()
property UniqueId as %String) [ InitialExpression = ##class(HS.Util.XSLTHelper).uuid2oid(..EntryUUID) ];
calculated OID for the document (based on the UUID)
Property methods: UniqueIdDisplayToLogical(), UniqueIdGet(), UniqueIdIsValid(), UniqueIdLogicalToDisplay(), UniqueIdLogicalToOdbc(), UniqueIdNormalize(), UniqueIdSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab