Plan Definition in electronicMedicalRecords

This entity allows for the definition of various types of plans as a shareable, consumable, and executable artifact.

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

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.1"	string	semantic version number of the entity

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

Parameter	Value	Data type	Explanation
attribute	PlanDefinition/(resolvedAttributes)/planDefinitionId	attribute

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

Parameter	Value	Data type	Explanation
attribute	PlanDefinition/(resolvedAttributes)/stateCode	attribute

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

Parameter	Value	Data type	Explanation
groupList	attributeGroupReference /core/applicationCommon/foundationCommon /crmCommon/accelerators/healthCare /electronicMedicalRecords/PlanDefinition.cdm.json /PlanDefinition/hasAttributes /attributesAddedAtThisScope	entity

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Plan Definition	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en This entity allows for the definition of various types of plans as a shareable, consumable, and executable artifact.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"msemr_plandefinition"	string

Attributes

Name	Description	First Included in Instance
createdBy	Unique identifier of the user who created the record.	electronicMedicalRecords/PlanDefinition
createdOn	Date and time when the record was created.	electronicMedicalRecords/PlanDefinition
createdOnBehalfBy	Unique identifier of the delegate user who created the record.	electronicMedicalRecords/PlanDefinition
importSequenceNumber	Sequence number of the import that created this record.	electronicMedicalRecords/PlanDefinition
modifiedBy	Unique identifier of the user who modified the record.	electronicMedicalRecords/PlanDefinition
modifiedOn	Date and time when the record was modified.	electronicMedicalRecords/PlanDefinition
modifiedOnBehalfBy	Unique identifier of the delegate user who modified the record.	electronicMedicalRecords/PlanDefinition
approvalDate	The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.	electronicMedicalRecords/PlanDefinition
copyright	A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.	electronicMedicalRecords/PlanDefinition
description	A free text natural language description of the plan definition from a consumer's perspective.	electronicMedicalRecords/PlanDefinition
endDate	The period end date during which the plan definition content was or is planned to be in active use.	electronicMedicalRecords/PlanDefinition
experimental	A boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.	electronicMedicalRecords/PlanDefinition
lastReviewDate	The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.	electronicMedicalRecords/PlanDefinition
name	A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.	electronicMedicalRecords/PlanDefinition
planDefinitionId	Unique identifier for entity instances	electronicMedicalRecords/PlanDefinition
planDefinitionNumber	A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.	electronicMedicalRecords/PlanDefinition
publisher	The name of the individual or organization that published the plan definition.	electronicMedicalRecords/PlanDefinition
purpose	Explanation of why this plan definition is needed and why it has been designed as it has.	electronicMedicalRecords/PlanDefinition
revisionDate	The date (and optionally time) when the plan definition was published. The date must change if and when the business version changes and it must change if the status code changes.	electronicMedicalRecords/PlanDefinition
startDate	The period during which the plan definition content was or is planned to be in active use.	electronicMedicalRecords/PlanDefinition
status	The status of this plan definition. Enables tracking the life-cycle of the content.	electronicMedicalRecords/PlanDefinition
status_display		electronicMedicalRecords/PlanDefinition
title	A short, descriptive, user-friendly title for the plan definition.	electronicMedicalRecords/PlanDefinition
type	The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.	electronicMedicalRecords/PlanDefinition
type_display		electronicMedicalRecords/PlanDefinition
URL	An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance.	electronicMedicalRecords/PlanDefinition
usage	A detailed description of how the asset is used from a clinical perspective.	electronicMedicalRecords/PlanDefinition
version	The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance.	electronicMedicalRecords/PlanDefinition
organizationId	Unique identifier for the organization	electronicMedicalRecords/PlanDefinition
overriddenCreatedOn	Date and time that the record was migrated.	electronicMedicalRecords/PlanDefinition
stateCode	Status of the Plan Definition	electronicMedicalRecords/PlanDefinition
stateCode_display		electronicMedicalRecords/PlanDefinition
statusCode	Reason for the status of the Plan Definition	electronicMedicalRecords/PlanDefinition
statusCode_display		electronicMedicalRecords/PlanDefinition
timeZoneRuleVersionNumber	For internal use only.	electronicMedicalRecords/PlanDefinition
UTCConversionTimeZoneCode	Time zone code that was in use when the record was created.	electronicMedicalRecords/PlanDefinition

createdBy

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

Properties

Name	Value
displayName	Created By
description	Unique identifier of the user who created the record.
dataFormat	guid
isNullable	true
sourceName	createdby

Traits

List of traits for the createdBy attribute are listed below.

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Created By	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier of the user who created the record.	entity	a 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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/User.cdm.json/User systemUserId	entity	a 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.

Parameter	Value	Data type	Explanation
name	"createdby"	string

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

createdOn

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

Properties

Name	Value
displayName	Created On
description	Date and time when the record was created.
dataFormat	dateTime
isNullable	true
sourceName	createdon

Traits

List of traits for the createdOn attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"createdon"	string

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Created On	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Date and time when the record was created.	entity	a reference to the constant entity holding the list of localized text

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

is.dataFormat.time
is.dataFormat.date

createdOnBehalfBy

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

Properties

Name	Value
displayName	Created By (Delegate)
description	Unique identifier of the delegate user who created the record.
dataFormat	guid
isNullable	true
sourceName	createdonbehalfby

Traits

List of traits for the createdOnBehalfBy attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"createdonbehalfby"	string

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Created By (Delegate)	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier of the delegate user who created the record.	entity	a reference to the constant entity holding the list of localized text

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

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

importSequenceNumber

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

Properties

Name	Value
displayName	Import Sequence Number
description	Sequence number of the import that created this record.
dataFormat	int32
maximumValue	2147483647
minimumValue	-2147483648
isNullable	true
sourceName	importsequencenumber

Traits

List of traits for the importSequenceNumber attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"importsequencenumber"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
minimumValue	"-2147483648"	decimal
maximumValue	"2147483647"	decimal

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Import Sequence Number	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Sequence number of the import that created this record.	entity	a reference to the constant entity holding the list of localized text

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

is.dataFormat.integer

modifiedBy

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

Properties

Name	Value
displayName	Modified By
description	Unique identifier of the user who modified the record.
dataFormat	guid
isNullable	true
sourceName	modifiedby

Traits

List of traits for the modifiedBy attribute are listed below.

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Modified By	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier of the user who modified the record.	entity	a 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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/User.cdm.json/User systemUserId	entity	a 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.

Parameter	Value	Data type	Explanation
name	"modifiedby"	string

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

modifiedOn

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

Properties

Name	Value
displayName	Modified On
description	Date and time when the record was modified.
dataFormat	dateTime
isNullable	true
sourceName	modifiedon

Traits

List of traits for the modifiedOn attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"modifiedon"	string

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Modified On	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Date and time when the record was modified.	entity	a reference to the constant entity holding the list of localized text

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

is.dataFormat.time
is.dataFormat.date

modifiedOnBehalfBy

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

Properties

Name	Value
displayName	Modified By (Delegate)
description	Unique identifier of the delegate user who modified the record.
dataFormat	guid
isNullable	true
sourceName	modifiedonbehalfby

Traits

List of traits for the modifiedOnBehalfBy attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"modifiedonbehalfby"	string

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Modified By (Delegate)	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier of the delegate user who modified the record.	entity	a reference to the constant entity holding the list of localized text

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

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

approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Approval Date
description	The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
dataFormat	dateTime
isNullable	true
sourceName	msemr_approvaldate

Traits

List of traits for the approvalDate 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.

Parameter	Value	Data type	Explanation
name	"msemr_approvaldate"	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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Approval Date	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.	entity	a 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

copyright

A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Copyright
description	A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_copyright

Traits

List of traits for the copyright attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_copyright"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Copyright	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.	entity	a 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

description

A free text natural language description of the plan definition from a consumer's perspective.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Description
description	A free text natural language description of the plan definition from a consumer's perspective.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_description

Traits

List of traits for the description attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_description"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Description	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en A free text natural language description of the plan definition from a consumer's perspective.	entity	a 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

endDate

The period end date during which the plan definition content was or is planned to be in active use.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	End Date
description	The period end date during which the plan definition content was or is planned to be in active use.
dataFormat	dateTime
isNullable	true
sourceName	msemr_enddate

Traits

List of traits for the endDate 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.

Parameter	Value	Data type	Explanation
name	"msemr_enddate"	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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en End Date	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The period end date during which the plan definition content was or is planned to be in active use.	entity	a 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

experimental

A boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Experimental
description	A boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
dataFormat	boolean
isNullable	true
sourceName	msemr_experimental

Traits

List of traits for the experimental attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_experimental"	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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Experimental	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en A boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.	entity	a reference to the constant entity holding the list of localized text

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

is.dataFormat.boolean

lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Last Review Date
description	The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
dataFormat	dateTime
isNullable	true
sourceName	msemr_lastreviewdate

Traits

List of traits for the lastReviewDate 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.

Parameter	Value	Data type	Explanation
name	"msemr_lastreviewdate"	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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Last Review Date	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.	entity	a 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

name

A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Name
description	A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
dataFormat	string
maximumLength	100
sourceName	msemr_name

Traits

List of traits for the name attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_name"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"required"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Name	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

planDefinitionId

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

Properties

Name	Value
displayName	Plan Definition
description	Unique identifier for entity instances
isPrimaryKey	true
dataFormat	guid
sourceName	msemr_plandefinitionid

Traits

List of traits for the planDefinitionId attribute are listed below.

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

Parameter	Value	Data type	Explanation
attribute	PlanDefinition/(resolvedAttributes)/planDefinitionId	attribute

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

Parameter	Value	Data type	Explanation
name	"msemr_plandefinitionid"	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

Parameter	Value	Data type	Explanation
level	"systemrequired"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Plan Definition	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier for entity instances	entity	a reference to the constant entity holding the list of localized text

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

planDefinitionNumber

A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Plan Definition Number
description	A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_plandefinitionnumber

Traits

List of traits for the planDefinitionNumber attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_plandefinitionnumber"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Plan Definition Number	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.	entity	a 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

publisher

The name of the individual or organization that published the plan definition.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Publisher
description	The name of the individual or organization that published the plan definition.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_publisher

Traits

List of traits for the publisher attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_publisher"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Publisher	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The name of the individual or organization that published the plan definition.	entity	a 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

purpose

Explanation of why this plan definition is needed and why it has been designed as it has.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Purpose
description	Explanation of why this plan definition is needed and why it has been designed as it has.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_purpose

Traits

List of traits for the purpose attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_purpose"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Purpose	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Explanation of why this plan definition is needed and why it has been designed as it has.	entity	a 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

revisionDate

The date (and optionally time) when the plan definition was published. The date must change if and when the business version changes and it must change if the status code changes.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Revision Date
description	The date (and optionally time) when the plan definition was published. The date must change if and when the business version changes and it must change if the status code changes.
dataFormat	dateTime
isNullable	true
sourceName	msemr_revisiondate

Traits

List of traits for the revisionDate 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.

Parameter	Value	Data type	Explanation
name	"msemr_revisiondate"	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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Revision Date	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The date (and optionally time) when the plan definition was published. The date must change if and when the business version changes and it must change if the status code changes.	entity	a 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

startDate

The period during which the plan definition content was or is planned to be in active use.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Start Date
description	The period during which the plan definition content was or is planned to be in active use.
dataFormat	dateTime
isNullable	true
sourceName	msemr_startdate

Traits

List of traits for the startDate 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.

Parameter	Value	Data type	Explanation
name	"msemr_startdate"	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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Start Date	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The period during which the plan definition content was or is planned to be in active use.	entity	a 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

status

The status of this plan definition. Enables tracking the life-cycle of the content.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Status
description	The status of this plan definition. Enables tracking the life-cycle of the content.
dataFormat	int32
isNullable	true
sourceName	msemr_status
valueConstrainedToList	true
defaultValue

Traits

List of traits for the status attribute are listed below.

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

Parameter	Value	Data type	Explanation
default	languageTag displayText attributeValue en Draft 935000000 en Active 935000001 en Retired 935000002 en Unknown 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.

Parameter	Value	Data type	Explanation
name	"msemr_status"	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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Status	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The status of this plan definition. Enables tracking the life-cycle of the content.	entity	a reference to the constant entity holding the list of localized text

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

is.dataFormat.integer

status_display

First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the status_display attribute are listed below.

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

Parameter	Value	Data type	Explanation
inSupportOf	"status"	attributeName	output parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

title

A short, descriptive, user-friendly title for the plan definition.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Title
description	A short, descriptive, user-friendly title for the plan definition.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_title

Traits

List of traits for the title attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_title"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Title	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en A short, descriptive, user-friendly title for the plan definition.	entity	a 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

type

The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Type
description	The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.
dataFormat	int32
isNullable	true
sourceName	msemr_type
valueConstrainedToList	true
defaultValue

Traits

List of traits for the type attribute are listed below.

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

Parameter	Value	Data type	Explanation
default	languageTag displayText attributeValue en Order Set 935000000 en Protocol 935000001 en ECA Rule 935000002	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.

Parameter	Value	Data type	Explanation
name	"msemr_type"	string

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Type	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.	entity	a reference to the constant entity holding the list of localized text

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

is.dataFormat.integer

type_display

First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the type_display attribute are listed below.

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

Parameter	Value	Data type	Explanation
inSupportOf	"type"	attributeName	output parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

URL

An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	URL
description	An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_url

Traits

List of traits for the URL attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_url"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en URL	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance.	entity	a 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

usage

A detailed description of how the asset is used from a clinical perspective.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Usage
description	A detailed description of how the asset is used from a clinical perspective.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_usage

Traits

List of traits for the usage attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_usage"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Usage	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en A detailed description of how the asset is used from a clinical perspective.	entity	a 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

version

The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance.
First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
displayName	Version
description	The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_version

Traits

List of traits for the version attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_version"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Version	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance.	entity	a 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

organizationId

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

Properties

Name	Value
displayName	Organization Id
description	Unique identifier for the organization
dataFormat	guid
isNullable	true
sourceName	organizationid

Traits

List of traits for the organizationId attribute are listed below.

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

Parameter	Value	Data type	Explanation
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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Organization Id	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier for the organization	entity	a 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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/applicationCommon/Organization.cdm.json/Organization organizationId	entity	a 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.

Parameter	Value	Data type	Explanation
name	"organizationid"	string

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

overriddenCreatedOn

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

Properties

Name	Value
displayName	Record Created On
description	Date and time that the record was migrated.
dataFormat	dateTime
isNullable	true
sourceName	overriddencreatedon

Traits

List of traits for the overriddenCreatedOn attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"overriddencreatedon"	string

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Record Created On	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Date and time that the record was migrated.	entity	a reference to the constant entity holding the list of localized text

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

is.dataFormat.time
is.dataFormat.date

stateCode

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

Properties

Name	Value
displayName	Status
description	Status of the Plan Definition
dataFormat	int32
sourceName	statecode
valueConstrainedToList	true
defaultValue	languageTag displayText attributeValue en Active 0 en Inactive 1

Traits

List of traits for the stateCode attribute are listed below.

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

Parameter	Value	Data type	Explanation
default	languageTag displayText attributeValue en Active 0 en Inactive 1	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.

Parameter	Value	Data type	Explanation
attribute	PlanDefinition/(resolvedAttributes)/stateCode	attribute

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

Parameter	Value	Data type	Explanation
name	"statecode"	string

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

Parameter	Value	Data type	Explanation
level	"systemrequired"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Status	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Status of the Plan Definition	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

stateCode_display

First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the stateCode_display attribute are listed below.

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

Parameter	Value	Data type	Explanation
inSupportOf	"stateCode"	attributeName	output parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

statusCode

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

Properties

Name	Value
displayName	Status Reason
description	Reason for the status of the Plan Definition
dataFormat	int32
isNullable	true
sourceName	statuscode
defaultValue	languageTag displayText attributeValue correlatedValue en Active 1 0 en Inactive 2 1

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

Parameter	Value	Data type	Explanation
default	languageTag displayText attributeValue correlatedValue en Active 1 0 en Inactive 2 1	any

is.correlatedWith
the attribute value is correlated with the sourceAttribute

Parameter	Value	Data type	Explanation
sourceAttribute	"stateCode"	attributeName

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

Parameter	Value	Data type	Explanation
name	"statuscode"	string

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Status Reason	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Reason for the status of the Plan Definition	entity	a reference to the constant entity holding the list of localized text

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

is.dataFormat.integer

statusCode_display

First included in: electronicMedicalRecords/PlanDefinition (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the statusCode_display attribute are listed below.

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

Parameter	Value	Data type	Explanation
inSupportOf	"statusCode"	attributeName	output parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

timeZoneRuleVersionNumber

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

Properties

Name	Value
displayName	Time Zone Rule Version Number
description	For internal use only.
dataFormat	int32
maximumValue	2147483647
minimumValue	-1
isNullable	true
sourceName	timezoneruleversionnumber

Traits

List of traits for the timeZoneRuleVersionNumber attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"timezoneruleversionnumber"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
minimumValue	"-1"	decimal
maximumValue	"2147483647"	decimal

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Time Zone Rule Version Number	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en For internal use only.	entity	a reference to the constant entity holding the list of localized text

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

is.dataFormat.integer

UTCConversionTimeZoneCode

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

Properties

Name	Value
displayName	UTC Conversion Time Zone Code
description	Time zone code that was in use when the record was created.
dataFormat	int32
maximumValue	2147483647
minimumValue	-1
isNullable	true
sourceName	utcconversiontimezonecode

Traits

List of traits for the UTCConversionTimeZoneCode attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"utcconversiontimezonecode"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
minimumValue	"-1"	decimal
maximumValue	"2147483647"	decimal

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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en UTC Conversion Time Zone Code	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Time zone code that was in use when the record was created.	entity	a reference to the constant entity holding the list of localized text

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

is.dataFormat.integer