HS.IHE.CodedEntry
persistent class HS.IHE.CodedEntry extends %Library.Persistent, %XML.Adaptor, HS.Sync.BaseClass, %Library.GlobalIdentifier
SQL Table Name: HS_IHE.CodedEntry
XSDb Coded values, sync'd from HUBProperty Inventory
Method Inventory
- Create()
- CreateOrUpdate()
- DistinctTypesClose()
- DistinctTypesExecute()
- DistinctTypesFetch()
- GetFormatToHTML()
- GetFormatToSDA()
- GetToOtherFlag()
- ImportFromURL()
- ItemsClose()
- ItemsExecute()
- ItemsFetch()
- SetupAUCDA()
- SetupBPPC()
- SetupCCDAR11()
- SetupCCDAR21()
- SetupCDA()
- SetupNHIN()
- SetupScannedDocument()
- ValidateEntry()
Parameters
parameter SYNCORDER = 140;
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 = 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.
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 Code as %String (MAXLEN = 255) [ Required ];
Classification code
Property methods: CodeDisplayToLogical(), CodeGet(), CodeGetStored(), CodeIsValid(), CodeLogicalToDisplay(), CodeLogicalToOdbc(), CodeNormalize(), CodeSet(), CodeTypeDisplayToLogical(), CodeTypeGet(), CodeTypeGetStored(), CodeTypeIsValid(), CodeTypeLogicalToDisplay(), CodeTypeLogicalToOdbc(), CodeTypeNormalize(), CodeTypeSet()
property CodeType as %String (VALUELIST = ",contentTypeCode,classCode,confidentialityCode,formatCode,healthcareFacilityTypeCode,practiceSettingCode,eventCodeList,typeCode,folderCodeList,associationDocumentation") [ Required ];
XDSb Classification Type (i.e. contentTypeCode, formatCode, etc)
NOTE: NIST defines mimeType as a code, we do not
Property methods: CodeTypeDisplayToLogical(), CodeTypeGet(), CodeTypeGetStored(), CodeTypeIsValid(), CodeTypeLogicalToDisplay(), CodeTypeLogicalToOdbc(), CodeTypeNormalize(), CodeTypeSet()
property CodingScheme as %String (MAXLEN = 255) [ Required ];
Classification coding scheme
Property methods: CodingSchemeDisplayToLogical(), CodingSchemeGet(), CodingSchemeGetStored(), CodingSchemeIsValid(), CodingSchemeLogicalToDisplay(), CodingSchemeLogicalToOdbc(), CodingSchemeNormalize(), CodingSchemeSet()
property Description as %String (MAXLEN = 1024);
Classification display string
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property ToHTML as %String (MAXLEN = 1024);
Optional XSLT transform for converting to HTML
Property methods: ToHTMLDisplayToLogical(), ToHTMLGet(), ToHTMLGetStored(), ToHTMLIsValid(), ToHTMLLogicalToDisplay(), ToHTMLLogicalToOdbc(), ToHTMLNormalize(), ToHTMLSet()
property ToOther as %String (MAXLEN = 255);
Optional arbitrary processing for repository documents when opened via the documents tab in the viewer
Insert the full classname of a custom class which extends HS.IHE.XDSb.Consumer.ViewerFetchProcess.BaseOtherHandler
Note: This will not execute if ToHTML is valued
Property methods: ToOtherDisplayToLogical(), ToOtherGet(), ToOtherGetStored(), ToOtherIsValid(), ToOtherLogicalToDisplay(), ToOtherLogicalToOdbc(), ToOtherNormalize(), ToOtherSet()
property ToSDA as %String (MAXLEN = 1024);
Optional XSLT transform for converting to SDA
Property methods: ToSDADisplayToLogical(), ToSDAGet(), ToSDAGetStored(), ToSDAIsValid(), ToSDALogicalToDisplay(), ToSDALogicalToOdbc(), ToSDANormalize(), ToSDASet()
Methods
classmethod Create(CodeType As %String = "", CodingScheme As %String = "", Code As %String = "", Description As %String = "", ToSDA As %String = "", ToHTML As %String = "") as %Status [ Language = objectscript ]
method CreateOrUpdate() as %Status [ Language = objectscript ]
classmethod DistinctTypesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
classmethod GetFormatToHTML(pCode As %String = "", pScheme As %String = "", Output pTransform As %String = "") as %Status [ Language = objectscript ]
Get the XSL transform for converting a XDSb DocumentEntry from specified format to HTML
classmethod GetFormatToSDA(pCode As %String = "", pScheme As %String = "", Output pTransform As %String = "") as %Status [ Language = objectscript ]
Get the XSL transform for converting a XDSb DocumentEntry from specified format to SDA
classmethod GetToOtherFlag(pCode As %String = "", pScheme As %String = "", Output pTransform As %String = "") as %Status [ Language = objectscript ]
Import codes from an XML source, such as http://ihexds.nist.gov:80/xdsref/codes/codes.xml
classmethod ItemsExecute(ByRef qHandle As %Binary, pType As %String = "", pSearch As %String = "") as %Status [ Language = objectscript ]
classmethod ItemsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
classmethod SetupAUCDA() as %Status [ Language = objectscript ]
classmethod SetupBPPC() as %Status [ Language = objectscript ]
Adds BPPC specific codes, called by the HS.Util.Installer
classmethod SetupCCDAR11() as %Status [ Language = objectscript ]
Adds Consolidated CDA R1.1 officially sanctioned codes, called by SetupCDA and by upgrade step.
classmethod SetupCCDAR21() as %Status [ Language = objectscript ]
Adds Consolidated CDA R2.1 officially sanctioned codes, called by SetupCDA and by upgrade step.
classmethod SetupCDA() as %Status [ Language = objectscript ]
classmethod SetupNHIN() as %Status [ Language = objectscript ]
classmethod SetupScannedDocument() as %Status [ Language = objectscript ]
Queries
query DistinctTypes()
Selects Type As %String
Indexes
index (UniqueIndex on CodeType,CodingScheme,Code) [Unique];
Index methods: UniqueIndexCheck(), UniqueIndexCheckUnique(), UniqueIndexDelete(), UniqueIndexExists(), UniqueIndexOpen(), UniqueIndexSQLCheckUnique(), UniqueIndexSQLExists(), UniqueIndexSQLFindPKeyByConstraint(), UniqueIndexSQLFindRowIDByConstraint()
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDetermineClass()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %OverrideGuidAssignment()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- GetGlobalInfo()
- GetSQLTableName()
- MappingData()
- SyncTables()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Storage
Storage Model: Storage (HS.IHE.CodedEntry)
^HS.IHE.CodedEntryD(ID) |
= | %%CLASSNAME
CodeType
CodingScheme
Code
Description
ToHTML
ToSDA
ToOther
|