Specimen in Commoncore
A sample to be used for analysis.
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 | Specimen/(resolvedAttributes)/specimenId | attribute |
means.entityState
the attribute represents the current state of the entity.
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | Specimen/(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_specimen" | string |
Attributes
Name | Description | First Included in Instance |
---|---|---|
createdOn | Date and time when the record was created. | Commoncore/Specimen |
createdBy | Unique identifier of the user who created the record. | Commoncore/Specimen |
modifiedOn | Date and time when the record was modified. | Commoncore/Specimen |
modifiedBy | Unique identifier of the user who modified the record. | Commoncore/Specimen |
createdOnBehalfBy | Unique identifier of the delegate user who created the record. | Commoncore/Specimen |
modifiedOnBehalfBy | Unique identifier of the delegate user who modified the record. | Commoncore/Specimen |
overriddenCreatedOn | Date and time that the record was migrated. | Commoncore/Specimen |
importSequenceNumber | Sequence number of the import that created this record. | Commoncore/Specimen |
ownerId | Owner Id | Commoncore/Specimen |
ownerIdType | The type of owner, either User or Team. | Commoncore/Specimen |
owningBusinessUnit | Unique identifier for the business unit that owns the record | Commoncore/Specimen |
owningUser | Unique identifier for the user that owns the record. | Commoncore/Specimen |
owningTeam | Unique identifier for the team that owns the record. | Commoncore/Specimen |
timeZoneRuleVersionNumber | For internal use only. | Commoncore/Specimen |
UTCConversionTimeZoneCode | Time zone code that was in use when the record was created. | Commoncore/Specimen |
versionNumber | Version Number | Commoncore/Specimen |
accessionNumber | The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. | Commoncore/Specimen |
bodySiteId | Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens. | Commoncore/Specimen |
collectedMethodId | A coded value specifying the technique that is used to perform the procedure. | Commoncore/Specimen |
collectedQuantity | The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. | Commoncore/Specimen |
collectionCollectedDateTime | The date Time when the specimen was collected from the subject - the physiologically relevant time. | Commoncore/Specimen |
collectionCollectedPeriodEnd | The End period when a specimen was collected from a subject - the physiologically relevant time. | Commoncore/Specimen |
collectionCollectedPeriodStart | The start period when a specimen was collected from a subject - the physiologically relevant time. | Commoncore/Specimen |
collectionCollectedType | Time when specimen was collected from subject - the physiologically relevant time. | Commoncore/Specimen |
collectionCollectedType_display | Commoncore/Specimen | |
collectionCollectorId | Person who collected the specimen. | Commoncore/Specimen |
name | The name of the custom entity. | Commoncore/Specimen |
receivedTime | Time when specimen was received for processing or testing. | Commoncore/Specimen |
specimenId | Unique identifier for entity instances | Commoncore/Specimen |
specimenNumber | Id for specimen. | Commoncore/Specimen |
status | The availability of the specimen. | Commoncore/Specimen |
status_display | Commoncore/Specimen | |
subjectType | Where the specimen came from. This may be from the patient(s) or from the environment or a device. | Commoncore/Specimen |
subjectType_display | Commoncore/Specimen | |
subjectTypeDeviceId | The Device Type of a Subject where the specimen came from. | Commoncore/Specimen |
subjectTypeGroupId | The groupType of a Subject where the specimen came from. | Commoncore/Specimen |
subjectTypePatientId | Where the specimen came from. This may be from the patient(s) or from the environment or a device. | Commoncore/Specimen |
subjectTypeSubstanceId | The substance type of a Subject where the specimen came from. | Commoncore/Specimen |
typeId | The kind of material that forms the specimen. | Commoncore/Specimen |
stateCode | Status of the Specimen | Commoncore/Specimen |
stateCode_display | Commoncore/Specimen | |
statusCode | Reason for the status of the Specimen | Commoncore/Specimen |
statusCode_display | Commoncore/Specimen |
createdOn
Date and time when the record was created.
First included in: Commoncore/Specimen (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/Specimen (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/Specimen (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/Specimen (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/Specimen (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/Specimen (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/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Record Created On |
description | Date and time that the record was migrated. |
dataFormat | dateTime |
isNullable | true |
sourceName | overriddencreatedon |
Traits
List of traits for the overriddenCreatedOn attribute are listed below.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.creation
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "overriddencreatedon" | string |
is.dataFormat.time
is.dataFormat.date
importSequenceNumber
Sequence number of the import that created this record.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Import Sequence Number |
description | Sequence number of the import that created this record. |
dataFormat | int32 |
maximumValue | 2147483647 |
minimumValue | -2147483648 |
isNullable | true |
sourceName | importsequencenumber |
Traits
List of traits for the importSequenceNumber attribute are listed below.
is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||||
---|---|---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "importsequencenumber" | string |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|---|---|---|
minimumValue | "-2147483648" | decimal | |
maximumValue | "2147483647" | decimal |
is.dataFormat.integer
ownerId
Owner Id
First included in: Commoncore/Specimen (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/Specimen (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/Specimen (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/Specimen (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/Specimen (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/Specimen (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/Specimen (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/Specimen (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.
accessionNumber
The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Accession Number |
description | The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. |
dataFormat | string |
maximumLength | 100 |
isNullable | true |
sourceName | msemr_accessionnumber |
Traits
List of traits for the accessionNumber 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_accessionnumber" | 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
bodySiteId
Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Body Site |
description | Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens. |
dataFormat | guid |
isNullable | true |
sourceName | msemr_bodysite |
Traits
List of traits for the bodySiteId 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_bodysite" | 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
collectedMethodId
A coded value specifying the technique that is used to perform the procedure.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Method |
description | A coded value specifying the technique that is used to perform the procedure. |
dataFormat | guid |
isNullable | true |
sourceName | msemr_collectedmethod |
Traits
List of traits for the collectedMethodId 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_collectedmethod" | 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
collectedQuantity
The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Quantity |
description | The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. |
dataFormat | int32 |
maximumValue | 2147483647 |
minimumValue | -2147483648 |
isNullable | true |
sourceName | msemr_collectedquantity |
Traits
List of traits for the collectedQuantity 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 | "msemr_collectedquantity" | 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
collectionCollectedDateTime
The date Time when the specimen was collected from the subject - the physiologically relevant time.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Collected Date Time |
description | The date Time when the specimen was collected from the subject - the physiologically relevant time. |
dataFormat | dateTime |
isNullable | true |
sourceName | msemr_collectioncollecteddatetime |
Traits
List of traits for the collectionCollectedDateTime 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_collectioncollecteddatetime" | 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
collectionCollectedPeriodEnd
The End period when a specimen was collected from a subject - the physiologically relevant time.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Collected Period End |
description | The End period when a specimen was collected from a subject - the physiologically relevant time. |
dataFormat | dateTime |
isNullable | true |
sourceName | msemr_collectioncollectedperiodend |
Traits
List of traits for the collectionCollectedPeriodEnd 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_collectioncollectedperiodend" | 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
collectionCollectedPeriodStart
The start period when a specimen was collected from a subject - the physiologically relevant time.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Collected Period Start |
description | The start period when a specimen was collected from a subject - the physiologically relevant time. |
dataFormat | dateTime |
isNullable | true |
sourceName | msemr_collectioncollectedperiodstart |
Traits
List of traits for the collectionCollectedPeriodStart 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_collectioncollectedperiodstart" | 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
collectionCollectedType
Time when specimen was collected from subject - the physiologically relevant time.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
displayName | Collected Type | |||||||||
description | Time when specimen was collected from subject - the physiologically relevant time. | |||||||||
dataFormat | int32 | |||||||||
isNullable | true | |||||||||
sourceName | msemr_collectioncollectedtype | |||||||||
valueConstrainedToList | true | |||||||||
defaultValue |
|
Traits
List of traits for the collectionCollectedType 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_collectioncollectedtype" | 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
collectionCollectedType_display
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
dataFormat | string |
isReadOnly | true |
isNullable | true |
Traits
List of traits for the collectionCollectedType_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 | "collectionCollectedType" | 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
collectionCollectorId
Person who collected the specimen.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Collector |
description | Person who collected the specimen. |
dataFormat | guid |
isNullable | true |
sourceName | msemr_collectioncollector |
Traits
List of traits for the collectionCollectorId 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_collectioncollector" | 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/Specimen (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
receivedTime
Time when specimen was received for processing or testing.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Received Time |
description | Time when specimen was received for processing or testing. |
dataFormat | dateTime |
isNullable | true |
sourceName | msemr_receivedtime |
Traits
List of traits for the receivedTime 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_receivedtime" | 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
specimenId
Unique identifier for entity instances
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Specimen |
description | Unique identifier for entity instances |
isPrimaryKey | true |
dataFormat | guid |
sourceName | msemr_specimenid |
Traits
List of traits for the specimenId 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 | Specimen/(resolvedAttributes)/specimenId | attribute |
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msemr_specimenid" | 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
specimenNumber
Id for specimen.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Specimen Number |
description | Id for specimen. |
dataFormat | string |
maximumLength | 100 |
isNullable | true |
sourceName | msemr_specimennumber |
Traits
List of traits for the specimenNumber 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_specimennumber" | 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
The availability of the specimen.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Status |
description | The availability of the specimen. |
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/Specimen (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
subjectType
Where the specimen came from. This may be from the patient(s) or from the environment or a device.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
displayName | Subject Type | |||||||||||||||
description | Where the specimen came from. This may be from the patient(s) or from the environment or a device. | |||||||||||||||
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/Specimen (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
subjectTypeDeviceId
The Device Type of a Subject where the specimen came from.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Device |
description | The Device Type of a Subject where the specimen came from. |
dataFormat | guid |
isNullable | true |
sourceName | msemr_subjecttypedevice |
Traits
List of traits for the subjectTypeDeviceId 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_subjecttypedevice" | 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
subjectTypeGroupId
The groupType of a Subject where the specimen came from.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Group |
description | The groupType of a Subject where the specimen came from. |
dataFormat | guid |
isNullable | true |
sourceName | msemr_subjecttypegroup |
Traits
List of traits for the subjectTypeGroupId 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_subjecttypegroup" | 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
subjectTypePatientId
Where the specimen came from. This may be from the patient(s) or from the environment or a device.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Patient |
description | Where the specimen came from. This may be from the patient(s) or from the environment or a device. |
dataFormat | guid |
isNullable | true |
sourceName | msemr_subjecttypepatient |
Traits
List of traits for the subjectTypePatientId 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_subjecttypepatient" | 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
subjectTypeSubstanceId
The substance type of a Subject where the specimen came from.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Substance |
description | The substance type of a Subject where the specimen came from. |
dataFormat | guid |
isNullable | true |
sourceName | msemr_subjecttypesubstance |
Traits
List of traits for the subjectTypeSubstanceId 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_subjecttypesubstance" | 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
typeId
The kind of material that forms the specimen.
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value |
---|---|
displayName | Type |
description | The kind of material that forms the specimen. |
dataFormat | guid |
isNullable | true |
sourceName | msemr_type |
Traits
List of traits for the typeId 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_type" | 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
stateCode
Status of the Specimen
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
displayName | Status | |||||||||
description | Status of the Specimen | |||||||||
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 | Specimen/(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/Specimen (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 Specimen
First included in: Commoncore/Specimen (this entity)
Properties
Name | Value | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
displayName | Status Reason | ||||||||||||
description | Reason for the status of the Specimen | ||||||||||||
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/Specimen (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