A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
Date and time when the record was created.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Created On
description
Date and time when the record was created.
dataFormat
dateTime
isNullable
true
sourceName
createdon
Traits
List of traits for the createdOn attribute are listed below.
is.dataFormat.date means.measurement.date is.dataFormat.time means.measurement.time means.measurement.date.creation is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Created On
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Date and time when the record was created.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Unique identifier of the user who created the record.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Created By
description
Unique identifier of the user who created the record.
dataFormat
guid
isNullable
true
sourceName
createdby
Traits
List of traits for the createdBy attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Created By
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Shows who created the record.
en
Unique identifier of the user who created the record.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Date and time when the record was modified.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Modified On
description
Date and time when the record was modified.
dataFormat
dateTime
isNullable
true
sourceName
modifiedon
Traits
List of traits for the modifiedOn attribute are listed below.
is.dataFormat.date means.measurement.date is.dataFormat.time means.measurement.time means.measurement.date.modify is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Modified On
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Date and time when the record was modified.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Unique identifier of the user who modified the record.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Modified By
description
Unique identifier of the user who modified the record.
dataFormat
guid
isNullable
true
sourceName
modifiedby
Traits
List of traits for the modifiedBy attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Modified By
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Shows who last updated the record.
en
Unique identifier of the user who modified the record.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Unique identifier of the delegate user who created the record.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Created By (Delegate)
description
Unique identifier of the delegate user who created the record.
dataFormat
guid
isNullable
true
sourceName
createdonbehalfby
Traits
List of traits for the createdOnBehalfBy attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Created By (Delegate)
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Shows who created the record on behalf of another user.
en
Unique identifier of the delegate user who created the record.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Unique identifier of the delegate user who modified the record.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Modified By (Delegate)
description
Unique identifier of the delegate user who modified the record.
dataFormat
guid
isNullable
true
sourceName
modifiedonbehalfby
Traits
List of traits for the modifiedOnBehalfBy attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Modified By (Delegate)
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Shows who last updated the record on behalf of another user.
en
Unique identifier of the delegate user who modified the record.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Date and time that the record was migrated.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Record Created On
description
Date and time that the record was migrated.
dataFormat
dateTime
isNullable
true
sourceName
overriddencreatedon
Traits
List of traits for the overriddenCreatedOn attribute are listed below.
is.dataFormat.date means.measurement.date is.dataFormat.time means.measurement.time means.measurement.date.creation is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Record Created On
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Date and time that the record was migrated.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Sequence number of the import that created this record.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Import Sequence Number
description
Sequence number of the import that created this record.
dataFormat
int32
maximumValue
2147483647
minimumValue
-2147483648
isNullable
true
sourceName
importsequencenumber
Traits
List of traits for the importSequenceNumber attribute are listed below.
is.dataFormat.integer is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Import Sequence Number
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Unique identifier of the data import or data migration that created this record.
en
Sequence number of the import that created this record.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"importsequencenumber"
string
is.constrained
maximum length or value constraints
Owner Id
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Owner
description
Owner Id
dataFormat
guid
sourceName
ownerid
Traits
List of traits for the ownerId attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"systemrequired"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Owner
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Owner Id
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
The type of owner, either User or Team.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Owner Type
description
The type of owner, either User or Team.
dataFormat
string
isReadOnly
true
sourceName
owneridtype
Traits
List of traits for the ownerIdType attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array means.entityName
[deprecated] use the standalone 'means.entityName' trait instead.
means.entityName
a string value is the name of a CDM entity.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"systemrequired"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Owner Type
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
The type of owner, either User or Team.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.
is.readOnly is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Unique identifier for the business unit that owns the record
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Owning Business Unit
description
Unique identifier for the business unit that owns the record
dataFormat
guid
isNullable
true
sourceName
owningbusinessunit
Traits
List of traits for the owningBusinessUnit attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Owning Business Unit
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Unique identifier for the business unit that owns the record
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Unique identifier of the user that owns the activity.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Owning User
description
Unique identifier of the user that owns the activity.
dataFormat
guid
isNullable
true
sourceName
owninguser
Traits
List of traits for the owningUser attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Owning User
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Unique identifier for the user that owns the record.
en
Unique identifier of the user that owns the activity.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Unique identifier for the team that owns the record.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Owning Team
description
Unique identifier for the team that owns the record.
dataFormat
guid
isNullable
true
sourceName
owningteam
Traits
List of traits for the owningTeam attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Owning Team
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Unique identifier for the team that owns the record.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
For internal use only.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Time Zone Rule Version Number
description
For internal use only.
dataFormat
int32
maximumValue
2147483647
minimumValue
-1
isNullable
true
sourceName
timezoneruleversionnumber
Traits
List of traits for the timeZoneRuleVersionNumber attribute are listed below.
is.dataFormat.integer is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Time Zone Rule Version Number
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
For internal use only.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"timezoneruleversionnumber"
string
is.constrained
maximum length or value constraints
Time zone code that was in use when the record was created.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
UTC Conversion Time Zone Code
description
Time zone code that was in use when the record was created.
dataFormat
int32
maximumValue
2147483647
minimumValue
-1
isNullable
true
sourceName
utcconversiontimezonecode
Traits
List of traits for the UTCConversionTimeZoneCode attribute are listed below.
is.dataFormat.integer is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
UTC Conversion Time Zone Code
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Time zone code that was in use when the record was created.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"utcconversiontimezonecode"
string
is.constrained
maximum length or value constraints
Version Number
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Version Number
description
Version Number
dataFormat
int64
isNullable
true
sourceName
versionnumber
Traits
List of traits for the versionNumber attribute are listed below.
is.dataFormat.integer is.dataFormat.big means.measurement.version is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Version Number
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Version Number
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Authored On
description
For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
dataFormat
dateTime
isNullable
true
sourceName
msemr_authoredon
Traits
List of traits for the authoredOn 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_authoredon"
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
Authored 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
For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
Unique identifier for entity instances
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Communication Request
description
Unique identifier for entity instances
isPrimaryKey
true
dataFormat
guid
sourceName
msemr_communicationrequestid
Traits
List of traits for the communicationRequestId 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
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"msemr_communicationrequestid"
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
Communication Request
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Unique identifier for entity instances
entity
a reference to the constant entity holding the list of localized text
The encounter or episode of care within which the communication request was created.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Context Encounter
description
The encounter or episode of care within which the communication request was created.
dataFormat
guid
isNullable
true
sourceName
msemr_contextencounter
Traits
List of traits for the contextEncounterId 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
Context Encounter
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 encounter or episode of care within which the communication request was created.
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.
The encounter or episode of care within which the communication request was created.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Context Episode Of Care
description
The encounter or episode of care within which the communication request was created.
dataFormat
guid
isNullable
true
sourceName
msemr_contextepisodeofcare
Traits
List of traits for the contextEpisodeOfCareId 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
Context Episode Of Care
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 encounter or episode of care within which the communication request was created.
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.
The encounter or episode of care within which the communication request was created.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Context Type
description
The encounter or episode of care within which the communication request was created.
dataFormat
int32
isNullable
true
sourceName
msemr_contexttype
valueConstrainedToList
true
defaultValue
languageTag
displayText
attributeValue
en
Encounter
935000000
en
Episode Of Care
935000001
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
languageTag
displayText
attributeValue
en
Encounter
935000000
en
Episode Of Care
935000001
any
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"msemr_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
languageTag
displayText
en
Context 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 encounter or episode of care within which the communication request 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.
A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Group Identifier
description
A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
dataFormat
string
maximumLength
100
isNullable
true
sourceName
msemr_groupidentifier
Traits
List of traits for the groupIdentifier 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_groupidentifier"
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
Group Identifier
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 shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
The individual who initiated the request and has responsibility for its activation.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Requester Agent Practitioner
description
The individual who initiated the request and has responsibility for its activation.
dataFormat
guid
isNullable
true
sourceName
msemr_lookup
Traits
List of traits for the lookupId 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
Requester Agent Practitioner
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 individual who initiated the request and has responsibility for its activation.
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.
The name of the custom entity.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Name
description
The name of the custom entity.
dataFormat
string
maximumLength
100
isNullable
true
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
"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
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.nullable
The attribute value may be set to NULL.
The time when this communication is to occur.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Occurrence Date
description
The time when this communication is to occur.
dataFormat
dateTime
isNullable
true
sourceName
msemr_occurrencedate
Traits
List of traits for the occurrenceDate 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_occurrencedate"
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
Occurrence 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 time when this communication 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.
The end time when this communication is to occur.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Occurrence End Date
description
The end time when this communication is to occur.
dataFormat
dateTime
isNullable
true
sourceName
msemr_occurrenceenddate
Traits
List of traits for the occurrenceEndDate 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_occurrenceenddate"
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
Occurrence End Date
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
The end time when this communication 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.
The start time when this communication is to occur.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Occurrence Start Date
description
The start time when this communication is to occur.
dataFormat
dateTime
isNullable
true
sourceName
msemr_occurrencestartdate
Traits
List of traits for the occurrenceStartDate 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_occurrencestartdate"
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
Occurrence 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 start time when this communication 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.
The time when this communication is to occur.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Occurrence Type
description
The time when this communication is to occur.
dataFormat
int32
isNullable
true
sourceName
msemr_occurrencetype
valueConstrainedToList
true
defaultValue
Traits
List of traits for the occurrenceType 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
Date
935000000
en
Period
935000001
any
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"msemr_occurrencetype"
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
Occurrence 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 time when this communication 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.
Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Priority
description
Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
dataFormat
guid
isNullable
true
sourceName
msemr_priority
Traits
List of traits for the priorityId 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
Priority
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
Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
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.
The individual who initiated the request and has responsibility for its activation.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Requester Agent Device
description
The individual who initiated the request and has responsibility for its activation.
dataFormat
guid
isNullable
true
sourceName
msemr_requesteragentdevice
Traits
List of traits for the requesterAgentDeviceId 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
Requester Agent Device
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 individual who initiated the request and has responsibility for its activation.
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.
The individual who initiated the request and has responsibility for its activation.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Requester Agent Organization
description
The individual who initiated the request and has responsibility for its activation.
dataFormat
guid
isNullable
true
sourceName
msemr_requesteragentorganization
Traits
List of traits for the requesterAgentOrganizationId 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
Requester Agent Organization
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 individual who initiated the request and has responsibility for its activation.
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.
The individual who initiated the request and has responsibility for its activation.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Requester Agent Patient
description
The individual who initiated the request and has responsibility for its activation.
dataFormat
guid
isNullable
true
sourceName
msemr_requesteragentpatient
Traits
List of traits for the requesterAgentPatientId 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
Requester Agent Patient
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 individual who initiated the request and has responsibility for its activation.
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.
The individual who initiated the request and has responsibility for its activation.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Requester Agent Related Person
description
The individual who initiated the request and has responsibility for its activation.
dataFormat
guid
isNullable
true
sourceName
msemr_requesteragentrelatedperson
Traits
List of traits for the requesterAgentRelatedPersonId 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
Requester Agent Related Person
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 individual who initiated the request and has responsibility for its activation.
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.
Type of the individual who initiated the request and has responsibility for its activation.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Requester Agent Type
description
Type of the individual who initiated the request and has responsibility for its activation.
dataFormat
int32
isNullable
true
sourceName
msemr_requesteragenttype
valueConstrainedToList
true
defaultValue
languageTag
displayText
attributeValue
en
Device
935000000
en
Patient
935000001
en
Practitioner
935000002
en
Related Person
935000003
en
Organization
935000004
Traits
List of traits for the requesterAgentType 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
Device
935000000
en
Patient
935000001
en
Practitioner
935000002
en
Related Person
935000003
en
Organization
935000004
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_requesteragenttype"
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
Requester Agent 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 individual who initiated the request and has responsibility for its activation.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
Organization agent is acting for.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Requester Organization
description
Organization agent is acting for.
dataFormat
guid
isNullable
true
sourceName
msemr_requesteronbehalfof
Traits
List of traits for the requesterOnBehalfOfId 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
Requester Organization
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
Organization agent is acting for.
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.
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Sender Device
description
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
dataFormat
guid
isNullable
true
sourceName
msemr_senderdevice
Traits
List of traits for the senderDeviceId 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
Sender Device
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 entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
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.
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Sender Organization
description
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
dataFormat
guid
isNullable
true
sourceName
msemr_senderorganization
Traits
List of traits for the senderOrganizationId 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
Sender Organization
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 entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
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.
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Sender Patient
description
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
dataFormat
guid
isNullable
true
sourceName
msemr_senderpatient
Traits
List of traits for the senderPatientId 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
Sender Patient
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 entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
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.
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Sender Practitioner
description
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
dataFormat
guid
isNullable
true
sourceName
msemr_senderpractitioner
Traits
List of traits for the senderPractitionerId 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
Sender Practitioner
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 entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
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.
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Sender Related Person
description
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
dataFormat
guid
isNullable
true
sourceName
msemr_senderrelatedperson
Traits
List of traits for the senderRelatedPersonId 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
Sender Related Person
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 entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
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.
Type of the entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Sender Type
description
Type of the entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
dataFormat
int32
isNullable
true
sourceName
msemr_sendertype
valueConstrainedToList
true
defaultValue
languageTag
displayText
attributeValue
en
Device
935000000
en
Organization
935000001
en
Patient
935000002
en
Practitioner
935000003
en
Related Person
935000004
Traits
List of traits for the senderType 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
Device
935000000
en
Organization
935000001
en
Patient
935000002
en
Practitioner
935000003
en
Related Person
935000004
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_sendertype"
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
Sender 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 entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
The status of the proposal or order.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Status
description
The status of the proposal or order.
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
Suspended
935000002
en
Cancelled
935000003
en
Completed
935000004
en
Entered in Error
935000005
en
Unknown
935000006
any
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"msemr_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 the proposal or order.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
The patient or group that is the focus of this communication request.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Subject Group
description
The patient or group that is the focus of this communication request.
dataFormat
guid
isNullable
true
sourceName
msemr_subjectgroup
Traits
List of traits for the subjectGroupId 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
Subject Group
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
The patient or group that is the focus of this communication request.
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.
The patient or group that is the focus of this communication request.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Subject Patient
description
The patient or group that is the focus of this communication request.
dataFormat
guid
isNullable
true
sourceName
msemr_subjectpatient
Traits
List of traits for the subjectPatientId 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
Subject Patient
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 patient or group that is the focus of this communication request.
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.
Type of subject that is focus of the communication.
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Subject Type
description
Type of subject that is focus of the communication.
dataFormat
int32
isNullable
true
sourceName
msemr_subjecttype
valueConstrainedToList
true
defaultValue
languageTag
displayText
attributeValue
en
Patient
935000001
en
Group
935000000
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
languageTag
displayText
attributeValue
en
Patient
935000001
en
Group
935000000
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
languageTag
displayText
en
Subject 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 subject that is focus of the communication.
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
"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 Communication Request
entity
a reference to the constant entity holding the list of localized text
Reason for the status of the Communication Request
First included in: electronicMedicalRecords/CommunicationRequest (this entity)
Properties
Name
Value
displayName
Status Reason
description
Reason for the status of the Communication Request
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 Communication Request
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
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.