Care Plan Activity in electronicMedicalRecords

Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

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.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.

Parameter	Value	Data type	Explanation
groupList	attributeGroupReference /core/wellKnownCDSAttributeGroups.cdm.json /cdsCreationModificationDatesAndIds /core/wellKnownCDSAttributeGroups.cdm.json /cdsOwnershipInfo /core/wellKnownCDSAttributeGroups.cdm.json /cdsTimeZoneInfo /core/wellKnownCDSAttributeGroups.cdm.json /cdsVersionTracking /core/applicationCommon/foundationCommon /crmCommon/accelerators/healthCare /electronicMedicalRecords /CarePlanActivity.cdm.json/CarePlanActivity /hasAttributes/attributesAddedAtThisScope	entity

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

Parameter	Value	Data type	Explanation
attribute	CarePlanActivity/(resolvedAttributes)/carePlanActivityId	attribute

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

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Care Plan Activity	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 Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.	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_careplanactivity"	string

Attributes

Name	Description	First Included in Instance
createdOn	Date and time when the record was created.	electronicMedicalRecords/CarePlanActivity
createdBy	Unique identifier of the user who created the record.	electronicMedicalRecords/CarePlanActivity
modifiedOn	Date and time when the record was modified.	electronicMedicalRecords/CarePlanActivity
modifiedBy	Unique identifier of the user who modified the record.	electronicMedicalRecords/CarePlanActivity
createdOnBehalfBy	Unique identifier of the delegate user who created the record.	electronicMedicalRecords/CarePlanActivity
modifiedOnBehalfBy	Unique identifier of the delegate user who modified the record.	electronicMedicalRecords/CarePlanActivity
overriddenCreatedOn	Date and time that the record was migrated.	electronicMedicalRecords/CarePlanActivity
importSequenceNumber	Sequence number of the import that created this record.	electronicMedicalRecords/CarePlanActivity
ownerId	Owner Id	electronicMedicalRecords/CarePlanActivity
ownerIdType	The type of owner, either User or Team.	electronicMedicalRecords/CarePlanActivity
owningBusinessUnit	Unique identifier for the business unit that owns the record	electronicMedicalRecords/CarePlanActivity
owningUser	Unique identifier of the user that owns the activity.	electronicMedicalRecords/CarePlanActivity
owningTeam	Unique identifier for the team that owns the record.	electronicMedicalRecords/CarePlanActivity
timeZoneRuleVersionNumber	For internal use only.	electronicMedicalRecords/CarePlanActivity
UTCConversionTimeZoneCode	Time zone code that was in use when the record was created.	electronicMedicalRecords/CarePlanActivity
versionNumber	Version Number	electronicMedicalRecords/CarePlanActivity
activityCategoryId	High-level categorization of the type of activity in a care plan.	electronicMedicalRecords/CarePlanActivity
activityCodeId	Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.	electronicMedicalRecords/CarePlanActivity
activityDailyAmount	Identifies the quantity expected to be consumed in a given day.	electronicMedicalRecords/CarePlanActivity
activityDefinitionType	Type of activity definition	electronicMedicalRecords/CarePlanActivity
activityDefinitionType_display		electronicMedicalRecords/CarePlanActivity
activityDefinitionTypeActivityDefinitionId	Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.	electronicMedicalRecords/CarePlanActivity
activityDefinitionTypePlanDefinitionId	Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.	electronicMedicalRecords/CarePlanActivity
activityDefinitionTypeQuestionnaireId	Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.	electronicMedicalRecords/CarePlanActivity
activityDescription	This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions.	electronicMedicalRecords/CarePlanActivity
activityEndDate	The period, timing or frequency upon which the described activity is to occur.	electronicMedicalRecords/CarePlanActivity
activityIdentifier	Unique Identifier of the care plan activity	electronicMedicalRecords/CarePlanActivity
activityLocationId	Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc	electronicMedicalRecords/CarePlanActivity
activityProductCodeableConceptId	Identifies the food, drug or other product to be consumed or supplied in the activity.	electronicMedicalRecords/CarePlanActivity
activityProductReferenceType	Type of the medication or substance to be consumed or supplied in the activity	electronicMedicalRecords/CarePlanActivity
activityProductReferenceType_display		electronicMedicalRecords/CarePlanActivity
activityProductReferenceTypeSubstanceId	Identifies the food, drug or other product to be consumed or supplied in the activity.	electronicMedicalRecords/CarePlanActivity
activityProductType	Type of the food, drug or other product to be consumed or supplied in the activity.	electronicMedicalRecords/CarePlanActivity
activityProductType_display		electronicMedicalRecords/CarePlanActivity
activityProhibited	If true, indicates that the described activity is one that must NOT be engaged in when following the plan.	electronicMedicalRecords/CarePlanActivity
activityQuantity	Identifies the quantity expected to be supplied, administered or consumed by the subject.	electronicMedicalRecords/CarePlanActivity
activityReferenceType	This refers to an appointment, communication request, device request, medication request, nutrition order, a task, procedure request, referral request, vision prescription.	electronicMedicalRecords/CarePlanActivity
activityReferenceType_display		electronicMedicalRecords/CarePlanActivity
activityScheduledType	Type of the period, timing or frequency upon which the described activity is to occur.	electronicMedicalRecords/CarePlanActivity
activityScheduledType_display		electronicMedicalRecords/CarePlanActivity
activityStartDate	The period, timing or frequency upon which the described activity is to occur.	electronicMedicalRecords/CarePlanActivity
activityStatus	Identifies what progress is being made for the specific activity.	electronicMedicalRecords/CarePlanActivity
activityStatus_display		electronicMedicalRecords/CarePlanActivity
activityStatusReason	Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.	electronicMedicalRecords/CarePlanActivity
activityString	The period, timing or frequency upon which the described activity is to occur.	electronicMedicalRecords/CarePlanActivity
activityTimingId	The period, timing or frequency upon which the described activity is to occur.	electronicMedicalRecords/CarePlanActivity
carePlanId	Healthcare plan for patient or group	electronicMedicalRecords/CarePlanActivity
carePlanActivityId	Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.	electronicMedicalRecords/CarePlanActivity
description	A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.	electronicMedicalRecords/CarePlanActivity
productReferenceMedicationNewId		electronicMedicalRecords/CarePlanActivity
referenceAppointmentIdentifierId	The details of the proposed activity represented in a specific resource.	electronicMedicalRecords/CarePlanActivity
referenceCommunicationRequestIdentifierId	The details of the proposed activity represented in a specific resource	electronicMedicalRecords/CarePlanActivity
referenceDeviceRequestIdentifierId	The details of the proposed activity represented in a specific resource	electronicMedicalRecords/CarePlanActivity
referenceMedicationRequestIdentifierId	The details of the proposed activity represented in a specific resource	electronicMedicalRecords/CarePlanActivity
referenceNutritionOrderIdentifierId	The details of the proposed activity represented in a specific resource	electronicMedicalRecords/CarePlanActivity
referenceProcedureRequestIdentifierId	The details of the proposed activity represented in a specific resource	electronicMedicalRecords/CarePlanActivity
referenceReferralRequestIdentifierId	The details of the proposed activity represented in a specific resource	electronicMedicalRecords/CarePlanActivity
referenceRequestGroupIdentifierId	The details of the proposed activity represented in a specific resource	electronicMedicalRecords/CarePlanActivity
referenceTaskIdentifierId	The details of the proposed activity represented in a specific resource	electronicMedicalRecords/CarePlanActivity
referenceVisionPrescriptionIdentifierId	The details of the proposed activity represented in a specific resource	electronicMedicalRecords/CarePlanActivity
emrstatusCode	Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.	electronicMedicalRecords/CarePlanActivity
stateCode	Status of the Care Plan Activity	electronicMedicalRecords/CarePlanActivity
stateCode_display		electronicMedicalRecords/CarePlanActivity
statusCode	Reason for the status of the Care Plan Activity	electronicMedicalRecords/CarePlanActivity
statusCode_display		electronicMedicalRecords/CarePlanActivity

createdOn

Date and time when the record was created.
First included in: electronicMedicalRecords/CarePlanActivity (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.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

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

Parameter	Value	Data type	Explanation
name	"createdon"	string

is.dataFormat.time
is.dataFormat.date

createdBy

Unique identifier of the user who created the record.
First included in: electronicMedicalRecords/CarePlanActivity (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
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

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 Shows who created the record. 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

modifiedOn

Date and time when the record was modified.
First included in: electronicMedicalRecords/CarePlanActivity (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.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

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

Parameter	Value	Data type	Explanation
name	"modifiedon"	string

is.dataFormat.time
is.dataFormat.date

modifiedBy

Unique identifier of the user who modified the record.
First included in: electronicMedicalRecords/CarePlanActivity (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
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

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 Shows who last updated the record. 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

createdOnBehalfBy

Unique identifier of the delegate user who created the record.
First included in: electronicMedicalRecords/CarePlanActivity (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
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

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

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

modifiedOnBehalfBy

Unique identifier of the delegate user who modified the record.
First included in: electronicMedicalRecords/CarePlanActivity (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
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

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

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

overriddenCreatedOn

Date and time that the record was migrated.
First included in: electronicMedicalRecords/CarePlanActivity (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.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

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

Parameter	Value	Data type	Explanation
name	"overriddencreatedon"	string

is.dataFormat.time
is.dataFormat.date

importSequenceNumber

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

ownerId

Owner Id
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Owner
description	Owner Id
dataFormat	guid
sourceName	ownerid

Traits

List of traits for the ownerId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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

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	"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 Owner	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 Owner Id	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 /core/applicationCommon/Team.cdm.json/Team teamId	entity	a 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.

Parameter	Value	Data type	Explanation
name	"ownerid"	string

is.CDS.owner
contains a User or Team ID

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

ownerIdType

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

Properties

Name	Value
displayName	Owner Type
description	The type of owner, either User or Team.
dataFormat	string
isReadOnly	true
sourceName	owneridtype

Traits

List of traits for the ownerIdType attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.entityName
[deprecated] use the standalone 'means.entityName' trait instead.

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

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 Owner 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 owner, either User or Team.	entity	a 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.

Parameter	Value	Data type	Explanation
name	"owneridtype"	string

is.CDS.owner
contains a User or Team ID

is.dataFormat.character
is.dataFormat.array

owningBusinessUnit

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

Properties

Name	Value
displayName	Owning Business Unit
description	Unique identifier for the business unit that owns the record
dataFormat	guid
isNullable	true
sourceName	owningbusinessunit

Traits

List of traits for the owningBusinessUnit attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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

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

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

owningUser

Unique identifier of the user that owns the activity.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Owning User
description	Unique identifier of the user that owns the activity.
dataFormat	guid
isNullable	true
sourceName	owninguser

Traits

List of traits for the owningUser attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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

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 Owning User	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 user that owns the record. en Unique identifier of the user that owns the activity.	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	"owninguser"	string

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

owningTeam

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

Properties

Name	Value
displayName	Owning Team
description	Unique identifier for the team that owns the record.
dataFormat	guid
isNullable	true
sourceName	owningteam

Traits

List of traits for the owningTeam attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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

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

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

timeZoneRuleVersionNumber

For internal use only.
First included in: electronicMedicalRecords/CarePlanActivity (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.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

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

UTCConversionTimeZoneCode

Time zone code that was in use when the record was created.
First included in: electronicMedicalRecords/CarePlanActivity (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.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

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

versionNumber

Version Number
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Version Number
description	Version Number
dataFormat	int64
isNullable	true
sourceName	versionnumber

Traits

List of traits for the versionNumber attribute are listed below.

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

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 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 Version Number	entity	a 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.

Parameter	Value	Data type	Explanation
name	"versionnumber"	string

is.dataFormat.integer
is.dataFormat.big

activityCategoryId

High-level categorization of the type of activity in a care plan.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity Category
description	High-level categorization of the type of activity in a care plan.
dataFormat	guid
isNullable	true
sourceName	msemr_activitycategory

Traits

List of traits for the activityCategoryId 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 Activity Category	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 High-level categorization of the type of activity in a care plan.	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/CodeableConcept.cdm.json/CodeableConcept codeableConceptId	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	"msemr_activitycategory"	string

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

activityCodeId

Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity Code
description	Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.
dataFormat	guid
isNullable	true
sourceName	msemr_activitycode

Traits

List of traits for the activityCodeId 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 Activity 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 Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/CodeableConcept.cdm.json/CodeableConcept codeableConceptId	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	"msemr_activitycode"	string

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

activityDailyAmount

Identifies the quantity expected to be consumed in a given day.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Daily Amount
description	Identifies the quantity expected to be consumed in a given day.
dataFormat	decimal
maximumValue	100000000000
minimumValue	-100000000000
isNullable	true
sourceName	msemr_activitydailyamount

Traits

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

Parameter	Value	Data type	Explanation
name	"msemr_activitydailyamount"	string

is.constrained
maximum length or value constraints

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

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 Daily Amount	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 Identifies the quantity expected to be consumed in a given day.	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.numeric.shaped
for setting the exact precision and scale of numeric values

activityDefinitionType

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

Properties

Name	Value
displayName	Activity Definition Type
description	Type of activity definition
dataFormat	int32
isNullable	true
sourceName	msemr_activitydefinitiontype
valueConstrainedToList	true
defaultValue	languageTag displayText attributeValue en Plan Definition 935000000 en Activity Definition 935000001 en Questionnaire 935000002

Traits

List of traits for the activityDefinitionType 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 Plan Definition 935000000 en Activity Definition 935000001 en Questionnaire 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_activitydefinitiontype"	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 Activity Definition 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 Type of activity 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

activityDefinitionType_display

First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the activityDefinitionType_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	"activityDefinitionType"	attributeName	output parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

activityDefinitionTypeActivityDefinitionId

Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity Definition
description	Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.
dataFormat	guid
isNullable	true
sourceName	msemr_activitydefinitiontypeactivitydefinition

Traits

List of traits for the activityDefinitionTypeActivityDefinitionId 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 Activity 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 Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/ActivityDefinition.cdm.json/ActivityDefinition identifiesspecifictimeswhentheeventoccuId	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	"msemr_activitydefinitiontypeactivitydefinition"	string

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

activityDefinitionTypePlanDefinitionId

Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Plan Definition
description	Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.
dataFormat	guid
isNullable	true
sourceName	msemr_activitydefinitiontypeplandefinition

Traits

List of traits for the activityDefinitionTypePlanDefinitionId 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 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 Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/PlanDefinition.cdm.json/PlanDefinition planDefinitionId	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	"msemr_activitydefinitiontypeplandefinition"	string

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

activityDefinitionTypeQuestionnaireId

Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Questionnaire
description	Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.
dataFormat	guid
isNullable	true
sourceName	msemr_activitydefinitiontypequestionnaire

Traits

List of traits for the activityDefinitionTypeQuestionnaireId 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 Questionnaire	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 Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/CodeableConcept.cdm.json/CodeableConcept codeableConceptId	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	"msemr_activitydefinitiontypequestionnaire"	string

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

activityDescription

This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity Description
description	This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_activitydescription

Traits

List of traits for the activityDescription 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_activitydescription"	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 Activity 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 This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions.	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

activityEndDate

The period, timing or frequency upon which the described activity is to occur.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity End Date
description	The period, timing or frequency upon which the described activity is to occur.
dataFormat	dateTime
isNullable	true
sourceName	msemr_activityenddate

Traits

List of traits for the activityEndDate 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_activityenddate"	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 Activity 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, timing or frequency upon which the described activity is to occur.	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

activityIdentifier

Unique Identifier of the care plan activity
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity ID
description	Unique Identifier of the care plan activity
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_activityidentifier

Traits

List of traits for the activityIdentifier 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_activityidentifier"	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 Activity 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 of the care plan activity	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

activityLocationId

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity Location
description	Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc
dataFormat	guid
isNullable	true
sourceName	msemr_activitylocation

Traits

List of traits for the activityLocationId 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 Activity Location	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 Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/Location.cdm.json/Location locationId	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	"msemr_activitylocation"	string

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

activityProductCodeableConceptId

Identifies the food, drug or other product to be consumed or supplied in the activity.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Product Codeable Concept
description	Identifies the food, drug or other product to be consumed or supplied in the activity.
dataFormat	guid
isNullable	true
sourceName	msemr_activityproductcodeableconcept

Traits

List of traits for the activityProductCodeableConceptId 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 Product Codeable Concept	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 Identifies the food, drug or other product to be consumed or supplied in the activity.	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/CodeableConcept.cdm.json/CodeableConcept codeableConceptId	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	"msemr_activityproductcodeableconcept"	string

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

activityProductReferenceType

Type of the medication or substance to be consumed or supplied in the activity
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Product Reference Type
description	Type of the medication or substance to be consumed or supplied in the activity
dataFormat	int32
isNullable	true
sourceName	msemr_activityproductreferencetype
valueConstrainedToList	true
defaultValue	languageTag displayText attributeValue en Medication 935000000 en Substance 935000001

Traits

List of traits for the activityProductReferenceType 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 Medication 935000000 en Substance 935000001	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_activityproductreferencetype"	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 Product Reference 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 Type of the medication or substance to be consumed or supplied in the activity	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

activityProductReferenceType_display

First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the activityProductReferenceType_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	"activityProductReferenceType"	attributeName	output parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

activityProductReferenceTypeSubstanceId

Identifies the food, drug or other product to be consumed or supplied in the activity.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Product Reference Substance
description	Identifies the food, drug or other product to be consumed or supplied in the activity.
dataFormat	guid
isNullable	true
sourceName	msemr_activityproductreferencetypesubstance

Traits

List of traits for the activityProductReferenceTypeSubstanceId 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 Product Reference Substance	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 Identifies the food, drug or other product to be consumed or supplied in the activity.	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/Substance.cdm.json/Substance substanceId	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	"msemr_activityproductreferencetypesubstance"	string

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

activityProductType

Type of the food, drug or other product to be consumed or supplied in the activity.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity Product Type
description	Type of the food, drug or other product to be consumed or supplied in the activity.
dataFormat	int32
isNullable	true
sourceName	msemr_activityproducttype
valueConstrainedToList	true
defaultValue	languageTag displayText attributeValue en Codeable Concept 935000000 en Reference 935000001

Traits

List of traits for the activityProductType 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 Codeable Concept 935000000 en Reference 935000001	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_activityproducttype"	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 Activity Product 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 Type of the food, drug or other product to be consumed or supplied in the activity.	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

activityProductType_display

First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the activityProductType_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	"activityProductType"	attributeName	output parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

activityProhibited

If true, indicates that the described activity is one that must NOT be engaged in when following the plan.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity Prohibited
description	If true, indicates that the described activity is one that must NOT be engaged in when following the plan.
dataFormat	boolean
isNullable	true
sourceName	msemr_activityprohibited

Traits

List of traits for the activityProhibited 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_activityprohibited"	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 Activity Prohibited	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 If true, indicates that the described activity is one that must NOT be engaged in when following the plan.	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

activityQuantity

Identifies the quantity expected to be supplied, administered or consumed by the subject.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity Quantity
description	Identifies the quantity expected to be supplied, administered or consumed by the subject.
dataFormat	double
maximumValue	1000000000
minimumValue	0
isNullable	true
sourceName	msemr_activityquantity

Traits

List of traits for the activityQuantity attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_activityquantity"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
minimumValue	"0"	decimal
maximumValue	"1000000000"	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 Activity Quantity	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 Identifies the quantity expected to be supplied, administered or consumed by the subject.	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.floatingPoint
is.dataFormat.big

activityReferenceType

This refers to an appointment, communication request, device request, medication request, nutrition order, a task, procedure request, referral request, vision prescription.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity Reference Type
description	This refers to an appointment, communication request, device request, medication request, nutrition order, a task, procedure request, referral request, vision prescription.
dataFormat	int32
isNullable	true
sourceName	msemr_activityreferencetype
valueConstrainedToList	true
defaultValue	languageTag displayText attributeValue en Appointment 935000000 en Communication Request 935000001 en Device Request 935000002 en Medication Request 935000003 en Nutrition Order 935000004 en Task 935000005 en Procedure Request 935000006 en Referral Request 935000007 en Vision Prescription 935000008 en Request Group 935000009

Traits

List of traits for the activityReferenceType 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 Appointment 935000000 en Communication Request 935000001 en Device Request 935000002 en Medication Request 935000003 en Nutrition Order 935000004 en Task 935000005 en Procedure Request 935000006 en Referral Request 935000007 en Vision Prescription 935000008 en Request Group 935000009	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_activityreferencetype"	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 Activity Reference 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 This refers to an appointment, communication request, device request, medication request, nutrition order, a task, procedure request, referral request, vision prescription.	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

activityReferenceType_display

First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the activityReferenceType_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	"activityReferenceType"	attributeName	output parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

activityScheduledType

Type of the period, timing or frequency upon which the described activity is to occur.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity Scheduled Type
description	Type of the period, timing or frequency upon which the described activity is to occur.
dataFormat	int32
isNullable	true
sourceName	msemr_activityscheduledtype
valueConstrainedToList	true
defaultValue	languageTag displayText attributeValue en Timing 935000000 en Period 935000001 en String 935000002

Traits

List of traits for the activityScheduledType 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 Timing 935000000 en Period 935000001 en String 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_activityscheduledtype"	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 Activity Scheduled 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 Type of the period, timing or frequency upon which the described activity is to occur.	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

activityScheduledType_display

First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the activityScheduledType_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	"activityScheduledType"	attributeName	output parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

activityStartDate

The period, timing or frequency upon which the described activity is to occur.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity Start Date
description	The period, timing or frequency upon which the described activity is to occur.
dataFormat	dateTime
isNullable	true
sourceName	msemr_activitystartdate

Traits

List of traits for the activityStartDate 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_activitystartdate"	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 Activity 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, timing or frequency upon which the described activity is to occur.	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

activityStatus

Identifies what progress is being made for the specific activity.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity Status
description	Identifies what progress is being made for the specific activity.
dataFormat	int32
isNullable	true
sourceName	msemr_activitystatus
valueConstrainedToList	true
defaultValue

Traits

List of traits for the activityStatus 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 Not Started 935000000 en Scheduled 935000001 en In Progress 935000002 en On Hold 935000003 en Completed 935000004 en Cancelled 935000005 en Unknown 935000006	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_activitystatus"	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 Activity 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 Identifies what progress is being made for the specific activity.	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

activityStatus_display

First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the activityStatus_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	"activityStatus"	attributeName	output parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

activityStatusReason

Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Reason Code
description	Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_activitystatusreason

Traits

List of traits for the activityStatusReason 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_activitystatusreason"	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 Reason 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 Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.	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

activityString

The period, timing or frequency upon which the described activity is to occur.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity String
description	The period, timing or frequency upon which the described activity is to occur.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_activitystring

Traits

List of traits for the activityString 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_activitystring"	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 Activity String	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, timing or frequency upon which the described activity is to occur.	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

activityTimingId

The period, timing or frequency upon which the described activity is to occur.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Activity Timing
description	The period, timing or frequency upon which the described activity is to occur.
dataFormat	guid
isNullable	true
sourceName	msemr_activitytiming

Traits

List of traits for the activityTimingId 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 Activity Timing	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, timing or frequency upon which the described activity is to occur.	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/CarePlanActivity.cdm.json/CarePlanActivity carePlanActivityId	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	"msemr_activitytiming"	string

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

carePlanId

Healthcare plan for patient or group
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Care Plan
description	Healthcare plan for patient or group
dataFormat	guid
isNullable	true
sourceName	msemr_careplan

Traits

List of traits for the carePlanId 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 Care Plan	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 Healthcare plan for patient or group	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/CarePlan.cdm.json/CarePlan carePlanId	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	"msemr_careplan"	string

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

carePlanActivityId

Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Care Plan Activity
description	Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
isPrimaryKey	true
dataFormat	guid
sourceName	msemr_careplanactivityid

Traits

List of traits for the carePlanActivityId 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	CarePlanActivity/(resolvedAttributes)/carePlanActivityId	attribute

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

Parameter	Value	Data type	Explanation
name	"msemr_careplanactivityid"	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 Care Plan Activity	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 Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.	entity	a reference to the constant entity holding the list of localized text

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

description

A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Description
description	A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.
dataFormat	string
maximumLength	256
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	"256"	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 simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.	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

productReferenceMedicationNewId

First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Product Reference Medication
dataFormat	guid
isNullable	true
sourceName	msemr_productreferencemedicationnew

Traits

List of traits for the productReferenceMedicationNewId 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 Product Reference Medication	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	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/Medication.cdm.json/Medication medicationId	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	"msemr_productreferencemedicationnew"	string

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

referenceAppointmentIdentifierId

The details of the proposed activity represented in a specific resource.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Appointment
description	The details of the proposed activity represented in a specific resource.
dataFormat	guid
isNullable	true
sourceName	msemr_referenceappointmentidentifier

Traits

List of traits for the referenceAppointmentIdentifierId 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 Appointment	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 details of the proposed activity represented in a specific resource.	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/AppointmentEMR.cdm.json/AppointmentEMR activityId	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	"msemr_referenceappointmentidentifier"	string

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

referenceCommunicationRequestIdentifierId

The details of the proposed activity represented in a specific resource
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Communication Request
description	The details of the proposed activity represented in a specific resource
dataFormat	guid
isNullable	true
sourceName	msemr_referencecommunicationrequestidentifier

Traits

List of traits for the referenceCommunicationRequestIdentifierId 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 Communication Request	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 details of the proposed activity represented in a specific resource	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/CommunicationRequest.cdm.json/CommunicationRequest communicationRequestId	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	"msemr_referencecommunicationrequestidentifier"	string

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

referenceDeviceRequestIdentifierId

The details of the proposed activity represented in a specific resource
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Device Request
description	The details of the proposed activity represented in a specific resource
dataFormat	guid
isNullable	true
sourceName	msemr_referencedevicerequestidentifier

Traits

List of traits for the referenceDeviceRequestIdentifierId 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 Device Request	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 details of the proposed activity represented in a specific resource	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/DeviceRequest.cdm.json/DeviceRequest deviceRequestId	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	"msemr_referencedevicerequestidentifier"	string

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

referenceMedicationRequestIdentifierId

The details of the proposed activity represented in a specific resource
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Medication Request
description	The details of the proposed activity represented in a specific resource
dataFormat	guid
isNullable	true
sourceName	msemr_referencemedicationrequestidentifier

Traits

List of traits for the referenceMedicationRequestIdentifierId 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 Medication Request	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 details of the proposed activity represented in a specific resource	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/MedicationRequest.cdm.json/MedicationRequest medicationRequestId	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	"msemr_referencemedicationrequestidentifier"	string

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

referenceNutritionOrderIdentifierId

The details of the proposed activity represented in a specific resource
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Nutrition Order
description	The details of the proposed activity represented in a specific resource
dataFormat	guid
isNullable	true
sourceName	msemr_referencenutritionorderidentifier

Traits

List of traits for the referenceNutritionOrderIdentifierId 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 Nutrition Order	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 details of the proposed activity represented in a specific resource	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/NutritionOrder.cdm.json/NutritionOrder nutritionOrderId	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	"msemr_referencenutritionorderidentifier"	string

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

referenceProcedureRequestIdentifierId

The details of the proposed activity represented in a specific resource
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Procedure Request
description	The details of the proposed activity represented in a specific resource
dataFormat	guid
isNullable	true
sourceName	msemr_referenceprocedurerequestidentifier

Traits

List of traits for the referenceProcedureRequestIdentifierId 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 Procedure Request	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 details of the proposed activity represented in a specific resource	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/ProcedureRequest.cdm.json/ProcedureRequest procedureRequestId	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	"msemr_referenceprocedurerequestidentifier"	string

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

referenceReferralRequestIdentifierId

The details of the proposed activity represented in a specific resource
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Referral Request
description	The details of the proposed activity represented in a specific resource
dataFormat	guid
isNullable	true
sourceName	msemr_referencereferralrequestidentifier

Traits

List of traits for the referenceReferralRequestIdentifierId 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 Referral Request	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 details of the proposed activity represented in a specific resource	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/ReferralRequest.cdm.json/ReferralRequest referralRequestId	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	"msemr_referencereferralrequestidentifier"	string

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

referenceRequestGroupIdentifierId

The details of the proposed activity represented in a specific resource
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Request Group
description	The details of the proposed activity represented in a specific resource
dataFormat	guid
isNullable	true
sourceName	msemr_referencerequestgroupidentifier

Traits

List of traits for the referenceRequestGroupIdentifierId 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 Request Group	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 details of the proposed activity represented in a specific resource	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/RequestGroup.cdm.json/RequestGroup requestGroupId	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	"msemr_referencerequestgroupidentifier"	string

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

referenceTaskIdentifierId

The details of the proposed activity represented in a specific resource
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Task
description	The details of the proposed activity represented in a specific resource
dataFormat	guid
isNullable	true
sourceName	msemr_referencetaskidentifier

Traits

List of traits for the referenceTaskIdentifierId 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 Task	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 details of the proposed activity represented in a specific resource	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/Task.cdm.json/Task activityId	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	"msemr_referencetaskidentifier"	string

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

referenceVisionPrescriptionIdentifierId

The details of the proposed activity represented in a specific resource
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Vision Prescription
description	The details of the proposed activity represented in a specific resource
dataFormat	guid
isNullable	true
sourceName	msemr_referencevisionprescriptionidentifier

Traits

List of traits for the referenceVisionPrescriptionIdentifierId 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 Vision Prescription	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 details of the proposed activity represented in a specific resource	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/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/VisionPrescription.cdm.json/VisionPrescription visionPrescriptionId	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	"msemr_referencevisionprescriptionidentifier"	string

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

emrstatusCode

Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Status Reason
description	Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_statusreason

Traits

List of traits for the emrstatusCode 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_statusreason"	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 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 Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.	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

stateCode

Status of the Care Plan Activity
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Status
description	Status of the Care Plan Activity
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	CarePlanActivity/(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 Care Plan Activity	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

stateCode_display

First included in: electronicMedicalRecords/CarePlanActivity (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 Care Plan Activity
First included in: electronicMedicalRecords/CarePlanActivity (this entity)

Properties

Name	Value
displayName	Status Reason
description	Reason for the status of the Care Plan Activity
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 Care Plan Activity	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/CarePlanActivity (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