EmergencyDepartment::Classes
Class CPERole

This file contains the user role settings. (CPE - Clinical Practice Environment)

Attributes
String abbreviation abbreviation

The abbreviation for the role.

Boolean allowAcuityEdit allowAcuityEdit

String defaultBoard defaultBoard

«File 232.6» EDPWorksheetSpecification defaultWorksheet defaultWorksheet
String role role

This is the role for use in the EDIS application.

String xmlAbbreviation xmlAbbreviation

This is the xml abbreviation for the role. Previously, logic had been hardcoded to check the role type. 'P' = "@md" 'N' = "@rn" 'R' = "@res" These values will remain the same, however they are now part of the file, and can be more easily enhanced to add roles in the future. The roles will now be able to be built without having to release a KIDS build to do so. All role settings are now table driven. This is accessed and used to build information out of the CLRSTAFF tag in EDPQDBS.

String xmlStaffName xmlStaffName

This holds the staff name that is related to building the XML needed for the client portion of the application. This is built from the LOAD tag in EDPBST.


Properties:

Alias
businessRule[]
Classifier Behavior
dateAdded3/3/14
dateModified
fileNameCPE ROLE
fileNumber232.5
highLevelConcept
informationDomain
Is Abstractfalse
Is Activefalse
Is Leaffalse
KeywordsFile 232.5
modReason
NameCPERole
Name Expression
NamespaceClasses
note
originalName
Owned Template Signature
OwnerClasses
Owning Template Parameter
PackageClasses
packageNameEMERGENCY DEPARTMENT
projectID
Qualified NameHybrid::EmergencyDepartment::Classes::CPERole
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
Representation
requestedBy
rootClass
StereotypeClassDictionary, VistaClassDictionary
synonym
Template Parameter
VisibilityPublic

Attribute Details

 abbreviation
Public String abbreviation

The abbreviation for the role.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 232.5» CPERole
dataTypeFREE TEXT
Datatype
dateAdded03/03/14
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameABBREVIATION
fieldNumber.02
fileNumber232.5
formatRule
formatString
generalDescriptionThe abbreviation for the role.
helpTextAnswer must be 1-3 characters in length.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredTrue
Keywords
Lower1
Lower Value(1)
maxLength3
minLength1
modReason
Multiplicity1
Nameabbreviation
Name Expression
Namespace«File 232.5» CPERole
note
Opposite
originalClass
originalName
Owner«File 232.5» CPERole
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::EmergencyDepartment::Classes::CPERole::abbreviation
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 allowAcuityEdit
Public Boolean allowAcuityEdit

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 232.5» CPERole
dataTypeSET
Datatype
dateAdded03/03/14
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameALLOW ACUITY EDIT
fieldNumber.06
fileNumber232.5
formatRule
formatString
generalDescription-
helpText-
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameallowAcuityEdit
Name Expression
Namespace«File 232.5» CPERole
note
Opposite
originalClass
originalName
Owner«File 232.5» CPERole
Owning Association
Owning Template Parameter
permissableValueMeaningsNO;YES
permissableValues0;1
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::EmergencyDepartment::Classes::CPERole::allowAcuityEdit
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 defaultBoard
Public String defaultBoard

Constraints:
Properties:

absMaxLength30
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 232.5» CPERole
dataTypeFREE TEXT
Datatype
dateAdded03/03/14
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameDEFAULT BOARD
fieldNumber.05
fileNumber232.5
formatRule
formatString
generalDescription-
helpTextAnswer must be 1-30 characters in length.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength30
minLength1
modReason
Multiplicity0..1
NamedefaultBoard
Name Expression
Namespace«File 232.5» CPERole
note
Opposite
originalClass
originalName
Owner«File 232.5» CPERole
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::EmergencyDepartment::Classes::CPERole::defaultBoard
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 defaultWorksheet
Public «File 232.6» EDPWorksheetSpecification defaultWorksheet
Constraints:
Properties:

AggregationNone
Alias
Association«VistaAssociationDictionary» (defaultWorksheet:EDPWorksheetSpecification)
Association End
businessRule[]
Class«File 232.5» CPERole
Datatype
dateAdded
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
formatRule
formatString
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isNullableFalse
Keywords
Lower0
Lower Value(0)
modReason
Multiplicity0..1
NamedefaultWorksheet
Name Expression
Namespace«File 232.5» CPERole
note
Opposite
originalClass
originalName
Owner«File 232.5» CPERole
Owning Association
Owning Template Parameter
Qualified NameHybrid::EmergencyDepartment::Classes::CPERole::defaultWorksheet
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary
synonym
Template Parameter
Type«File 232.6» EDPWorksheetSpecification
Upper1
Upper Value(1)
VisibilityPublic


 role
Public String role

This is the role for use in the EDIS application.

Constraints:
Properties:

absMaxLength60
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 232.5» CPERole
dataTypeFREE TEXT
Datatype
dateAdded03/03/14
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameROLE
fieldNumber.01
fileNumber232.5
formatRule
formatString
generalDescriptionThis is the role for use in the EDIS application.
helpTextAnswer must be 3-60 characters in length.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredTrue
Keywords
Lower1
Lower Value(1)
maxLength60
minLength3
modReason
Multiplicity1
Namerole
Name Expression
Namespace«File 232.5» CPERole
note
Opposite
originalClass
originalName
Owner«File 232.5» CPERole
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::EmergencyDepartment::Classes::CPERole::role
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 xmlAbbreviation
Public String xmlAbbreviation

This is the xml abbreviation for the role. Previously, logic had been hardcoded to check the role type. 'P' = "@md" 'N' = "@rn" 'R' = "@res" These values will remain the same, however they are now part of the file, and can be more easily enhanced to add roles in the future. The roles will now be able to be built without having to release a KIDS build to do so. All role settings are now table driven. This is accessed and used to build information out of the CLRSTAFF tag in EDPQDBS.

Constraints:
Properties:

absMaxLength7
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 232.5» CPERole
dataTypeFREE TEXT
Datatype
dateAdded03/03/14
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameXML ABBREVIATION
fieldNumber.03
fileNumber232.5
formatRule
formatString
generalDescriptionThis is the xml abbreviation for the role. Previously, logic had been hardcoded to check the role type. 'P' = "@md" 'N' = "@rn" 'R' = "@res" These values will remain the same, however they are now part of the file, and can be more easily enhanced to add roles in the future. The roles will now be able to be built without having to release a KIDS build to do so. All role settings are now table driven. This is accessed and used to build information out of the CLRSTAFF tag in EDPQDBS.
helpTextAnswer must be 2-7 characters in length.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredTrue
Keywords
Lower1
Lower Value(1)
maxLength7
minLength2
modReason
Multiplicity1
NamexmlAbbreviation
Name Expression
Namespace«File 232.5» CPERole
note
Opposite
originalClass
originalName
Owner«File 232.5» CPERole
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::EmergencyDepartment::Classes::CPERole::xmlAbbreviation
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionAny time a new role is added, the UI will need to change to be able to consume the new role type. In addition to this field, the XML ROLE NAME will need to be entered in order to pass the needed information back to the client application. There is flexibility in the use of these two fields, however they MUST be defined when creating a new role. For example: Currently for the role of 'Provider', the XML ABBREVIATION field is "@md", and the XML ROLE NAME is 'providers'. As long as these fields are unique to this role, the API's will build meaningful information for the client to consume.
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 xmlStaffName
Public String xmlStaffName

This holds the staff name that is related to building the XML needed for the client portion of the application. This is built from the LOAD tag in EDPBST.

Constraints:
Properties:

absMaxLength30
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 232.5» CPERole
dataTypeFREE TEXT
Datatype
dateAdded03/03/14
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameXML STAFF NAME
fieldNumber.07
fileNumber232.5
formatRule
formatString
generalDescriptionThis holds the staff name that is related to building the XML needed for the client portion of the application. This is built from the LOAD tag in EDPBST.
helpTextAnswer must be 2-30 characters in length.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredTrue
Keywords
Lower1
Lower Value(1)
maxLength30
minLength2
modReason
Multiplicity1
NamexmlStaffName
Name Expression
Namespace«File 232.5» CPERole
note
Opposite
originalClass
originalName
Owner«File 232.5» CPERole
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::EmergencyDepartment::Classes::CPERole::xmlStaffName
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThis is a value such as '@rn' or '@md' that was previously hard-coded. This was changed to be a part of the file.
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic