This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsLib.HL7.Schema

EnsLib.HL7.Schema

abstract class EnsLib.HL7.Schema

VDoc Schema classmethods and queries

Method Inventory

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 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 = "") as %String
Get the description of an item or an indexed piece of an item
classmethod GetFieldNameFromNumber(SchemaCategory As %String, SegmentName As %String, FieldNumber As %String) as %String
classmethod GetFieldNumberFromName(SchemaCategory As %String, SegmentName As %String, FieldName As %String) as %String
classmethod MessageStructuresClose(ByRef qHandle As %Binary) as %Status
classmethod MessageStructuresExecute(ByRef qHandle As %Binary, Category As %String = "", IncludeBase As %Boolean = 0) as %Status
classmethod MessageStructuresFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod MessageTypesClose(ByRef qHandle As %Binary) as %Status
classmethod MessageTypesExecute(ByRef qHandle As %Binary, Category As %String = "", IncludeBase As %Boolean = 0) as %Status
classmethod MessageTypesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod ResolveReplyNameAndDocType(pMessageType As %String, Output pReplyMsgName As %String, Output pReplyDocType As %String, pForceAck As %Boolean = 1)
Given an HL7 Schema category and a Message TypeName string, return the corresponding commit ACK name and doctype Note: CommitAck name and doctype are not specified from the message structure definition
classmethod ResolveSchemaTypeToDocType(pSchemaCategory As %String, pTypeName As %String, Output pStatus As %Status, pDocTypeResolution As %String = "") as %String
Given a Schema category and a Message TypeName string, return the corresponding HL7 DocType (message 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) 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 buildComponentStructMap(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 getComponentsContentArray(Output pContents, pMode As %String, pCategory As %String, pDataStructType As %String, pLevel As %Integer = 0) as %Status
Get the components of a DataStructure / 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 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 MessageStructures(Category As %String = "", IncludeBase As %Boolean = 0)
Selects MessageStructure As %String, Description As %String, IsStandard As %Boolean
Returns a list of available DocTypes for the corresponding document class.
Note that for HL7 DocType is not the same as Message Type; rather it corresponds to Message Structure.
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 MessageTypes(Category As %String = "", IncludeBase As %Boolean = 0)
Selects MessageStructure As %String, Description As %String, IsStandard As %Boolean
Returns a list of available MessageTypes for the corresponding document class.
Note that for HL7 DocType is not the same as Message Type; rather DocType corresponds to Message Structure.
The MessageTypes 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 MessageTypes in standard categories
+ - return only MessageTypes in user-defined categories
empty - return MessageTypes from all categories
a category name - return only MessageTypes in the named category
a partial name suffixed with '%' - return only MessageTypes in categories matching the partial category name
other - return nothing
If IncludeBase is:
0 - return only MessageTypes defined in the current schema category itself
1 - return all MessageTypes 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)
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
query TypeCategories(Standard As %String = "")
Selects Category As %String, Description As %String, IsStandard As %Boolean, Base As %String
FeedbackOpens in a new window