Activity Definition in electronicMedicalRecords

Article
02/22/2022

This entity allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

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

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

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

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

Parameter	Value	Data type	Explanation
attribute	ActivityDefinition/(resolvedAttributes)/identifiesspecifictimeswhentheeventoccuId	attribute

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

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

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

Parameter

Value

Data type

Explanation

groupList

attributeGroupReference
/core/applicationCommon/foundationCommon /crmCommon/accelerators/healthCare /electronicMedicalRecords /ActivityDefinition.cdm.json/ActivityDefinition /hasAttributes/attributesAddedAtThisScope

entity

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	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	This entity allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

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

Attributes

Name	Description	First Included in Instance
createdBy	Unique identifier of the user who created the record.	electronicMedicalRecords/ActivityDefinition
createdOn	Date and time when the record was created.	electronicMedicalRecords/ActivityDefinition
createdOnBehalfBy	Unique identifier of the delegate user who created the record.	electronicMedicalRecords/ActivityDefinition
importSequenceNumber	Sequence number of the import that created this record.	electronicMedicalRecords/ActivityDefinition
modifiedBy	Unique identifier of the user who modified the record.	electronicMedicalRecords/ActivityDefinition
modifiedOn	Date and time when the record was modified.	electronicMedicalRecords/ActivityDefinition
modifiedOnBehalfBy	Unique identifier of the delegate user who modified the record.	electronicMedicalRecords/ActivityDefinition
activityDefinitionNumber	A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.	electronicMedicalRecords/ActivityDefinition
activityTimingId	Activity timing lookup to select a value.	electronicMedicalRecords/ActivityDefinition
approvalDate	The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.	electronicMedicalRecords/ActivityDefinition
codeNewId		electronicMedicalRecords/ActivityDefinition
copyright	A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.	electronicMedicalRecords/ActivityDefinition
datetime	Date this was last changed	electronicMedicalRecords/ActivityDefinition
description	A free text natural language description of the activity definition from a consumer's perspective.	electronicMedicalRecords/ActivityDefinition
effectivePeriodEndDate	Effective Period End time with inclusive boundary, if not ongoing.	electronicMedicalRecords/ActivityDefinition
effectivePeriodStartDate	The period during which the activity definition content was or is planned to be in active use.	electronicMedicalRecords/ActivityDefinition
enddatetime	The period, timing or frequency upon which the described activity is to occur.	electronicMedicalRecords/ActivityDefinition
experimental	A boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.	electronicMedicalRecords/ActivityDefinition
identifiesspecifictimeswhentheeventoccuId	Unique identifier for entity instances	electronicMedicalRecords/ActivityDefinition
kindId	A description of the kind of resource the activity definition is representing. For example, a Medication Request, a Procedure Request, or a Communication Request.	electronicMedicalRecords/ActivityDefinition
lastReviewDate	The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.	electronicMedicalRecords/ActivityDefinition
locationId	Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.	electronicMedicalRecords/ActivityDefinition
lowerlimit	Activity low limit	electronicMedicalRecords/ActivityDefinition
medicationId	Identifies the food, drug or other product being consumed or supplied in the activity.	electronicMedicalRecords/ActivityDefinition
name	The name of the custom entity.	electronicMedicalRecords/ActivityDefinition
productconceptId	A Code-able Concept look which represents a value that is usually supplied by providing a reference to one or more terminologies, but may also be defined by the provision of text.	electronicMedicalRecords/ActivityDefinition
productsubstanceId	Identifies the food, drug or other product being consumed or supplied in the activity.	electronicMedicalRecords/ActivityDefinition
productType	Type of: the food, drug or other product being consumed or supplied in the activity.	electronicMedicalRecords/ActivityDefinition
productType_display		electronicMedicalRecords/ActivityDefinition
publishdate	The date (and optionally time) when the activity definition was published. The date must change if and when the business version changes and it must change if the status code changes.	electronicMedicalRecords/ActivityDefinition
publisher	The name of the individual or organization that published the activity definition.	electronicMedicalRecords/ActivityDefinition
purpose	Explanation of why this activity definition is needed and why it has been designed as it has.	electronicMedicalRecords/ActivityDefinition
quantity	Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).	electronicMedicalRecords/ActivityDefinition
startdatetime	The period, timing or frequency upon which the described activity is to occur.	electronicMedicalRecords/ActivityDefinition
status	The status of this activity definition. Enables tracking the life-cycle of the content.	electronicMedicalRecords/ActivityDefinition
status_display		electronicMedicalRecords/ActivityDefinition
timingType	The period, timing or frequency upon which the described activity is to occur.	electronicMedicalRecords/ActivityDefinition
timingType_display		electronicMedicalRecords/ActivityDefinition
title	A short, descriptive, user-friendly title for the activity definition.	electronicMedicalRecords/ActivityDefinition
transformId	A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.	electronicMedicalRecords/ActivityDefinition
upperlimit	The period, timing or frequency upon which the described activity is to occur.	electronicMedicalRecords/ActivityDefinition
uri	An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance.	electronicMedicalRecords/ActivityDefinition
usage	A detailed description of how the asset is used from a clinical perspective.	electronicMedicalRecords/ActivityDefinition
version	The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance.	electronicMedicalRecords/ActivityDefinition
organizationId	Unique identifier for the organization	electronicMedicalRecords/ActivityDefinition
overriddenCreatedOn	Date and time that the record was migrated.	electronicMedicalRecords/ActivityDefinition
stateCode	Status of the Activity Definition	electronicMedicalRecords/ActivityDefinition
stateCode_display		electronicMedicalRecords/ActivityDefinition
statusCode	Reason for the status of the Activity Definition	electronicMedicalRecords/ActivityDefinition
statusCode_display		electronicMedicalRecords/ActivityDefinition
timeZoneRuleVersionNumber	For internal use only.	electronicMedicalRecords/ActivityDefinition
UTCConversionTimeZoneCode	Time zone code that was in use when the record was created.	electronicMedicalRecords/ActivityDefinition

createdBy

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

Properties

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

Traits

List of traits for the createdBy attribute are listed below.

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Created By

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Unique identifier of the user who created the record.

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/User.cdm.json/User	systemUserId

entity

a reference to the constant entity holding the list of entity references

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

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

Parameter	Value	Data type	Explanation
name	"createdby"	string

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

createdOn

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

Properties

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

Traits

List of traits for the createdOn attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"createdon"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Created On

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Date and time when the record was created.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.time
is.dataFormat.date

createdOnBehalfBy

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

Properties

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

Traits

List of traits for the createdOnBehalfBy attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"createdonbehalfby"	string

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Created By (Delegate)

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Unique identifier of the delegate user who created the record.

entity

a reference to the constant entity holding the list of localized text

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

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

importSequenceNumber

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

Properties

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

Traits

List of traits for the importSequenceNumber attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"importsequencenumber"	string

is.constrained
maximum length or value constraints

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

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Import Sequence Number

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Sequence number of the import that created this record.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.integer

modifiedBy

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Modified By

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Unique identifier of the user who modified the record.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/User.cdm.json/User	systemUserId

entity

a reference to the constant entity holding the list of entity references

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

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

Parameter	Value	Data type	Explanation
name	"modifiedby"	string

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

modifiedOn

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

Properties

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

Traits

List of traits for the modifiedOn attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"modifiedon"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Modified On

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Date and time when the record was modified.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.time
is.dataFormat.date

modifiedOnBehalfBy

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

Parameter	Value	Data type	Explanation
name	"modifiedonbehalfby"	string

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Modified By (Delegate)

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Unique identifier of the delegate user who modified the record.

entity

a reference to the constant entity holding the list of localized text

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

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

activityDefinitionNumber

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

Properties

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

Traits

List of traits for the activityDefinitionNumber 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_activitydefinitionnumber"	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 Definition Number

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.character
is.dataFormat.array

activityTimingId

Activity timing lookup to select a value.
First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name	Value
displayName	Activity Timing
description	Activity timing lookup to select a value.
dataFormat	guid
isNullable	true
sourceName	msemr_activitytiming

Traits

List of traits for the activityTimingId attribute are listed below.

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	Activity timing lookup to select a value.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/foundationCommon/crmCommon/accelerators/healthCare/electronicMedicalRecords/Timing.cdm.json/Timing	timingId

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

approvalDate

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

Properties

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

Traits

List of traits for the approvalDate attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_approvaldate"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Approval Date

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.time
is.dataFormat.date

codeNewId

First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name	Value
displayName	Procedure Code
dataFormat	guid
isNullable	true
sourceName	msemr_codenew

Traits

List of traits for the codeNewId attribute are listed below.

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 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

entity

a reference to the constant entity holding the list of localized text

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

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

copyright

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

Properties

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

Traits

List of traits for the copyright attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_copyright"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"100"	integer

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Copyright

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the 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.character
is.dataFormat.array

datetime

Date this was last changed
First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name	Value
displayName	Activity Date/Time
description	Date this was last changed
dataFormat	dateTime
isNullable	true
sourceName	msemr_datetime

Traits

List of traits for the datetime 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_datetime"	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 Date/Time

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 this was last changed

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

description

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

Properties

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

Traits

List of traits for the description attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_description"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"100"	integer

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Description

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	A free text natural language description of the activity definition from a consumer's perspective.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.character
is.dataFormat.array

effectivePeriodEndDate

Effective Period End time with inclusive boundary, if not ongoing.
First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name	Value
displayName	Effective Period End Date
description	Effective Period End time with inclusive boundary, if not ongoing.
dataFormat	dateTime
isNullable	true
sourceName	msemr_effectiveperiodenddate

Traits

List of traits for the effectivePeriodEndDate 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_effectiveperiodenddate"	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	Effective Period 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	Effective Period End time with inclusive boundary, if not ongoing.

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

effectivePeriodStartDate

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

Properties

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

Traits

List of traits for the effectivePeriodStartDate 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_effectiveperiodstartdate"	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	Effective Period Start Date

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The period during which the activity definition content was or is planned to be in active use.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.time
is.dataFormat.date

enddatetime

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

Properties

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

Traits

List of traits for the enddatetime 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_enddatetime"	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/Time

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

experimental

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

Properties

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

Traits

List of traits for the experimental attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_experimental"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Experimental

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	A boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.boolean

identifiesspecifictimeswhentheeventoccuId

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

Properties

Name	Value
displayName	Activity Definition
description	Unique identifier for entity instances
isPrimaryKey	true
dataFormat	guid
sourceName	msemr_identifiesspecifictimeswhentheeventoccuid

Traits

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

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

Parameter	Value	Data type	Explanation
name	"msemr_identifiesspecifictimeswhentheeventoccuid"	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	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	Unique identifier for entity instances

entity

a reference to the constant entity holding the list of localized text

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

kindId

A description of the kind of resource the activity definition is representing. For example, a Medication Request, a Procedure Request, or a Communication Request.
First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name	Value
displayName	Kind
description	A description of the kind of resource the activity definition is representing. For example, a Medication Request, a Procedure Request, or a Communication Request.
dataFormat	guid
isNullable	true
sourceName	msemr_kind

Traits

List of traits for the kindId attribute are listed below.

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	Kind

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 description of the kind of resource the activity definition is representing. For example, a Medication Request, a Procedure Request, or a Communication Request.

entity

a reference to the constant entity holding the list of localized text

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

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

lastReviewDate

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

Properties

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

Traits

List of traits for the lastReviewDate attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_lastreviewdate"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Last Review Date

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.time
is.dataFormat.date

locationId

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

Properties

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

Traits

List of traits for the locationId attribute are listed below.

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	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

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

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

lowerlimit

Activity low limit
First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name	Value
displayName	Activity Lower Limit
description	Activity low limit
dataFormat	decimal
maximumValue	100000000000
minimumValue	-100000000000
isNullable	true
sourceName	msemr_lowerlimit

Traits

List of traits for the lowerlimit 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_lowerlimit"	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	Activity Lower Limit

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	Activity low limit

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

medicationId

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

Properties

Name	Value
displayName	Medication
description	Identifies the food, drug or other product being consumed or supplied in the activity.
dataFormat	guid
isNullable	true
sourceName	msemr_medication

Traits

List of traits for the medicationId attribute are listed below.

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

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 being consumed or supplied in the activity.

entity

a reference to the constant entity holding the list of localized text

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

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

name

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

Properties

Name	Value
displayName	Name
description	The name of the custom entity.
dataFormat	string
maximumLength	100
sourceName	msemr_name

Traits

List of traits for the name attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_name"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"100"	integer

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Name

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The name of the custom entity.

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

productconceptId

A Code-able Concept look which represents a value that is usually supplied by providing a reference to one or more terminologies, but may also be defined by the provision of text.
First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name	Value
displayName	Concept
description	A Code-able Concept look which represents a value that is usually supplied by providing a reference to one or more terminologies, but may also be defined by the provision of text.
dataFormat	guid
isNullable	true
sourceName	msemr_productconcept

Traits

List of traits for the productconceptId attribute are listed below.

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	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	A Code-able Concept look which represents a value that is usually supplied by providing a reference to one or more terminologies, but may also be defined by the provision of text.

entity

a reference to the constant entity holding the list of localized text

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

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

productsubstanceId

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

Properties

Name	Value
displayName	Substance
description	Identifies the food, drug or other product being consumed or supplied in the activity.
dataFormat	guid
isNullable	true
sourceName	msemr_productsubstance

Traits

List of traits for the productsubstanceId attribute are listed below.

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	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 being consumed or supplied in the activity.

entity

a reference to the constant entity holding the list of localized text

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

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

productType

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

Properties

Name

Value

displayName

Product Type

description

Type of: the food, drug or other product being consumed or supplied in the activity.

dataFormat

int32

isNullable

true

sourceName

msemr_producttype

valueConstrainedToList

true

defaultValue

languageTag	displayText	attributeValue
en	Medication	935000000
en	Substance	935000001
en	Codeable Concept	935000002

Traits

List of traits for the productType 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
en	Codeable Concept	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_producttype"	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 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 being 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

productType_display

First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

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

is.dataFormat.character
is.dataFormat.array

publishdate

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

Properties

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

Traits

List of traits for the publishdate 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_publishdate"	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	Published Date

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The date (and optionally time) when the activity definition was published. The date must change if and when the business version changes and it must change if the status code changes.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.time
is.dataFormat.date

publisher

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

Properties

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

Traits

List of traits for the publisher attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_publisher"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"100"	integer

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Publisher

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The name of the individual or organization that published the 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.character
is.dataFormat.array

purpose

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

Properties

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

Traits

List of traits for the purpose attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_purpose"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"100"	integer

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Purpose

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Explanation of why this activity definition is needed and why it has been designed as it has.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.character
is.dataFormat.array

quantity

Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name	Value
displayName	Quantity
description	Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
dataFormat	decimal
maximumValue	100000000000
minimumValue	-100000000000
isNullable	true
sourceName	msemr_quantity

Traits

List of traits for the quantity 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_quantity"	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	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 consumed at once (per dose, per meal, 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.numeric.shaped
for setting the exact precision and scale of numeric values

startdatetime

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

Properties

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

Traits

List of traits for the startdatetime 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_startdatetime"	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/Time

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

status

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

Properties

Name

Value

displayName

Status

description

The status of this activity definition. Enables tracking the life-cycle of the content.

dataFormat

int32

isNullable

true

sourceName

msemr_status

valueConstrainedToList

true

defaultValue

Traits

List of traits for the status attribute are listed below.

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

Parameter

Value

Data type

Explanation

default

languageTag	displayText	attributeValue
en	Draft	935000000
en	Active	935000001
en	Retired	935000002
en	Unknown	935000003

any

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

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

Parameter	Value	Data type	Explanation
name	"msemr_status"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Status

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The status of this activity definition. Enables tracking the life-cycle of the content.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.integer

status_display

First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the status_display attribute are listed below.

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

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

is.dataFormat.character
is.dataFormat.array

timingType

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

Properties

Name

Value

displayName

Timing Type

description

The period, timing or frequency upon which the described activity is to occur.

dataFormat

int32

isNullable

true

sourceName

msemr_timingtype

valueConstrainedToList

true

defaultValue

Traits

List of traits for the timingType 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	Date Time	935000001
en	Period	935000002
en	Range	935000003

any

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

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

Parameter	Value	Data type	Explanation
name	"msemr_timingtype"	string

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

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	Timing 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 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

timingType_display

First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the timingType_display attribute are listed below.

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

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

is.dataFormat.character
is.dataFormat.array

title

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

Properties

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

Traits

List of traits for the title attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_title"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"100"	integer

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Title

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	A short, descriptive, user-friendly title for the 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.character
is.dataFormat.array

transformId

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

Properties

Name	Value
displayName	Transform
description	A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
dataFormat	guid
isNullable	true
sourceName	msemr_transform

Traits

List of traits for the transformId attribute are listed below.

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	Transform

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 reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

entity

a reference to the constant entity holding the list of localized text

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

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

upperlimit

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

Properties

Name	Value
displayName	Activity Upper Limit
description	The period, timing or frequency upon which the described activity is to occur.
dataFormat	decimal
maximumValue	100000000000
minimumValue	-100000000000
isNullable	true
sourceName	msemr_upperlimit

Traits

List of traits for the upperlimit 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_upperlimit"	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	Activity Upper Limit

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.numeric.shaped
for setting the exact precision and scale of numeric values

uri

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

Properties

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

Traits

List of traits for the uri 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_uri"	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 URL

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.character
is.dataFormat.array

usage

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

Properties

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

Traits

List of traits for the usage attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_usage"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"100"	integer

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Usage

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	A detailed description of how the asset is used from a clinical perspective.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.character
is.dataFormat.array

version

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

Properties

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

Traits

List of traits for the version attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"msemr_version"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"100"	integer

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Version

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.character
is.dataFormat.array

organizationId

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

Properties

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

Traits

List of traits for the organizationId attribute are listed below.

Parameter	Value	Data type	Explanation
style	"single"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Organization Id

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Unique identifier for the organization

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/Organization.cdm.json/Organization	organizationId

entity

a reference to the constant entity holding the list of entity references

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

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

Parameter	Value	Data type	Explanation
name	"organizationid"	string

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

overriddenCreatedOn

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

Parameter	Value	Data type	Explanation
name	"overriddencreatedon"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Record Created On

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Date and time that the record was migrated.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.time
is.dataFormat.date

stateCode

Status of the Activity Definition
First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name

Value

displayName

Status

description

Status of the Activity Definition

dataFormat

int32

sourceName

statecode

valueConstrainedToList

true

defaultValue

languageTag	displayText	attributeValue
en	Active	0
en	Inactive	1

Traits

List of traits for the stateCode attribute are listed below.

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

Parameter

Value

Data type

Explanation

default

languageTag	displayText	attributeValue
en	Active	0
en	Inactive	1

any

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

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

Parameter	Value	Data type	Explanation
attribute	ActivityDefinition/(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 Activity Definition

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

stateCode_display

First included in: electronicMedicalRecords/ActivityDefinition (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 Activity Definition
First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name

Value

displayName

Status Reason

description

Reason for the status of the Activity Definition

dataFormat

int32

isNullable

true

sourceName

statuscode

defaultValue

languageTag	displayText	attributeValue	correlatedValue
en	Active	1	0
en	Inactive	2	1

Traits

List of traits for the statusCode attribute are listed below.

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

does.haveDefault
An attribute has a default value

Parameter

Value

Data type

Explanation

default

languageTag	displayText	attributeValue	correlatedValue
en	Active	1	0
en	Inactive	2	1

any

is.correlatedWith
the attribute value is correlated with the sourceAttribute

Parameter	Value	Data type	Explanation
sourceAttribute	"stateCode"	attributeName

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

Parameter	Value	Data type	Explanation
name	"statuscode"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Status Reason

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Reason for the status of the 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

statusCode_display

First included in: electronicMedicalRecords/ActivityDefinition (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the statusCode_display attribute are listed below.

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

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

is.dataFormat.character
is.dataFormat.array

timeZoneRuleVersionNumber

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

Properties

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

Traits

List of traits for the timeZoneRuleVersionNumber attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"timezoneruleversionnumber"	string

is.constrained
maximum length or value constraints

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

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Time Zone Rule Version Number

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	For internal use only.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.integer

UTCConversionTimeZoneCode

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

Properties

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

Traits

List of traits for the UTCConversionTimeZoneCode attribute are listed below.

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

Parameter	Value	Data type	Explanation
name	"utcconversiontimezonecode"	string

is.constrained
maximum length or value constraints

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

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	UTC Conversion Time Zone Code

entity

a reference to the constant entity holding the list of localized text

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Time zone code that was in use when the record was created.

entity

a reference to the constant entity holding the list of localized text

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

is.dataFormat.integer

Share via

Activity Definition in electronicMedicalRecords

Traits

Attributes

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits