Encounter in Commoncore

Artikkeli
02/22/2022

An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

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

attributeGroupReference
/core/wellKnownCDSAttributeGroups.cdm.json /cdsCreationModificationDatesAndIds
/core/wellKnownCDSAttributeGroups.cdm.json /cdsOwnershipInfo
/core/wellKnownCDSAttributeGroups.cdm.json /cdsTimeZoneInfo
/core/wellKnownCDSAttributeGroups.cdm.json /cdsVersionTracking
/Healthcare/Foundational/Commoncore /Encounter.cdm.json/Encounter/hasAttributes /attributesAddedAtThisScope

entity

is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	Encounter/(resolvedAttributes)/encounterId	attribute

means.entityState
the attribute represents the current state of the entity.

Parameter	Value	Data type	Explanation
attribute	Encounter/(resolvedAttributes)/stateCode	attribute

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Encounter

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

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_encounter"	string

Attributes

Name	Description	First Included in Instance
createdOn	Date and time when the record was created.	Commoncore/Encounter
createdBy	Unique identifier of the user who created the record.	Commoncore/Encounter
modifiedOn	Date and time when the record was modified.	Commoncore/Encounter
modifiedBy	Unique identifier of the user who modified the record.	Commoncore/Encounter
createdOnBehalfBy	Unique identifier of the delegate user who created the record.	Commoncore/Encounter
modifiedOnBehalfBy	Unique identifier of the delegate user who modified the record.	Commoncore/Encounter
overriddenCreatedOn	Date and time that the record was migrated.	Commoncore/Encounter
importSequenceNumber	Unique identifier of the data import or data migration that created this record.	Commoncore/Encounter
ownerId	Owner Id	Commoncore/Encounter
ownerIdType	The type of owner, either User or Team.	Commoncore/Encounter
owningBusinessUnit	Unique identifier for the business unit that owns the record	Commoncore/Encounter
owningUser	Unique identifier for the user that owns the record.	Commoncore/Encounter
owningTeam	Unique identifier for the team that owns the record.	Commoncore/Encounter
timeZoneRuleVersionNumber	For internal use only.	Commoncore/Encounter
UTCConversionTimeZoneCode	Time zone code that was in use when the record was created.	Commoncore/Encounter
versionNumber	Version Number	Commoncore/Encounter
appointmentEMRId	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).	Commoncore/Encounter
class	Type of: inpatient \| outpatient \| ambulatory \| emergency +.	Commoncore/Encounter
class_display		Commoncore/Encounter
contextEncounterId		Commoncore/Encounter
contextEpisodeOfCareId		Commoncore/Encounter
duration	Quantity of time the encounter lasted. This excludes the time during leaves of absence.	Commoncore/Encounter
encounterClass	Refers to the class of encounter.	Commoncore/Encounter
encounterClass_display		Commoncore/Encounter
encounterEndDate	The start and end time of the encounter.	Commoncore/Encounter
encounterGroupIdentifierId	The group present at the encounter	Commoncore/Encounter
encounterId	Unique identifier for entity instances	Commoncore/Encounter
encounterIdentifier	Identifier(s) by which this encounter is known.	Commoncore/Encounter
encounterLength	Quantity of time the encounter lasted. This excludes the time during leaves of absence.	Commoncore/Encounter
encounterParentEncounterIdentifierId	Another Encounter of which this encounter is a part of (administratively or in time).	Commoncore/Encounter
encounterPatientIdentifierId	The patient present at the encounter.	Commoncore/Encounter
encounterPriorityId	Indicates the urgency of the encounter.	Commoncore/Encounter
encounterStartDate	The start and end time of the encounter.	Commoncore/Encounter
encounterStatus	Refers to the status of encounter.	Commoncore/Encounter
encounterStatus_display		Commoncore/Encounter
hospitalizationAdmitSourceId	From where patient was admitted (physician referral, transfer).	Commoncore/Encounter
hospitalizationDestinationId	Location to which the patient is discharged.	Commoncore/Encounter
hospitalizationDischargeDispositionId	Category or kind of location after discharge.	Commoncore/Encounter
hospitalizationOriginId	The location from which the patient came before admission.	Commoncore/Encounter
hospitalizationPreAdmissionNumber	Pre-admission identifier.	Commoncore/Encounter
hospitalizationReadmissionId	Whether this hospitalization is a readmission and why if known.	Commoncore/Encounter
name	The name of the custom entity.	Commoncore/Encounter
onBehalfOfId		Commoncore/Encounter
periodEnd	The start and end time of the encounter.	Commoncore/Encounter
periodStart	The start and end time of the encounter.	Commoncore/Encounter
priority	Indicates the urgency of the encounter.	Commoncore/Encounter
priority_display		Commoncore/Encounter
subjectPatientId	The patient or group present at the encounter.	Commoncore/Encounter
stateCode	Status of the Encounter	Commoncore/Encounter
stateCode_display		Commoncore/Encounter
statusCode	Reason for the status of the Encounter	Commoncore/Encounter
statusCode_display		Commoncore/Encounter

createdOn

Date and time when the record was created.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Created On
description	Date and time when the record was created.
dataFormat	dateTime
isNullable	true
sourceName	createdon

Traits

List of traits for the createdOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.creation
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Created On

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Date and time when the record was created.

entity

a reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

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/Encounter (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

languageTag	displayText
en	Created By

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Shows who created the record.
en	Unique identifier of the user who created the record.

entity

a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/User.cdm.json/User	systemUserId

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/Encounter (this entity)

Properties

Name	Value
displayName	Modified On
description	Date and time when the record was modified.
dataFormat	dateTime
isNullable	true
sourceName	modifiedon

Traits

List of traits for the modifiedOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.modify
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Modified On

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Date and time when the record was modified.

entity

a reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

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/Encounter (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

languageTag	displayText
en	Modified By

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Shows who last updated the record.
en	Unique identifier of the user who modified the record.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/User.cdm.json/User	systemUserId

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

createdOnBehalfBy

Unique identifier of the delegate user who created the record.
First included in: Commoncore/Encounter (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

languageTag	displayText
en	Created By (Delegate)

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Shows who created the record on behalf of another user.
en	Unique identifier of the delegate user who created the record.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/User.cdm.json/User	systemUserId

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

modifiedOnBehalfBy

Unique identifier of the delegate user who modified the record.
First included in: Commoncore/Encounter (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

languageTag	displayText
en	Modified By (Delegate)

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Shows who last updated the record on behalf of another user.
en	Unique identifier of the delegate user who modified the record.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/User.cdm.json/User	systemUserId

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

overriddenCreatedOn

Date and time that the record was migrated.
First included in: Commoncore/Encounter (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.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Record Created On

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Date and time that the record was migrated.

entity

a reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

Parameter	Value	Data type	Explanation
name	"overriddencreatedon"	string

is.dataFormat.time
is.dataFormat.date

importSequenceNumber

Unique identifier of the data import or data migration that created this record.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Import Sequence Number
description	Unique identifier of the data import or data migration that created this record.
dataFormat	int32
maximumValue	2147483647
minimumValue	-2147483648
isNullable	true
sourceName	importsequencenumber

Traits

List of traits for the importSequenceNumber attribute are listed below.

is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Import Sequence Number

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Unique identifier of the data import or data migration that created this record.

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/Encounter (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

languageTag	displayText
en	Owner

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Owner Id

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/User.cdm.json/User	systemUserId
/core/applicationCommon/Team.cdm.json/Team	teamId

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

ownerIdType

The type of owner, either User or Team.
First included in: Commoncore/Encounter (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

languageTag	displayText
en	Owner Type

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The type of owner, either User or Team.

entity

a reference to the constant entity holding the list of localized text

is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.

is.readOnly
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

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/Encounter (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

languageTag	displayText
en	Owning Business Unit

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Unique identifier for the business unit that owns the record

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/BusinessUnit.cdm.json/BusinessUnit	businessUnitId

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

owningUser

Unique identifier for the user that owns the record.
First included in: Commoncore/Encounter (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

languageTag	displayText
en	Owning User

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Unique identifier for the user that owns the record.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/User.cdm.json/User	systemUserId

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

owningTeam

Unique identifier for the team that owns the record.
First included in: Commoncore/Encounter (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

languageTag	displayText
en	Owning Team

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Unique identifier for the team that owns the record.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/Team.cdm.json/Team	teamId

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

timeZoneRuleVersionNumber

For internal use only.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Time Zone Rule Version Number
description	For internal use only.
dataFormat	int32
maximumValue	2147483647
minimumValue	-1
isNullable	true
sourceName	timezoneruleversionnumber

Traits

List of traits for the timeZoneRuleVersionNumber attribute are listed below.

is.dataFormat.integer
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Time Zone Rule Version Number

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	For internal use only.

entity

a reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

Parameter	Value	Data type	Explanation
name	"timezoneruleversionnumber"	string

is.constrained
maximum length or value constraints

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/Encounter (this entity)

Properties

Name	Value
displayName	UTC Conversion Time Zone Code
description	Time zone code that was in use when the record was created.
dataFormat	int32
maximumValue	2147483647
minimumValue	-1
isNullable	true
sourceName	utcconversiontimezonecode

Traits

List of traits for the UTCConversionTimeZoneCode attribute are listed below.

is.dataFormat.integer
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	UTC Conversion Time Zone Code

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Time zone code that was in use when the record was created.

entity

a reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

Parameter	Value	Data type	Explanation
name	"utcconversiontimezonecode"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
minimumValue	"-1"	decimal
maximumValue	"2147483647"	decimal

is.dataFormat.integer

versionNumber

Version Number
First included in: Commoncore/Encounter (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

languageTag	displayText
en	Version Number

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Version Number

entity

a reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

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.

appointmentEMRId

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Appointment (EMR)
description	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
dataFormat	guid
isNullable	true
sourceName	msemr_appointmentemr

Traits

List of traits for the appointmentEMRId 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

languageTag	displayText
en	Appointment (EMR)

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/Healthcare/Foundational/Commoncore/AppointmentEMR.cdm.json/AppointmentEMR	activityId

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_appointmentemr"	string

class

Type of: inpatient | outpatient | ambulatory | emergency +.
First included in: Commoncore/Encounter (this entity)

Properties

Name

Value

displayName

Class

description

Type of: inpatient | outpatient | ambulatory | emergency +.

dataFormat

int32

isNullable

true

sourceName

msemr_class

valueConstrainedToList

true

defaultValue

languageTag	displayText	attributeValue
en	ambulatory	935000000
en	emergency	935000001
en	field	935000002
en	home health	935000003
en	inpatient encounter	935000004
en	inpatient acute	935000005
en	inpatient non-acute	935000006
en	pre-admission	935000007
en	short stay	935000008
en	virtual	935000009

Traits

List of traits for the class attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

Parameter

Value

Data type

Explanation

default

languageTag	displayText	attributeValue
en	ambulatory	935000000
en	emergency	935000001
en	field	935000002
en	home health	935000003
en	inpatient encounter	935000004
en	inpatient acute	935000005
en	inpatient non-acute	935000006
en	pre-admission	935000007
en	short stay	935000008
en	virtual	935000009

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_class"	string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Class

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Type of: inpatient \| outpatient \| ambulatory \| emergency +.

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

class_display

First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the class_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	"class"	attributeName	output parameter naming the attribute that is being supported

contextEncounterId

First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Context (Encounter)
dataFormat	guid
isNullable	true
sourceName	msemr_contextencounter

Traits

List of traits for the contextEncounterId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

Parameter	Value	Data type	Explanation
style	"single"	string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Context (Encounter)

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/Healthcare/Foundational/Commoncore/Encounter.cdm.json/Encounter	encounterId

entity

a reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

Parameter	Value	Data type	Explanation
name	"msemr_contextencounter"	string

contextEpisodeOfCareId

First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Context (Episode of Care)
dataFormat	guid
isNullable	true
sourceName	msemr_contextepisodeofcare

Traits

List of traits for the contextEpisodeOfCareId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

Parameter	Value	Data type	Explanation
style	"single"	string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Context (Episode of Care)

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/Healthcare/Foundational/Commoncore/EpisodeOfCare.cdm.json/EpisodeOfCare	episodeOfCareId

entity

a reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

Parameter	Value	Data type	Explanation
name	"msemr_contextepisodeofcare"	string

duration

Quantity of time the encounter lasted. This excludes the time during leaves of absence.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Duration
description	Quantity of time the encounter lasted. This excludes the time during leaves of absence.
dataFormat	int32
maximumValue	2147483647
minimumValue	-2147483648
isNullable	true
sourceName	msemr_duration

Traits

List of traits for the duration 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_duration"	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

languageTag	displayText
en	Duration

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Quantity of time the encounter lasted. This excludes the time during leaves of absence.

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

encounterClass

Refers to the class of encounter.
First included in: Commoncore/Encounter (this entity)

Properties

Name

Value

displayName

Class

description

Refers to the class of encounter.

dataFormat

int32

isNullable

true

sourceName

msemr_encounterclass

valueConstrainedToList

true

defaultValue

Traits

List of traits for the encounterClass attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

Parameter

Value

Data type

Explanation

default

languageTag	displayText	attributeValue
en	Inpatient	935000000
en	Outpatient	935000001
en	Ambulatory	935000002
en	Emergency	935000003

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_encounterclass"	string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Class

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Refers to the class of encounter.

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

encounterClass_display

First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the encounterClass_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	"encounterClass"	attributeName	output parameter naming the attribute that is being supported

encounterEndDate

The start and end time of the encounter.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	End Date/Time
description	The start and end time of the encounter.
dataFormat	dateTime
isNullable	true
sourceName	msemr_encounterenddate

Traits

List of traits for the encounterEndDate 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_encounterenddate"	string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	End Date/Time

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The start and end time of the encounter.

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

encounterGroupIdentifierId

The group present at the encounter
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Group
description	The group present at the encounter
dataFormat	guid
isNullable	true
sourceName	msemr_encountergroupidentifier

Traits

List of traits for the encounterGroupIdentifierId 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

languageTag	displayText
en	Group

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The group present at the encounter

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/Healthcare/Foundational/Commoncore/CodeableConcept.cdm.json/CodeableConcept	codeableConceptId

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_encountergroupidentifier"	string

encounterId

Unique identifier for entity instances
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Encounter
description	Unique identifier for entity instances
isPrimaryKey	true
dataFormat	guid
sourceName	msemr_encounterid

Traits

List of traits for the encounterId 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	Encounter/(resolvedAttributes)/encounterId	attribute

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

Parameter	Value	Data type	Explanation
name	"msemr_encounterid"	string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"systemrequired"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Encounter

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Unique identifier for entity instances

entity

a reference to the constant entity holding the list of localized text

encounterIdentifier

Identifier(s) by which this encounter is known.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Encounter Number
description	Identifier(s) by which this encounter is known.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_encounteridentifier

Traits

List of traits for the encounterIdentifier 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_encounteridentifier"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"100"	integer

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Encounter Number

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Identifier(s) by which this encounter is known.

entity

a reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

encounterLength

Quantity of time the encounter lasted. This excludes the time during leaves of absence.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Duration
description	Quantity of time the encounter lasted. This excludes the time during leaves of absence.
dataFormat	decimal
maximumValue	100000000000
minimumValue	-100000000000
isNullable	true
sourceName	msemr_encounterlength

Traits

List of traits for the encounterLength attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

Parameter	Value	Data type	Explanation
name	"msemr_encounterlength"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
minimumValue	"-100000000000"	decimal
maximumValue	"100000000000"	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

languageTag	displayText
en	Duration

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Quantity of time the encounter lasted. This excludes the time during leaves of absence.

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.numeric.shaped
for setting the exact precision and scale of numeric values

encounterParentEncounterIdentifierId

Another Encounter of which this encounter is a part of (administratively or in time).
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Parent Enounter
description	Another Encounter of which this encounter is a part of (administratively or in time).
dataFormat	guid
isNullable	true
sourceName	msemr_encounterparentencounteridentifier

Traits

List of traits for the encounterParentEncounterIdentifierId 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

languageTag	displayText
en	Parent Enounter

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Another Encounter of which this encounter is a part of (administratively or in time).

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/Healthcare/Foundational/Commoncore/Encounter.cdm.json/Encounter	encounterId

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_encounterparentencounteridentifier"	string

encounterPatientIdentifierId

The patient present at the encounter.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Patient
description	The patient present at the encounter.
dataFormat	guid
isNullable	true
sourceName	msemr_encounterpatientidentifier

Traits

List of traits for the encounterPatientIdentifierId 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

languageTag	displayText
en	Patient

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The patient present at the encounter.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/Contact.cdm.json/Contact	contactId

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_encounterpatientidentifier"	string

encounterPriorityId

Indicates the urgency of the encounter.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Priority
description	Indicates the urgency of the encounter.
dataFormat	guid
isNullable	true
sourceName	msemr_encounterpriority

Traits

List of traits for the encounterPriorityId 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

languageTag	displayText
en	Priority

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Indicates the urgency of the encounter.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/Healthcare/Foundational/Commoncore/CodeableConcept.cdm.json/CodeableConcept	codeableConceptId

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_encounterpriority"	string

encounterStartDate

The start and end time of the encounter.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Start Date/Time
description	The start and end time of the encounter.
dataFormat	dateTime
isNullable	true
sourceName	msemr_encounterstartdate

Traits

List of traits for the encounterStartDate 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_encounterstartdate"	string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Start Date/Time

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The start and end time of the encounter.

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

encounterStatus

Refers to the status of encounter.
First included in: Commoncore/Encounter (this entity)

Properties

Name

Value

displayName

Status

description

Refers to the status of encounter.

dataFormat

int32

isNullable

true

sourceName

msemr_encounterstatus

valueConstrainedToList

true

defaultValue

Traits

List of traits for the encounterStatus attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

Parameter

Value

Data type

Explanation

default

languageTag	displayText	attributeValue
en	Planned	935000000
en	Arrived	935000001
en	Triaged	935000002
en	In Progress	935000003
en	On Leave	935000004
en	Finished	935000005
en	Cancelled	935000006
en	Entered in Error	935000007
en	Unknown	935000008

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_encounterstatus"	string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Status

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Refers to the status of encounter.

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

encounterStatus_display

First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the encounterStatus_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	"encounterStatus"	attributeName	output parameter naming the attribute that is being supported

hospitalizationAdmitSourceId

From where patient was admitted (physician referral, transfer).
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Admit Source
description	From where patient was admitted (physician referral, transfer).
dataFormat	guid
isNullable	true
sourceName	msemr_hospitalizationadmitsource

Traits

List of traits for the hospitalizationAdmitSourceId 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

languageTag	displayText
en	Admit Source

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	From where patient was admitted (physician referral, transfer).

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/Healthcare/Foundational/Commoncore/CodeableConcept.cdm.json/CodeableConcept	codeableConceptId

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_hospitalizationadmitsource"	string

hospitalizationDestinationId

Location to which the patient is discharged.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Destination
description	Location to which the patient is discharged.
dataFormat	guid
isNullable	true
sourceName	msemr_hospitalizationdestination

Traits

List of traits for the hospitalizationDestinationId 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

languageTag	displayText
en	Destination

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Location to which the patient is discharged.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/Healthcare/Foundational/Commoncore/Location.cdm.json/Location	locationId

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_hospitalizationdestination"	string

hospitalizationDischargeDispositionId

Category or kind of location after discharge.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Discharge Disposition
description	Category or kind of location after discharge.
dataFormat	guid
isNullable	true
sourceName	msemr_hospitalizationdischargedisposition

Traits

List of traits for the hospitalizationDischargeDispositionId 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

languageTag	displayText
en	Discharge Disposition

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Category or kind of location after discharge.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/Healthcare/Foundational/Commoncore/CodeableConcept.cdm.json/CodeableConcept	codeableConceptId

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_hospitalizationdischargedisposition"	string

hospitalizationOriginId

The location from which the patient came before admission.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Origin
description	The location from which the patient came before admission.
dataFormat	guid
isNullable	true
sourceName	msemr_hospitalizationorigin

Traits

List of traits for the hospitalizationOriginId 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

languageTag	displayText
en	Origin

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The location from which the patient came before admission.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/Healthcare/Foundational/Commoncore/Location.cdm.json/Location	locationId

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_hospitalizationorigin"	string

hospitalizationPreAdmissionNumber

Pre-admission identifier.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Pre Admission Number
description	Pre-admission identifier.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_hospitalizationpreadmissionnumber

Traits

List of traits for the hospitalizationPreAdmissionNumber 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_hospitalizationpreadmissionnumber"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"100"	integer

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Pre Admission Number

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Pre-admission identifier.

entity

a reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

hospitalizationReadmissionId

Whether this hospitalization is a readmission and why if known.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Re admission
description	Whether this hospitalization is a readmission and why if known.
dataFormat	guid
isNullable	true
sourceName	msemr_hospitalizationreadmission

Traits

List of traits for the hospitalizationReadmissionId 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

languageTag	displayText
en	Re admission

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Whether this hospitalization is a readmission and why if known.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/Healthcare/Foundational/Commoncore/CodeableConcept.cdm.json/CodeableConcept	codeableConceptId

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_hospitalizationreadmission"	string

name

The name of the custom entity.
First included in: Commoncore/Encounter (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

languageTag	displayText
en	Name

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The name of the custom entity.

entity

a reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

onBehalfOfId

First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	On behalf of
dataFormat	guid
isNullable	true
sourceName	msemr_onbehalfof

Traits

List of traits for the onBehalfOfId 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

languageTag	displayText
en	On behalf of

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/Account.cdm.json/Account	accountId

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_onbehalfof"	string

periodEnd

The start and end time of the encounter.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Period End
description	The start and end time of the encounter.
dataFormat	dateTime
isNullable	true
sourceName	msemr_periodend

Traits

List of traits for the periodEnd 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_periodend"	string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Period End

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The start and end time of the encounter.

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

periodStart

The start and end time of the encounter.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Period Start
description	The start and end time of the encounter.
dataFormat	dateTime
isNullable	true
sourceName	msemr_periodstart

Traits

List of traits for the periodStart 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_periodstart"	string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Period Start

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The start and end time of the encounter.

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

priority

Indicates the urgency of the encounter.
First included in: Commoncore/Encounter (this entity)

Properties

Name

Value

displayName

Priority

description

Indicates the urgency of the encounter.

dataFormat

int32

isNullable

true

sourceName

msemr_priority

valueConstrainedToList

true

defaultValue

languageTag	displayText	attributeValue
en	ASAP	935000000
en	callback results	935000001
en	callback for scheduling	935000002
en	callback placer for scheduling	935000003
en	contact recipient for scheduling	935000004
en	elective	935000005
en	emergency	935000006
en	preop	935000007
en	as needed	935000008
en	routine	935000009
en	rush reporting	935000010
en	stat	935000011
en	timing critical	935000012
en	use as directed	935000013
en	urgent	935000014

Traits

List of traits for the priority attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

Parameter

Value

Data type

Explanation

default

languageTag	displayText	attributeValue
en	ASAP	935000000
en	callback results	935000001
en	callback for scheduling	935000002
en	callback placer for scheduling	935000003
en	contact recipient for scheduling	935000004
en	elective	935000005
en	emergency	935000006
en	preop	935000007
en	as needed	935000008
en	routine	935000009
en	rush reporting	935000010
en	stat	935000011
en	timing critical	935000012
en	use as directed	935000013
en	urgent	935000014

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_priority"	string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Priority

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Indicates the urgency of the encounter.

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

priority_display

First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the priority_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	"priority"	attributeName	output parameter naming the attribute that is being supported

subjectPatientId

The patient or group present at the encounter.
First included in: Commoncore/Encounter (this entity)

Properties

Name	Value
displayName	Subject (Patient)
description	The patient or group present at the encounter.
dataFormat	guid
isNullable	true
sourceName	msemr_subjectpatient

Traits

List of traits for the subjectPatientId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

Parameter	Value	Data type	Explanation
style	"single"	string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Subject (Patient)

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	The patient or group present at the encounter.

entity

a reference to the constant entity holding the list of localized text

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/core/applicationCommon/Contact.cdm.json/Contact	contactId

entity

a reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

Parameter	Value	Data type	Explanation
name	"msemr_subjectpatient"	string

stateCode

Status of the Encounter
First included in: Commoncore/Encounter (this entity)

Properties

Name

Value

displayName

Status

description

Status of the Encounter

dataFormat

int32

sourceName

statecode

valueConstrainedToList

true

defaultValue

languageTag	displayText	attributeValue
en	Active	0
en	Inactive	1

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

languageTag	displayText	attributeValue
en	Active	0
en	Inactive	1

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	Encounter/(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

languageTag	displayText
en	Status

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Status of the Encounter

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

stateCode_display

First included in: Commoncore/Encounter (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

statusCode

Reason for the status of the Encounter
First included in: Commoncore/Encounter (this entity)

Properties

Name

Value

displayName

Status Reason

description

Reason for the status of the Encounter

dataFormat

int32

isNullable

true

sourceName

statuscode

valueConstrainedToList

true

defaultValue

languageTag	displayText	attributeValue	correlatedValue
en	Planned	1	0
en	Arrived	935000000	0
en	Triaged	935000001	0
en	In Progress	935000002	0
en	On Leave	935000003	0
en	Inactive	2	1
en	Finished	935000004	1
en	Cancelled	935000005	1
en	Entered in Error	935000006	1
en	Unknown	935000007	1

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

languageTag	displayText	attributeValue	correlatedValue
en	Planned	1	0
en	Arrived	935000000	0
en	Triaged	935000001	0
en	In Progress	935000002	0
en	On Leave	935000003	0
en	Inactive	2	1
en	Finished	935000004	1
en	Cancelled	935000005	1
en	Entered in Error	935000006	1
en	Unknown	935000007	1

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

languageTag	displayText
en	Status Reason

entity

a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Reason for the status of the Encounter

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/Encounter (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

Jaa

Encounter in Commoncore

Traits

Attributes

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits