Communication Request in Commoncore
A request to convey information.
Latest version of the JSON entity definition is available on GitHub.
Traits
Traits for this entity are listed below.
is.CDM.entityVersion
Parameter | Value | Data type | Explanation |
---|---|---|---|
versionNumber | "1.0" | 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 | CommunicationRequest/(resolvedAttributes)/communicationRequestId | attribute |
means.entityState
the attribute represents the current state of the entity.
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | CommunicationRequest/(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_communicationrequest" | string |
Attributes
Name | Description | First Included in Instance |
---|---|---|
createdOn | Date and time when the record was created. | Commoncore/CommunicationRequest |
createdBy | Unique identifier of the user who created the record. | Commoncore/CommunicationRequest |
modifiedOn | Date and time when the record was modified. | Commoncore/CommunicationRequest |
modifiedBy | Unique identifier of the user who modified the record. | Commoncore/CommunicationRequest |
createdOnBehalfBy | Unique identifier of the delegate user who created the record. | Commoncore/CommunicationRequest |
modifiedOnBehalfBy | Unique identifier of the delegate user who modified the record. | Commoncore/CommunicationRequest |
overriddenCreatedOn | Date and time that the record was migrated. | Commoncore/CommunicationRequest |
importSequenceNumber | Unique identifier of the data import or data migration that created this record. | Commoncore/CommunicationRequest |
ownerId | Owner Id | Commoncore/CommunicationRequest |
ownerIdType | The type of owner, either User or Team. | Commoncore/CommunicationRequest |
owningBusinessUnit | Unique identifier for the business unit that owns the record | Commoncore/CommunicationRequest |
owningUser | Unique identifier for the user that owns the record. | Commoncore/CommunicationRequest |
owningTeam | Unique identifier for the team that owns the record. | Commoncore/CommunicationRequest |
timeZoneRuleVersionNumber | For internal use only. | Commoncore/CommunicationRequest |
UTCConversionTimeZoneCode | Time zone code that was in use when the record was created. | Commoncore/CommunicationRequest |
versionNumber | Version Number | Commoncore/CommunicationRequest |
authoredOn | For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation. | Commoncore/CommunicationRequest |
communicationRequestId | Unique identifier for entity instances | Commoncore/CommunicationRequest |
contextEncounterId | The encounter or episode of care within which the communication request was created. | Commoncore/CommunicationRequest |
contextEpisodeOfCareId | The encounter or episode of care within which the communication request was created. | Commoncore/CommunicationRequest |
contextType | The encounter or episode of care within which the communication request was created. | Commoncore/CommunicationRequest |
contextType_display | Commoncore/CommunicationRequest | |
groupIdentifier | 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. | Commoncore/CommunicationRequest |
lookupId | The individual who initiated the request and has responsibility for its activation. | Commoncore/CommunicationRequest |
name | The name of the custom entity. | Commoncore/CommunicationRequest |
occurrenceDate | The time when this communication is to occur. | Commoncore/CommunicationRequest |
occurrenceEndDate | The end time when this communication is to occur. | Commoncore/CommunicationRequest |
occurrenceStartDate | The start time when this communication is to occur. | Commoncore/CommunicationRequest |
occurrenceType | The time when this communication is to occur. | Commoncore/CommunicationRequest |
occurrenceType_display | Commoncore/CommunicationRequest | |
priorityId | Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. | Commoncore/CommunicationRequest |
requesterAgentDeviceId | The individual who initiated the request and has responsibility for its activation. | Commoncore/CommunicationRequest |
requesterAgentOrganizationId | The individual who initiated the request and has responsibility for its activation. | Commoncore/CommunicationRequest |
requesterAgentPatientId | The individual who initiated the request and has responsibility for its activation. | Commoncore/CommunicationRequest |
requesterAgentRelatedPersonId | The individual who initiated the request and has responsibility for its activation. | Commoncore/CommunicationRequest |
requesterAgentType | Type of the individual who initiated the request and has responsibility for its activation. | Commoncore/CommunicationRequest |
requesterAgentType_display | Commoncore/CommunicationRequest | |
requesterOnBehalfOfId | Organization agent is acting for. | Commoncore/CommunicationRequest |
senderDeviceId | The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. | Commoncore/CommunicationRequest |
senderOrganizationId | The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. | Commoncore/CommunicationRequest |
senderPatientId | The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. | Commoncore/CommunicationRequest |
senderPractitionerId | The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. | Commoncore/CommunicationRequest |
senderRelatedPersonId | The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. | Commoncore/CommunicationRequest |
senderType | Type of the entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. | Commoncore/CommunicationRequest |
senderType_display | Commoncore/CommunicationRequest | |
status | The status of the proposal or order. | Commoncore/CommunicationRequest |
status_display | Commoncore/CommunicationRequest | |
subjectGroupId | The patient or group that is the focus of this communication request. | Commoncore/CommunicationRequest |
subjectPatientId | The patient or group that is the focus of this communication request. | Commoncore/CommunicationRequest |
subjectType | Type of subject that is focus of the communication. | Commoncore/CommunicationRequest |
subjectType_display | Commoncore/CommunicationRequest | |
stateCode | Status of the Communication Request | Commoncore/CommunicationRequest |
stateCode_display | Commoncore/CommunicationRequest | |
statusCode | Reason for the status of the Communication Request | Commoncore/CommunicationRequest |
statusCode_display | Commoncore/CommunicationRequest |
createdOn
Date and time when the record was created.
First included in: Commoncore/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 |
| 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: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
modifiedOn
Date and time when the record was modified.
First included in: Commoncore/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 |
| 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: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
createdOnBehalfBy
Unique identifier of the delegate user who created the record.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
modifiedOnBehalfBy
Unique identifier of the delegate user who modified the record.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
overriddenCreatedOn
Date and time that the record was migrated.
First included in: Commoncore/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 |
| 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
Unique identifier of the data import or data migration that created this record.
First included in: Commoncore/CommunicationRequest (this entity)
Properties
Name | Value |
---|---|
displayName | Import Sequence Number |
description | Unique identifier of the data import or data migration 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: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
ownerIdType
The type of owner, either User or Team.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
owningBusinessUnit
Unique identifier for the business unit that owns the record
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
owningUser
Unique identifier for the user that owns the record.
First included in: Commoncore/CommunicationRequest (this entity)
Properties
Name | Value |
---|---|
displayName | Owning User |
description | Unique identifier for the user that owns the record. |
dataFormat | guid |
isNullable | true |
sourceName | owninguser |
Traits
List of traits for the owningUser attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
owningTeam
Unique identifier for the team that owns the record.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
timeZoneRuleVersionNumber
For internal use only.
First included in: Commoncore/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 |
| 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: Commoncore/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 |
| 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: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
authoredOn
For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
First included in: Commoncore/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 |
| 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
communicationRequestId
Unique identifier for entity instances
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.dataFormat.guid
means.identity.entityId
is.identifiedBy
names a specifc identity attribute to use with an entity
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | CommunicationRequest/(resolvedAttributes)/communicationRequestId | attribute |
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 |
| 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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
contextEncounterId
The encounter or episode of care within which the communication request was created.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_contextencounter" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
contextEpisodeOfCareId
The encounter or episode of care within which the communication request was created.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_contextepisodeofcare" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
contextType
The encounter or episode of care within which the communication request was created.
First included in: Commoncore/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 |
|
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: Commoncore/CommunicationRequest (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the contextType_display attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
groupIdentifier
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: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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 |
| 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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
lookupId
The individual who initiated the request and has responsibility for its activation.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_lookup" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
name
The name of the custom entity.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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 |
| 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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
occurrenceDate
The time when this communication is to occur.
First included in: Commoncore/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 |
| 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
occurrenceEndDate
The end time when this communication is to occur.
First included in: Commoncore/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 |
| 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
occurrenceStartDate
The start time when this communication is to occur.
First included in: Commoncore/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 |
| 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
occurrenceType
The time when this communication is to occur.
First included in: Commoncore/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 |
| 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 |
| 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
occurrenceType_display
First included in: Commoncore/CommunicationRequest (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the occurrenceType_display attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.addedInSupportOf
Parameter | Value | Data type | Explanation |
---|---|---|---|
inSupportOf | "occurrenceType" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
priorityId
Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_priority" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
requesterAgentDeviceId
The individual who initiated the request and has responsibility for its activation.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_requesteragentdevice" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
requesterAgentOrganizationId
The individual who initiated the request and has responsibility for its activation.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_requesteragentorganization" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
requesterAgentPatientId
The individual who initiated the request and has responsibility for its activation.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_requesteragentpatient" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
requesterAgentRelatedPersonId
The individual who initiated the request and has responsibility for its activation.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_requesteragentrelatedperson" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
requesterAgentType
Type of the individual who initiated the request and has responsibility for its activation.
First included in: Commoncore/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 |
|
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 |
| 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 |
| 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
requesterAgentType_display
First included in: Commoncore/CommunicationRequest (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the requesterAgentType_display attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.addedInSupportOf
Parameter | Value | Data type | Explanation |
---|---|---|---|
inSupportOf | "requesterAgentType" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
requesterOnBehalfOfId
Organization agent is acting for.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_requesteronbehalfof" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
senderDeviceId
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_senderdevice" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
senderOrganizationId
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_senderorganization" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
senderPatientId
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_senderpatient" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
senderPractitionerId
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_senderpractitioner" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
senderRelatedPersonId
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_senderrelatedperson" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
senderType
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: Commoncore/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 |
|
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 |
| 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 |
| 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
senderType_display
First included in: Commoncore/CommunicationRequest (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the senderType_display attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.addedInSupportOf
Parameter | Value | Data type | Explanation |
---|---|---|---|
inSupportOf | "senderType" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
status
The status of the proposal or order.
First included in: Commoncore/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 |
| 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 |
| 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
status_display
First included in: Commoncore/CommunicationRequest (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the status_display attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.
is.addedInSupportOf
Parameter | Value | Data type | Explanation |
---|---|---|---|
inSupportOf | "status" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
subjectGroupId
The patient or group that is the focus of this communication request.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_subjectgroup" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
subjectPatientId
The patient or group that is the focus of this communication request.
First included in: Commoncore/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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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_subjectpatient" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
subjectType
Type of subject that is focus of the communication.
First included in: Commoncore/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 |
|
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: Commoncore/CommunicationRequest (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the subjectType_display attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
stateCode
Status of the Communication Request
First included in: Commoncore/CommunicationRequest (this entity)
Properties
Name | Value | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
displayName | Status | |||||||||
description | Status of the Communication Request | |||||||||
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 | CommunicationRequest/(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: Commoncore/CommunicationRequest (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
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
statusCode
Reason for the status of the Communication Request
First included in: Commoncore/CommunicationRequest (this entity)
Properties
Name | Value | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
displayName | Status Reason | ||||||||||||
description | Reason for the status of the Communication Request | ||||||||||||
dataFormat | int32 | ||||||||||||
isNullable | true | ||||||||||||
sourceName | statuscode | ||||||||||||
valueConstrainedToList | true | ||||||||||||
defaultValue |
|
Traits
List of traits for the statusCode 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.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: Commoncore/CommunicationRequest (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the statusCode_display attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.
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
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object