Skip to main content

HS.Registry.Document

persistent class HS.Registry.Document extends %Library.Persistent, %XML.Adaptor

SQL Table Name: HS_Registry.Document

Property Inventory

Method Inventory

Parameters

parameter DOMAIN = HS;
parameter DSINTERVAL = 5;
Inherited description: DSINTERVAL is the number of seconds between one DSTIME value and the next. The DSTIME value for DSINTERVAL > 0 is computed from $ZTIMESTAMP and is the number of seconds from day 0, time 0 to the nearest interval, rounded down. Using an interval has the effect of grouping all DSTIME entries for the class in some number of seconds.
parameter DSTIME = AUTO;
Inherited description: If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value for each object will be recorded in a global, ^OBJ.DSTIME:
^OBJ.DSTIME(ExtentName,DSTIME,objectID) = filing operation
For DSTIME=AUTO the DSTIME value is recorded in ^OBJ.DSTIME and is set by the consumer of DSTIME data.
Refer to %DeepSee documentation for more information on how DSTIME is used by %DeepSee.
The filing operations are:
CodeOperation
0Update
1Insert
2Delete

If the DSTIME parameter is set to MANUAL then the user is responsible for journaling object filing operations. If DSTIME is set to "CONDITIONAL", the user is expected to define the parameter DSCONDITION setting it to an expression which will determine if the actions performed when DSTIME is set to AUTO will execute or not
parameter XMLIGNOREINVALIDTAG = 1;
Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
parameter XMLIGNORENULL = 1;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

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.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.

Properties

property Attributes as array of %String (MAXLEN = 32000, STORAGEDEFAULT = "array", XMLNAME = "Attributes", XMLPROJECTION = "ELEMENT");
Property methods: AttributesBuildValueArray(), AttributesCollectionToDisplay(), AttributesCollectionToOdbc(), AttributesDisplayToCollection(), AttributesDisplayToLogical(), AttributesGet(), AttributesGetObject(), AttributesGetObjectId(), AttributesGetStored(), AttributesGetSwizzled(), AttributesIsValid(), AttributesLogicalToDisplay(), AttributesLogicalToOdbc(), AttributesNormalize(), AttributesOdbcToCollection(), AttributesSet(), AttributesSetObject(), AttributesSetObjectId()
property Availability as %String (DISPLAYLIST = ",urn:ihe:iti:2010:DocumentAvailability:Offline,urn:ihe:iti:2010:DocumentAvailability:Online", VALUELIST = ",0,1", XMLLISTPARAMETER = "DISPLAYLIST") [ InitialExpression = 1 ];
1 - online, 0 - Offline
Property methods: AvailabilityDisplayToLogical(), AvailabilityGet(), AvailabilityGetStored(), AvailabilityIsValid(), AvailabilityLogicalToDisplay(), AvailabilityLogicalToOdbc(), AvailabilityLogicalToXSD(), AvailabilityNormalize(), AvailabilitySet(), AvailabilityXSDToLogical()
Property methods: ClassCodeGet(), ClassCodeGetObject(), ClassCodeGetObjectId(), ClassCodeGetStored(), ClassCodeGetSwizzled(), ClassCodeIsEmpty(), ClassCodeIsValid(), ClassCodeNewObject(), ClassCodeSet(), ClassCodeSetObject(), ClassCodeSetObjectId(), ClassCodeUnSwizzle()
relationship Classifications as array of HS.Registry.Document.Classification (XMLNAME = "Classification", XMLPROJECTION = "ELEMENT") [ InitialExpression = $listbuild("HS.Registry.Document.Classification","Document",+$this,"many",1,1) , Transient , Inverse = Document , Cardinality = many ];
Property methods: ClassificationsGet(), ClassificationsGetObject(), ClassificationsGetObjectId(), ClassificationsGetSwizzled(), ClassificationsIsEmpty(), ClassificationsIsValid(), ClassificationsNewObject(), ClassificationsRClose(), ClassificationsRExec(), ClassificationsRFetch(), ClassificationsRelate(), ClassificationsSQLCompute(), ClassificationsSet(), ClassificationsUnRelate()
property Comments as HS.Registry.Document.Type.ValueType (XMLNAME = "Comments", XMLPROJECTION = "ELEMENT");
Property methods: CommentsGet(), CommentsGetObject(), CommentsGetObjectId(), CommentsGetStored(), CommentsGetSwizzled(), CommentsIsEmpty(), CommentsIsValid(), CommentsNewObject(), CommentsSet(), CommentsSetObject(), CommentsSetObjectId(), CommentsUnSwizzle()
property CreationTime as %String;
Property methods: CreationTimeDayCompute(), CreationTimeDayDisplayToLogical(), CreationTimeDayGet(), CreationTimeDayIsValid(), CreationTimeDayLogicalToDisplay(), CreationTimeDayNormalize(), CreationTimeDaySQLCompute(), CreationTimeDayXSDToLogical(), CreationTimeDisplayToLogical(), CreationTimeGet(), CreationTimeGetStored(), CreationTimeIndexExists(), CreationTimeInternalDisplayToLogical(), CreationTimeInternalGet(), CreationTimeInternalGetStored(), CreationTimeInternalIndexExists(), CreationTimeInternalIsValid(), CreationTimeInternalLogicalToDisplay(), CreationTimeInternalLogicalToOdbc(), CreationTimeInternalNormalize(), CreationTimeInternalSet(), CreationTimeIsValid(), CreationTimeLogicalToDisplay(), CreationTimeLogicalToOdbc(), CreationTimeMonthCompute(), CreationTimeMonthDisplayToLogical(), CreationTimeMonthGet(), CreationTimeMonthIsValid(), CreationTimeMonthLogicalToDisplay(), CreationTimeMonthNormalize(), CreationTimeMonthSQLCompute(), CreationTimeMonthXSDToLogical(), CreationTimeNormalize(), CreationTimeSet(), CreationTimeYearCompute(), CreationTimeYearDisplayToLogical(), CreationTimeYearGet(), CreationTimeYearIsValid(), CreationTimeYearLogicalToDisplay(), CreationTimeYearNormalize(), CreationTimeYearSQLCompute(), CreationTimeYearXSDToLogical()
property CreationTimeDay as %Integer [ Calculated ];
Property methods: CreationTimeDayCompute(), CreationTimeDayDisplayToLogical(), CreationTimeDayGet(), CreationTimeDayIsValid(), CreationTimeDayLogicalToDisplay(), CreationTimeDayNormalize(), CreationTimeDaySQLCompute(), CreationTimeDayXSDToLogical()
property CreationTimeInternal as %String [ InitialExpression = $tr($zdt($H,8)," :") ];
since creationtime is not always accurate
Property methods: CreationTimeInternalDisplayToLogical(), CreationTimeInternalGet(), CreationTimeInternalGetStored(), CreationTimeInternalIndexExists(), CreationTimeInternalIsValid(), CreationTimeInternalLogicalToDisplay(), CreationTimeInternalLogicalToOdbc(), CreationTimeInternalNormalize(), CreationTimeInternalSet()
property CreationTimeMonth as %Integer [ Calculated ];
Property methods: CreationTimeMonthCompute(), CreationTimeMonthDisplayToLogical(), CreationTimeMonthGet(), CreationTimeMonthIsValid(), CreationTimeMonthLogicalToDisplay(), CreationTimeMonthNormalize(), CreationTimeMonthSQLCompute(), CreationTimeMonthXSDToLogical()
property CreationTimeYear as %Integer [ Calculated ];
Property methods: CreationTimeYearCompute(), CreationTimeYearDisplayToLogical(), CreationTimeYearGet(), CreationTimeYearIsValid(), CreationTimeYearLogicalToDisplay(), CreationTimeYearNormalize(), CreationTimeYearSQLCompute(), CreationTimeYearXSDToLogical()
property Description as list of HS.Registry.Document.Type.ValueType (XMLNAME = "Description", XMLPROJECTION = "ELEMENT");
Property methods: DescriptionBuildValueArray(), DescriptionCollectionToDisplay(), DescriptionCollectionToOdbc(), DescriptionDisplayToCollection(), DescriptionGet(), DescriptionGetObject(), DescriptionGetObjectId(), DescriptionGetStored(), DescriptionGetSwizzled(), DescriptionIsValid(), DescriptionOdbcToCollection(), DescriptionSet(), DescriptionSetObject(), DescriptionSetObjectId()
property DocumentID as %String (MAXLEN = 128);
Deprecated, use DocumentUniqueIdentifier.Value
Property methods: DocumentIDDisplayToLogical(), DocumentIDGet(), DocumentIDGetStored(), DocumentIDIndexExists(), DocumentIDIsValid(), DocumentIDLogicalToDisplay(), DocumentIDLogicalToOdbc(), DocumentIDNormalize(), DocumentIDSet(), DocumentIDsForPatient()
property DocumentUniqueIdentifier as HS.Types.IHE.XDSb.SerialExternalIdentifier;
Property methods: DocumentUniqueIdentifierGet(), DocumentUniqueIdentifierGetObject(), DocumentUniqueIdentifierGetObjectId(), DocumentUniqueIdentifierGetStored(), DocumentUniqueIdentifierGetSwizzled(), DocumentUniqueIdentifierIndexExists(), DocumentUniqueIdentifierIsEmpty(), DocumentUniqueIdentifierIsValid(), DocumentUniqueIdentifierNewObject(), DocumentUniqueIdentifierSet(), DocumentUniqueIdentifierSetObject(), DocumentUniqueIdentifierSetObjectId(), DocumentUniqueIdentifierUnSwizzle()
property ExternalIdentifiers as list of HS.Registry.Document.ExternalIdentifier (XMLNAME = "ExternalIdentifier", XMLPROJECTION = "ELEMENT");
Property methods: ExternalIdentifiersBuildValueArray(), ExternalIdentifiersCollectionToDisplay(), ExternalIdentifiersCollectionToOdbc(), ExternalIdentifiersDisplayToCollection(), ExternalIdentifiersGet(), ExternalIdentifiersGetObject(), ExternalIdentifiersGetObjectId(), ExternalIdentifiersGetStored(), ExternalIdentifiersGetSwizzled(), ExternalIdentifiersIsValid(), ExternalIdentifiersOdbcToCollection(), ExternalIdentifiersSet(), ExternalIdentifiersSetObject(), ExternalIdentifiersSetObjectId()
property FormatCode as HS.Types.IHE.XDSb.SerialClassification;
Property methods: FormatCodeGet(), FormatCodeGetObject(), FormatCodeGetObjectId(), FormatCodeGetStored(), FormatCodeGetSwizzled(), FormatCodeIsEmpty(), FormatCodeIsValid(), FormatCodeNewObject(), FormatCodeSet(), FormatCodeSetObject(), FormatCodeSetObjectId(), FormatCodeUnSwizzle()
property Hash as %String;
Property methods: HashDisplayToLogical(), HashForIID(), HashGet(), HashGetStored(), HashIsValid(), HashLogicalToDisplay(), HashLogicalToOdbc(), HashNormalize(), HashSet()
property HealthCareFacilityTypeCode as HS.Types.IHE.XDSb.SerialClassification;
Property methods: HealthCareFacilityTypeCodeGet(), HealthCareFacilityTypeCodeGetObject(), HealthCareFacilityTypeCodeGetObjectId(), HealthCareFacilityTypeCodeGetStored(), HealthCareFacilityTypeCodeGetSwizzled(), HealthCareFacilityTypeCodeIsEmpty(), HealthCareFacilityTypeCodeIsValid(), HealthCareFacilityTypeCodeNewObject(), HealthCareFacilityTypeCodeSet(), HealthCareFacilityTypeCodeSetObject(), HealthCareFacilityTypeCodeSetObjectId(), HealthCareFacilityTypeCodeUnSwizzle()
property IID as %String (MAXLEN = 256, XMLNAME = "id", XMLPROJECTION = "ATTRIBUTE");
known as id in the provide and register / register
Property methods: IIDDisplayToLogical(), IIDForUniqueID(), IIDGet(), IIDGetStored(), IIDIndexCheck(), IIDIndexCheckUnique(), IIDIndexDelete(), IIDIndexExists(), IIDIndexOpen(), IIDIndexSQLCheckUnique(), IIDIndexSQLExists(), IIDIndexSQLFindPKeyByConstraint(), IIDIndexSQLFindRowIDByConstraint(), IIDIsValid(), IIDLogicalToDisplay(), IIDLogicalToOdbc(), IIDNormalize(), IIDSet()
property LanguageCode as %String;
Property methods: LanguageCodeDisplayToLogical(), LanguageCodeGet(), LanguageCodeGetStored(), LanguageCodeIsValid(), LanguageCodeLogicalToDisplay(), LanguageCodeLogicalToOdbc(), LanguageCodeNormalize(), LanguageCodeSet()
property LastUpdateTimeInternal as %String;
last time document was updated
Property methods: LastUpdateTimeInternalDisplayToLogical(), LastUpdateTimeInternalGet(), LastUpdateTimeInternalGetStored(), LastUpdateTimeInternalIndexExists(), LastUpdateTimeInternalIsValid(), LastUpdateTimeInternalLogicalToDisplay(), LastUpdateTimeInternalLogicalToOdbc(), LastUpdateTimeInternalNormalize(), LastUpdateTimeInternalSet()
property LogicalIID as %String (MAXLEN = 256, XMLNAME = "lid", XMLPROJECTION = "ATTRIBUTE");
Property methods: LogicalIIDDisplayToLogical(), LogicalIIDGet(), LogicalIIDGetStored(), LogicalIIDIndexExists(), LogicalIIDIsValid(), LogicalIIDLogicalToDisplay(), LogicalIIDLogicalToOdbc(), LogicalIIDNormalize(), LogicalIIDSet()
property MimeType as %String;
Property methods: MimeTypeDisplayToLogical(), MimeTypeGet(), MimeTypeGetStored(), MimeTypeIsValid(), MimeTypeLogicalToDisplay(), MimeTypeLogicalToOdbc(), MimeTypeNormalize(), MimeTypeSet()
property Name as list of HS.Registry.Document.Type.ValueType (STORAGEDEFAULT = "array", XMLNAME = "Name", XMLPROJECTION = "ELEMENT");
Property methods: NameBuildValueArray(), NameCollectionToDisplay(), NameCollectionToOdbc(), NameDisplayToCollection(), NameGet(), NameGetObject(), NameGetObjectId(), NameGetStored(), NameGetSwizzled(), NameIsValid(), NameOdbcToCollection(), NameSet(), NameSetObject(), NameSetObjectId()
property ObjectType as %String;
Property methods: ObjectTypeDisplayToLogical(), ObjectTypeGet(), ObjectTypeGetStored(), ObjectTypeIsValid(), ObjectTypeLogicalToDisplay(), ObjectTypeLogicalToOdbc(), ObjectTypeNormalize(), ObjectTypeSet()
property PatientID as %String (MAXLEN = 255);
Deprecated, use PatientIdentifier_Value
Property methods: PatientIDDisplayToLogical(), PatientIDForObject(), PatientIDGet(), PatientIDGetStored(), PatientIDIndexExists(), PatientIDIsValid(), PatientIDLogicalToDisplay(), PatientIDLogicalToOdbc(), PatientIDNormalize(), PatientIDSet()
property PatientIdentifier as HS.Types.IHE.XDSb.SerialExternalIdentifier;
Property methods: PatientIdentifierGet(), PatientIdentifierGetObject(), PatientIdentifierGetObjectId(), PatientIdentifierGetStored(), PatientIdentifierGetSwizzled(), PatientIdentifierIndexExists(), PatientIdentifierIsEmpty(), PatientIdentifierIsValid(), PatientIdentifierNewObject(), PatientIdentifierSet(), PatientIdentifierSetObject(), PatientIdentifierSetObjectId(), PatientIdentifierUnSwizzle()
property PracticeSettingCode as HS.Types.IHE.XDSb.SerialClassification;
Property methods: PracticeSettingCodeGet(), PracticeSettingCodeGetObject(), PracticeSettingCodeGetObjectId(), PracticeSettingCodeGetStored(), PracticeSettingCodeGetSwizzled(), PracticeSettingCodeIsEmpty(), PracticeSettingCodeIsValid(), PracticeSettingCodeNewObject(), PracticeSettingCodeSet(), PracticeSettingCodeSetObject(), PracticeSettingCodeSetObjectId(), PracticeSettingCodeUnSwizzle()
property RepositoryUniqueID as %String;
Property methods: RepositoryUniqueIDDisplayToLogical(), RepositoryUniqueIDGet(), RepositoryUniqueIDGetStored(), RepositoryUniqueIDIsValid(), RepositoryUniqueIDLogicalToDisplay(), RepositoryUniqueIDLogicalToOdbc(), RepositoryUniqueIDNormalize(), RepositoryUniqueIDSet()
property ServiceStartTime as %String;
Property methods: ServiceStartTimeDayCompute(), ServiceStartTimeDayDisplayToLogical(), ServiceStartTimeDayGet(), ServiceStartTimeDayIsValid(), ServiceStartTimeDayLogicalToDisplay(), ServiceStartTimeDayNormalize(), ServiceStartTimeDaySQLCompute(), ServiceStartTimeDayXSDToLogical(), ServiceStartTimeDisplayToLogical(), ServiceStartTimeGet(), ServiceStartTimeGetStored(), ServiceStartTimeIndexExists(), ServiceStartTimeIsValid(), ServiceStartTimeLogicalToDisplay(), ServiceStartTimeLogicalToOdbc(), ServiceStartTimeMonthCompute(), ServiceStartTimeMonthDisplayToLogical(), ServiceStartTimeMonthGet(), ServiceStartTimeMonthIsValid(), ServiceStartTimeMonthLogicalToDisplay(), ServiceStartTimeMonthNormalize(), ServiceStartTimeMonthSQLCompute(), ServiceStartTimeMonthXSDToLogical(), ServiceStartTimeNormalize(), ServiceStartTimeSet(), ServiceStartTimeYearCompute(), ServiceStartTimeYearDisplayToLogical(), ServiceStartTimeYearGet(), ServiceStartTimeYearIsValid(), ServiceStartTimeYearLogicalToDisplay(), ServiceStartTimeYearNormalize(), ServiceStartTimeYearSQLCompute(), ServiceStartTimeYearXSDToLogical()
property ServiceStartTimeDay as %Integer [ Calculated ];
Property methods: ServiceStartTimeDayCompute(), ServiceStartTimeDayDisplayToLogical(), ServiceStartTimeDayGet(), ServiceStartTimeDayIsValid(), ServiceStartTimeDayLogicalToDisplay(), ServiceStartTimeDayNormalize(), ServiceStartTimeDaySQLCompute(), ServiceStartTimeDayXSDToLogical()
property ServiceStartTimeMonth as %Integer [ Calculated ];
Property methods: ServiceStartTimeMonthCompute(), ServiceStartTimeMonthDisplayToLogical(), ServiceStartTimeMonthGet(), ServiceStartTimeMonthIsValid(), ServiceStartTimeMonthLogicalToDisplay(), ServiceStartTimeMonthNormalize(), ServiceStartTimeMonthSQLCompute(), ServiceStartTimeMonthXSDToLogical()
property ServiceStartTimeYear as %Integer [ Calculated ];
Property methods: ServiceStartTimeYearCompute(), ServiceStartTimeYearDisplayToLogical(), ServiceStartTimeYearGet(), ServiceStartTimeYearIsValid(), ServiceStartTimeYearLogicalToDisplay(), ServiceStartTimeYearNormalize(), ServiceStartTimeYearSQLCompute(), ServiceStartTimeYearXSDToLogical()
property ServiceStopTime as %String;
Property methods: ServiceStopTimeDayCompute(), ServiceStopTimeDayDisplayToLogical(), ServiceStopTimeDayGet(), ServiceStopTimeDayIsValid(), ServiceStopTimeDayLogicalToDisplay(), ServiceStopTimeDayNormalize(), ServiceStopTimeDaySQLCompute(), ServiceStopTimeDayXSDToLogical(), ServiceStopTimeDisplayToLogical(), ServiceStopTimeGet(), ServiceStopTimeGetStored(), ServiceStopTimeIndexExists(), ServiceStopTimeIsValid(), ServiceStopTimeLogicalToDisplay(), ServiceStopTimeLogicalToOdbc(), ServiceStopTimeMonthCompute(), ServiceStopTimeMonthDisplayToLogical(), ServiceStopTimeMonthGet(), ServiceStopTimeMonthIsValid(), ServiceStopTimeMonthLogicalToDisplay(), ServiceStopTimeMonthNormalize(), ServiceStopTimeMonthSQLCompute(), ServiceStopTimeMonthXSDToLogical(), ServiceStopTimeNormalize(), ServiceStopTimeSet(), ServiceStopTimeYearCompute(), ServiceStopTimeYearDisplayToLogical(), ServiceStopTimeYearGet(), ServiceStopTimeYearIsValid(), ServiceStopTimeYearLogicalToDisplay(), ServiceStopTimeYearNormalize(), ServiceStopTimeYearSQLCompute(), ServiceStopTimeYearXSDToLogical()
property ServiceStopTimeDay as %Integer [ Calculated ];
Property methods: ServiceStopTimeDayCompute(), ServiceStopTimeDayDisplayToLogical(), ServiceStopTimeDayGet(), ServiceStopTimeDayIsValid(), ServiceStopTimeDayLogicalToDisplay(), ServiceStopTimeDayNormalize(), ServiceStopTimeDaySQLCompute(), ServiceStopTimeDayXSDToLogical()
property ServiceStopTimeMonth as %Integer [ Calculated ];
Property methods: ServiceStopTimeMonthCompute(), ServiceStopTimeMonthDisplayToLogical(), ServiceStopTimeMonthGet(), ServiceStopTimeMonthIsValid(), ServiceStopTimeMonthLogicalToDisplay(), ServiceStopTimeMonthNormalize(), ServiceStopTimeMonthSQLCompute(), ServiceStopTimeMonthXSDToLogical()
property ServiceStopTimeYear as %Integer [ Calculated ];
Property methods: ServiceStopTimeYearCompute(), ServiceStopTimeYearDisplayToLogical(), ServiceStopTimeYearGet(), ServiceStopTimeYearIsValid(), ServiceStopTimeYearLogicalToDisplay(), ServiceStopTimeYearNormalize(), ServiceStopTimeYearSQLCompute(), ServiceStopTimeYearXSDToLogical()
property Size as %String;
Property methods: SizeDisplayToLogical(), SizeGet(), SizeGetStored(), SizeIsValid(), SizeLogicalToDisplay(), SizeLogicalToOdbc(), SizeNormalize(), SizeSet()
relationship Slots as array of HS.Registry.Document.Slot (XMLNAME = "Slot", XMLPROJECTION = "ELEMENT") [ InitialExpression = $listbuild("HS.Registry.Document.Slot","Document",+$this,"many",1,1) , Transient , Inverse = Document , Cardinality = many ];
Property methods: SlotsGet(), SlotsGetObject(), SlotsGetObjectId(), SlotsGetSwizzled(), SlotsIsEmpty(), SlotsIsValid(), SlotsNewObject(), SlotsRClose(), SlotsRExec(), SlotsRFetch(), SlotsRelate(), SlotsSQLCompute(), SlotsSet(), SlotsUnRelate()
property SourceIdentifier as HS.Types.IHE.XDSb.SerialExternalIdentifier;
SourceIdentifier is from the submission set, carried forward to the document
Property methods: SourceIdentifierGet(), SourceIdentifierGetObject(), SourceIdentifierGetObjectId(), SourceIdentifierGetStored(), SourceIdentifierGetSwizzled(), SourceIdentifierIndexExists(), SourceIdentifierIsEmpty(), SourceIdentifierIsValid(), SourceIdentifierNewObject(), SourceIdentifierSet(), SourceIdentifierSetObject(), SourceIdentifierSetObjectId(), SourceIdentifierUnSwizzle()
property SourcePatientID as %String (MAXLEN = 255);
Property methods: SourcePatientIDDisplayToLogical(), SourcePatientIDGet(), SourcePatientIDGetStored(), SourcePatientIDIsValid(), SourcePatientIDLogicalToDisplay(), SourcePatientIDLogicalToOdbc(), SourcePatientIDNormalize(), SourcePatientIDSet()
property Status as HS.Types.IHE.Status (XMLNAME = "Status", XMLPROJECTION = "Element") [ InitialExpression = "Submitted" ];
Property methods: StatusDisplayToLogical(), StatusGet(), StatusGetStored(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusLogicalToXSD(), StatusNormalize(), StatusSet(), StatusXSDToLogical()
property SubmissionTime as %String;
Property methods: SubmissionTimeDisplayToLogical(), SubmissionTimeGet(), SubmissionTimeGetStored(), SubmissionTimeIndexExists(), SubmissionTimeIsValid(), SubmissionTimeLogicalToDisplay(), SubmissionTimeLogicalToOdbc(), SubmissionTimeNormalize(), SubmissionTimeSet()
property Title as HS.Registry.Document.Type.ValueType (XMLNAME = "Title", XMLPROJECTION = "ELEMENT");
Property methods: TitleGet(), TitleGetObject(), TitleGetObjectId(), TitleGetStored(), TitleGetSwizzled(), TitleIsEmpty(), TitleIsValid(), TitleNewObject(), TitleSet(), TitleSetObject(), TitleSetObjectId(), TitleUnSwizzle()
Property methods: TypeCodeGet(), TypeCodeGetObject(), TypeCodeGetObjectId(), TypeCodeGetStored(), TypeCodeGetSwizzled(), TypeCodeIsEmpty(), TypeCodeIsValid(), TypeCodeNewObject(), TypeCodeSet(), TypeCodeSetObject(), TypeCodeSetObjectId(), TypeCodeUnSwizzle()
property Version as %Integer;
Property methods: VersionDisplayToLogical(), VersionGet(), VersionGetStored(), VersionIsValid(), VersionLogicalToDisplay(), VersionNormalize(), VersionSet(), VersionXSDToLogical()

Methods

classmethod %OnDelete(oid As %ObjectIdentity) as %Status
This callback method is invoked by the %Delete() method to provide notification that the object specified by oid is being deleted.

If this method returns an error then the object will not be deleted. [Previously private]

classmethod DocumentForEntryID(pID As %String) as %String
classmethod DocumentForUniqueID(pID As %String, ByRef pAry, pOnlyApproved As %Boolean = 0, pMaxCount=0) as %Status
classmethod DocumentIDsForPatient(pID As %String, ByRef pDocuments As %String, ByRef pQueryParams, ByRef pIIDs As %String, %pTempGbl As %String = "", pRemoveParams As %Boolean = 1) as %Status
Find document ids for Patient
classmethod DocumentsForLogicalID(pID As %String, Output pAry) as %Status
classmethod DocumentsForPatient(pID As %String, ByRef pDocuments As %String) as %Status
*** Deprecated *** find registryObject references from ExternalIdentifier where patient id = pID
classmethod HashForIID(pIID As %String) as %String
classmethod HighestVersionForLogicalIID(pIID As %String, Output pDocument) as %Status
classmethod IIDForUniqueID(pUniqueID As %String, Output pAryIID) as %Status
classmethod ObjectForIID(pIID As %String) as Document
classmethod ObjectForIIDOfHighestVersion(pIID As %String, Output pDocument) as %Status
method PatientIDForObject() as %String
method SlotValueForObject(pSlotName="") as %String
method UniqueIDForObject() as %String

Indexes

index ($Document on ) [Extent, Type = bitmap];
index (AttributesIndex on Attributes(ELEMENTS),Attributes(KEYS));
index (ClassCodeCodingSchemeIndex on ClassCode.CodingScheme) [Type = bitmap];
index (ClassCodeIndex on ClassCode.Code) [Type = bitmap];
index (CreationTimeDayIndex on CreationTimeDay) [Type = bitmap];
index (CreationTimeIndex on CreationTime);
Index methods: CreationTimeIndexExists()
index (CreationTimeInternalIndex on CreationTimeInternal);
Index methods: CreationTimeInternalIndexExists()
index (CreationTimeMonthIndex on CreationTimeMonth) [Type = bitmap];
index (CreationTimeYearIndex on CreationTimeYear) [Type = bitmap];
index (DocumentIDIndex on DocumentID);
Index methods: DocumentIDIndexExists()
index (DocumentUniqueIdentifierIndex on DocumentUniqueIdentifier.Value);
Index methods: DocumentUniqueIdentifierIndexExists()
index (FormatCodeCodingSchemeIndex on FormatCode.CodingScheme) [Type = bitmap];
index (FormatCodeIndex on FormatCode.Code) [Type = bitmap];
index (HealthCareFacilityTypeCodeCodingSchemeIndex on HealthCareFacilityTypeCode.CodingScheme) [Type = bitmap];
index (HealthCareFacilityTypeCodeIndex on HealthCareFacilityTypeCode.Code) [Type = bitmap];
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (IIDIndex on IID) [Unique];
Index methods: IIDIndexCheck(), IIDIndexCheckUnique(), IIDIndexDelete(), IIDIndexExists(), IIDIndexOpen(), IIDIndexSQLCheckUnique(), IIDIndexSQLExists(), IIDIndexSQLFindPKeyByConstraint(), IIDIndexSQLFindRowIDByConstraint()
index (LastUpdateTimeInternalIndex on LastUpdateTimeInternal);
Index methods: LastUpdateTimeInternalIndexExists()
index (LogicalIIDIndex on LogicalIID,Version);
Index methods: LogicalIIDIndexExists()
index (ObjectTypeIndex on ObjectType) [Type = bitmap];
index (PatientIDIndex on PatientID);
Index methods: PatientIDIndexExists()
index (PatientIdentifierIndex on PatientIdentifier.Value);
Index methods: PatientIdentifierIndexExists()
index (PracticeSettingCodeCodingSchemeIndex on PracticeSettingCode.CodingScheme) [Type = bitmap];
index (PracticeSettingCodeIndex on PracticeSettingCode.Code) [Type = bitmap];
index (RepositoryUniqueIDIndex on RepositoryUniqueID) [Type = bitmap];
index (ServiceStartDayIndex on ServiceStartTimeDay) [Type = bitmap];
index (ServiceStartMonthIndex on ServiceStartTimeMonth) [Type = bitmap];
index (ServiceStartTimeIndex on ServiceStartTime);
Index methods: ServiceStartTimeIndexExists()
index (ServiceStartYearIndex on ServiceStartTimeYear) [Type = bitmap];
index (ServiceStopDayIndex on ServiceStopTimeDay) [Type = bitmap];
index (ServiceStopMonthIndex on ServiceStopTimeMonth) [Type = bitmap];
index (ServiceStopTimeIndex on ServiceStopTime);
Index methods: ServiceStopTimeIndexExists()
index (ServiceStopYearIndex on ServiceStopTimeYear) [Type = bitmap];
index (SourceIdentifierIndex on SourceIdentifier.Value);
Index methods: SourceIdentifierIndexExists()
index (StatusIndex on Status) [Type = bitmap];
index (SubmissionTimeIndex on SubmissionTime);
Index methods: SubmissionTimeIndexExists()
index (TypeCodeCodingSchemeIndex on TypeCode.CodingScheme) [Type = bitmap];
index (TypeCodeIndex on TypeCode.Code) [Type = bitmap];

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (HS.Registry.Document)

^HS.Registry.DocumentD(ID,"Attributes",n)
=
Attributes(n)

Storage Model: Storage (HS.Registry.Document)

^HS.Registry.DocumentD(ID,"Comments",n)
=
Comments(n)

Storage Model: Storage (HS.Registry.Document)

^HS.Registry.DocumentD(ID,"DataElements",n)
=
DataElements(n)

Storage Model: Storage (HS.Registry.Document)

^HS.Registry.DocumentD(ID,"Description",n)
=
Description(n)

Storage Model: Storage (HS.Registry.Document)

^HS.Registry.DocumentD(ID)
=
%%CLASSNAME
IID
PatientID
PatientAssigningAuthority
SourcePatientID
SourcePatientAssigningAuthority
DocumentID
MimeType
ObjectType
Status
ExternalIdentifiers
LogicalID
ClassCode
Size
Hash
ServiceStartTime
ServiceStopTime
SubmissionTime
RepositoryUniqueID
CreationTime
CreationTimeInternal
LastUpdateTimeInternal
LanguageCode
FormatCode
HealthCareFacilityTypeCode
PracticeSettingCode
TypeCode
PatientIdentifier
DocumentUniqueIdentifier
SourceIdentifier
Title
LogicalIID
Version
Availability

Storage Model: Storage (HS.Registry.Document)

^HS.Registry.DocumentD(ID,"Name",n)
=
Name(n)
FeedbackOpens in a new tab