Care Plan in electronicMedicalRecords
Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition
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 | "2.1" | string | semantic version number of the entity |
is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.
| Parameter | Value | Data type | Explanation | ||||||
|---|---|---|---|---|---|---|---|---|---|
| groupList |
| entity |
is.identifiedBy
names a specifc identity attribute to use with an entity
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | CarePlan/(resolvedAttributes)/carePlanId | attribute |
means.entityState
the attribute represents the current state of the entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | CarePlan/(resolvedAttributes)/stateCode | attribute |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| 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_careplan" | string |
Attributes
| Name | Description | First Included in Instance |
|---|---|---|
| createdOn | Date and time when the record was created. | electronicMedicalRecords/CarePlan |
| createdBy | Unique identifier of the user who created the record. | electronicMedicalRecords/CarePlan |
| modifiedOn | Date and time when the record was modified. | electronicMedicalRecords/CarePlan |
| modifiedBy | Unique identifier of the user who modified the record. | electronicMedicalRecords/CarePlan |
| createdOnBehalfBy | Unique identifier of the delegate user who created the record. | electronicMedicalRecords/CarePlan |
| modifiedOnBehalfBy | Unique identifier of the delegate user who modified the record. | electronicMedicalRecords/CarePlan |
| overriddenCreatedOn | Date and time that the record was migrated. | electronicMedicalRecords/CarePlan |
| importSequenceNumber | Sequence number of the import that created this record. | electronicMedicalRecords/CarePlan |
| ownerId | Owner Id | electronicMedicalRecords/CarePlan |
| ownerIdType | The type of owner, either User or Team. | electronicMedicalRecords/CarePlan |
| owningBusinessUnit | Unique identifier for the business unit that owns the record | electronicMedicalRecords/CarePlan |
| owningUser | Unique identifier of the user that owns the activity. | electronicMedicalRecords/CarePlan |
| owningTeam | Unique identifier for the team that owns the record. | electronicMedicalRecords/CarePlan |
| timeZoneRuleVersionNumber | For internal use only. | electronicMedicalRecords/CarePlan |
| UTCConversionTimeZoneCode | Time zone code that was in use when the record was created. | electronicMedicalRecords/CarePlan |
| versionNumber | Version Number | electronicMedicalRecords/CarePlan |
| carePlanId | Unique identifier for entity instances | electronicMedicalRecords/CarePlan |
| carePlanIdentifier | This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. | electronicMedicalRecords/CarePlan |
| contextType | Type of the context care plan is created for | electronicMedicalRecords/CarePlan |
| contextType_display | electronicMedicalRecords/CarePlan | |
| encounterIdentifierId | Identifies the original context in which this particular CarePlan was created. | electronicMedicalRecords/CarePlan |
| episodeOfCareId | Identifies the original context in which this particular CarePlan was created. | electronicMedicalRecords/CarePlan |
| groupIdentifierId | Identifies the patient or group whose intended care is described by the plan. | electronicMedicalRecords/CarePlan |
| patientIdentifierId | Identifies the patient or group whose intended care is described by the plan. | electronicMedicalRecords/CarePlan |
| planDescription | A description of the scope and nature of the plan. | electronicMedicalRecords/CarePlan |
| planEndDate | Indicates when the plan did (or is intended to) come into effect and end. | electronicMedicalRecords/CarePlan |
| planIntent | Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. | electronicMedicalRecords/CarePlan |
| planIntent_display | electronicMedicalRecords/CarePlan | |
| planStartDate | Indicates when the plan did (or is intended to) come into effect and end. | electronicMedicalRecords/CarePlan |
| planStatus | Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | electronicMedicalRecords/CarePlan |
| planStatus_display | electronicMedicalRecords/CarePlan | |
| subjectType | Type of subject of the care plan | electronicMedicalRecords/CarePlan |
| subjectType_display | electronicMedicalRecords/CarePlan | |
| title | The name of the custom entity. | electronicMedicalRecords/CarePlan |
| stateCode | Status of the Care Plan | electronicMedicalRecords/CarePlan |
| stateCode_display | electronicMedicalRecords/CarePlan | |
| statusCode | Reason for the status of the Care Plan | electronicMedicalRecords/CarePlan |
| statusCode_display | electronicMedicalRecords/CarePlan |
createdOn
Date and time when the record was created.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Created On |
| description | Date and time when the record was created. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | createdon |
Traits
List of traits for the createdOn attribute are listed below.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.creation
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "createdon" | string |
is.dataFormat.time
is.dataFormat.date
createdBy
Unique identifier of the user who created the record.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Created By |
| description | Unique identifier of the user who created the record. |
| dataFormat | guid |
| isNullable | true |
| sourceName | createdby |
Traits
List of traits for the createdBy attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| style | "single" | string |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| 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 |
| entity | a reference to the constant entity holding the list of entity references |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "createdby" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
modifiedOn
Date and time when the record was modified.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Modified On |
| description | Date and time when the record was modified. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | modifiedon |
Traits
List of traits for the modifiedOn attribute are listed below.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.modify
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "modifiedon" | string |
is.dataFormat.time
is.dataFormat.date
modifiedBy
Unique identifier of the user who modified the record.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Modified By |
| description | Unique identifier of the user who modified the record. |
| dataFormat | guid |
| isNullable | true |
| sourceName | modifiedby |
Traits
List of traits for the modifiedBy attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| style | "single" | string |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| 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 |
| entity | a reference to the constant entity holding the list of entity references |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "modifiedby" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
createdOnBehalfBy
Unique identifier of the delegate user who created the record.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Created By (Delegate) |
| description | Unique identifier of the delegate user who created the record. |
| dataFormat | guid |
| isNullable | true |
| sourceName | createdonbehalfby |
Traits
List of traits for the createdOnBehalfBy attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| style | "single" | string |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| 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 |
| entity | a reference to the constant entity holding the list of entity references |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "createdonbehalfby" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
modifiedOnBehalfBy
Unique identifier of the delegate user who modified the record.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Modified By (Delegate) |
| description | Unique identifier of the delegate user who modified the record. |
| dataFormat | guid |
| isNullable | true |
| sourceName | modifiedonbehalfby |
Traits
List of traits for the modifiedOnBehalfBy attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| style | "single" | string |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| 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 |
| entity | a reference to the constant entity holding the list of entity references |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "modifiedonbehalfby" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
overriddenCreatedOn
Date and time that the record was migrated.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Record Created On |
| description | Date and time that the record was migrated. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | overriddencreatedon |
Traits
List of traits for the overriddenCreatedOn attribute are listed below.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.creation
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "overriddencreatedon" | string |
is.dataFormat.time
is.dataFormat.date
importSequenceNumber
Sequence number of the import that created this record.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Import Sequence Number |
| description | Sequence number of the import that created this record. |
| dataFormat | int32 |
| maximumValue | 2147483647 |
| minimumValue | -2147483648 |
| isNullable | true |
| sourceName | importsequencenumber |
Traits
List of traits for the importSequenceNumber attribute are listed below.
is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "importsequencenumber" | string |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-2147483648" | decimal | |
| maximumValue | "2147483647" | decimal |
is.dataFormat.integer
ownerId
Owner Id
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Owner |
| description | Owner Id |
| dataFormat | guid |
| sourceName | ownerid |
Traits
List of traits for the ownerId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| style | "single" | string |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| 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 |
| entity | a reference to the constant entity holding the list of entity references |
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "ownerid" | string |
is.CDS.owner
contains a User or Team ID
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
ownerIdType
The type of owner, either User or Team.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Owner Type |
| description | The type of owner, either User or Team. |
| dataFormat | string |
| isReadOnly | true |
| sourceName | owneridtype |
Traits
List of traits for the ownerIdType attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.entityName
[deprecated] use the standalone 'means.entityName' trait instead.
means.entityName
a string value is the name of a CDM entity.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.
is.readOnly
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "owneridtype" | string |
is.CDS.owner
contains a User or Team ID
is.dataFormat.character
is.dataFormat.array
owningBusinessUnit
Unique identifier for the business unit that owns the record
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Owning Business Unit |
| description | Unique identifier for the business unit that owns the record |
| dataFormat | guid |
| isNullable | true |
| sourceName | owningbusinessunit |
Traits
List of traits for the owningBusinessUnit attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| style | "single" | string |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| 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 |
| entity | a reference to the constant entity holding the list of entity references |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "owningbusinessunit" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
owningUser
Unique identifier of the user that owns the activity.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Owning User |
| description | Unique identifier of the user that owns the activity. |
| dataFormat | guid |
| isNullable | true |
| sourceName | owninguser |
Traits
List of traits for the owningUser attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| style | "single" | string |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| 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 |
| entity | a reference to the constant entity holding the list of entity references |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "owninguser" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
owningTeam
Unique identifier for the team that owns the record.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Owning Team |
| description | Unique identifier for the team that owns the record. |
| dataFormat | guid |
| isNullable | true |
| sourceName | owningteam |
Traits
List of traits for the owningTeam attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| style | "single" | string |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| 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 |
| entity | a reference to the constant entity holding the list of entity references |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "owningteam" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
timeZoneRuleVersionNumber
For internal use only.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Time Zone Rule Version Number |
| description | For internal use only. |
| dataFormat | int32 |
| maximumValue | 2147483647 |
| minimumValue | -1 |
| isNullable | true |
| sourceName | timezoneruleversionnumber |
Traits
List of traits for the timeZoneRuleVersionNumber attribute are listed below.
is.dataFormat.integer
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "timezoneruleversionnumber" | string |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-1" | decimal | |
| maximumValue | "2147483647" | decimal |
is.dataFormat.integer
UTCConversionTimeZoneCode
Time zone code that was in use when the record was created.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | UTC Conversion Time Zone Code |
| description | Time zone code that was in use when the record was created. |
| dataFormat | int32 |
| maximumValue | 2147483647 |
| minimumValue | -1 |
| isNullable | true |
| sourceName | utcconversiontimezonecode |
Traits
List of traits for the UTCConversionTimeZoneCode attribute are listed below.
is.dataFormat.integer
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "utcconversiontimezonecode" | string |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-1" | decimal | |
| maximumValue | "2147483647" | decimal |
is.dataFormat.integer
versionNumber
Version Number
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Version Number |
| description | Version Number |
| dataFormat | int64 |
| isNullable | true |
| sourceName | versionnumber |
Traits
List of traits for the versionNumber attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
means.measurement.version
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "versionnumber" | string |
is.dataFormat.integer
is.dataFormat.big
carePlanId
Unique identifier for entity instances
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Care Plan |
| description | Unique identifier for entity instances |
| isPrimaryKey | true |
| dataFormat | guid |
| sourceName | msemr_careplanid |
Traits
List of traits for the carePlanId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.identifiedBy
names a specifc identity attribute to use with an entity
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | CarePlan/(resolvedAttributes)/carePlanId | attribute |
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "msemr_careplanid" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
carePlanIdentifier
This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Identifier |
| description | This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. |
| dataFormat | string |
| maximumLength | 100 |
| isNullable | true |
| sourceName | msemr_careplanidentifier |
Traits
List of traits for the carePlanIdentifier 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_careplanidentifier" | 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 |
| 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 |
| 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
contextType
Type of the context care plan is created for
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Context Type |
| description | Type of the context care plan is created for |
| dataFormat | int32 |
| isNullable | true |
| sourceName | msemr_contexttype |
| valueConstrainedToList | true |
| defaultValue |
Traits
List of traits for the contextType attribute are listed below.
is.dataFormat.integer
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| 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_contexttype" | 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 |
| 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 |
| 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
contextType_display
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the contextType_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 | "contextType" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
encounterIdentifierId
Identifies the original context in which this particular CarePlan was created.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Encounter |
| description | Identifies the original context in which this particular CarePlan was created. |
| dataFormat | guid |
| isNullable | true |
| sourceName | msemr_encounteridentifier |
Traits
List of traits for the encounterIdentifierId 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 |
| 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 |
| 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 |
| 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_encounteridentifier" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
episodeOfCareId
Identifies the original context in which this particular CarePlan was created.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Episode of Care |
| description | Identifies the original context in which this particular CarePlan was created. |
| dataFormat | guid |
| isNullable | true |
| sourceName | msemr_episodeofcare |
Traits
List of traits for the episodeOfCareId 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 |
| 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 |
| 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 |
| 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_episodeofcare" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
groupIdentifierId
Identifies the patient or group whose intended care is described by the plan.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Group |
| description | Identifies the patient or group whose intended care is described by the plan. |
| dataFormat | guid |
| isNullable | true |
| sourceName | msemr_groupidentifier |
Traits
List of traits for the groupIdentifierId 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 |
| 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 |
| 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 |
| 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_groupidentifier" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
patientIdentifierId
Identifies the patient or group whose intended care is described by the plan.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Patient |
| description | Identifies the patient or group whose intended care is described by the plan. |
| dataFormat | guid |
| isNullable | true |
| sourceName | msemr_patientidentifier |
Traits
List of traits for the patientIdentifierId 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 |
| 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 |
| 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 |
| 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_patientidentifier" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
planDescription
A description of the scope and nature of the plan.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Description |
| description | A description of the scope and nature of the plan. |
| dataFormat | string |
| maximumLength | 100 |
| isNullable | true |
| sourceName | msemr_plandescription |
Traits
List of traits for the planDescription 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_plandescription" | 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 |
| 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 |
| 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
planEndDate
Indicates when the plan did (or is intended to) come into effect and end.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | End Date |
| description | Indicates when the plan did (or is intended to) come into effect and end. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | msemr_planenddate |
Traits
List of traits for the planEndDate 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_planenddate" | 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 |
| 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 |
| 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
planIntent
Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Intent | |||||||||||||||
| description | Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. | |||||||||||||||
| dataFormat | int32 | |||||||||||||||
| isNullable | true | |||||||||||||||
| sourceName | msemr_planintent | |||||||||||||||
| valueConstrainedToList | true | |||||||||||||||
| defaultValue |
|
Traits
List of traits for the planIntent attribute are listed below.
is.dataFormat.integer
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| 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_planintent" | 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 |
| 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 |
| 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
planIntent_display
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the planIntent_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 | "planIntent" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
planStartDate
Indicates when the plan did (or is intended to) come into effect and end.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Start Date |
| description | Indicates when the plan did (or is intended to) come into effect and end. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | msemr_planstartdate |
Traits
List of traits for the planStartDate 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_planstartdate" | 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 |
| 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 |
| 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
planStatus
Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Status | ||||||||||||||||||||||||
| description | Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||||||||||||||||||||||
| dataFormat | int32 | ||||||||||||||||||||||||
| isNullable | true | ||||||||||||||||||||||||
| sourceName | msemr_planstatus | ||||||||||||||||||||||||
| valueConstrainedToList | true | ||||||||||||||||||||||||
| defaultValue |
|
Traits
List of traits for the planStatus attribute are listed below.
is.dataFormat.integer
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| 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_planstatus" | 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 |
| 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 |
| 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
planStatus_display
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the planStatus_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 | "planStatus" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
subjectType
Type of subject of the care plan
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Subject Type | |||||||||
| description | Type of subject of the care plan | |||||||||
| dataFormat | int32 | |||||||||
| isNullable | true | |||||||||
| sourceName | msemr_subjecttype | |||||||||
| valueConstrainedToList | true | |||||||||
| defaultValue |
|
Traits
List of traits for the subjectType attribute are listed below.
is.dataFormat.integer
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| 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_subjecttype" | 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 |
| 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 |
| 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
subjectType_display
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the subjectType_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 | "subjectType" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
title
The name of the custom entity.
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Title |
| description | The name of the custom entity. |
| dataFormat | string |
| maximumLength | 100 |
| 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 | "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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
stateCode
Status of the Care Plan
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Status | |||||||||
| description | Status of the Care Plan | |||||||||
| dataFormat | int32 | |||||||||
| sourceName | statecode | |||||||||
| valueConstrainedToList | true | |||||||||
| defaultValue |
|
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 |
| 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 | CarePlan/(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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
stateCode_display
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the stateCode_display attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| inSupportOf | "stateCode" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
statusCode
Reason for the status of the Care Plan
First included in: electronicMedicalRecords/CarePlan (this entity)
Properties
| Name | Value | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Status Reason | ||||||||||||
| description | Reason for the status of the Care Plan | ||||||||||||
| dataFormat | int32 | ||||||||||||
| isNullable | true | ||||||||||||
| sourceName | statuscode | ||||||||||||
| defaultValue |
|
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 |
| 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 |
| 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 |
| 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/CarePlan (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
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for