Skip to main content


class EnsPortal.HL7.SchemaDocumentStructure extends EnsPortal.HL7.Template

Property Inventory

Method Inventory


parameter CSSINCLUDES = ensemble/Ensemble_Wizards.css,ensemble/Ensemble_EDI.css,ensemble/Ensemble_SchemaStruct.css,bootstrap-4-4-1/dist/css/bootstrap.min.css;
Inherited description: Comma-separated list of additional CSS include files for the page. If this page is using CSS3 then the CSS3INCLUDES parameter is used (if defined).
parameter JSINCLUDES = ensschemazen.js,fontawesome-5.12.0.all.js,jquery-3.5.1.min.js,bootstrap-4-4-1/dist/js/bootstrap.min.js;
Comma-delimited list of additional .js files.
parameter PAGENAME = HL7 Schema Message Structure;
Displayed name of this page.


property Category as %String;
Property methods: CategoryDisplayToLogical(), CategoryGet(), CategoryIsValid(), CategoryLogicalToDisplay(), CategoryLogicalToOdbc(), CategoryNormalize(), CategorySet()
property CopyFromBase as %Boolean (ZENURL = "COPY") [ InitialExpression = "false" ];
Property methods: CopyFromBaseDisplayToLogical(), CopyFromBaseGet(), CopyFromBaseIsValid(), CopyFromBaseLogicalToDisplay(), CopyFromBaseLogicalToXSD(), CopyFromBaseNormalize(), CopyFromBaseSet(), CopyFromBaseXSDToLogical()
property DocType as %String;
Property methods: DocTypeDisplayToLogical(), DocTypeGet(), DocTypeIsValid(), DocTypeLogicalToDisplay(), DocTypeLogicalToOdbc(), DocTypeNormalize(), DocTypeSet()
property docStruct as %String);
Property methods: docStructDisplayToLogical(), docStructGet(), docStructIsValid(), docStructLogicalToDisplay(), docStructLogicalToOdbc(), docStructNormalize(), docStructSet()
property lastSaved as %String;
Property methods: lastSavedDisplayToLogical(), lastSavedGet(), lastSavedIsValid(), lastSavedLogicalToDisplay(), lastSavedLogicalToOdbc(), lastSavedNormalize(), lastSavedSet()
property listViewMode as %String (VALUELIST = "All,Custom") [ InitialExpression = "All" ];
Property methods: listViewModeDisplayToLogical(), listViewModeGet(), listViewModeIsValid(), listViewModeLogicalToDisplay(), listViewModeLogicalToOdbc(), listViewModeNormalize(), listViewModeSet()
property rawDefinition as %String;
Property methods: rawDefinitionDisplayToLogical(), rawDefinitionGet(), rawDefinitionIsValid(), rawDefinitionLogicalToDisplay(), rawDefinitionLogicalToOdbc(), rawDefinitionNormalize(), rawDefinitionSet()
property viewMode as %String (VALUELIST = "SVG,RAW") [ InitialExpression = "SVG" ];
Property methods: viewModeDisplayToLogical(), viewModeGet(), viewModeIsValid(), viewModeLogicalToDisplay(), viewModeLogicalToOdbc(), viewModeNormalize(), viewModeSet()


method %OnAfterCreatePage() as %Status
Inherited description: Decorate the page.
method %OnGetPageName() as %String
Get the (localized) name of the page.
method DeleteStructure(pSchema As %String, pMessageStructure As %String) as %ZEN.Datatype.string [ ZenMethod ]
method DrawHTMLForm(pSeed As %String) as %Status
method DrawIcons(pSeed As %String) as %Status
method DrawRaw(pSeed As %String) as %Status
method DrawSVG(pSeed As %String) as %Status
method DrawSegList(pSeed As %String) as %Status
method DrawTitles(pSeed As %String) as %Status
method GetBase(pCategory) as %String [ ZenMethod ]
classmethod GetFullSegName(pSegName As %String, pCategory As %String) as %String
classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
classmethod GetRawContent(pDocType) as %String [ ZenMethod ]
classmethod GetRawNoPrefixes(pRaw) as %String
method GetSchemaSelectList(ByRef pArray)
method GetSegPage(pSegName As %String) as %String [ ZenMethod ]
method GetSegmentDescription(pName) [ ZenMethod ]
method GetSegments(pSegment As %String, pNodeAddr As %String = "") as %Boolean [ ZenMethod ]
Called from client to get list of subsegments pNodeAddr is csv-list of id numbers
method GetSegmentsList(pFilter As %String = "All") as %Boolean [ ZenMethod ]
method GetTopSegments(pDyn As %Boolean = 0) as %Boolean [ ZenMethod ]
Generate JS to populate list of top-level segment
classmethod GetValidationDataFromServer(pCustomSchema As %String, pNewMS As %String) as %String [ ZenMethod ]
Get all the necessary data from the server in one call and use it later. pCustomSchema and pNewMS are without prefix or suffix.

Here is the format of the semi-colon separated string (values shown in angle brackets which are not really there):

method IsCustomSchema(pCategory) as %Boolean [ ZenMethod ]
method PutNewMessageOnServer(pCategory As %String, pStructure As %String, pRawDescription As %String, pTextDescription As %String) as %String [ ZenMethod ]
clientmethod adjustDiagramScrollBox() [ Language = javascript ]
clientmethod adjustListScrollBox() [ Language = javascript ]
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod clearKeyBuffer() [ Language = javascript ]
clientmethod clearKeyRedoBuffer() [ Language = javascript ]
clientmethod decrementKeyBuffer() [ Language = javascript ]
clientmethod decrementKeyRedoBuffer() [ Language = javascript ]
clientmethod doDelete() [ Language = javascript ]
clientmethod doEdit() [ Language = javascript ]
clientmethod doFilter() [ Language = javascript ]
clientmethod doMouseMove(evt) [ Language = javascript ]
clientmethod doMouseUp(evt) [ Language = javascript ]
clientmethod doNewSS() [ Language = javascript ]
clientmethod doSave() [ Language = javascript ]
clientmethod doUndoKey() [ Language = javascript ]
clientmethod incrementKeyBuffer(raw, inRedo) [ Language = javascript ]
clientmethod initUIConstraints() [ Language = javascript ]
clientmethod initializeSVG(noAdjust) [ Language = javascript ]
clientmethod loadSegListFromServer() [ Language = javascript ]
Load the list of available segements from the server
clientmethod loadSegmentsFromServer(origName, idlist) [ Language = javascript ]
Load specified segments from the server.
clientmethod loadTopSegmentsFromServer(reload) as %Boolean [ Language = javascript ]
Load top-level document segments from the server and populate part of the diagram.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod propertyClick(prop) [ Language = javascript ]
User double-clicked on a property box in the diagram.
method scCategoryGet() as %String
Inherited description: Override to return correct Category
clientmethod setModified(flag As %Library.String) [ Language = javascript ]
Inherited description: Set the modified flag for the page.
clientmethod setRawFromSVG() [ Language = javascript ]
clientmethod sortOutEntityName(name, msg) [ Language = javascript ]
clientmethod switchViewMode() [ Language = javascript ]
clientmethod textKeyUp() [ Language = javascript ]
clientmethod updateCopyStruct(docType) [ Language = javascript ]
clientmethod validateAll() [ Language = javascript ]
clientmethod validateContentToDisplay(doAlert) as %Boolean [ Language = javascript ]
clientmethod validateRaw(raw) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab