Skip to main content


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

SQL Table Name: HS_Registry_Document.FHIR

Property Inventory

Method Inventory


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.


property DocumentUniqueID as %String) [ Required ];
Property methods: DocumentUniqueIDDisplayToLogical(), DocumentUniqueIDGet(), DocumentUniqueIDGetStored(), DocumentUniqueIDIsValid(), DocumentUniqueIDLogicalToDisplay(), DocumentUniqueIDLogicalToOdbc(), DocumentUniqueIDNormalize(), DocumentUniqueIDSet()
property FHIRResourceId as %String) [ Required ];
Property methods: FHIRResourceIdDisplayToLogical(), FHIRResourceIdGet(), FHIRResourceIdGetStored(), FHIRResourceIdIsValid(), FHIRResourceIdLogicalToDisplay(), FHIRResourceIdLogicalToOdbc(), FHIRResourceIdNormalize(), FHIRResourceIdSet()
property FHIRVersion as %String);
Property methods: FHIRVersionDisplayToLogical(), FHIRVersionGet(), FHIRVersionGetStored(), FHIRVersionIsValid(), FHIRVersionLogicalToDisplay(), FHIRVersionLogicalToOdbc(), FHIRVersionNormalize(), FHIRVersionSet()
property RepositoryUniqueID as %String) [ Required ];
Property methods: RepositoryUniqueIDDisplayToLogical(), RepositoryUniqueIDGet(), RepositoryUniqueIDGetStored(), RepositoryUniqueIDIsValid(), RepositoryUniqueIDLogicalToDisplay(), RepositoryUniqueIDLogicalToOdbc(), RepositoryUniqueIDNormalize(), RepositoryUniqueIDSet()


classmethod GetFHIRResourceId(pDocumentUniqueId As %String, pRepositoryUniqueId As %String, pFHIRVersion As %String, ByRef pFHIRResourceId As %String) as %Status


index (DocumentIndex on DocumentUniqueID,RepositoryUniqueID,FHIRVersion) [Unique];
Index methods: DocumentIndexCheck(), DocumentIndexCheckUnique(), DocumentIndexDelete(), DocumentIndexExists(), DocumentIndexOpen(), DocumentIndexSQLCheckUnique(), DocumentIndexSQLExists(), DocumentIndexSQLFindPKeyByConstraint(), DocumentIndexSQLFindRowIDByConstraint()
index (FHIRIndex on FHIRVersion,FHIRResourceId) [Unique];
Index methods: FHIRIndexCheck(), FHIRIndexCheckUnique(), FHIRIndexDelete(), FHIRIndexExists(), FHIRIndexOpen(), FHIRIndexSQLCheckUnique(), FHIRIndexSQLExists(), FHIRIndexSQLFindPKeyByConstraint(), FHIRIndexSQLFindRowIDByConstraint()
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: Storage (HS.Registry.Document.FHIR)

FeedbackOpens in a new tab