編輯

共用方式為


Goal in Commoncore

Describes the intended objective(s) for a patient, group or organization care

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.0"stringsemantic version number of the entity

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

ParameterValueData typeExplanation
groupList
attributeGroupReference
/core/wellKnownCDSAttributeGroups.cdm.json
/cdsCreationModificationDatesAndIds
/core/wellKnownCDSAttributeGroups.cdm.json
/cdsOwnershipInfo
/core/wellKnownCDSAttributeGroups.cdm.json
/cdsTimeZoneInfo
/core/wellKnownCDSAttributeGroups.cdm.json
/cdsVersionTracking
/core/applicationCommon/Goal.cdm.json/Goal
/hasAttributes/attributesAddedAtThisScope
/Healthcare/Foundational/Commoncore/Goal.cdm.json
/Goal/hasAttributes/attributesAddedAtThisScope
entity

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

ParameterValueData typeExplanation
attributeGoal/(resolvedAttributes)/goalIdattribute

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

ParameterValueData typeExplanation
attributeGoal/(resolvedAttributes)/stateCodeattribute

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enGoal
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
enTarget objective for a user or a team for a specified time period.
enDescribes the intended objective(s) for a patient, group or organization care
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_goal"string

Attributes

Name Description First Included in Instance
createdOn Date and time when the record was created. Commoncore/Goal
createdBy Unique identifier of the user who created the record. Commoncore/Goal
modifiedOn Date and time when the record was modified. Commoncore/Goal
modifiedBy Unique identifier of the user who modified the record. Commoncore/Goal
createdOnBehalfBy Unique identifier of the delegate user who created the record. Commoncore/Goal
modifiedOnBehalfBy Unique identifier of the delegate user who modified the record. Commoncore/Goal
overriddenCreatedOn Date and time that the record was migrated. Commoncore/Goal
importSequenceNumber Sequence number of the import that created this record. Commoncore/Goal
ownerId Owner Id Commoncore/Goal
ownerIdType The type of owner, either User or Team. Commoncore/Goal
owningBusinessUnit Unique identifier for the business unit that owns the record Commoncore/Goal
owningUser Unique identifier for the user that owns the record. Commoncore/Goal
owningTeam Unique identifier for the team that owns the record. Commoncore/Goal
timeZoneRuleVersionNumber For internal use only. Commoncore/Goal
UTCConversionTimeZoneCode Time zone code that was in use when the record was created. Commoncore/Goal
versionNumber Version Number Commoncore/Goal
goalId Unique identifier for entity instances Commoncore/Goal
stateCode Status of the Goal Commoncore/Goal
stateCode_display Commoncore/Goal
statusCode Reason for the status of the Goal Commoncore/Goal
statusCode_display Commoncore/Goal
title Type a title or name that describes the goal. Commoncore/Goal
fiscalPeriod Select the fiscal period for the goal. Commoncore/Goal
fiscalPeriod_display Commoncore/Goal
fiscalYear Select the fiscal year for the goal that's being tracked. Commoncore/Goal
fiscalYear_display Commoncore/Goal
goalStartDate The date after which the goal should begin being pursued. Commoncore/Goal
goalEndDate Enter the date when the goal ends. Commoncore/Goal
goalOwnerId Choose the user or team responsible for meeting the goal. Commoncore/Goal
goalOwnerIdType The name of the entity linked by goalOwnerId Commoncore/Goal
parentGoalId Choose a parent goal if the current goal is a child goal. This sets up a parent-child relationship for reporting and analytics. Commoncore/Goal
transactionCurrencyId Choose the local currency for the record to make sure budgets are reported in the correct currency. Commoncore/Goal
exchangeRate Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency. Commoncore/Goal
metricId Choose the metric for the goal. This metric determines how the goal is tracked. Commoncore/Goal
treeId Unique identifier of the goal tree. Commoncore/Goal
depth Depth of the goal in the tree. Commoncore/Goal
stretchTargetMoney Select stretch target (money) of the goal to define a higher or difficult level of goal than the usual ones. Commoncore/Goal
stretchTargetMoneyBase Shows the stretch target (money) in base currency to indicate a higher or difficult level of goal than the usual ones. Commoncore/Goal
stretchTargetDecimal Select a stretch target (decimal) of the goal to define a higher or difficult level of goal than the usual ones. Commoncore/Goal
stretchTargetInteger Select the stretch target (integer) of the goal to define a higher or difficult level of goal than the usual ones. Commoncore/Goal
targetMoney Select a goal target (money) to track a monetary amount such as revenue from a product. Commoncore/Goal
targetMoneyBase Shows the goal target of the money type in base currency. Commoncore/Goal
targetDecimal Select a goal target of the decimal type to use for tracking data that include partial numbers, such as pounds sold of a product sold by weight. Commoncore/Goal
targetInteger Select a goal target of the integer type to use for tracking anything countable in whole numbers, such as units sold. Commoncore/Goal
actualMoney Shows the actual value (Money type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Money. Commoncore/Goal
actualMoneyBase Shows the actual value (money type) in base currency to track goal results against the target. Commoncore/Goal
customRollupFieldMoney Indicates a placeholder rollup field for a money value to track a third category of results other than actuals and in-progress results. Commoncore/Goal
customRollupFieldMoneyBase Indicates a placeholder rollup field for a money value in base currency to track a third category of results other than actuals and in-progress results. Commoncore/Goal
inProgressMoney Shows the in-progress value (money) against the target. This value could contribute to a goal, but is not counted yet as actual. Commoncore/Goal
inProgressMoneyBase Shows the in-progress value (money) in base currency to track goal results against the target. Commoncore/Goal
actualDecimal Shows the actual value (Decimal type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Decimal. Commoncore/Goal
customRollupFieldDecimal Indicates a placeholder rollup field for a decimal value to track a third category of results other than actuals and in-progress results. Commoncore/Goal
inProgressDecimal Shows the in-progress value (decimal) against the target. This value could contribute to a goal, but is not counted yet as actual. Commoncore/Goal
actualInteger Shows the actual value (integer) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount or Count and the amount data type is Integer. Commoncore/Goal
customRollupFieldInteger Indicates a placeholder rollup field for an integer value to track a third category of results other than actuals and in-progress results. Commoncore/Goal
inProgressInteger Shows the in-progress value (integer) against the target. This value could contribute to a goal, but is not counted yet as actual. Commoncore/Goal
percentage Shows the percentage achieved against the target goal. Commoncore/Goal
isFiscalPeriodGoal Select whether the goal period is a fiscal period or custom period. Commoncore/Goal
considerOnlyGoalOwnersRecords Select whether only the goal owner's records, or all records, should be rolled up for goal results. Commoncore/Goal
lastRolledupDate Shows the date and time when the goal was last rolled up. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options. Commoncore/Goal
targetString Target value of the goal. Commoncore/Goal
stretchTargetString Stretch target value for all data types. Commoncore/Goal
actualString Actual Value of the goal. Commoncore/Goal
customRollupFieldString Placeholder rollup field for the goal. Commoncore/Goal
inProgressString In-progress value of the goal. Commoncore/Goal
amountDataType Data type of the amount. Commoncore/Goal
amountDataType_display Commoncore/Goal
isAmount Indicates whether the metric type is Count or Amount. Commoncore/Goal
rollupQueryActualIntegerId Choose the query that will be used to calculate the actual data for the goal (integer). Commoncore/Goal
rollUpQueryActualMoneyId Choose the query that will be used to calculate the actual data for the goal (money). Commoncore/Goal
rollUpQueryActualDecimalId Choose the query that will be used to calculate the actual data for the goal (decimal). Commoncore/Goal
rollUpQueryCustomIntegerId Choose the query that will be used to calculate data for the custom rollup field (integer). Commoncore/Goal
rollUpQueryCustomMoneyId Choose the query that will be used to calculate data for the custom rollup field (money). Commoncore/Goal
rollUpQueryCustomDecimalId Choose the query that will be used to calculate data for the custom rollup field (decimal). Commoncore/Goal
rollUpQueryInprogressIntegerId Choose the query that will be used to calculate data for the in-progress rollup field (integer). Commoncore/Goal
rollUpQueryInprogressMoneyId Choose the query that will be used to calculate data for the in-progress rollup field (money). Commoncore/Goal
rollUpQueryInprogressDecimalId Choose the query that will be used to calculate data for the in-progress rollup field (decimal). Commoncore/Goal
rollupOnlyFromChildGoals Select whether the data should be rolled up only from the child goals. Commoncore/Goal
goalWithErrorId Unique identifier of the goal that caused an error in the rollup of the goal hierarchy. Commoncore/Goal
rollupErrorCode Error code associated with rollup. Commoncore/Goal
computedTargetAsOfTodayPercentageAchieved Shows the expected value for percentage achieved against the target goal as of the current date. Commoncore/Goal
computedTargetAsOfTodayMoney Shows the expected amount for actual value (money type) against the target goal as of the current date. Commoncore/Goal
computedTargetAsOfTodayMoneyBase Shows the expected amount in base currency for actual value (money type) against the target goal as of the current date. Commoncore/Goal
computedTargetAsOfTodayDecimal Shows the expected amount for actual value (decimal type) against the target goal. Commoncore/Goal
computedTargetAsOfTodayInteger Shows the expected amount for actual value (integer type) against the target goal as of the current date. Commoncore/Goal
isOverride Indicates whether the values of system rollup fields can be updated. Commoncore/Goal
isOverridden Select whether the system rollup fields are updated. If set to Yes, the next system rollup will not update the values of the rollup fields with the system calculated values. Commoncore/Goal
entityImageId For internal use only. Commoncore/Goal
goalDescriptionId Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding Commoncore/Goal
goalExpressedByPatientId Indicates whose goal this is - patient Commoncore/Goal
goalExpressedByPractitionerId Indicates whose goal this is - practitioner Commoncore/Goal
goalExpressedByRelatedPersonId Indicates whose goal this is - patient goal, practitioner goal, etc. Commoncore/Goal
goalExpressedByType Refers to Patient or Practitioner Commoncore/Goal
goalExpressedByType_display Commoncore/Goal
goalNumber This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. Commoncore/Goal
goalPriorityId Identifies the mutually agreed level of importance associated with reaching/sustaining the goal. Commoncore/Goal
goalStartCodeId The event after which the goal should begin being pursued. Commoncore/Goal
goalStartType Starting Method Commoncore/Goal
goalStartType_display Commoncore/Goal
goalStatus Indicates whether the goal has been reached and is still considered relevant. Commoncore/Goal
goalStatus_display Commoncore/Goal
goalStatusDate Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc. Commoncore/Goal
goalStatusReason Captures the reason for the current status. This will typically be captured for statuses such as rejected, on-hold or cancelled, but could be present for others. Commoncore/Goal
goalSubjectGroupId Identifies the group for whom the goal is being established. Commoncore/Goal
goalSubjectOrganizationId Identifies the patient, group or organization for whom the goal is being established. Commoncore/Goal
goalSubjectPatientId Identifies the patient for whom the goal is being established. Commoncore/Goal
goalSubjectType Type of subject Commoncore/Goal
goalSubjectType_display Commoncore/Goal
goalTargetDetailLowerValue The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. Commoncore/Goal
goalTargetDetailQuantityCodeId A computer processable form of the unit in some unit representation system. Commoncore/Goal
goalTargetDetailQuantityComparator How the value should be understood and represented Commoncore/Goal
goalTargetDetailQuantityComparator_display Commoncore/Goal
goalTargetDetailQuantitySystem The identification of the system that provides the coded form of the unit. Commoncore/Goal
goalTargetDetailQuantityUnit A human-readable form of the unit. Commoncore/Goal
goalTargetDetailQuantityValue The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. Commoncore/Goal
goalTargetDetailType Type of measurement value. Commoncore/Goal
goalTargetDetailType_display Commoncore/Goal
goalTargetDetailUpperValue The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. Commoncore/Goal
goalTargetDetailValueCodeId The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. Commoncore/Goal
goalTargetMeasureId The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. Commoncore/Goal
goalTargetMeasureValueDueDate Indicates either the date or the duration after start by which the goal should be met. Commoncore/Goal
goalTargetMeasureValueDueDuration Indicates either the date or the duration after start by which the goal should be met. Commoncore/Goal
goalTargetMeasureValueDueType Type of value due Commoncore/Goal
goalTargetMeasureValueDueType_display Commoncore/Goal
name The name of the custom entity. Commoncore/Goal

createdOn

Date and time when the record was created.
First included in: Commoncore/Goal (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.standard
identifies attributes that are part of the cdsStandard base set.

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.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdon"string

is.dataFormat.time
is.dataFormat.date

createdBy

Unique identifier of the user who created the record.
First included in: Commoncore/Goal (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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

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
enShows who created the record.
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

modifiedOn

Date and time when the record was modified.
First included in: Commoncore/Goal (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.standard
identifies attributes that are part of the cdsStandard base set.

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.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedon"string

is.dataFormat.time
is.dataFormat.date

modifiedBy

Unique identifier of the user who modified the record.
First included in: Commoncore/Goal (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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

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
enShows who last updated the record.
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

createdOnBehalfBy

Unique identifier of the delegate user who created the record.
First included in: Commoncore/Goal (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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

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
enShows who created the record on behalf of another user.
enUnique identifier of the delegate 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"createdonbehalfby"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

modifiedOnBehalfBy

Unique identifier of the delegate user who modified the record.
First included in: Commoncore/Goal (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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

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
enShows who last updated the record on behalf of another user.
enUnique identifier of the delegate 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"modifiedonbehalfby"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

overriddenCreatedOn

Date and time that the record was migrated.
First included in: Commoncore/Goal (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.standard
identifies attributes that are part of the cdsStandard base set.

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.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"overriddencreatedon"string

is.dataFormat.time
is.dataFormat.date

importSequenceNumber

Sequence number of the import that created this record.
First included in: Commoncore/Goal (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.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
enUnique identifier of the data import or data migration that created this record.
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.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.dataFormat.integer

ownerId

Owner Id
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameOwner
descriptionOwner Id
dataFormatguid
sourceNameownerid

Traits

List of traits for the ownerId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

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"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
enOwner
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
enOwner Id
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
/core/applicationCommon/Team.cdm.json/TeamteamId
entitya reference to the constant entity holding the list of entity references

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

ParameterValueData typeExplanation
name"ownerid"string

is.CDS.owner
contains a User or Team ID

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

ownerIdType

The type of owner, either User or Team.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameOwner Type
descriptionThe type of owner, either User or Team.
dataFormatstring
isReadOnlytrue
sourceNameowneridtype

Traits

List of traits for the ownerIdType attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

means.entityName
a string value is the name of a CDM entity.

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
enOwner 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
enThe type of owner, either User or Team.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.

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

ParameterValueData typeExplanation
name"owneridtype"string

is.CDS.owner
contains a User or Team ID

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

owningBusinessUnit

Unique identifier for the business unit that owns the record
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameOwning Business Unit
descriptionUnique identifier for the business unit that owns the record
dataFormatguid
isNullabletrue
sourceNameowningbusinessunit

Traits

List of traits for the owningBusinessUnit attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

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
enOwning Business Unit
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 business unit that owns 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/BusinessUnit.cdm.json/BusinessUnitbusinessUnitId
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"owningbusinessunit"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

owningUser

Unique identifier for the user that owns the record.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameOwning User
descriptionUnique identifier for the user that owns the record.
dataFormatguid
isNullabletrue
sourceNameowninguser

Traits

List of traits for the owningUser attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId

is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

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
enOwning User
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 user that owns 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"owninguser"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

owningTeam

Unique identifier for the team that owns the record.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameOwning Team
descriptionUnique identifier for the team that owns the record.
dataFormatguid
isNullabletrue
sourceNameowningteam

Traits

List of traits for the owningTeam attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

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
enOwning Team
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 team that owns 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/Team.cdm.json/TeamteamId
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"owningteam"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

timeZoneRuleVersionNumber

For internal use only.
First included in: Commoncore/Goal (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.standard
identifies attributes that are part of the cdsStandard base set.

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.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.dataFormat.integer

UTCConversionTimeZoneCode

Time zone code that was in use when the record was created.
First included in: Commoncore/Goal (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.standard
identifies attributes that are part of the cdsStandard base set.

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.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.dataFormat.integer

versionNumber

Version Number
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameVersion Number
descriptionVersion Number
dataFormatint64
isNullabletrue
sourceNameversionnumber

Traits

List of traits for the versionNumber attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

means.measurement.version
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

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
enVersion 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
enVersion Number
entitya reference to the constant entity holding the list of localized text

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"versionnumber"string

is.dataFormat.integer
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

goalId

Unique identifier for entity instances
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameGoal
descriptionUnique identifier for entity instances
isPrimaryKeytrue
dataFormatguid
sourceNamemsemr_goalid

Traits

List of traits for the goalId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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

ParameterValueData typeExplanation
attributeGoal/(resolvedAttributes)/goalIdattribute

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
enGoal
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 goal.
enUnique identifier for entity instances
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_goalid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"1"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

stateCode

Status of the Goal
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameStatus
descriptionStatus of the Goal
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
attributeGoal/(resolvedAttributes)/stateCodeattribute

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
enShows whether the goal is open, completed, or canceled. Completed and canceled goals are read-only and can't be edited.
enStatus of the Goal
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"statecode"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"20"integer

is.dataFormat.integer

stateCode_display

First included in: Commoncore/Goal (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the stateCode_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

statusCode

Reason for the status of the Goal
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameStatus Reason
descriptionReason for the status of the Goal
dataFormatint32
isNullabletrue
sourceNamestatuscode
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValuecorrelatedValue
enOpen00
enClosed11
enDiscarded21

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
enOpen00
enClosed11
enDiscarded21
any

is.correlatedWith
the attribute value is correlated with the sourceAttribute

ParameterValueData typeExplanation
sourceAttribute"stateCode"attributeName

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
enSelect the goal's status.
enReason for the status of the Goal
entitya reference to the constant entity holding the list of localized text

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"statuscode"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"22"integer

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

is.dataFormat.integer

statusCode_display

First included in: Commoncore/Goal (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue
isNullabletrue

Traits

List of traits for the statusCode_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

means.reference.displayText
is.readOnly
is.addedInSupportOf

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

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

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

title

Type a title or name that describes the goal.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameName
descriptionType a title or name that describes the goal.
dataFormatstring
maximumLength100
isNullabletrue
sourceNametitle

Traits

List of traits for the title attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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"required"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
enType a title or name that describes the goal.
entitya reference to the constant entity holding the list of localized text

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"title"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"29"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

fiscalPeriod

Select the fiscal period for the goal.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameFiscal Period
descriptionSelect the fiscal period for the goal.
dataFormatint32
isNullabletrue
sourceNamefiscalperiod
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enQuarter 11
enQuarter 22
enQuarter 33
enQuarter 44
enJanuary101
enFebruary102
enMarch103
enApril104
enMay105
enJune106
enJuly107
enAugust108
enSeptember109
enOctober110
enNovember111
enDecember112
enSemester 1201
enSemester 2202
enAnnual301
enP1401
enP2402
enP3403
enP4404
enP5405
enP6406
enP7407
enP8408
enP9409
enP10410
enP11411
enP12412
enP13413

Traits

List of traits for the fiscalPeriod attribute are listed below.

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

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enQuarter 11
enQuarter 22
enQuarter 33
enQuarter 44
enJanuary101
enFebruary102
enMarch103
enApril104
enMay105
enJune106
enJuly107
enAugust108
enSeptember109
enOctober110
enNovember111
enDecember112
enSemester 1201
enSemester 2202
enAnnual301
enP1401
enP2402
enP3403
enP4404
enP5405
enP6406
enP7407
enP8408
enP9409
enP10410
enP11411
enP12412
enP13413
any

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

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
enFiscal Period
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
enSelect the fiscal period for the goal.
entitya reference to the constant entity holding the list of localized text

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"fiscalperiod"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"30"integer

is.dataFormat.integer

fiscalPeriod_display

First included in: Commoncore/Goal (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the fiscalPeriod_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

means.reference.displayText
is.readOnly
is.addedInSupportOf

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

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

fiscalYear

Select the fiscal year for the goal that's being tracked.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameFiscal Year
descriptionSelect the fiscal year for the goal that's being tracked.
dataFormatint32
isNullabletrue
sourceNamefiscalyear
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enFY20382038
enFY20372037
enFY20362036
enFY20352035
enFY20342034
enFY20332033
enFY20322032
enFY20312031
enFY20302030
enFY20292029
enFY20282028
enFY20272027
enFY20262026
enFY20252025
enFY20242024
enFY20232023
enFY20222022
enFY20212021
enFY20202020
enFY20192019
enFY20182018
enFY20172017
enFY20162016
enFY20152015
enFY20142014
enFY20132013
enFY20122012
enFY20112011
enFY20102010
enFY20092009
enFY20082008
enFY20072007
enFY20062006
enFY20052005
enFY20042004
enFY20032003
enFY20022002
enFY20012001
enFY20002000
enFY19991999
enFY19981998
enFY19971997
enFY19961996
enFY19951995
enFY19941994
enFY19931993
enFY19921992
enFY19911991
enFY19901990
enFY19891989
enFY19881988
enFY19871987
enFY19861986
enFY19851985
enFY19841984
enFY19831983
enFY19821982
enFY19811981
enFY19801980
enFY19791979
enFY19781978
enFY19771977
enFY19761976
enFY19751975
enFY19741974
enFY19731973
enFY19721972
enFY19711971
enFY19701970

Traits

List of traits for the fiscalYear attribute are listed below.

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

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enFY20382038
enFY20372037
enFY20362036
enFY20352035
enFY20342034
enFY20332033
enFY20322032
enFY20312031
enFY20302030
enFY20292029
enFY20282028
enFY20272027
enFY20262026
enFY20252025
enFY20242024
enFY20232023
enFY20222022
enFY20212021
enFY20202020
enFY20192019
enFY20182018
enFY20172017
enFY20162016
enFY20152015
enFY20142014
enFY20132013
enFY20122012
enFY20112011
enFY20102010
enFY20092009
enFY20082008
enFY20072007
enFY20062006
enFY20052005
enFY20042004
enFY20032003
enFY20022002
enFY20012001
enFY20002000
enFY19991999
enFY19981998
enFY19971997
enFY19961996
enFY19951995
enFY19941994
enFY19931993
enFY19921992
enFY19911991
enFY19901990
enFY19891989
enFY19881988
enFY19871987
enFY19861986
enFY19851985
enFY19841984
enFY19831983
enFY19821982
enFY19811981
enFY19801980
enFY19791979
enFY19781978
enFY19771977
enFY19761976
enFY19751975
enFY19741974
enFY19731973
enFY19721972
enFY19711971
enFY19701970
any

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

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
enFiscal Year
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
enSelect the fiscal year for the goal that's being tracked.
entitya reference to the constant entity holding the list of localized text

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"fiscalyear"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"32"integer

is.dataFormat.integer

fiscalYear_display

First included in: Commoncore/Goal (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the fiscalYear_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

means.reference.displayText
is.readOnly
is.addedInSupportOf

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

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalStartDate

The date after which the goal should begin being pursued.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameStarting Date
descriptionThe date after which the goal should begin being pursued.
dataFormatdateTime
isNullabletrue
sourceNamemsemr_goalstartdate

Traits

List of traits for the goalStartDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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
enFrom
enStarting Date
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
enEnter the date and time when the period for tracking the goal begins.
enThe date after which the goal should begin being pursued.
entitya reference to the constant entity holding the list of localized text

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_goalstartdate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"34"integer

is.dataFormat.time
is.dataFormat.date

goalEndDate

Enter the date when the goal ends.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameTo
descriptionEnter the date when the goal ends.
dataFormatdateTime
isNullabletrue
sourceNamegoalenddate

Traits

List of traits for the goalEndDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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
enTo
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
enEnter the date when the goal ends.
entitya reference to the constant entity holding the list of localized text

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"goalenddate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"35"integer

is.dataFormat.time
is.dataFormat.date

goalOwnerId

Choose the user or team responsible for meeting the goal.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameGoal Owner
descriptionChoose the user or team responsible for meeting the goal.
dataFormatguid
isNullabletrue
sourceNamegoalownerid

Traits

List of traits for the goalOwnerId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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"required"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
enGoal Owner
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
enChoose the user or team responsible for meeting the goal.
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/Team.cdm.json/TeamteamId
/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"goalownerid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"36"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalOwnerIdType

The name of the entity linked by goalOwnerId
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNamegoalOwnerId Type
descriptionThe name of the entity linked by goalOwnerId
dataFormatstring
isReadOnlytrue
sourceNamegoalowneridtype

Traits

List of traits for the goalOwnerIdType attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

means.entityName
a string value is the name of a CDM entity.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
engoalOwnerId 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
enThe name of the entity linked by goalOwnerId
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.

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

ParameterValueData typeExplanation
name"goalowneridtype"string

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

parentGoalId

Choose a parent goal if the current goal is a child goal. This sets up a parent-child relationship for reporting and analytics.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameParent Goal
descriptionChoose a parent goal if the current goal is a child goal. This sets up a parent-child relationship for reporting and analytics.
dataFormatguid
isNullabletrue
sourceNameparentgoalid

Traits

List of traits for the parentGoalId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enParent Goal
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
enChoose a parent goal if the current goal is a child goal. This sets up a parent-child relationship for reporting and analytics.
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
/Healthcare/Foundational/Commoncore/Goal.cdm.json/GoalgoalId
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"parentgoalid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"39"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

transactionCurrencyId

Choose the local currency for the record to make sure budgets are reported in the correct currency.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameCurrency
descriptionChoose the local currency for the record to make sure budgets are reported in the correct currency.
dataFormatguid
isNullabletrue
sourceNametransactioncurrencyid

Traits

List of traits for the transactionCurrencyId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enCurrency
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
enChoose the local currency for the record to make sure budgets are reported in the correct currency.
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/Currency.cdm.json/CurrencytransactionCurrencyId
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"transactioncurrencyid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"42"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

exchangeRate

Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameExchange Rate
descriptionShows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
dataFormatdecimal
maximumValue100000000000
minimumValue1E-10
isNullabletrue
sourceNameexchangerate

Traits

List of traits for the exchangeRate attribute are listed below.

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

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
enExchange Rate
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
enShows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
entitya reference to the constant entity holding the list of localized text

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"exchangerate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"44"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"1E-10"decimal
maximumValue"100000000000"decimal

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

metricId

Choose the metric for the goal. This metric determines how the goal is tracked.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameGoal Metric
descriptionChoose the metric for the goal. This metric determines how the goal is tracked.
dataFormatguid
isNullabletrue
sourceNamemetricid

Traits

List of traits for the metricId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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"required"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
enGoal Metric
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
enChoose the metric for the goal. This metric determines how the goal is tracked.
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/GoalMetric.cdm.json/GoalMetricmetricId
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"metricid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"48"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

treeId

Unique identifier of the goal tree.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameTree ID
descriptionUnique identifier of the goal tree.
dataFormatguid
isNullabletrue
sourceNametreeid

Traits

List of traits for the treeId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
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
enTree 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 of the goal tree.
entitya reference to the constant entity holding the list of localized text

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"treeid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"54"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

depth

Depth of the goal in the tree.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameDepth
descriptionDepth of the goal in the tree.
dataFormatint32
maximumValue2147483647
minimumValue0
isNullabletrue
sourceNamedepth

Traits

List of traits for the depth attribute are listed below.

is.dataFormat.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
enDepth
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
enDepth of the goal in the tree.
entitya reference to the constant entity holding the list of localized text

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"depth"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"55"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

stretchTargetMoney

Select stretch target (money) of the goal to define a higher or difficult level of goal than the usual ones.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameStretch Target (Money)
descriptionSelect stretch target (money) of the goal to define a higher or difficult level of goal than the usual ones.
dataFormatdecimal
maximumValue922337203685477
minimumValue0
isNullabletrue
sourceNamestretchtargetmoney

Traits

List of traits for the stretchTargetMoney attribute are listed below.

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

ParameterValueData typeExplanation
precision"19"integerthe total number of significant digits
scale"4"integerthe number of digits to the right of the decimal place

means.measurement.currency
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
enStretch Target (Money)
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
enSelect stretch target (money) of the goal to define a higher or difficult level of goal than the usual ones.
entitya reference to the constant entity holding the list of localized text

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"stretchtargetmoney"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"106"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"922337203685477"decimal

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

stretchTargetMoneyBase

Shows the stretch target (money) in base currency to indicate a higher or difficult level of goal than the usual ones.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameStretch Target (Money) (Base)
descriptionShows the stretch target (money) in base currency to indicate a higher or difficult level of goal than the usual ones.
dataFormatdecimal
maximumValue922337203685477
minimumValue-922337203685477
isNullabletrue
sourceNamestretchtargetmoney_base

Traits

List of traits for the stretchTargetMoneyBase attribute are listed below.

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

ParameterValueData typeExplanation
precision"19"integerthe total number of significant digits
scale"4"integerthe number of digits to the right of the decimal place

means.measurement.currency
is.calculationOf
the attribute value is the result of a calculation on the sourceAttribute

ParameterValueData typeExplanation
sourceAttribute"stretchTargetMoney"attributeName

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
enStretch Target (Money) (Base)
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
enShows the stretch target (money) in base currency to indicate a higher or difficult level of goal than the usual ones.
entitya reference to the constant entity holding the list of localized text

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"stretchtargetmoney_base"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"107"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-922337203685477"decimal
maximumValue"922337203685477"decimal

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

stretchTargetDecimal

Select a stretch target (decimal) of the goal to define a higher or difficult level of goal than the usual ones.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameStretch Target (Decimal)
descriptionSelect a stretch target (decimal) of the goal to define a higher or difficult level of goal than the usual ones.
dataFormatdecimal
maximumValue100000000000
minimumValue0
isNullabletrue
sourceNamestretchtargetdecimal

Traits

List of traits for the stretchTargetDecimal attribute are listed below.

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

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
enStretch Target (Decimal)
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
enSelect a stretch target (decimal) of the goal to define a higher or difficult level of goal than the usual ones.
entitya reference to the constant entity holding the list of localized text

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"stretchtargetdecimal"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"108"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"100000000000"decimal

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

stretchTargetInteger

Select the stretch target (integer) of the goal to define a higher or difficult level of goal than the usual ones.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameStretch Target (Integer)
descriptionSelect the stretch target (integer) of the goal to define a higher or difficult level of goal than the usual ones.
dataFormatint32
maximumValue2147483647
minimumValue0
isNullabletrue
sourceNamestretchtargetinteger

Traits

List of traits for the stretchTargetInteger attribute are listed below.

is.dataFormat.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
enStretch Target (Integer)
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
enSelect the stretch target (integer) of the goal to define a higher or difficult level of goal than the usual ones.
entitya reference to the constant entity holding the list of localized text

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"stretchtargetinteger"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"109"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

targetMoney

Select a goal target (money) to track a monetary amount such as revenue from a product.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameTarget (Money)
descriptionSelect a goal target (money) to track a monetary amount such as revenue from a product.
dataFormatdecimal
maximumValue922337203685477
minimumValue0
isNullabletrue
sourceNametargetmoney

Traits

List of traits for the targetMoney attribute are listed below.

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

ParameterValueData typeExplanation
precision"19"integerthe total number of significant digits
scale"4"integerthe number of digits to the right of the decimal place

means.measurement.currency
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
enTarget (Money)
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
enSelect a goal target (money) to track a monetary amount such as revenue from a product.
entitya reference to the constant entity holding the list of localized text

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"targetmoney"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"110"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"922337203685477"decimal

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

targetMoneyBase

Shows the goal target of the money type in base currency.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameTarget (Money) (Base)
descriptionShows the goal target of the money type in base currency.
dataFormatdecimal
maximumValue922337203685477
minimumValue-922337203685477
isNullabletrue
sourceNametargetmoney_base

Traits

List of traits for the targetMoneyBase attribute are listed below.

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

ParameterValueData typeExplanation
precision"19"integerthe total number of significant digits
scale"4"integerthe number of digits to the right of the decimal place

means.measurement.currency
is.calculationOf
the attribute value is the result of a calculation on the sourceAttribute

ParameterValueData typeExplanation
sourceAttribute"targetMoney"attributeName

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
enTarget (Money) (Base)
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
enShows the goal target of the money type in base currency.
entitya reference to the constant entity holding the list of localized text

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"targetmoney_base"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"111"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-922337203685477"decimal
maximumValue"922337203685477"decimal

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

targetDecimal

Select a goal target of the decimal type to use for tracking data that include partial numbers, such as pounds sold of a product sold by weight.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameTarget (Decimal)
descriptionSelect a goal target of the decimal type to use for tracking data that include partial numbers, such as pounds sold of a product sold by weight.
dataFormatdecimal
maximumValue100000000000
minimumValue0
isNullabletrue
sourceNametargetdecimal

Traits

List of traits for the targetDecimal attribute are listed below.

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

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
enTarget (Decimal)
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
enSelect a goal target of the decimal type to use for tracking data that include partial numbers, such as pounds sold of a product sold by weight.
entitya reference to the constant entity holding the list of localized text

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"targetdecimal"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"112"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"100000000000"decimal

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

targetInteger

Select a goal target of the integer type to use for tracking anything countable in whole numbers, such as units sold.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameTarget (Integer)
descriptionSelect a goal target of the integer type to use for tracking anything countable in whole numbers, such as units sold.
dataFormatint32
maximumValue2147483647
minimumValue0
isNullabletrue
sourceNametargetinteger

Traits

List of traits for the targetInteger attribute are listed below.

is.dataFormat.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
enTarget (Integer)
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
enSelect a goal target of the integer type to use for tracking anything countable in whole numbers, such as units sold.
entitya reference to the constant entity holding the list of localized text

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"targetinteger"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"113"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

actualMoney

Shows the actual value (Money type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Money.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameActual (Money)
descriptionShows the actual value (Money type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Money.
dataFormatdecimal
maximumValue922337203685477
minimumValue-922337203685477
isNullabletrue
sourceNameactualmoney

Traits

List of traits for the actualMoney attribute are listed below.

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

ParameterValueData typeExplanation
precision"19"integerthe total number of significant digits
scale"4"integerthe number of digits to the right of the decimal place

means.measurement.currency
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
enActual (Money)
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
enShows the actual value (Money type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Money.
entitya reference to the constant entity holding the list of localized text

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"actualmoney"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"114"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-922337203685477"decimal
maximumValue"922337203685477"decimal

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

actualMoneyBase

Shows the actual value (money type) in base currency to track goal results against the target.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameActual (Money) (Base)
descriptionShows the actual value (money type) in base currency to track goal results against the target.
dataFormatdecimal
maximumValue922337203685477
minimumValue-922337203685477
isNullabletrue
sourceNameactualmoney_base

Traits

List of traits for the actualMoneyBase attribute are listed below.

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

ParameterValueData typeExplanation
precision"19"integerthe total number of significant digits
scale"4"integerthe number of digits to the right of the decimal place

means.measurement.currency
is.calculationOf
the attribute value is the result of a calculation on the sourceAttribute

ParameterValueData typeExplanation
sourceAttribute"actualMoney"attributeName

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
enActual (Money) (Base)
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
enShows the actual value (money type) in base currency to track goal results against the target.
entitya reference to the constant entity holding the list of localized text

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"actualmoney_base"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"115"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-922337203685477"decimal
maximumValue"922337203685477"decimal

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

customRollupFieldMoney

Indicates a placeholder rollup field for a money value to track a third category of results other than actuals and in-progress results.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameCustom Rollup Field (Money)
descriptionIndicates a placeholder rollup field for a money value to track a third category of results other than actuals and in-progress results.
dataFormatdecimal
maximumValue922337203685477
minimumValue-922337203685477
isNullabletrue
sourceNamecustomrollupfieldmoney

Traits

List of traits for the customRollupFieldMoney attribute are listed below.

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

ParameterValueData typeExplanation
precision"19"integerthe total number of significant digits
scale"4"integerthe number of digits to the right of the decimal place

means.measurement.currency
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
enCustom Rollup Field (Money)
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
enIndicates a placeholder rollup field for a money value to track a third category of results other than actuals and in-progress results.
entitya reference to the constant entity holding the list of localized text

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"customrollupfieldmoney"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"116"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-922337203685477"decimal
maximumValue"922337203685477"decimal

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

customRollupFieldMoneyBase

Indicates a placeholder rollup field for a money value in base currency to track a third category of results other than actuals and in-progress results.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameCustom Rollup Field (Money) (Base)
descriptionIndicates a placeholder rollup field for a money value in base currency to track a third category of results other than actuals and in-progress results.
dataFormatdecimal
maximumValue922337203685477
minimumValue-922337203685477
isNullabletrue
sourceNamecustomrollupfieldmoney_base

Traits

List of traits for the customRollupFieldMoneyBase attribute are listed below.

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

ParameterValueData typeExplanation
precision"19"integerthe total number of significant digits
scale"4"integerthe number of digits to the right of the decimal place

means.measurement.currency
is.calculationOf
the attribute value is the result of a calculation on the sourceAttribute

ParameterValueData typeExplanation
sourceAttribute"customRollupFieldMoney"attributeName

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
enCustom Rollup Field (Money) (Base)
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
enIndicates a placeholder rollup field for a money value in base currency to track a third category of results other than actuals and in-progress results.
entitya reference to the constant entity holding the list of localized text

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"customrollupfieldmoney_base"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"117"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-922337203685477"decimal
maximumValue"922337203685477"decimal

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

inProgressMoney

Shows the in-progress value (money) against the target. This value could contribute to a goal, but is not counted yet as actual.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameIn-progress (Money)
descriptionShows the in-progress value (money) against the target. This value could contribute to a goal, but is not counted yet as actual.
dataFormatdecimal
maximumValue922337203685477
minimumValue-922337203685477
isNullabletrue
sourceNameinprogressmoney

Traits

List of traits for the inProgressMoney attribute are listed below.

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

ParameterValueData typeExplanation
precision"19"integerthe total number of significant digits
scale"4"integerthe number of digits to the right of the decimal place

means.measurement.currency
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
enIn-progress (Money)
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
enShows the in-progress value (money) against the target. This value could contribute to a goal, but is not counted yet as actual.
entitya reference to the constant entity holding the list of localized text

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"inprogressmoney"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"118"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-922337203685477"decimal
maximumValue"922337203685477"decimal

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

inProgressMoneyBase

Shows the in-progress value (money) in base currency to track goal results against the target.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameIn-progress (Money) (Base)
descriptionShows the in-progress value (money) in base currency to track goal results against the target.
dataFormatdecimal
maximumValue922337203685477
minimumValue-922337203685477
isNullabletrue
sourceNameinprogressmoney_base

Traits

List of traits for the inProgressMoneyBase attribute are listed below.

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

ParameterValueData typeExplanation
precision"19"integerthe total number of significant digits
scale"4"integerthe number of digits to the right of the decimal place

means.measurement.currency
is.calculationOf
the attribute value is the result of a calculation on the sourceAttribute

ParameterValueData typeExplanation
sourceAttribute"inProgressMoney"attributeName

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
enIn-progress (Money) (Base)
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
enShows the in-progress value (money) in base currency to track goal results against the target.
entitya reference to the constant entity holding the list of localized text

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"inprogressmoney_base"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"119"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-922337203685477"decimal
maximumValue"922337203685477"decimal

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

actualDecimal

Shows the actual value (Decimal type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Decimal.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameActual (Decimal)
descriptionShows the actual value (Decimal type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Decimal.
dataFormatdecimal
maximumValue100000000000
minimumValue-100000000000
isNullabletrue
sourceNameactualdecimal

Traits

List of traits for the actualDecimal attribute are listed below.

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

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
enActual (Decimal)
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
enShows the actual value (Decimal type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Decimal.
entitya reference to the constant entity holding the list of localized text

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"actualdecimal"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"120"integer

is.constrained
maximum length or value constraints

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

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

customRollupFieldDecimal

Indicates a placeholder rollup field for a decimal value to track a third category of results other than actuals and in-progress results.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameCustom Rollup Field (Decimal)
descriptionIndicates a placeholder rollup field for a decimal value to track a third category of results other than actuals and in-progress results.
dataFormatdecimal
maximumValue100000000000
minimumValue-100000000000
isNullabletrue
sourceNamecustomrollupfielddecimal

Traits

List of traits for the customRollupFieldDecimal attribute are listed below.

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

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
enCustom Rollup Field (Decimal)
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
enIndicates a placeholder rollup field for a decimal value to track a third category of results other than actuals and in-progress results.
entitya reference to the constant entity holding the list of localized text

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"customrollupfielddecimal"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"121"integer

is.constrained
maximum length or value constraints

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

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

inProgressDecimal

Shows the in-progress value (decimal) against the target. This value could contribute to a goal, but is not counted yet as actual.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameIn-progress (Decimal)
descriptionShows the in-progress value (decimal) against the target. This value could contribute to a goal, but is not counted yet as actual.
dataFormatdecimal
maximumValue100000000000
minimumValue-100000000000
isNullabletrue
sourceNameinprogressdecimal

Traits

List of traits for the inProgressDecimal attribute are listed below.

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

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
enIn-progress (Decimal)
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
enShows the in-progress value (decimal) against the target. This value could contribute to a goal, but is not counted yet as actual.
entitya reference to the constant entity holding the list of localized text

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"inprogressdecimal"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"122"integer

is.constrained
maximum length or value constraints

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

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

actualInteger

Shows the actual value (integer) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount or Count and the amount data type is Integer.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameActual (Integer)
descriptionShows the actual value (integer) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount or Count and the amount data type is Integer.
dataFormatint32
maximumValue2147483647
minimumValue-2147483648
isNullabletrue
sourceNameactualinteger

Traits

List of traits for the actualInteger attribute are listed below.

is.dataFormat.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
enActual (Integer)
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
enShows the actual value (integer) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount or Count and the amount data type is Integer.
entitya reference to the constant entity holding the list of localized text

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"actualinteger"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"123"integer

is.constrained
maximum length or value constraints

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

is.dataFormat.integer

customRollupFieldInteger

Indicates a placeholder rollup field for an integer value to track a third category of results other than actuals and in-progress results.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameCustom Rollup Field (Integer)
descriptionIndicates a placeholder rollup field for an integer value to track a third category of results other than actuals and in-progress results.
dataFormatint32
maximumValue2147483647
minimumValue-2147483648
isNullabletrue
sourceNamecustomrollupfieldinteger

Traits

List of traits for the customRollupFieldInteger attribute are listed below.

is.dataFormat.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
enCustom Rollup Field (Integer)
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
enIndicates a placeholder rollup field for an integer value to track a third category of results other than actuals and in-progress results.
entitya reference to the constant entity holding the list of localized text

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"customrollupfieldinteger"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"124"integer

is.constrained
maximum length or value constraints

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

is.dataFormat.integer

inProgressInteger

Shows the in-progress value (integer) against the target. This value could contribute to a goal, but is not counted yet as actual.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameIn-progress (Integer)
descriptionShows the in-progress value (integer) against the target. This value could contribute to a goal, but is not counted yet as actual.
dataFormatint32
maximumValue2147483647
minimumValue-2147483648
isNullabletrue
sourceNameinprogressinteger

Traits

List of traits for the inProgressInteger attribute are listed below.

is.dataFormat.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
enIn-progress (Integer)
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
enShows the in-progress value (integer) against the target. This value could contribute to a goal, but is not counted yet as actual.
entitya reference to the constant entity holding the list of localized text

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"inprogressinteger"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"125"integer

is.constrained
maximum length or value constraints

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

is.dataFormat.integer

percentage

Shows the percentage achieved against the target goal.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNamePercentage Achieved
descriptionShows the percentage achieved against the target goal.
dataFormatdecimal
maximumValue100000000000
minimumValue-100000000000
isNullabletrue
sourceNamepercentage

Traits

List of traits for the percentage attribute are listed below.

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

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
enPercentage Achieved
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
enShows the percentage achieved against the target goal.
entitya reference to the constant entity holding the list of localized text

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"percentage"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"126"integer

is.constrained
maximum length or value constraints

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

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

isFiscalPeriodGoal

Select whether the goal period is a fiscal period or custom period.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameGoal Period Type
descriptionSelect whether the goal period is a fiscal period or custom period.
dataFormatboolean
isNullabletrue
sourceNameisfiscalperiodgoal

Traits

List of traits for the isFiscalPeriodGoal attribute are listed below.

is.dataFormat.boolean
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
enGoal Period 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
enSelect whether the goal period is a fiscal period or custom period.
entitya reference to the constant entity holding the list of localized text

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"isfiscalperiodgoal"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"127"integer

is.dataFormat.boolean

considerOnlyGoalOwnersRecords

Select whether only the goal owner's records, or all records, should be rolled up for goal results.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameRecord Set for Rollup
descriptionSelect whether only the goal owner's records, or all records, should be rolled up for goal results.
dataFormatboolean
sourceNameconsideronlygoalownersrecords

Traits

List of traits for the considerOnlyGoalOwnersRecords attribute are listed below.

is.dataFormat.boolean
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
enRecord Set for Rollup
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
enSelect whether only the goal owner's records, or all records, should be rolled up for goal results.
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"consideronlygoalownersrecords"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"129"integer

is.dataFormat.boolean

lastRolledupDate

Shows the date and time when the goal was last rolled up. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameLast Rolled Up Date
descriptionShows the date and time when the goal was last rolled up. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
dataFormatdateTime
isNullabletrue
sourceNamelastrolledupdate

Traits

List of traits for the lastRolledupDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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
enLast Rolled Up Date
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
enShows the date and time when the goal was last rolled up. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
entitya reference to the constant entity holding the list of localized text

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"lastrolledupdate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"131"integer

is.dataFormat.time
is.dataFormat.date

targetString

Target value of the goal.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameTarget
descriptionTarget value of the goal.
dataFormatstring
maximumLength100
isNullabletrue
sourceNametargetstring

Traits

List of traits for the targetString attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enTarget
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
enTarget value of the goal.
entitya reference to the constant entity holding the list of localized text

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"targetstring"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"132"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

stretchTargetString

Stretch target value for all data types.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameStretched Target
descriptionStretch target value for all data types.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamestretchtargetstring

Traits

List of traits for the stretchTargetString attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enStretched Target
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
enStretch target value for all data types.
entitya reference to the constant entity holding the list of localized text

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"stretchtargetstring"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"133"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

actualString

Actual Value of the goal.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameActual
descriptionActual Value of the goal.
dataFormatstring
maximumLength100
isNullabletrue
sourceNameactualstring

Traits

List of traits for the actualString attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enActual
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
enActual Value of the goal.
entitya reference to the constant entity holding the list of localized text

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"actualstring"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"134"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

customRollupFieldString

Placeholder rollup field for the goal.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameCustom Rollup Field
descriptionPlaceholder rollup field for the goal.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamecustomrollupfieldstring

Traits

List of traits for the customRollupFieldString attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enCustom Rollup Field
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
enPlaceholder rollup field for the goal.
entitya reference to the constant entity holding the list of localized text

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"customrollupfieldstring"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"135"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

inProgressString

In-progress value of the goal.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameIn-Progress
descriptionIn-progress value of the goal.
dataFormatstring
maximumLength100
isNullabletrue
sourceNameinprogressstring

Traits

List of traits for the inProgressString attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enIn-Progress
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
enIn-progress value of the goal.
entitya reference to the constant entity holding the list of localized text

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"inprogressstring"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"136"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

amountDataType

Data type of the amount.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameAmount Data Type
descriptionData type of the amount.
dataFormatint32
isNullabletrue
sourceNameamountdatatype
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enMoney0
enDecimal1
enInteger2

Traits

List of traits for the amountDataType attribute are listed below.

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

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enMoney0
enDecimal1
enInteger2
any

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

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
enAmount Data 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
enData type of the amount.
entitya reference to the constant entity holding the list of localized text

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"amountdatatype"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"144"integer

is.dataFormat.integer

amountDataType_display

First included in: Commoncore/Goal (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the amountDataType_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

means.reference.displayText
is.readOnly
is.addedInSupportOf

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

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

isAmount

Indicates whether the metric type is Count or Amount.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameMetric Type
descriptionIndicates whether the metric type is Count or Amount.
dataFormatboolean
isNullabletrue
sourceNameisamount

Traits

List of traits for the isAmount attribute are listed below.

is.dataFormat.boolean
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"required"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
enMetric 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
enIndicates whether the metric type is Count or Amount.
entitya reference to the constant entity holding the list of localized text

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"isamount"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"145"integer

is.dataFormat.boolean

rollupQueryActualIntegerId

Choose the query that will be used to calculate the actual data for the goal (integer).
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameRollup Query - Actual(Integer)
descriptionChoose the query that will be used to calculate the actual data for the goal (integer).
dataFormatguid
isNullabletrue
sourceNamerollupqueryactualintegerid

Traits

List of traits for the rollupQueryActualIntegerId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enRollup Query - Actual(Integer)
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
enChoose the query that will be used to calculate the actual data for the goal (integer).
entitya reference to the constant entity holding the list of localized text

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"rollupqueryactualintegerid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"200"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

rollUpQueryActualMoneyId

Choose the query that will be used to calculate the actual data for the goal (money).
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameRollup Query - Actual(Money)
descriptionChoose the query that will be used to calculate the actual data for the goal (money).
dataFormatguid
isNullabletrue
sourceNamerollupqueryactualmoneyid

Traits

List of traits for the rollUpQueryActualMoneyId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enRollup Query - Actual(Money)
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
enChoose the query that will be used to calculate the actual data for the goal (money).
entitya reference to the constant entity holding the list of localized text

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"rollupqueryactualmoneyid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"202"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

rollUpQueryActualDecimalId

Choose the query that will be used to calculate the actual data for the goal (decimal).
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameRollup Query - Actual(Decimal)
descriptionChoose the query that will be used to calculate the actual data for the goal (decimal).
dataFormatguid
isNullabletrue
sourceNamerollupqueryactualdecimalid

Traits

List of traits for the rollUpQueryActualDecimalId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enRollup Query - Actual(Decimal)
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
enChoose the query that will be used to calculate the actual data for the goal (decimal).
entitya reference to the constant entity holding the list of localized text

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"rollupqueryactualdecimalid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"204"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

rollUpQueryCustomIntegerId

Choose the query that will be used to calculate data for the custom rollup field (integer).
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameRollup Query - Custom Rollup Field (Integer)
descriptionChoose the query that will be used to calculate data for the custom rollup field (integer).
dataFormatguid
isNullabletrue
sourceNamerollupquerycustomintegerid

Traits

List of traits for the rollUpQueryCustomIntegerId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enRollup Query - Custom Rollup Field (Integer)
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
enChoose the query that will be used to calculate data for the custom rollup field (integer).
entitya reference to the constant entity holding the list of localized text

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"rollupquerycustomintegerid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"206"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

rollUpQueryCustomMoneyId

Choose the query that will be used to calculate data for the custom rollup field (money).
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameRollup Query - Custom Rollup Field (Money)
descriptionChoose the query that will be used to calculate data for the custom rollup field (money).
dataFormatguid
isNullabletrue
sourceNamerollupquerycustommoneyid

Traits

List of traits for the rollUpQueryCustomMoneyId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enRollup Query - Custom Rollup Field (Money)
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
enChoose the query that will be used to calculate data for the custom rollup field (money).
entitya reference to the constant entity holding the list of localized text

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"rollupquerycustommoneyid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"208"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

rollUpQueryCustomDecimalId

Choose the query that will be used to calculate data for the custom rollup field (decimal).
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameRollup Query - Custom Rollup Field (Decimal)
descriptionChoose the query that will be used to calculate data for the custom rollup field (decimal).
dataFormatguid
isNullabletrue
sourceNamerollupquerycustomdecimalid

Traits

List of traits for the rollUpQueryCustomDecimalId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enRollup Query - Custom Rollup Field (Decimal)
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
enChoose the query that will be used to calculate data for the custom rollup field (decimal).
entitya reference to the constant entity holding the list of localized text

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"rollupquerycustomdecimalid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"210"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

rollUpQueryInprogressIntegerId

Choose the query that will be used to calculate data for the in-progress rollup field (integer).
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameRollup Query - In-progress(Integer)
descriptionChoose the query that will be used to calculate data for the in-progress rollup field (integer).
dataFormatguid
isNullabletrue
sourceNamerollupqueryinprogressintegerid

Traits

List of traits for the rollUpQueryInprogressIntegerId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enRollup Query - In-progress(Integer)
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
enChoose the query that will be used to calculate data for the in-progress rollup field (integer).
entitya reference to the constant entity holding the list of localized text

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"rollupqueryinprogressintegerid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"212"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

rollUpQueryInprogressMoneyId

Choose the query that will be used to calculate data for the in-progress rollup field (money).
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameRollup Query - In-progress(Money)
descriptionChoose the query that will be used to calculate data for the in-progress rollup field (money).
dataFormatguid
isNullabletrue
sourceNamerollupqueryinprogressmoneyid

Traits

List of traits for the rollUpQueryInprogressMoneyId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enRollup Query - In-progress(Money)
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
enChoose the query that will be used to calculate data for the in-progress rollup field (money).
entitya reference to the constant entity holding the list of localized text

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"rollupqueryinprogressmoneyid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"214"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

rollUpQueryInprogressDecimalId

Choose the query that will be used to calculate data for the in-progress rollup field (decimal).
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameRollup Query - In-progress(Decimal)
descriptionChoose the query that will be used to calculate data for the in-progress rollup field (decimal).
dataFormatguid
isNullabletrue
sourceNamerollupqueryinprogressdecimalid

Traits

List of traits for the rollUpQueryInprogressDecimalId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enRollup Query - In-progress(Decimal)
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
enChoose the query that will be used to calculate data for the in-progress rollup field (decimal).
entitya reference to the constant entity holding the list of localized text

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"rollupqueryinprogressdecimalid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"216"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

rollupOnlyFromChildGoals

Select whether the data should be rolled up only from the child goals.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameRoll Up Only from Child Goals
descriptionSelect whether the data should be rolled up only from the child goals.
dataFormatboolean
sourceNamerolluponlyfromchildgoals

Traits

List of traits for the rollupOnlyFromChildGoals attribute are listed below.

is.dataFormat.boolean
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
enRoll Up Only from Child Goals
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
enSelect whether the data should be rolled up only from the child goals.
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"rolluponlyfromchildgoals"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"250"integer

is.dataFormat.boolean

goalWithErrorId

Unique identifier of the goal that caused an error in the rollup of the goal hierarchy.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameGoal With Error
descriptionUnique identifier of the goal that caused an error in the rollup of the goal hierarchy.
dataFormatguid
isNullabletrue
sourceNamegoalwitherrorid

Traits

List of traits for the goalWithErrorId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enGoal With Error
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 goal that caused an error in the rollup of the goal hierarchy.
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
/Healthcare/Foundational/Commoncore/Goal.cdm.json/GoalgoalId
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"goalwitherrorid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"252"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

rollupErrorCode

Error code associated with rollup.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameRollup Error Code
descriptionError code associated with rollup.
dataFormatint32
maximumValue2147483647
minimumValue-2147483648
isNullabletrue
sourceNamerolluperrorcode

Traits

List of traits for the rollupErrorCode attribute are listed below.

is.dataFormat.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
enRollup Error 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
enError code associated with rollup.
entitya reference to the constant entity holding the list of localized text

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"rolluperrorcode"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"254"integer

is.constrained
maximum length or value constraints

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

is.dataFormat.integer

computedTargetAsOfTodayPercentageAchieved

Shows the expected value for percentage achieved against the target goal as of the current date.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameToday's Target (Percentage Achieved)
descriptionShows the expected value for percentage achieved against the target goal as of the current date.
dataFormatdecimal
maximumValue100000000000
minimumValue0
isNullabletrue
sourceNamecomputedtargetasoftodaypercentageachieved

Traits

List of traits for the computedTargetAsOfTodayPercentageAchieved attribute are listed below.

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

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
enToday's Target (Percentage Achieved)
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
enShows the expected value for percentage achieved against the target goal as of the current date.
entitya reference to the constant entity holding the list of localized text

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"computedtargetasoftodaypercentageachieved"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"256"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"100000000000"decimal

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

computedTargetAsOfTodayMoney

Shows the expected amount for actual value (money type) against the target goal as of the current date.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameToday's Target (Money)
descriptionShows the expected amount for actual value (money type) against the target goal as of the current date.
dataFormatdecimal
maximumValue922337203685477
minimumValue0
isNullabletrue
sourceNamecomputedtargetasoftodaymoney

Traits

List of traits for the computedTargetAsOfTodayMoney attribute are listed below.

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

ParameterValueData typeExplanation
precision"19"integerthe total number of significant digits
scale"4"integerthe number of digits to the right of the decimal place

means.measurement.currency
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
enToday's Target (Money)
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
enShows the expected amount for actual value (money type) against the target goal as of the current date.
entitya reference to the constant entity holding the list of localized text

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"computedtargetasoftodaymoney"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"257"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"922337203685477"decimal

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

computedTargetAsOfTodayMoneyBase

Shows the expected amount in base currency for actual value (money type) against the target goal as of the current date.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameToday's Target (Money) (Base)
descriptionShows the expected amount in base currency for actual value (money type) against the target goal as of the current date.
dataFormatdecimal
maximumValue922337203685477
minimumValue-922337203685477
isNullabletrue
sourceNamecomputedtargetasoftodaymoney_base

Traits

List of traits for the computedTargetAsOfTodayMoneyBase attribute are listed below.

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

ParameterValueData typeExplanation
precision"19"integerthe total number of significant digits
scale"4"integerthe number of digits to the right of the decimal place

means.measurement.currency
is.calculationOf
the attribute value is the result of a calculation on the sourceAttribute

ParameterValueData typeExplanation
sourceAttribute"computedTargetAsOfTodayMoney"attributeName

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
enToday's Target (Money) (Base)
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
enShows the expected amount in base currency for actual value (money type) against the target goal as of the current date.
entitya reference to the constant entity holding the list of localized text

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"computedtargetasoftodaymoney_base"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"258"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-922337203685477"decimal
maximumValue"922337203685477"decimal

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

computedTargetAsOfTodayDecimal

Shows the expected amount for actual value (decimal type) against the target goal.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameToday's Target (Decimal)
descriptionShows the expected amount for actual value (decimal type) against the target goal.
dataFormatdecimal
maximumValue100000000000
minimumValue0
isNullabletrue
sourceNamecomputedtargetasoftodaydecimal

Traits

List of traits for the computedTargetAsOfTodayDecimal attribute are listed below.

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

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
enToday's Target (Decimal)
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
enShows the expected amount for actual value (decimal type) against the target goal.
entitya reference to the constant entity holding the list of localized text

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"computedtargetasoftodaydecimal"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"259"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"100000000000"decimal

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

computedTargetAsOfTodayInteger

Shows the expected amount for actual value (integer type) against the target goal as of the current date.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameToday's Target (Integer)
descriptionShows the expected amount for actual value (integer type) against the target goal as of the current date.
dataFormatint32
maximumValue2147483647
minimumValue0
isNullabletrue
sourceNamecomputedtargetasoftodayinteger

Traits

List of traits for the computedTargetAsOfTodayInteger attribute are listed below.

is.dataFormat.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
enToday's Target (Integer)
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
enShows the expected amount for actual value (integer type) against the target goal as of the current date.
entitya reference to the constant entity holding the list of localized text

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"computedtargetasoftodayinteger"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"260"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

isOverride

Indicates whether the values of system rollup fields can be updated.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameOverride
descriptionIndicates whether the values of system rollup fields can be updated.
dataFormatboolean
isNullabletrue
sourceNameisoverride

Traits

List of traits for the isOverride attribute are listed below.

is.dataFormat.boolean
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
enOverride
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
enIndicates whether the values of system rollup fields can be updated.
entitya reference to the constant entity holding the list of localized text

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"isoverride"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"261"integer

is.dataFormat.boolean

isOverridden

Select whether the system rollup fields are updated. If set to Yes, the next system rollup will not update the values of the rollup fields with the system calculated values.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameOverridden
descriptionSelect whether the system rollup fields are updated. If set to Yes, the next system rollup will not update the values of the rollup fields with the system calculated values.
dataFormatboolean
isNullabletrue
sourceNameisoverridden

Traits

List of traits for the isOverridden attribute are listed below.

is.dataFormat.boolean
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
enOverridden
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
enSelect whether the system rollup fields are updated. If set to Yes, the next system rollup will not update the values of the rollup fields with the system calculated values.
entitya reference to the constant entity holding the list of localized text

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"isoverridden"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"262"integer

is.dataFormat.boolean

entityImageId

For internal use only.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameEntity Image Id
descriptionFor internal use only.
dataFormatguid
isNullabletrue
sourceNameentityimageid

Traits

List of traits for the entityImageId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
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
enEntity Image 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
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.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"entityimageid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"265"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalDescriptionId

Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameDescription
descriptionHuman-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding
dataFormatguid
isNullabletrue
sourceNamemsemr_goaldescription

Traits

List of traits for the goalDescriptionId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
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
enHuman-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding
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
/Healthcare/Foundational/Commoncore/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_goaldescription"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalExpressedByPatientId

Indicates whose goal this is - patient
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNamePatient
descriptionIndicates whose goal this is - patient
dataFormatguid
isNullabletrue
sourceNamemsemr_goalexpressedbypatient

Traits

List of traits for the goalExpressedByPatientId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enPatient
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
enIndicates whose goal this is - patient
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/Contact.cdm.json/ContactcontactId
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_goalexpressedbypatient"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalExpressedByPractitionerId

Indicates whose goal this is - practitioner
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNamePractitioner
descriptionIndicates whose goal this is - practitioner
dataFormatguid
isNullabletrue
sourceNamemsemr_goalexpressedbypractitioner

Traits

List of traits for the goalExpressedByPractitionerId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enPractitioner
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
enIndicates whose goal this is - practitioner
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/Contact.cdm.json/ContactcontactId
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_goalexpressedbypractitioner"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalExpressedByRelatedPersonId

Indicates whose goal this is - patient goal, practitioner goal, etc.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameRelated Person
descriptionIndicates whose goal this is - patient goal, practitioner goal, etc.
dataFormatguid
isNullabletrue
sourceNamemsemr_goalexpressedbyrelatedperson

Traits

List of traits for the goalExpressedByRelatedPersonId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enRelated Person
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
enIndicates whose goal this is - patient goal, practitioner goal, etc.
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/Contact.cdm.json/ContactcontactId
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_goalexpressedbyrelatedperson"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalExpressedByType

Refers to Patient or Practitioner
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameGoal Expressed By Type
descriptionRefers to Patient or Practitioner
dataFormatint32
isNullabletrue
sourceNamemsemr_goalexpressedbytype
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enPatient935000000
enPractitioner935000001
enRelated Person935000002

Traits

List of traits for the goalExpressedByType attribute are listed below.

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

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enPatient935000000
enPractitioner935000001
enRelated Person935000002
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_goalexpressedbytype"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
enGoal Expressed By 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
enRefers to Patient or Practitioner
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

goalExpressedByType_display

First included in: Commoncore/Goal (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue
isNullabletrue

Traits

List of traits for the goalExpressedByType_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.addedInSupportOf

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

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalNumber

This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameGoal Number
descriptionThis records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsemr_goalnumber

Traits

List of traits for the goalNumber attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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

ParameterValueData typeExplanation
name"msemr_goalnumber"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
enGoal 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
enThis records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalPriorityId

Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNamePriority
descriptionIdentifies the mutually agreed level of importance associated with reaching/sustaining the goal.
dataFormatguid
isNullabletrue
sourceNamemsemr_goalpriority

Traits

List of traits for the goalPriorityId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enPriority
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
enIdentifies the mutually agreed level of importance associated with reaching/sustaining the goal.
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
/Healthcare/Foundational/Commoncore/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_goalpriority"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalStartCodeId

The event after which the goal should begin being pursued.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameStarting Code
descriptionThe event after which the goal should begin being pursued.
dataFormatguid
isNullabletrue
sourceNamemsemr_goalstartcode

Traits

List of traits for the goalStartCodeId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enStarting 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
enThe event after which the goal should begin being pursued.
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
/Healthcare/Foundational/Commoncore/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_goalstartcode"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalStartType

Starting Method
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameStarting Method
descriptionStarting Method
dataFormatint32
isNullabletrue
sourceNamemsemr_goalstarttype
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enDate935000000
enCodeable Concept935000001

Traits

List of traits for the goalStartType attribute are listed below.

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

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enDate935000000
enCodeable Concept935000001
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_goalstarttype"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
enStarting Method
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
enStarting Method
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

goalStartType_display

First included in: Commoncore/Goal (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue
isNullabletrue

Traits

List of traits for the goalStartType_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.addedInSupportOf

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

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalStatus

Indicates whether the goal has been reached and is still considered relevant.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameStatus
descriptionIndicates whether the goal has been reached and is still considered relevant.
dataFormatint32
isNullabletrue
sourceNamemsemr_goalstatus
valueConstrainedToListtrue
defaultValue

Traits

List of traits for the goalStatus attribute are listed below.

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

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enProposed935000000
enAccepted935000001
enPlanned935000002
enIn Progress935000003
enOn Target935000004
enAhead of Target935000005
enBehind Target935000006
enSustaining935000007
enAchieved935000008
enOn Hold935000009
enCancelled935000010
enEntered In Error935000011
enRejected935000012
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_goalstatus"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
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
enIndicates whether the goal has been reached and is still considered relevant.
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

goalStatus_display

First included in: Commoncore/Goal (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue
isNullabletrue

Traits

List of traits for the goalStatus_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.addedInSupportOf

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

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalStatusDate

Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameModified On
descriptionIdentifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
dataFormatdateTime
isNullabletrue
sourceNamemsemr_goalstatusdate

Traits

List of traits for the goalStatusDate 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_goalstatusdate"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
enIdentifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
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

goalStatusReason

Captures the reason for the current status. This will typically be captured for statuses such as rejected, on-hold or cancelled, but could be present for others.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameModify Reason
descriptionCaptures the reason for the current status. This will typically be captured for statuses such as rejected, on-hold or cancelled, but could be present for others.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsemr_goalstatusreason

Traits

List of traits for the goalStatusReason attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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

ParameterValueData typeExplanation
name"msemr_goalstatusreason"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
enModify 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
enCaptures the reason for the current status. This will typically be captured for statuses such as rejected, on-hold or cancelled, but could be present for others.
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalSubjectGroupId

Identifies the group for whom the goal is being established.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameGroup
descriptionIdentifies the group for whom the goal is being established.
dataFormatguid
isNullabletrue
sourceNamemsemr_goalsubjectgroup

Traits

List of traits for the goalSubjectGroupId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enGroup
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
enIdentifies the group for whom the goal is being established.
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
/Healthcare/Foundational/Commoncore/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_goalsubjectgroup"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalSubjectOrganizationId

Identifies the patient, group or organization for whom the goal is being established.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameOrganization
descriptionIdentifies the patient, group or organization for whom the goal is being established.
dataFormatguid
isNullabletrue
sourceNamemsemr_goalsubjectorganization

Traits

List of traits for the goalSubjectOrganizationId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
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
enIdentifies the patient, group or organization for whom the goal is being established.
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/Account.cdm.json/AccountaccountId
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_goalsubjectorganization"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalSubjectPatientId

Identifies the patient for whom the goal is being established.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNamePatient
descriptionIdentifies the patient for whom the goal is being established.
dataFormatguid
isNullabletrue
sourceNamemsemr_goalsubjectpatient

Traits

List of traits for the goalSubjectPatientId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enPatient
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
enIdentifies the patient for whom the goal is being established.
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/Contact.cdm.json/ContactcontactId
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_goalsubjectpatient"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalSubjectType

Type of subject
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameSubject Type
descriptionType of subject
dataFormatint32
isNullabletrue
sourceNamemsemr_goalsubjecttype
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enPatient935000000
enGroup935000001
enOrganization935000002

Traits

List of traits for the goalSubjectType attribute are listed below.

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

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enPatient935000000
enGroup935000001
enOrganization935000002
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_goalsubjecttype"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
enSubject 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 subject
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

goalSubjectType_display

First included in: Commoncore/Goal (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue
isNullabletrue

Traits

List of traits for the goalSubjectType_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.addedInSupportOf

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

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalTargetDetailLowerValue

The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameLower Value
descriptionThe target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified.
dataFormatdecimal
maximumValue100000000000
minimumValue-100000000000
isNullabletrue
sourceNamemsemr_goaltargetdetaillowervalue

Traits

List of traits for the goalTargetDetailLowerValue 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_goaltargetdetaillowervalue"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 Value
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 target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified.
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

goalTargetDetailQuantityCodeId

A computer processable form of the unit in some unit representation system.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameQuantity Code
descriptionA computer processable form of the unit in some unit representation system.
dataFormatguid
isNullabletrue
sourceNamemsemr_goaltargetdetailquantitycode

Traits

List of traits for the goalTargetDetailQuantityCodeId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enQuantity 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
enA computer processable form of the unit in some unit representation system.
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
/Healthcare/Foundational/Commoncore/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_goaltargetdetailquantitycode"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalTargetDetailQuantityComparator

How the value should be understood and represented
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameQuantity Comparator
descriptionHow the value should be understood and represented
dataFormatint32
isNullabletrue
sourceNamemsemr_goaltargetdetailquantitycomparator
valueConstrainedToListtrue
defaultValue

Traits

List of traits for the goalTargetDetailQuantityComparator attribute are listed below.

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

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
en<935000000
en<=935000001
en>=935000002
en>935000003
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_goaltargetdetailquantitycomparator"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
enQuantity Comparator
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
enHow the value should be understood and represented
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

goalTargetDetailQuantityComparator_display

First included in: Commoncore/Goal (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue
isNullabletrue

Traits

List of traits for the goalTargetDetailQuantityComparator_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.addedInSupportOf

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

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalTargetDetailQuantitySystem

The identification of the system that provides the coded form of the unit.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameQuantity System
descriptionThe identification of the system that provides the coded form of the unit.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsemr_goaltargetdetailquantitysystem

Traits

List of traits for the goalTargetDetailQuantitySystem attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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

ParameterValueData typeExplanation
name"msemr_goaltargetdetailquantitysystem"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
enQuantity System
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 identification of the system that provides the coded form of the unit.
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalTargetDetailQuantityUnit

A human-readable form of the unit.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameQuantity Unit
descriptionA human-readable form of the unit.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsemr_goaltargetdetailquantityunit

Traits

List of traits for the goalTargetDetailQuantityUnit attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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

ParameterValueData typeExplanation
name"msemr_goaltargetdetailquantityunit"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
enQuantity Unit
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 human-readable form of the unit.
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalTargetDetailQuantityValue

The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameQuantity Value
descriptionThe target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified.
dataFormatdecimal
maximumValue100000000000
minimumValue-100000000000
isNullabletrue
sourceNamemsemr_goaltargetdetailquantityvalue

Traits

List of traits for the goalTargetDetailQuantityValue 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_goaltargetdetailquantityvalue"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
enQuantity Value
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 target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified.
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

goalTargetDetailType

Type of measurement value.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameDetail Type
descriptionType of measurement value.
dataFormatint32
isNullabletrue
sourceNamemsemr_goaltargetdetailtype
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enQuantity935000000
enRange935000001
enCodeable Concept935000002

Traits

List of traits for the goalTargetDetailType attribute are listed below.

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

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enQuantity935000000
enRange935000001
enCodeable Concept935000002
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_goaltargetdetailtype"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
enDetail 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 measurement 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.integer

goalTargetDetailType_display

First included in: Commoncore/Goal (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue
isNullabletrue

Traits

List of traits for the goalTargetDetailType_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.addedInSupportOf

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

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalTargetDetailUpperValue

The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameUpper Value
descriptionThe target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified.
dataFormatdecimal
maximumValue100000000000
minimumValue-100000000000
isNullabletrue
sourceNamemsemr_goaltargetdetailuppervalue

Traits

List of traits for the goalTargetDetailUpperValue 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_goaltargetdetailuppervalue"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 Value
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 target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified.
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

goalTargetDetailValueCodeId

The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameCode
descriptionThe target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified.
dataFormatguid
isNullabletrue
sourceNamemsemr_goaltargetdetailvaluecode

Traits

List of traits for the goalTargetDetailValueCodeId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enCode
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 target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified.
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
/Healthcare/Foundational/Commoncore/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_goaltargetdetailvaluecode"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalTargetMeasureId

The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameGoal Measurement
descriptionThe parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
dataFormatguid
isNullabletrue
sourceNamemsemr_goaltargetmeasure

Traits

List of traits for the goalTargetMeasureId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
enGoal Measurement
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 parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
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
/Healthcare/Foundational/Commoncore/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_goaltargetmeasure"string

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

goalTargetMeasureValueDueDate

Indicates either the date or the duration after start by which the goal should be met.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameDue Date
descriptionIndicates either the date or the duration after start by which the goal should be met.
dataFormatdateTime
isNullabletrue
sourceNamemsemr_goaltargetmeasurevalueduedate

Traits

List of traits for the goalTargetMeasureValueDueDate 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_goaltargetmeasurevalueduedate"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
enDue Date
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
enIndicates either the date or the duration after start by which the goal should be met.
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

goalTargetMeasureValueDueDuration

Indicates either the date or the duration after start by which the goal should be met.
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameDue Duration
descriptionIndicates either the date or the duration after start by which the goal should be met.
dataFormatdecimal
maximumValue100000000000
minimumValue-100000000000
isNullabletrue
sourceNamemsemr_goaltargetmeasurevaluedueduration

Traits

List of traits for the goalTargetMeasureValueDueDuration 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_goaltargetmeasurevaluedueduration"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
enDue Duration
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
enIndicates either the date or the duration after start by which the goal should be met.
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

goalTargetMeasureValueDueType

Type of value due
First included in: Commoncore/Goal (this entity)

Properties

NameValue
displayNameMeasure Due Type
descriptionType of value due
dataFormatint32
isNullabletrue
sourceNamemsemr_goaltargetmeasurevalueduetype
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enDate935000000
enDuration935000001

Traits

List of traits for the goalTargetMeasureValueDueType attribute are listed below.

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

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enDate935000000
enDuration935000001
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_goaltargetmeasurevalueduetype"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
enMeasure Due 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 value due
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

goalTargetMeasureValueDueType_display

First included in: Commoncore/Goal (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue
isNullabletrue

Traits

List of traits for the goalTargetMeasureValueDueType_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.addedInSupportOf

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

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

name

The name of the custom entity.
First included in: Commoncore/Goal (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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object