Skip to main content


class HS.IHE.XDSb.Types.Submission extends HS.IHE.XDSb.Types.ObjectRef, HS.Util.CopyFrom

Property Inventory


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.


property Author as list of HS.IHE.XDSb.Types.Author (XMLPROJECTION = "ELEMENT");
Authors of this submission set
Property methods: AuthorBuildValueArray(), AuthorCollectionToDisplay(), AuthorCollectionToOdbc(), AuthorDisplayToCollection(), AuthorGet(), AuthorGetObject(), AuthorGetObjectId(), AuthorGetSwizzled(), AuthorIsValid(), AuthorOdbcToCollection(), AuthorSet(), AuthorSetObject(), AuthorSetObjectId()
property AvailabilityStatus as %String (VALUELIST = ",Submitted,Approved");
Submitted / Approved -- generated by registry
Property methods: AvailabilityStatusDisplayToLogical(), AvailabilityStatusGet(), AvailabilityStatusIsValid(), AvailabilityStatusLogicalToDisplay(), AvailabilityStatusLogicalToOdbc(), AvailabilityStatusNormalize(), AvailabilityStatusSet()
property Comments as %String);
Free text description
Property methods: CommentsDisplayToLogical(), CommentsGet(), CommentsIsValid(), CommentsLogicalToDisplay(), CommentsLogicalToOdbc(), CommentsNormalize(), CommentsSet()
property ContentTypeCode as HS.IHE.XDSb.Types.CodedValue;
Indicates the overall type for all documents
Property methods: ContentTypeCodeGet(), ContentTypeCodeGetObject(), ContentTypeCodeGetObjectId(), ContentTypeCodeGetSwizzled(), ContentTypeCodeIsEmpty(), ContentTypeCodeIsValid(), ContentTypeCodeNewObject(), ContentTypeCodeSet(), ContentTypeCodeSetObject(), ContentTypeCodeSetObjectId(), ContentTypeCodeUnSwizzle()
property IntendedRecipient as list of HS.IHE.XDSb.Types.SlotValue (XMLITEMNAME = "Value");
Optional list of recipient
Property methods: IntendedRecipientBuildValueArray(), IntendedRecipientCollectionToDisplay(), IntendedRecipientCollectionToOdbc(), IntendedRecipientDisplayToCollection(), IntendedRecipientGet(), IntendedRecipientGetObject(), IntendedRecipientGetObjectId(), IntendedRecipientGetSwizzled(), IntendedRecipientIsValid(), IntendedRecipientOdbcToCollection(), IntendedRecipientSet(), IntendedRecipientSetObject(), IntendedRecipientSetObjectId()
property PatientId as %String (CONTENT = "ESCAPE");
Patient ID
Property methods: PatientIdDisplayToLogical(), PatientIdGet(), PatientIdIsValid(), PatientIdLogicalToDisplay(), PatientIdLogicalToOdbc(), PatientIdNormalize(), PatientIdSet()
property SourceId as %String);
Source OID
Property methods: SourceIdDisplayToLogical(), SourceIdGet(), SourceIdIsValid(), SourceIdLogicalToDisplay(), SourceIdLogicalToOdbc(), SourceIdNormalize(), SourceIdSet()
property SubmissionSlots as list of HS.IHE.XDSb.Types.Slot;
Collection of slots from submission set
Property methods: SubmissionSlotsBuildValueArray(), SubmissionSlotsCollectionToDisplay(), SubmissionSlotsCollectionToOdbc(), SubmissionSlotsDisplayToCollection(), SubmissionSlotsGet(), SubmissionSlotsGetObject(), SubmissionSlotsGetObjectId(), SubmissionSlotsGetSwizzled(), SubmissionSlotsIsValid(), SubmissionSlotsOdbcToCollection(), SubmissionSlotsSet(), SubmissionSlotsSetObject(), SubmissionSlotsSetObjectId()
property SubmissionTime as %String);
When submission was generated, UTC, HL7v2 format
Property methods: SubmissionTimeDisplayToLogical(), SubmissionTimeGet(), SubmissionTimeIsValid(), SubmissionTimeLogicalToDisplay(), SubmissionTimeLogicalToOdbc(), SubmissionTimeNormalize(), SubmissionTimeSet()
property Title as %String);
Free text title
Property methods: TitleDisplayToLogical(), TitleGet(), TitleIsValid(), TitleLogicalToDisplay(), TitleLogicalToOdbc(), TitleNormalize(), TitleSet()
property UniqueId as %String);
OID assigned by the source
Property methods: UniqueIdDisplayToLogical(), UniqueIdGet(), UniqueIdIsValid(), UniqueIdLogicalToDisplay(), UniqueIdLogicalToOdbc(), UniqueIdNormalize(), UniqueIdSet()

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab