Skip to main content

HS.IHE.XDSb.Types.Document

class HS.IHE.XDSb.Types.Document extends HS.IHE.XDSb.Types.ObjectRef

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 Author as list of HS.IHE.XDSb.Types.Author (XMLPROJECTION = "ELEMENT");
List of document authors
Property methods: AuthorBuildValueArray(), AuthorCollectionToDisplay(), AuthorCollectionToOdbc(), AuthorDisplayToCollection(), AuthorGet(), AuthorGetObject(), AuthorGetObjectId(), AuthorGetSwizzled(), AuthorIsValid(), AuthorOdbcToCollection(), AuthorSet(), AuthorSetObject(), AuthorSetObjectId()
property Availability as %String (DISPLAYLIST = ",urn:ihe:iti:2010:DocumentAvailability:Offline,urn:ihe:iti:2010:DocumentAvailability:Online", VALUELIST = ",0,1", XMLLISTPARAMETER = "DISPLAYLIST");
Property methods: AvailabilityDisplayToLogical(), AvailabilityGet(), AvailabilityIsValid(), AvailabilityLogicalToDisplay(), AvailabilityLogicalToOdbc(), AvailabilityLogicalToXSD(), AvailabilityNormalize(), AvailabilitySet(), AvailabilityStatusDisplayToLogical(), AvailabilityStatusGet(), AvailabilityStatusIsValid(), AvailabilityStatusLogicalToDisplay(), AvailabilityStatusLogicalToOdbc(), AvailabilityStatusNormalize(), AvailabilityStatusSet(), AvailabilityXSDToLogical()
property AvailabilityStatus as %String (VALUELIST = ",Approved,Deprecated");
Document status, generated by the registry
Property methods: AvailabilityStatusDisplayToLogical(), AvailabilityStatusGet(), AvailabilityStatusIsValid(), AvailabilityStatusLogicalToDisplay(), AvailabilityStatusLogicalToOdbc(), AvailabilityStatusNormalize(), AvailabilityStatusSet()
property Body as %Stream.GlobalBinary;
Binary document stream
Property methods: BodyCharacterDelete(), BodyCharacterGet(), BodyCharacterGetObject(), BodyCharacterGetObjectId(), BodyCharacterGetSwizzled(), BodyCharacterIsValid(), BodyCharacterNewObject(), BodyCharacterOid(), BodyCharacterOpen(), BodyCharacterSet(), BodyCharacterSetObject(), BodyCharacterSetObjectId(), BodyCharacterUnSwizzle(), BodyDelete(), BodyGet(), BodyGetObject(), BodyGetObjectId(), BodyGetSwizzled(), BodyIsValid(), BodyNewObject(), BodyOid(), BodyOpen(), BodySet(), BodySetObject(), BodySetObjectId(), BodyUnSwizzle()
property BodyCharacter as %Stream.GlobalCharacter;
Character document stream, if present, will be used to extract CDA information and copied to the submission attachments, unless a Body stream is defined.
Property methods: BodyCharacterDelete(), BodyCharacterGet(), BodyCharacterGetObject(), BodyCharacterGetObjectId(), BodyCharacterGetSwizzled(), BodyCharacterIsValid(), BodyCharacterNewObject(), BodyCharacterOid(), BodyCharacterOpen(), BodyCharacterSet(), BodyCharacterSetObject(), BodyCharacterSetObjectId(), BodyCharacterUnSwizzle()
property ClassCode as HS.IHE.XDSb.Types.CodedValue;
The kind of document
Property methods: ClassCodeGet(), ClassCodeGetObject(), ClassCodeGetObjectId(), ClassCodeGetSwizzled(), ClassCodeIsEmpty(), ClassCodeIsValid(), ClassCodeNewObject(), ClassCodeSet(), ClassCodeSetObject(), ClassCodeSetObjectId(), ClassCodeUnSwizzle()
property Comments as %String);
Comments
Property methods: CommentsDisplayToLogical(), CommentsGet(), CommentsIsValid(), CommentsLogicalToDisplay(), CommentsLogicalToOdbc(), CommentsNormalize(), CommentsSet()
property ConfidentialityCode as list of HS.IHE.XDSb.Types.CodedValue (XMLPROJECTION = "ELEMENT");
The level of confidentiality - to be addressed in future IHE specifications
Property methods: ConfidentialityCodeBuildValueArray(), ConfidentialityCodeCollectionToDisplay(), ConfidentialityCodeCollectionToOdbc(), ConfidentialityCodeDisplayToCollection(), ConfidentialityCodeGet(), ConfidentialityCodeGetObject(), ConfidentialityCodeGetObjectId(), ConfidentialityCodeGetSwizzled(), ConfidentialityCodeIsValid(), ConfidentialityCodeOdbcToCollection(), ConfidentialityCodeSet(), ConfidentialityCodeSetObject(), ConfidentialityCodeSetObjectId()
property Context as HS.IHE.XDSb.Types.Context;
The context to create this document (MPI, MRN, Encounter, etc)
Property methods: ContextGet(), ContextGetSwizzled(), ContextIsValid(), ContextNewObject(), ContextSet()
property CreationTime as %String);
Time the author created the document
Property methods: CreationTimeDisplayToLogical(), CreationTimeGet(), CreationTimeIsValid(), CreationTimeLogicalToDisplay(), CreationTimeLogicalToOdbc(), CreationTimeNormalize(), CreationTimeSet()
property DocumentSlots as list of HS.IHE.XDSb.Types.Slot;
Property methods: DocumentSlotsBuildValueArray(), DocumentSlotsCollectionToDisplay(), DocumentSlotsCollectionToOdbc(), DocumentSlotsDisplayToCollection(), DocumentSlotsGet(), DocumentSlotsGetObject(), DocumentSlotsGetObjectId(), DocumentSlotsGetSwizzled(), DocumentSlotsIsValid(), DocumentSlotsOdbcToCollection(), DocumentSlotsSet(), DocumentSlotsSetObject(), DocumentSlotsSetObjectId()
property EventCodeList as list of HS.IHE.XDSb.Types.CodedValue (XMLPROJECTION = "ELEMENT");
Optional list of the main clinical acts
Property methods: EventCodeListBuildValueArray(), EventCodeListCollectionToDisplay(), EventCodeListCollectionToOdbc(), EventCodeListDisplayToCollection(), EventCodeListGet(), EventCodeListGetObject(), EventCodeListGetObjectId(), EventCodeListGetSwizzled(), EventCodeListIsValid(), EventCodeListOdbcToCollection(), EventCodeListSet(), EventCodeListSetObject(), EventCodeListSetObjectId()
property FormatCode as HS.IHE.XDSb.Types.CodedValue;
Document format
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.IHE.XDSb.Types.CodedValue;
Type of organizational setting of the encounter during which the document act occurred
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 MimeType as %String);
MIME type
Property methods: MimeTypeDisplayToLogical(), MimeTypeGet(), MimeTypeIsValid(), MimeTypeLogicalToDisplay(), MimeTypeLogicalToOdbc(), MimeTypeNormalize(), MimeTypeSet()
property ObjectType as %String (VALUELIST = ",Stable,OnDemand", XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = "Stable" ];
ObjectType
Property methods: ObjectTypeDisplayToLogical(), ObjectTypeGet(), ObjectTypeIsValid(), ObjectTypeLogicalToDisplay(), ObjectTypeLogicalToOdbc(), ObjectTypeNormalize(), ObjectTypeSet()
property PatientId as %String (CONTENT = "ESCAPE");
Patient ID
Property methods: PatientIdDisplayToLogical(), PatientIdGet(), PatientIdIsValid(), PatientIdLogicalToDisplay(), PatientIdLogicalToOdbc(), PatientIdNormalize(), PatientIdSet()
property PracticeSettingCode as HS.IHE.XDSb.Types.CodedValue;
The clinical specialty where the act that resulted in the document was performed
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 %Integer;
Document size, computed by repository
Property methods: SizeDisplayToLogical(), SizeGet(), SizeIsValid(), SizeLogicalToDisplay(), SizeNormalize(), SizeSet(), SizeXSDToLogical()
property Snapshot as HS.IHE.XDSb.Types.Document;
For on-demand documents, the snapshot ID, UniqueID and Repository
Property methods: SnapshotGet(), SnapshotGetSwizzled(), SnapshotIsValid(), SnapshotNewObject(), SnapshotSet()
property SourcePatientId as %String (CONTENT = "ESCAPE");
Patient MRN
Property methods: SourcePatientIdDisplayToLogical(), SourcePatientIdGet(), SourcePatientIdIsValid(), SourcePatientIdLogicalToDisplay(), SourcePatientIdLogicalToOdbc(), SourcePatientIdNormalize(), SourcePatientIdSet()
property SourcePatientInfo as list of HS.IHE.XDSb.Types.SlotValue (XMLITEMNAME = "Value");
Patient demographics
Property methods: SourcePatientInfoBuildValueArray(), SourcePatientInfoCollectionToDisplay(), SourcePatientInfoCollectionToOdbc(), SourcePatientInfoDisplayToCollection(), SourcePatientInfoGet(), SourcePatientInfoGetObject(), SourcePatientInfoGetObjectId(), SourcePatientInfoGetSwizzled(), SourcePatientInfoIsValid(), SourcePatientInfoOdbcToCollection(), SourcePatientInfoSet(), SourcePatientInfoSetObject(), SourcePatientInfoSetObjectId()
property Title as %String);
Document title
Property methods: TitleDisplayToLogical(), TitleGet(), TitleIsValid(), TitleLogicalToDisplay(), TitleLogicalToOdbc(), TitleNormalize(), TitleSet()
property TypeCode as HS.IHE.XDSb.Types.CodedValue;
The precise kind of document
Property methods: TypeCodeGet(), TypeCodeGetObject(), TypeCodeGetObjectId(), TypeCodeGetSwizzled(), TypeCodeIsEmpty(), TypeCodeIsValid(), TypeCodeNewObject(), TypeCodeSet(), TypeCodeSetObject(), TypeCodeSetObjectId(), TypeCodeUnSwizzle()
property URI as %String);
URI used for retrieval, computed by repository
Property methods: URIDisplayToLogical(), URIGet(), URIIsValid(), URILogicalToDisplay(), URILogicalToOdbc(), URINormalize(), URISet()
property UniqueId as %String);
Document OID
Property methods: UniqueIdDisplayToLogical(), UniqueIdGet(), UniqueIdIsValid(), UniqueIdLogicalToDisplay(), UniqueIdLogicalToOdbc(), UniqueIdNormalize(), UniqueIdSet()
property Version as %String;
Property methods: VersionDisplayToLogical(), VersionGet(), VersionIsValid(), VersionLogicalToDisplay(), VersionLogicalToOdbc(), VersionNormalize(), VersionSet()
property XOP as %String);
Used to maintain the XOP href when imported
Property methods: XOPDisplayToLogical(), XOPGet(), XOPIsValid(), XOPLogicalToDisplay(), XOPLogicalToOdbc(), XOPNormalize(), XOPSet()
property ZipItems as list of HS.Types.ZipItem;
Property methods: ZipItemsBuildValueArray(), ZipItemsCollectionToDisplay(), ZipItemsCollectionToOdbc(), ZipItemsDisplayToCollection(), ZipItemsGet(), ZipItemsGetObject(), ZipItemsGetObjectId(), ZipItemsGetSwizzled(), ZipItemsIsValid(), ZipItemsOdbcToCollection(), ZipItemsSet(), ZipItemsSetObject(), ZipItemsSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new tab