Substance in Commoncore
A homogeneous material with a definite composition.
Latest version of the JSON entity definition is available on GitHub.
Traits
Traits for this entity are listed below.
is.CDM.entityVersion
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "1.1" | string | semantic version number of the entity |
is.identifiedBy
names a specifc identity attribute to use with an entity
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | Substance/(resolvedAttributes)/substanceId | attribute |
means.entityState
the attribute represents the current state of the entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | Substance/(resolvedAttributes)/stateCode | attribute |
is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.
| Parameter | Value | Data type | Explanation | ||
|---|---|---|---|---|---|
| groupList |
| entity |
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_substance" | string |
Attributes
| Name | Description | First Included in Instance |
|---|---|---|
| createdBy | Unique identifier of the user who created the record. | Commoncore/Substance |
| createdOn | Date and time when the record was created. | Commoncore/Substance |
| createdOnBehalfBy | Unique identifier of the delegate user who created the record. | Commoncore/Substance |
| importSequenceNumber | Sequence number of the import that created this record. | Commoncore/Substance |
| modifiedBy | Unique identifier of the user who modified the record. | Commoncore/Substance |
| modifiedOn | Date and time when the record was modified. | Commoncore/Substance |
| modifiedOnBehalfBy | Unique identifier of the delegate user who modified the record. | Commoncore/Substance |
| codeId | A code (or set of codes) that identify this substance. | Commoncore/Substance |
| description | A description of the substance - its appearance, handling requirements, and other usage notes. | Commoncore/Substance |
| name | The name of the substance entity. | Commoncore/Substance |
| status | A code to indicate if the substance is actively used. | Commoncore/Substance |
| status_display | Commoncore/Substance | |
| substanceId | Unique identifier for entity instances | Commoncore/Substance |
| substanceNumber | Unique identifier for the substance. | Commoncore/Substance |
| organizationId | Unique identifier for the organization | Commoncore/Substance |
| overriddenCreatedOn | Date and time that the record was migrated. | Commoncore/Substance |
| stateCode | Status of the Substance | Commoncore/Substance |
| stateCode_display | Commoncore/Substance | |
| statusCode | Reason for the status of the Substance | Commoncore/Substance |
| statusCode_display | Commoncore/Substance | |
| timeZoneRuleVersionNumber | For internal use only. | Commoncore/Substance |
| UTCConversionTimeZoneCode | Time zone code that was in use when the record was created. | Commoncore/Substance |
createdBy
Unique identifier of the user who created the record.
First included in: Commoncore/Substance (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
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
createdOn
Date and time when the record was created.
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Created On |
| description | Date and time when the record was created. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | createdon |
Traits
List of traits for the createdOn attribute are listed below.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.creation
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "createdon" | string |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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
createdOnBehalfBy
Unique identifier of the delegate user who created the record.
First included in: Commoncore/Substance (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
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "createdonbehalfby" | string |
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| style | "single" | string |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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.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
importSequenceNumber
Sequence number of the import that created this record.
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Import Sequence Number |
| description | Sequence number of the import that created this record. |
| dataFormat | int32 |
| maximumValue | 2147483647 |
| minimumValue | -2147483648 |
| isNullable | true |
| sourceName | importsequencenumber |
Traits
List of traits for the importSequenceNumber attribute are listed below.
is.dataFormat.integer
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "importsequencenumber" | string |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-2147483648" | decimal | |
| maximumValue | "2147483647" | decimal |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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
modifiedBy
Unique identifier of the user who modified the record.
First included in: Commoncore/Substance (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
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
modifiedOn
Date and time when the record was modified.
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Modified On |
| description | Date and time when the record was modified. |
| dataFormat | dateTime |
| isNullable | true |
| sourceName | modifiedon |
Traits
List of traits for the modifiedOn attribute are listed below.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.modify
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "modifiedon" | string |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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
modifiedOnBehalfBy
Unique identifier of the delegate user who modified the record.
First included in: Commoncore/Substance (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
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "modifiedonbehalfby" | string |
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| style | "single" | string |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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.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
codeId
A code (or set of codes) that identify this substance.
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Code |
| description | A code (or set of codes) that identify this substance. |
| dataFormat | guid |
| isNullable | true |
| sourceName | msemr_code |
Traits
List of traits for the codeId 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_code" | 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
description
A description of the substance - its appearance, handling requirements, and other usage notes.
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Description |
| description | A description of the substance - its appearance, handling requirements, and other usage notes. |
| dataFormat | string |
| maximumLength | 2000 |
| isNullable | true |
| sourceName | msemr_description |
Traits
List of traits for the description 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_description" | string |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "2000" | 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
name
The name of the substance entity.
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Name |
| description | The name of the substance 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
status
A code to indicate if the substance is actively used.
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Status |
| description | A code to indicate if the substance is actively used. |
| 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/Substance (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
substanceId
Unique identifier for entity instances
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Substance |
| description | Unique identifier for entity instances |
| isPrimaryKey | true |
| dataFormat | guid |
| sourceName | msemr_substanceid |
Traits
List of traits for the substanceId 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 | Substance/(resolvedAttributes)/substanceId | attribute |
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "msemr_substanceid" | 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
substanceNumber
Unique identifier for the substance.
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Substance Number |
| description | Unique identifier for the substance. |
| dataFormat | string |
| maximumLength | 100 |
| isNullable | true |
| sourceName | msemr_substancenumber |
Traits
List of traits for the substanceNumber 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_substancenumber" | 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
organizationId
Unique identifier for the organization
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Organization Id |
| description | Unique identifier for the organization |
| dataFormat | guid |
| isNullable | true |
| sourceName | organizationid |
Traits
List of traits for the organizationId attribute are listed below.
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 | "organizationid" | 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/Substance (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.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "overriddencreatedon" | string |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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
stateCode
Status of the Substance
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Status | |||||||||
| description | Status of the Substance | |||||||||
| 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 | Substance/(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/Substance (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 Substance
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Status Reason | ||||||||||||
| description | Reason for the status of the Substance | ||||||||||||
| 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/Substance (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
timeZoneRuleVersionNumber
For internal use only.
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Time Zone Rule Version Number |
| description | For internal use only. |
| dataFormat | int32 |
| maximumValue | 2147483647 |
| minimumValue | -1 |
| isNullable | true |
| sourceName | timezoneruleversionnumber |
Traits
List of traits for the timeZoneRuleVersionNumber attribute are listed below.
is.dataFormat.integer
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "timezoneruleversionnumber" | string |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-1" | decimal | |
| maximumValue | "2147483647" | decimal |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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
UTCConversionTimeZoneCode
Time zone code that was in use when the record was created.
First included in: Commoncore/Substance (this entity)
Properties
| Name | Value |
|---|---|
| displayName | UTC Conversion Time Zone Code |
| description | Time zone code that was in use when the record was created. |
| dataFormat | int32 |
| maximumValue | 2147483647 |
| minimumValue | -1 |
| isNullable | true |
| sourceName | utcconversiontimezonecode |
Traits
List of traits for the UTCConversionTimeZoneCode attribute are listed below.
is.dataFormat.integer
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "utcconversiontimezonecode" | string |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-1" | decimal | |
| maximumValue | "2147483647" | decimal |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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
Commenti e suggerimenti
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedere https://aka.ms/ContentUserFeedback.
Invia e visualizza il feedback per