Plan Definition Action in electronicMedicalRecords

An action to be taken as part of the plan.

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"1.1"stringsemantic version number of the entity

is.identifiedBy
names a specifc identity attribute to use with an entity

ParameterValueData typeExplanation
attributePlanDefinitionAction/(resolvedAttributes)/planDefinitionActionIdattribute

means.entityState
the attribute represents the current state of the entity.

ParameterValueData typeExplanation
attributePlanDefinitionAction/(resolvedAttributes)/stateCodeattribute

is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.

ParameterValueData typeExplanation
groupList
attributeGroupReference
/core/applicationCommon/foundationCommon
/crmCommon/accelerators/healthCare
/electronicMedicalRecords
/PlanDefinitionAction.cdm.json
/PlanDefinitionAction/hasAttributes
/attributesAddedAtThisScope
entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPlan Definition Action
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAn action to be taken as part of the plan.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_plandefinitionaction"string

Attributes

Name Description First Included in Instance
createdBy Unique identifier of the user who created the record. electronicMedicalRecords/PlanDefinitionAction
createdOn Date and time when the record was created. electronicMedicalRecords/PlanDefinitionAction
createdOnBehalfBy Unique identifier of the delegate user who created the record. electronicMedicalRecords/PlanDefinitionAction
importSequenceNumber Sequence number of the import that created this record. electronicMedicalRecords/PlanDefinitionAction
modifiedBy Unique identifier of the user who modified the record. electronicMedicalRecords/PlanDefinitionAction
modifiedOn Date and time when the record was modified. electronicMedicalRecords/PlanDefinitionAction
modifiedOnBehalfBy Unique identifier of the delegate user who modified the record. electronicMedicalRecords/PlanDefinitionAction
cardinalityBehavior Defines whether the action can be selected multiple times. electronicMedicalRecords/PlanDefinitionAction
cardinalityBehavior_display electronicMedicalRecords/PlanDefinitionAction
definitionactivityId A reference to an ActivityDefinition that describes the action to be taken in detail. electronicMedicalRecords/PlanDefinitionAction
definitionplanId A reference to a PlanDefinition that describes a series of actions to be taken. electronicMedicalRecords/PlanDefinitionAction
definitionType Type of definition electronicMedicalRecords/PlanDefinitionAction
definitionType_display electronicMedicalRecords/PlanDefinitionAction
description A brief, natural language description of the intended semantics of the dynamic value. electronicMedicalRecords/PlanDefinitionAction
groupingBehavior Defines the selection behavior for the action and its children. electronicMedicalRecords/PlanDefinitionAction
groupingBehavior_display electronicMedicalRecords/PlanDefinitionAction
label A user-visible label for the action. electronicMedicalRecords/PlanDefinitionAction
name The name of the custom entity. electronicMedicalRecords/PlanDefinitionAction
planDefinitionId This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. electronicMedicalRecords/PlanDefinitionAction
planDefinitionActionId Unique identifier for entity instances electronicMedicalRecords/PlanDefinitionAction
preCheckBehavior Defines whether the action should usually be preselected. electronicMedicalRecords/PlanDefinitionAction
requiredBehavior Defines the requiredness behavior for the action. electronicMedicalRecords/PlanDefinitionAction
requiredBehavior_display electronicMedicalRecords/PlanDefinitionAction
selectionBehavior Defines the selection behavior for the action and its children. electronicMedicalRecords/PlanDefinitionAction
selectionBehavior_display electronicMedicalRecords/PlanDefinitionAction
textEquivalent A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system. electronicMedicalRecords/PlanDefinitionAction
timingdatetime An optional value describing when the action should be performed. electronicMedicalRecords/PlanDefinitionAction
timingduration An optional duration value describing when the action should be performed. electronicMedicalRecords/PlanDefinitionAction
timingenddate An optional period end date value describing when the action should be performed. electronicMedicalRecords/PlanDefinitionAction
timinglowerlimit An optional lower range value describing when the action should be performed. electronicMedicalRecords/PlanDefinitionAction
timingstartdate An optional period start date value describing when the action should be performed. electronicMedicalRecords/PlanDefinitionAction
timingtimingId An optional value describing when the action should be performed. electronicMedicalRecords/PlanDefinitionAction
timingType Type of timing electronicMedicalRecords/PlanDefinitionAction
timingType_display electronicMedicalRecords/PlanDefinitionAction
timingupperlimit An optional upper range value describing when the action should be performed. electronicMedicalRecords/PlanDefinitionAction
title The title of the action displayed to a user. electronicMedicalRecords/PlanDefinitionAction
transformId A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the Activity Definition instance as the input. electronicMedicalRecords/PlanDefinitionAction
type The type of action to perform (create, update, remove). electronicMedicalRecords/PlanDefinitionAction
type_display electronicMedicalRecords/PlanDefinitionAction
organizationId Unique identifier for the organization electronicMedicalRecords/PlanDefinitionAction
overriddenCreatedOn Date and time that the record was migrated. electronicMedicalRecords/PlanDefinitionAction
stateCode Status of the Plan Definition Action electronicMedicalRecords/PlanDefinitionAction
stateCode_display electronicMedicalRecords/PlanDefinitionAction
statusCode Reason for the status of the Plan Definition Action electronicMedicalRecords/PlanDefinitionAction
statusCode_display electronicMedicalRecords/PlanDefinitionAction
timeZoneRuleVersionNumber For internal use only. electronicMedicalRecords/PlanDefinitionAction
UTCConversionTimeZoneCode Time zone code that was in use when the record was created. electronicMedicalRecords/PlanDefinitionAction

createdBy

Unique identifier of the user who created the record.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameCreated By
descriptionUnique identifier of the user who created the record.
dataFormatguid
isNullabletrue
sourceNamecreatedby

Traits

List of traits for the createdBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated By
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the user who created the record.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdby"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

createdOn

Date and time when the record was created.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameCreated On
descriptionDate and time when the record was created.
dataFormatdateTime
isNullabletrue
sourceNamecreatedon

Traits

List of traits for the createdOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.creation
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdon"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated On
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time when the record was created.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.time
is.dataFormat.date

createdOnBehalfBy

Unique identifier of the delegate user who created the record.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameCreated By (Delegate)
descriptionUnique identifier of the delegate user who created the record.
dataFormatguid
isNullabletrue
sourceNamecreatedonbehalfby

Traits

List of traits for the createdOnBehalfBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdonbehalfby"string

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated By (Delegate)
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the delegate user who created the record.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

importSequenceNumber

Sequence number of the import that created this record.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameImport Sequence Number
descriptionSequence number of the import that created this record.
dataFormatint32
maximumValue2147483647
minimumValue-2147483648
isNullabletrue
sourceNameimportsequencenumber

Traits

List of traits for the importSequenceNumber attribute are listed below.

is.dataFormat.integer
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"importsequencenumber"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-2147483648"decimal
maximumValue"2147483647"decimal

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enImport Sequence Number
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSequence number of the import that created this record.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

modifiedBy

Unique identifier of the user who modified the record.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameModified By
descriptionUnique identifier of the user who modified the record.
dataFormatguid
isNullabletrue
sourceNamemodifiedby

Traits

List of traits for the modifiedBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified By
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the user who modified the record.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedby"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

modifiedOn

Date and time when the record was modified.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameModified On
descriptionDate and time when the record was modified.
dataFormatdateTime
isNullabletrue
sourceNamemodifiedon

Traits

List of traits for the modifiedOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.modify
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedon"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified On
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time when the record was modified.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.time
is.dataFormat.date

modifiedOnBehalfBy

Unique identifier of the delegate user who modified the record.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameModified By (Delegate)
descriptionUnique identifier of the delegate user who modified the record.
dataFormatguid
isNullabletrue
sourceNamemodifiedonbehalfby

Traits

List of traits for the modifiedOnBehalfBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedonbehalfby"string

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified By (Delegate)
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the delegate user who modified the record.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

cardinalityBehavior

Defines whether the action can be selected multiple times.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameCardinality Behavior
descriptionDefines whether the action can be selected multiple times.
dataFormatint32
isNullabletrue
sourceNamemsemr_cardinalitybehavior
valueConstrainedToListtrue
defaultValue

Traits

List of traits for the cardinalityBehavior attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enSingle935000000
enMultiple935000001
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_cardinalitybehavior"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCardinality Behavior
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDefines whether the action can be selected multiple times.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

cardinalityBehavior_display

First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the cardinalityBehavior_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"cardinalityBehavior"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

definitionactivityId

A reference to an ActivityDefinition that describes the action to be taken in detail.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameActivity Definition
descriptionA reference to an ActivityDefinition that describes the action to be taken in detail.
dataFormatguid
isNullabletrue
sourceNamemsemr_definitionactivity

Traits

List of traits for the definitionactivityId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActivity Definition
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enA reference to an ActivityDefinition that describes the action to be taken in detail.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/ActivityDefinition.cdm.json/ActivityDefinitionidentifiesspecifictimeswhentheeventoccuId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_definitionactivity"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

definitionplanId

A reference to a PlanDefinition that describes a series of actions to be taken.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNamePlan Definition
descriptionA reference to a PlanDefinition that describes a series of actions to be taken.
dataFormatguid
isNullabletrue
sourceNamemsemr_definitionplan

Traits

List of traits for the definitionplanId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPlan Definition
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enA reference to a PlanDefinition that describes a series of actions to be taken.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/PlanDefinition.cdm.json/PlanDefinitionplanDefinitionId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_definitionplan"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

definitionType

Type of definition
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameDefinition Type
descriptionType of definition
dataFormatint32
isNullabletrue
sourceNamemsemr_definitiontype
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enActivity Definition935000000
enPlan Definition935000001

Traits

List of traits for the definitionType attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enActivity Definition935000000
enPlan Definition935000001
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_definitiontype"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDefinition Type
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enType of definition
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

definitionType_display

First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the definitionType_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"definitionType"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

description

A brief, natural language description of the intended semantics of the dynamic value.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameDescription
descriptionA brief, natural language description of the intended semantics of the dynamic value.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsemr_description

Traits

List of traits for the description attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_description"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDescription
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enA brief, natural language description of the intended semantics of the dynamic value.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

groupingBehavior

Defines the selection behavior for the action and its children.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameGrouping Behavior
descriptionDefines the selection behavior for the action and its children.
dataFormatint32
isNullabletrue
sourceNamemsemr_groupingbehavior
valueConstrainedToListtrue
defaultValue

Traits

List of traits for the groupingBehavior attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enVisual Group935000000
enLogical Group935000001
enSentence Group935000002
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_groupingbehavior"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enGrouping Behavior
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDefines the selection behavior for the action and its children.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

groupingBehavior_display

First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the groupingBehavior_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"groupingBehavior"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

label

A user-visible label for the action.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameLabel
descriptionA user-visible label for the action.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsemr_label

Traits

List of traits for the label attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_label"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLabel
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enA user-visible label for the action.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

name

The name of the custom entity.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameName
descriptionThe name of the custom entity.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsemr_name

Traits

List of traits for the name attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.identity.name
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_name"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enName
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe name of the custom entity.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

planDefinitionId

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNamePlan Definition
descriptionThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact.
dataFormatguid
isNullabletrue
sourceNamemsemr_plandefinition

Traits

List of traits for the planDefinitionId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPlan Definition
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/PlanDefinition.cdm.json/PlanDefinitionplanDefinitionId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_plandefinition"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

planDefinitionActionId

Unique identifier for entity instances
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNamePlan Definition Action
descriptionUnique identifier for entity instances
isPrimaryKeytrue
dataFormatguid
sourceNamemsemr_plandefinitionactionid

Traits

List of traits for the planDefinitionActionId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.identifiedBy
names a specifc identity attribute to use with an entity

ParameterValueData typeExplanation
attributePlanDefinitionAction/(resolvedAttributes)/planDefinitionActionIdattribute

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_plandefinitionactionid"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPlan Definition Action
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier for entity instances
entitya reference to the constant entity holding the list of localized text

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

preCheckBehavior

Defines whether the action should usually be preselected.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNamePre-Check Behavior
descriptionDefines whether the action should usually be preselected.
dataFormatboolean
isNullabletrue
sourceNamemsemr_precheckbehavior

Traits

List of traits for the preCheckBehavior attribute are listed below.

is.dataFormat.boolean
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_precheckbehavior"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPre-Check Behavior
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDefines whether the action should usually be preselected.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.boolean

requiredBehavior

Defines the requiredness behavior for the action.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameRequired Behavior
descriptionDefines the requiredness behavior for the action.
dataFormatint32
isNullabletrue
sourceNamemsemr_requiredbehavior
valueConstrainedToListtrue
defaultValue

Traits

List of traits for the requiredBehavior attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enMust935000000
enCould935000001
enMust Unless Documented935000002
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_requiredbehavior"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRequired Behavior
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDefines the requiredness behavior for the action.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

requiredBehavior_display

First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the requiredBehavior_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"requiredBehavior"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

selectionBehavior

Defines the selection behavior for the action and its children.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameSelection Behavior
descriptionDefines the selection behavior for the action and its children.
dataFormatint32
isNullabletrue
sourceNamemsemr_selectionbehavior
valueConstrainedToListtrue
defaultValue

Traits

List of traits for the selectionBehavior attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enAny935000000
enAll935000001
enAll-Or-None935000002
enExactly-One935000003
enAt-Most-One935000004
enOne-Or-More935000005
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_selectionbehavior"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSelection Behavior
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDefines the selection behavior for the action and its children.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

selectionBehavior_display

First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the selectionBehavior_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"selectionBehavior"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

textEquivalent

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameText Equivalent
descriptionA text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsemr_textequivalent

Traits

List of traits for the textEquivalent attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_textequivalent"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enText Equivalent
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enA text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

timingdatetime

An optional value describing when the action should be performed.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameDate/Time
descriptionAn optional value describing when the action should be performed.
dataFormatdateTime
isNullabletrue
sourceNamemsemr_timingdatetime

Traits

List of traits for the timingdatetime attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_timingdatetime"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate/Time
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAn optional value describing when the action should be performed.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.time
is.dataFormat.date

timingduration

An optional duration value describing when the action should be performed.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameDuration
descriptionAn optional duration value describing when the action should be performed.
dataFormatdecimal
maximumValue100000000000
minimumValue-100000000000
isNullabletrue
sourceNamemsemr_timingduration

Traits

List of traits for the timingduration attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_timingduration"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-100000000000"decimal
maximumValue"100000000000"decimal

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDuration
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAn optional duration value describing when the action should be performed.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

timingenddate

An optional period end date value describing when the action should be performed.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameEnd Date/Time
descriptionAn optional period end date value describing when the action should be performed.
dataFormatdateTime
isNullabletrue
sourceNamemsemr_timingenddate

Traits

List of traits for the timingenddate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_timingenddate"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEnd Date/Time
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAn optional period end date value describing when the action should be performed.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.time
is.dataFormat.date

timinglowerlimit

An optional lower range value describing when the action should be performed.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameLower Limit
descriptionAn optional lower range value describing when the action should be performed.
dataFormatdecimal
maximumValue100000000000
minimumValue-100000000000
isNullabletrue
sourceNamemsemr_timinglowerlimit

Traits

List of traits for the timinglowerlimit attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_timinglowerlimit"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-100000000000"decimal
maximumValue"100000000000"decimal

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLower Limit
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAn optional lower range value describing when the action should be performed.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

timingstartdate

An optional period start date value describing when the action should be performed.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameStart Date/Time
descriptionAn optional period start date value describing when the action should be performed.
dataFormatdateTime
isNullabletrue
sourceNamemsemr_timingstartdate

Traits

List of traits for the timingstartdate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_timingstartdate"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStart Date/Time
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAn optional period start date value describing when the action should be performed.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.time
is.dataFormat.date

timingtimingId

An optional value describing when the action should be performed.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameTiming
descriptionAn optional value describing when the action should be performed.
dataFormatguid
isNullabletrue
sourceNamemsemr_timingtiming

Traits

List of traits for the timingtimingId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTiming
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAn optional value describing when the action should be performed.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/Timing.cdm.json/TimingtimingId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_timingtiming"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

timingType

Type of timing
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameTiming Type
descriptionType of timing
dataFormatint32
isNullabletrue
sourceNamemsemr_timingtype
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enDateTime935000000
enPeriod935000001
enDuration935000002
enTiming935000003

Traits

List of traits for the timingType attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enDateTime935000000
enPeriod935000001
enDuration935000002
enTiming935000003
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_timingtype"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTiming Type
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enType of timing
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

timingType_display

First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the timingType_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"timingType"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

timingupperlimit

An optional upper range value describing when the action should be performed.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameUpper Limit
descriptionAn optional upper range value describing when the action should be performed.
dataFormatdecimal
maximumValue100000000000
minimumValue-100000000000
isNullabletrue
sourceNamemsemr_timingupperlimit

Traits

List of traits for the timingupperlimit attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_timingupperlimit"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-100000000000"decimal
maximumValue"100000000000"decimal

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUpper Limit
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAn optional upper range value describing when the action should be performed.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

title

The title of the action displayed to a user.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameTitle
descriptionThe title of the action displayed to a user.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsemr_title

Traits

List of traits for the title attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_title"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTitle
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe title of the action displayed to a user.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

transformId

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the Activity Definition instance as the input.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameTransform
descriptionA reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the Activity Definition instance as the input.
dataFormatguid
isNullabletrue
sourceNamemsemr_transform

Traits

List of traits for the transformId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTransform
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enA reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the Activity Definition instance as the input.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/CodeableConcept.cdm.json/CodeableConceptcodeableConceptId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_transform"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

type

The type of action to perform (create, update, remove).
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameType
descriptionThe type of action to perform (create, update, remove).
dataFormatint32
isNullabletrue
sourceNamemsemr_type
valueConstrainedToListtrue
defaultValue

Traits

List of traits for the type attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enCreate935000000
enUpdate935000001
enRemove935000002
enFire-Event935000003
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msemr_type"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enType
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe type of action to perform (create, update, remove).
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

type_display

First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the type_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"type"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

organizationId

Unique identifier for the organization
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameOrganization Id
descriptionUnique identifier for the organization
dataFormatguid
isNullabletrue
sourceNameorganizationid

Traits

List of traits for the organizationId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOrganization Id
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier for the organization
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/Organization.cdm.json/OrganizationorganizationId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"organizationid"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

overriddenCreatedOn

Date and time that the record was migrated.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameRecord Created On
descriptionDate and time that the record was migrated.
dataFormatdateTime
isNullabletrue
sourceNameoverriddencreatedon

Traits

List of traits for the overriddenCreatedOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.creation
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"overriddencreatedon"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecord Created On
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time that the record was migrated.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.time
is.dataFormat.date

stateCode

Status of the Plan Definition Action
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameStatus
descriptionStatus of the Plan Definition Action
dataFormatint32
sourceNamestatecode
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enActive0
enInactive1

Traits

List of traits for the stateCode attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enActive0
enInactive1
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

means.entityState
the attribute represents the current state of the entity.

ParameterValueData typeExplanation
attributePlanDefinitionAction/(resolvedAttributes)/stateCodeattribute

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"statecode"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStatus
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStatus of the Plan Definition Action
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

stateCode_display

First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the stateCode_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"stateCode"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

statusCode

Reason for the status of the Plan Definition Action
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameStatus Reason
descriptionReason for the status of the Plan Definition Action
dataFormatint32
isNullabletrue
sourceNamestatuscode
defaultValue
languageTagdisplayTextattributeValuecorrelatedValue
enActive10
enInactive21

Traits

List of traits for the statusCode attribute are listed below.

is.dataFormat.integer
is.constrainedList.correlated
the values of an attribute are taken from or looked up from a fixed list of possibilities that represent correlated status

does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValuecorrelatedValue
enActive10
enInactive21
any

is.correlatedWith
the attribute value is correlated with the sourceAttribute

ParameterValueData typeExplanation
sourceAttribute"stateCode"attributeName

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"statuscode"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStatus Reason
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enReason for the status of the Plan Definition Action
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

statusCode_display

First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the statusCode_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"statusCode"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

timeZoneRuleVersionNumber

For internal use only.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameTime Zone Rule Version Number
descriptionFor internal use only.
dataFormatint32
maximumValue2147483647
minimumValue-1
isNullabletrue
sourceNametimezoneruleversionnumber

Traits

List of traits for the timeZoneRuleVersionNumber attribute are listed below.

is.dataFormat.integer
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"timezoneruleversionnumber"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-1"decimal
maximumValue"2147483647"decimal

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTime Zone Rule Version Number
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFor internal use only.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

UTCConversionTimeZoneCode

Time zone code that was in use when the record was created.
First included in: electronicMedicalRecords/PlanDefinitionAction (this entity)

Properties

NameValue
displayNameUTC Conversion Time Zone Code
descriptionTime zone code that was in use when the record was created.
dataFormatint32
maximumValue2147483647
minimumValue-1
isNullabletrue
sourceNameutcconversiontimezonecode

Traits

List of traits for the UTCConversionTimeZoneCode attribute are listed below.

is.dataFormat.integer
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"utcconversiontimezonecode"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-1"decimal
maximumValue"2147483647"decimal

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUTC Conversion Time Zone Code
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTime zone code that was in use when the record was created.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer