HS.Types.IHE.XDSb.DocumentStored

serial class HS.Types.IHE.XDSb.DocumentStored extends %Library.SerialObject, %XML.Adaptor, HS.Util.CopyFrom

Property Inventory

Parameters

parameter XMLIGNORENULL = INPUTONLY;

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 Availability as HS.Types.IHE.XDSb.OnlineStatus;

1 - online, 0 - Offline

Property methods: AvailabilityDisplayToLogical(), AvailabilityGet(), AvailabilityIsValid(), AvailabilityLogicalToDisplay(), AvailabilityLogicalToOdbc(), AvailabilityLogicalToXSD(), AvailabilityNormalize(), AvailabilitySet(), AvailabilityXSDToLogical()

property AvailabilityStatus as HS.Types.IHE.Status;

Document status, generated by the registry Approved;Deprecated;Submitted

Property methods: AvailabilityStatusDisplayToLogical(), AvailabilityStatusGet(), AvailabilityStatusIsValid(), AvailabilityStatusLogicalToDisplay(), AvailabilityStatusLogicalToOdbc(), AvailabilityStatusLogicalToXSD(), AvailabilityStatusNormalize(), AvailabilityStatusSet(), AvailabilityStatusXSDToLogical()

property ClassCode as HS.Types.IHE.XDSb.SerialClassification;

The kind of document

Property methods: ClassCodeGet(), ClassCodeGetObject(), ClassCodeGetObjectId(), ClassCodeGetSwizzled(), ClassCodeIsEmpty(), ClassCodeIsValid(), ClassCodeNewObject(), ClassCodeSet(), ClassCodeSetObject(), ClassCodeSetObjectId(), ClassCodeUnSwizzle()

property Classifications as list of HS.Types.IHE.XDSb.SerialClassification (XMLNAME = "Classification", XMLPROJECTION = "ELEMENT");

Property methods: ClassificationsBuildValueArray(), ClassificationsCollectionToDisplay(), ClassificationsCollectionToOdbc(), ClassificationsDisplayToCollection(), ClassificationsGet(), ClassificationsGetObject(), ClassificationsGetObjectId(), ClassificationsGetSwizzled(), ClassificationsIsValid(), ClassificationsOdbcToCollection(), ClassificationsSet(), ClassificationsSetObject(), ClassificationsSetObjectId()

property CreationTime as %String);

Time the author created the document

Property methods: CreationTimeDisplayToLogical(), CreationTimeGet(), CreationTimeIsValid(), CreationTimeLogicalToDisplay(), CreationTimeLogicalToOdbc(), CreationTimeNormalize(), CreationTimeSet()

property Descriptions as list of HS.Types.IHE.XDSb.ValueType (XMLNAME = "Description", XMLPROJECTION = "ELEMENT");

previously known as comments

Property methods: DescriptionsBuildValueArray(), DescriptionsCollectionToDisplay(), DescriptionsCollectionToOdbc(), DescriptionsDisplayToCollection(), DescriptionsGet(), DescriptionsGetObject(), DescriptionsGetObjectId(), DescriptionsGetSwizzled(), DescriptionsIsValid(), DescriptionsOdbcToCollection(), DescriptionsSet(), DescriptionsSetObject(), DescriptionsSetObjectId()

property DocumentUniqueIdentifier as HS.Types.IHE.XDSb.SerialExternalIdentifier;

Property methods: DocumentUniqueIdentifierGet(), DocumentUniqueIdentifierGetObject(), DocumentUniqueIdentifierGetObjectId(), DocumentUniqueIdentifierGetSwizzled(), DocumentUniqueIdentifierIsEmpty(), DocumentUniqueIdentifierIsValid(), DocumentUniqueIdentifierNewObject(), DocumentUniqueIdentifierSet(), DocumentUniqueIdentifierSetObject(), DocumentUniqueIdentifierSetObjectId(), DocumentUniqueIdentifierUnSwizzle()

property EntryUUID as %String (MAXLEN = 256, XMLNAME = "id", XMLPROJECTION = "ATTRIBUTE");

known as id in the provide and register / register

Property methods: EntryUUIDDisplayToLogical(), EntryUUIDGet(), EntryUUIDIsValid(), EntryUUIDLogicalToDisplay(), EntryUUIDLogicalToOdbc(), EntryUUIDNormalize(), EntryUUIDSet()

property ExternalIdentifiers as list of HS.Types.IHE.XDSb.SerialExternalIdentifierFull (XMLNAME = "ExternalIdentifier", XMLPROJECTION = "ELEMENT");

Property methods: ExternalIdentifiersBuildValueArray(), ExternalIdentifiersCollectionToDisplay(), ExternalIdentifiersCollectionToOdbc(), ExternalIdentifiersDisplayToCollection(), ExternalIdentifiersGet(), ExternalIdentifiersGetObject(), ExternalIdentifiersGetObjectId(), ExternalIdentifiersGetSwizzled(), ExternalIdentifiersIsValid(), ExternalIdentifiersOdbcToCollection(), ExternalIdentifiersSet(), ExternalIdentifiersSetObject(), ExternalIdentifiersSetObjectId()

property FormatCode as HS.Types.IHE.XDSb.SerialClassification;

Document format Property FormatCode As HS.IHE.XDSb.Types.CodedValue;

Property methods: FormatCodeGet(), FormatCodeGetObject(), FormatCodeGetObjectId(), FormatCodeGetSwizzled(), FormatCodeIsEmpty(), FormatCodeIsValid(), FormatCodeNewObject(), FormatCodeSet(), FormatCodeSetObject(), FormatCodeSetObjectId(), FormatCodeUnSwizzle()

property Hash as %String);

Hash key of the document, computed by the repository

Property methods: HashDisplayToLogical(), HashGet(), HashIsValid(), HashLogicalToDisplay(), HashLogicalToOdbc(), HashNormalize(), HashSet()

property HealthCareFacilityTypeCode as HS.Types.IHE.XDSb.SerialClassification (XMLPROJECTION = "ELEMENT");

Type of organizational setting of the encounter during which the document act occurred Property HealthcareFacilityTypeCode As HS.IHE.XDSb.Types.CodedValue;

Property methods: HealthCareFacilityTypeCodeGet(), HealthCareFacilityTypeCodeGetObject(), HealthCareFacilityTypeCodeGetObjectId(), HealthCareFacilityTypeCodeGetSwizzled(), HealthCareFacilityTypeCodeIsEmpty(), HealthCareFacilityTypeCodeIsValid(), HealthCareFacilityTypeCodeNewObject(), HealthCareFacilityTypeCodeSet(), HealthCareFacilityTypeCodeSetObject(), HealthCareFacilityTypeCodeSetObjectId(), HealthCareFacilityTypeCodeUnSwizzle()

property LanguageCode as %String);

The language of character data in the document

Property methods: LanguageCodeDisplayToLogical(), LanguageCodeGet(), LanguageCodeIsValid(), LanguageCodeLogicalToDisplay(), LanguageCodeLogicalToOdbc(), LanguageCodeNormalize(), LanguageCodeSet()

property LegalAuthenticator as %String);

Who has legally authenticated the document (optional)

Property methods: LegalAuthenticatorDisplayToLogical(), LegalAuthenticatorGet(), LegalAuthenticatorIsValid(), LegalAuthenticatorLogicalToDisplay(), LegalAuthenticatorLogicalToOdbc(), LegalAuthenticatorNormalize(), LegalAuthenticatorSet()

property LogicalUUID as %String (MAXLEN = 256, XMLNAME = "lid", XMLPROJECTION = "ATTRIBUTE");

known as lid in the provide and register / register

Property methods: LogicalUUIDDisplayToLogical(), LogicalUUIDGet(), LogicalUUIDIsValid(), LogicalUUIDLogicalToDisplay(), LogicalUUIDLogicalToOdbc(), LogicalUUIDNormalize(), LogicalUUIDSet()

property MimeType as %String);

MIME type

Property methods: MimeTypeDisplayToLogical(), MimeTypeGet(), MimeTypeIsValid(), MimeTypeLogicalToDisplay(), MimeTypeLogicalToOdbc(), MimeTypeNormalize(), MimeTypeSet()

property Names as list of HS.Types.IHE.XDSb.ValueType (XMLNAME = "Name", XMLPROJECTION = "ELEMENT");

Document Name (previously title)

Property methods: NamesBuildValueArray(), NamesCollectionToDisplay(), NamesCollectionToOdbc(), NamesDisplayToCollection(), NamesGet(), NamesGetObject(), NamesGetObjectId(), NamesGetSwizzled(), NamesIsValid(), NamesOdbcToCollection(), NamesSet(), NamesSetObject(), NamesSetObjectId()

property ObjectType as %String (DISPLAYLIST = ",urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1,urn:uuid:34268e47-fdf5-41a6-ba33-82133c465248", VALUELIST = ",Stable,OnDemand", XMLLISTPARAMETER = "DISPLAYLIST", XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = "Stable" ];

ObjectType

Property methods: ObjectTypeDisplayToLogical(), ObjectTypeGet(), ObjectTypeIsValid(), ObjectTypeLogicalToDisplay(), ObjectTypeLogicalToOdbc(), ObjectTypeLogicalToXSD(), ObjectTypeNormalize(), ObjectTypeSet(), ObjectTypeXSDToLogical()

property PatientIdentifier as HS.Types.IHE.XDSb.SerialExternalIdentifier;

Property methods: PatientIdentifierGet(), PatientIdentifierGetObject(), PatientIdentifierGetObjectId(), PatientIdentifierGetSwizzled(), PatientIdentifierIsEmpty(), PatientIdentifierIsValid(), PatientIdentifierNewObject(), PatientIdentifierSet(), PatientIdentifierSetObject(), PatientIdentifierSetObjectId(), PatientIdentifierUnSwizzle()

property PracticeSettingCode as HS.Types.IHE.XDSb.SerialClassification;

The clinical specialty where the act that resulted in the document was performed Property PracticeSettingCode As HS.IHE.XDSb.Types.CodedValue;

Property methods: PracticeSettingCodeGet(), PracticeSettingCodeGetObject(), PracticeSettingCodeGetObjectId(), PracticeSettingCodeGetSwizzled(), PracticeSettingCodeIsEmpty(), PracticeSettingCodeIsValid(), PracticeSettingCodeNewObject(), PracticeSettingCodeSet(), PracticeSettingCodeSetObject(), PracticeSettingCodeSetObjectId(), PracticeSettingCodeUnSwizzle()

property RepositoryUniqueId as %String);

Repository OID of where the document is stored

Property methods: RepositoryUniqueIdDisplayToLogical(), RepositoryUniqueIdGet(), RepositoryUniqueIdIsValid(), RepositoryUniqueIdLogicalToDisplay(), RepositoryUniqueIdLogicalToOdbc(), RepositoryUniqueIdNormalize(), RepositoryUniqueIdSet()

property ServiceStartTime as %String);

Start time, UTC, HL7v2 format

Property methods: ServiceStartTimeDisplayToLogical(), ServiceStartTimeGet(), ServiceStartTimeIsValid(), ServiceStartTimeLogicalToDisplay(), ServiceStartTimeLogicalToOdbc(), ServiceStartTimeNormalize(), ServiceStartTimeSet()

property ServiceStopTime as %String);

Stop time, UTC, HL7v2 format

Property methods: ServiceStopTimeDisplayToLogical(), ServiceStopTimeGet(), ServiceStopTimeIsValid(), ServiceStopTimeLogicalToDisplay(), ServiceStopTimeLogicalToOdbc(), ServiceStopTimeNormalize(), ServiceStopTimeSet()

property Size as %String;

Document size, computed by repository

Property methods: SizeDisplayToLogical(), SizeGet(), SizeIsValid(), SizeLogicalToDisplay(), SizeLogicalToOdbc(), SizeNormalize(), SizeSet()

property Slots as list of HS.Types.IHE.XDSb.Slot (XMLNAME = "Slot", XMLPROJECTION = "ELEMENT");

Property DocumentSlots As list Of HS.IHE.XDSb.Types.Slot;

Property methods: SlotsBuildValueArray(), SlotsCollectionToDisplay(), SlotsCollectionToOdbc(), SlotsDisplayToCollection(), SlotsGet(), SlotsGetObject(), SlotsGetObjectId(), SlotsGetSwizzled(), SlotsIsValid(), SlotsOdbcToCollection(), SlotsSet(), SlotsSetObject(), SlotsSetObjectId()

property SourceIdentifier as HS.Types.IHE.XDSb.SerialExternalIdentifier;

SourceIdentifier is from the submission set, carried forward to the document

Property methods: SourceIdentifierGet(), SourceIdentifierGetObject(), SourceIdentifierGetObjectId(), SourceIdentifierGetSwizzled(), SourceIdentifierIsEmpty(), SourceIdentifierIsValid(), SourceIdentifierNewObject(), SourceIdentifierSet(), SourceIdentifierSetObject(), SourceIdentifierSetObjectId(), SourceIdentifierUnSwizzle()

property SourcePatientId as %String (CONTENT = "ESCAPE");

Patient MRN

Property methods: SourcePatientIdDisplayToLogical(), SourcePatientIdGet(), SourcePatientIdIsValid(), SourcePatientIdLogicalToDisplay(), SourcePatientIdLogicalToOdbc(), SourcePatientIdNormalize(), SourcePatientIdSet()

property SourcePatientInfo as list of HS.Types.IHE.XDSb.SlotValue (XMLITEMNAME = "Value");

Patient demographics

Property methods: SourcePatientInfoBuildValueArray(), SourcePatientInfoCollectionToDisplay(), SourcePatientInfoCollectionToOdbc(), SourcePatientInfoDisplayToCollection(), SourcePatientInfoGet(), SourcePatientInfoGetObject(), SourcePatientInfoGetObjectId(), SourcePatientInfoGetSwizzled(), SourcePatientInfoIsValid(), SourcePatientInfoOdbcToCollection(), SourcePatientInfoSet(), SourcePatientInfoSetObject(), SourcePatientInfoSetObjectId()

property SubmissionTime as %String;

Property methods: SubmissionTimeDisplayToLogical(), SubmissionTimeGet(), SubmissionTimeIsValid(), SubmissionTimeLogicalToDisplay(), SubmissionTimeLogicalToOdbc(), SubmissionTimeNormalize(), SubmissionTimeSet()

property TypeCode as HS.Types.IHE.XDSb.SerialClassification;

The precise kind of document Property TypeCode As HS.IHE.XDSb.Types.CodedValue;

Property methods: TypeCodeGet(), TypeCodeGetObject(), TypeCodeGetObjectId(), TypeCodeGetSwizzled(), TypeCodeIsEmpty(), TypeCodeIsValid(), TypeCodeNewObject(), TypeCodeSet(), TypeCodeSetObject(), TypeCodeSetObjectId(), TypeCodeUnSwizzle()

property Version as %String;

URI used for retrieval, computed by repository Used to maintain the XOP href when imported

Property methods: VersionDisplayToLogical(), VersionGet(), VersionIsValid(), VersionLogicalToDisplay(), VersionLogicalToOdbc(), VersionNormalize(), VersionSet()

Inherited Members

Inherited Methods

Subclasses

HS.Types.IHE.XDSb.Document