Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsLib] >  [EDI] >  [X12] >  [Schema]
Private  Storage   

abstract class EnsLib.EDI.X12.Schema

VDoc Schema classmethods and queries

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
30 5


Summary

Methods
BuildCategoryMaps CodeTablesClose CodeTablesExecute CodeTablesFetch
DataStructuresClose DataStructuresExecute DataStructuresFetch DocStructuresClose
DocStructuresExecute DocStructuresFetch ElementExists GetAlias
GetContentArray GetDescription ResolveSchemaTypeToDocType ResolveSegNameToStructure
SegTypesClose SegTypesExecute SegTypesFetch TypeCategoriesClose
TypeCategoriesExecute TypeCategoriesFetch buildCompositeStructMap buildContentArray
buildDocStructureMap buildDocStructureMapLoop buildSegmentStructureMap getCompositesContentArray
getFieldsContentArray getSegsContentArray


Methods

• classmethod BuildCategoryMaps(pCategory As %String) as %Status
• classmethod CodeTablesClose(ByRef qHandle As %Binary) as %Status
• classmethod CodeTablesExecute(ByRef qHandle As %Binary, Category As %String = "", IncludeBase As %Boolean = 0) as %Status
• classmethod CodeTablesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod DataStructuresClose(ByRef qHandle As %Binary) as %Status
• classmethod DataStructuresExecute(ByRef qHandle As %Binary, Category As %String = "", IncludeBase As %Boolean = 0) as %Status
• classmethod DataStructuresFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod DocStructuresClose(ByRef qHandle As %Binary) as %Status
• classmethod DocStructuresExecute(ByRef qHandle As %Binary, Category As %String = "", IncludeBase As %Boolean = 0, IncludeInterchangeTree As %Boolean = 0) as %Status
• classmethod DocStructuresFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod ElementExists(pElementSpec As %String = "") as %Boolean
• classmethod GetAlias(pContentArrayName As %String, pArrayPos As %String) as %String
This method computes the Alias string for a property name, given the property's node in the Content Array.
• classmethod GetContentArray(Output pContents, pMode As %String, pType As %String = "", pLevel As %Integer, pIncludeBase As %Boolean = 0) as %Status
Get all properties for a given document structure
• classmethod GetDescription(pElementSpec As %String, pItem As %Integer = "", pVerbose As %Boolean = 0) as %String
Get the description of an item or an indexed piece of an item
• classmethod ResolveSchemaTypeToDocType(pSchemaCategory As %String, pTypeName As %String, Output pStatus As %Status, pImplementationGuide As %String = "", pPurpose As %String = "") as %String
Given a Schema category and a Document TypeName string, return the corresponding DocType (document structure) The pImplementationGuide argument, if given, is used to disambiguate when a schema category contains multiple versions of a given type of document, e.g. the three types of HIPAA 837.
• classmethod ResolveSegNameToStructure(pSchemaCategory As %String = "", pDocType As %String = "", pSegName As %String = "", Output pStatus As %Status) as %String
Given a Schema Category and a Segment name, and possibly a DocType (required for old-style schemas) return the corresponding segment structure declared in the schema
• classmethod SegTypesClose(ByRef qHandle As %Binary) as %Status
• classmethod SegTypesExecute(ByRef qHandle As %Binary, Category As %String = "", Level As %String = "", IncludeBase As %Boolean = 0, ExpandedDocType As %Boolean = 0) as %Status
• classmethod SegTypesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod TypeCategoriesClose(ByRef qHandle As %Binary) as %Status
• classmethod TypeCategoriesExecute(ByRef qHandle As %Binary, Standard As %String = "") as %Status
• classmethod TypeCategoriesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod buildCompositeStructMap(pDocTypeCategory, pTypeName, pCSMap) as %Status
• classmethod buildContentArray(Output pContents, pMode As %String = "source", pType As %String, pLevel As %Integer = 0) as %Status
Get all properties for a given document structure
• classmethod buildDocStructureMap(pCategory As %String, pDocStructName As %String) as %Status
• classmethod buildDocStructureMapLoop(pContentArrayName As %String, pSchemaPathMap As %String, pNamePrefix As %String, pValuePrefix As %String)
• classmethod buildSegmentStructureMap(pCategory As %String, pSegmentType As %String) as %Status
• classmethod getCompositesContentArray(Output pContents, pMode As %String, pCategory As %String, pCompositeStructType As %String, pLevel As %Integer = 0) as %Status
Get the components of a CompositeStructure / Type
• classmethod getFieldsContentArray(Output pContents, pMode As %String, pCategory As %String, pSeg As %String, pLevel As %Integer) as %Status
Given a segment type, extract the content array for the fields (items)
• classmethod getSegsContentArray(Output pContents, pMode As %String, pCategory As %String, pSchema As %String, pPrevSeg As %String, pLevel As %Integer, Output pSC As %Status = $$$OK) as %Integer

Queries

• query CodeTables(Category As %String = "", IncludeBase As %Boolean = 0)
Selects CodeTable As %String, Description As %String, IsStandard As %Boolean
Returns a list of available Code Tables for the corresponding document class.
The Code Table is returned as the first column in the result set.
The Category parameter can be used to restrict the list.
If Category is:
0 - return only Code Tables in standard categories
+ - return only Code Tables in user-defined categories
empty - return Code Tables from all categories
a category name - return only Code Tables in the named category
a partial name suffixed with '%' - return only Code Tables in categories matching the partial category name
other - return nothing
If IncludeBase is:
0 - return only Code Table defined in the current schema category itself
1 - return all Code Table in the current schema category's base category in addition to those defined in the current category itself
• query DataStructures(Category As %String = "", IncludeBase As %Boolean = 0)
Selects DataStruct As %String, Description As %String, IsStandard As %Boolean
Returns a list of available Composite Data Structures for the corresponding document class.
The Data Structure is returned as the first column in the result set.
The Category parameter can be used to restrict the list.
If Category is:
0 - return only Data Structures in standard categories
+ - return only Data Structures in user-defined categories
empty - return Data Structures from all categories
a category name - return only Data Structures in the named category
a partial name suffixed with '%' - return only Data Structures in categories matching the partial category name
other - return nothing
If IncludeBase is:
0 - return only Data Structure defined in the current schema category itself
1 - return all Data Structure in the current schema category's base category in addition to those defined in the current category itself
• query DocStructures(Category As %String = "", IncludeBase As %Boolean = 0, IncludeInterchangeTree As %Boolean = 0)
Selects DocStructure As %String, Description As %String, IsStandard As %Boolean
Returns a list of available DocTypes for the corresponding document class.
The DocType is returned as the first column in the result set.
The Category parameter can be used to restrict the list.
If Category is:
0 - return only DocTypes in standard categories
+ - return only DocTypes in user-defined categories
empty - return DocTypes from all categories
a category name - return only DocTypes in the named category
a partial name suffixed with '%' - return only DocTypes in categories matching the partial category name
other - return nothing
If IncludeBase is:
0 - return only DocTypes defined in the current schema category itself
1 - return all DocTypes in the current schema category's base category in addition to those defined in the current category itself
• query SegTypes(Category As %String = "", Level As %String = "", IncludeBase As %Boolean = 0, ExpandedDocType As %Boolean = 0)
Selects SegType As %String, Field As %String, Description As %String, IsStandard As %Boolean
Returns a list of schema categories and segment types and segment fields for the corresponding document class.
The Category and Level parameters can be used to restrict the list.
If Category is:
0 - return only standard categories
+ - return only user-defined categories
empty - return all categories
a category name - return only SegTypes in the named category
a category name:segment type name - return only information about the named SegType
a partial name suffixed with '%' - return only SegTypes in categories matching the partial category name
other - return nothing
If Level is:
0 - return all segment names
n - return the given number of levels of nested field names within each segment
empty - return all levels of nested field names within each segment
If IncludeBase is:
0 - return only segment names defined in the current schema category itself
1 - return all segment names in the current schema category's base category in addition to those defined in the current category itself
If ExpandedDocType is:
0 - return all SegTypes as Category:SegName
1 - return old-style SegTypes as Category:DocStruct:Segment-Ordinal
• query TypeCategories(Standard As %String = "")
Selects Category As %String, Description As %String, IsStandard As %Boolean, Base As %String, OldStyle As %Integer
Returns a list of document type schema categories for the document class.
The Standard parameter can be used to restrict the list.
If Standard is: 0 - return only standard categories + - return only user-defined categories empty - return all categories a partial category name - return only categories starting with the given category name part
other - return nothing
OldStyle=-1 if only old is available, 0 if only new is available, 1 if both are available but old is preferred, empty if both are available and new is preferred

Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.