Editar

Compartir a través de


Episode of Care in Commoncore(EpisodeOfCare)

An association between a patient and an organization / healthcare provider(s) during which time encounters may occur.

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"1.0"stringsemantic version number of the entity

is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.

ParameterValueData typeExplanation
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
/EpisodeOfCare.cdm.json/EpisodeOfCare
/hasAttributes/attributesAddedAtThisScope
entity

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

ParameterValueData typeExplanation
attributeEpisodeOfCare/(resolvedAttributes)/episodeOfCareIdattribute

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

ParameterValueData typeExplanation
attributeEpisodeOfCare/(resolvedAttributes)/stateCodeattribute

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEpisode of Care
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAn association between a patient and an organization / healthcare provider(s) during which time encounters may occur.
entitya 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.

ParameterValueData typeExplanation
name"msemr_episodeofcare"string

Attributes

Name Description First Included in Instance
createdOn Date and time when the record was created. Commoncore/EpisodeOfCare
createdBy Unique identifier of the user who created the record. Commoncore/EpisodeOfCare
modifiedOn Date and time when the record was modified. Commoncore/EpisodeOfCare
modifiedBy Unique identifier of the user who modified the record. Commoncore/EpisodeOfCare
createdOnBehalfBy Unique identifier of the delegate user who created the record. Commoncore/EpisodeOfCare
modifiedOnBehalfBy Unique identifier of the delegate user who modified the record. Commoncore/EpisodeOfCare
overriddenCreatedOn Date and time that the record was migrated. Commoncore/EpisodeOfCare
importSequenceNumber Unique identifier of the data import or data migration that created this record. Commoncore/EpisodeOfCare
ownerId Owner Id Commoncore/EpisodeOfCare
ownerIdType The type of owner, either User or Team. Commoncore/EpisodeOfCare
owningBusinessUnit Unique identifier for the business unit that owns the record Commoncore/EpisodeOfCare
owningUser Unique identifier for the user that owns the record. Commoncore/EpisodeOfCare
owningTeam Unique identifier for the team that owns the record. Commoncore/EpisodeOfCare
timeZoneRuleVersionNumber For internal use only. Commoncore/EpisodeOfCare
UTCConversionTimeZoneCode Time zone code that was in use when the record was created. Commoncore/EpisodeOfCare
versionNumber Version Number Commoncore/EpisodeOfCare
careManagerId The practitioner that is the care manager/care coordinator for this patient. Commoncore/EpisodeOfCare
description The name of the custom entity. Commoncore/EpisodeOfCare
endDateTime The interval during which the managing organization assumes the defined responsibility. Commoncore/EpisodeOfCare
episodeOfCareId Unique identifier for entity instances Commoncore/EpisodeOfCare
identifier The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes. Commoncore/EpisodeOfCare
organizationId The organization that has assumed the specific responsibilities for the specified duration. Commoncore/EpisodeOfCare
patientId The patient who is the focus of this episode of care. Commoncore/EpisodeOfCare
startDateTime The interval during which the managing organization assumes the defined responsibility. Commoncore/EpisodeOfCare
status Current status of episode. Commoncore/EpisodeOfCare
status_display Commoncore/EpisodeOfCare
stateCode Status of the Episode of Care Commoncore/EpisodeOfCare
stateCode_display Commoncore/EpisodeOfCare
statusCode Reason for the status of the Episode of Care Commoncore/EpisodeOfCare
statusCode_display Commoncore/EpisodeOfCare

createdOn

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

Properties

NameValue
displayNameCreated On
descriptionDate and time when the record was created.
dataFormatdateTime
isNullabletrue
sourceNamecreatedon

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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated On
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time when the record was created.
entitya 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.

ParameterValueData typeExplanation
name"createdon"string

is.dataFormat.time
is.dataFormat.date

createdBy

Unique identifier of the user who created the record.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameCreated By
descriptionUnique identifier of the user who created the record.
dataFormatguid
isNullabletrue
sourceNamecreatedby

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

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated By
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShows who created the record.
enUnique identifier of the user who created the record.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya 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.

ParameterValueData typeExplanation
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/EpisodeOfCare (this entity)

Properties

NameValue
displayNameModified On
descriptionDate and time when the record was modified.
dataFormatdateTime
isNullabletrue
sourceNamemodifiedon

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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified On
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time when the record was modified.
entitya 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.

ParameterValueData typeExplanation
name"modifiedon"string

is.dataFormat.time
is.dataFormat.date

modifiedBy

Unique identifier of the user who modified the record.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameModified By
descriptionUnique identifier of the user who modified the record.
dataFormatguid
isNullabletrue
sourceNamemodifiedby

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

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified By
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShows who last updated the record.
enUnique identifier of the user who modified the record.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya 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.

ParameterValueData typeExplanation
name"modifiedby"string

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

createdOnBehalfBy

Unique identifier of the delegate user who created the record.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameCreated By (Delegate)
descriptionUnique identifier of the delegate user who created the record.
dataFormatguid
isNullabletrue
sourceNamecreatedonbehalfby

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

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated By (Delegate)
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShows who created the record on behalf of another user.
enUnique identifier of the delegate user who created the record.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya 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.

ParameterValueData typeExplanation
name"createdonbehalfby"string

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

modifiedOnBehalfBy

Unique identifier of the delegate user who modified the record.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameModified By (Delegate)
descriptionUnique identifier of the delegate user who modified the record.
dataFormatguid
isNullabletrue
sourceNamemodifiedonbehalfby

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

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified By (Delegate)
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enShows who last updated the record on behalf of another user.
enUnique identifier of the delegate user who modified the record.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya 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.

ParameterValueData typeExplanation
name"modifiedonbehalfby"string

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

overriddenCreatedOn

Date and time that the record was migrated.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameRecord Created On
descriptionDate and time that the record was migrated.
dataFormatdateTime
isNullabletrue
sourceNameoverriddencreatedon

Traits

List of traits for the overriddenCreatedOn attribute are listed below.

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

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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecord Created On
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time that the record was migrated.
entitya 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.

ParameterValueData typeExplanation
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/EpisodeOfCare (this entity)

Properties

NameValue
displayNameImport Sequence Number
descriptionUnique identifier of the data import or data migration that created this record.
dataFormatint32
maximumValue2147483647
minimumValue-2147483648
isNullabletrue
sourceNameimportsequencenumber

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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enImport Sequence Number
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the data import or data migration that created this record.
entitya 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.

ParameterValueData typeExplanation
name"importsequencenumber"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-2147483648"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

ownerId

Owner Id
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameOwner
descriptionOwner Id
dataFormatguid
sourceNameownerid

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

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwner
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwner Id
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/User.cdm.json/UsersystemUserId
/core/applicationCommon/Team.cdm.json/TeamteamId
entitya 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.

ParameterValueData typeExplanation
name"ownerid"string

is.CDS.owner
contains a User or Team ID

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

ownerIdType

The type of owner, either User or Team.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameOwner Type
descriptionThe type of owner, either User or Team.
dataFormatstring
isReadOnlytrue
sourceNameowneridtype

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

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwner Type
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe type of owner, either User or Team.
entitya 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.

ParameterValueData typeExplanation
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/EpisodeOfCare (this entity)

Properties

NameValue
displayNameOwning Business Unit
descriptionUnique identifier for the business unit that owns the record
dataFormatguid
isNullabletrue
sourceNameowningbusinessunit

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

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwning Business Unit
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier for the business unit that owns the record
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/BusinessUnit.cdm.json/BusinessUnitbusinessUnitId
entitya 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.

ParameterValueData typeExplanation
name"owningbusinessunit"string

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

owningUser

Unique identifier for the user that owns the record.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameOwning User
descriptionUnique identifier for the user that owns the record.
dataFormatguid
isNullabletrue
sourceNameowninguser

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

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwning User
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier for the user that owns the record.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya 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.

ParameterValueData typeExplanation
name"owninguser"string

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

owningTeam

Unique identifier for the team that owns the record.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameOwning Team
descriptionUnique identifier for the team that owns the record.
dataFormatguid
isNullabletrue
sourceNameowningteam

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

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOwning Team
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier for the team that owns the record.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/Team.cdm.json/TeamteamId
entitya 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.

ParameterValueData typeExplanation
name"owningteam"string

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

timeZoneRuleVersionNumber

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

Properties

NameValue
displayNameTime Zone Rule Version Number
descriptionFor internal use only.
dataFormatint32
maximumValue2147483647
minimumValue-1
isNullabletrue
sourceNametimezoneruleversionnumber

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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTime Zone Rule Version Number
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFor internal use only.
entitya 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.

ParameterValueData typeExplanation
name"timezoneruleversionnumber"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
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/EpisodeOfCare (this entity)

Properties

NameValue
displayNameUTC Conversion Time Zone Code
descriptionTime zone code that was in use when the record was created.
dataFormatint32
maximumValue2147483647
minimumValue-1
isNullabletrue
sourceNameutcconversiontimezonecode

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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUTC Conversion Time Zone Code
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTime zone code that was in use when the record was created.
entitya 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.

ParameterValueData typeExplanation
name"utcconversiontimezonecode"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-1"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

versionNumber

Version Number
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameVersion Number
descriptionVersion Number
dataFormatint64
isNullabletrue
sourceNameversionnumber

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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enVersion Number
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enVersion Number
entitya 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.

ParameterValueData typeExplanation
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.

careManagerId

The practitioner that is the care manager/care coordinator for this patient.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameCare Manager
descriptionThe practitioner that is the care manager/care coordinator for this patient.
dataFormatguid
isNullabletrue
sourceNamemsemr_caremanager

Traits

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

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCare Manager
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe practitioner that is the care manager/care coordinator for this patient.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/Contact.cdm.json/ContactcontactId
entitya 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.

ParameterValueData typeExplanation
name"msemr_caremanager"string

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

description

The name of the custom entity.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameDescription
descriptionThe name of the custom entity.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsemr_description

Traits

List of traits for the description attribute are listed below.

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

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

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

ParameterValueData typeExplanation
name"msemr_description"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDescription
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe name of the custom entity.
entitya reference to the constant entity holding the list of localized text

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

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

endDateTime

The interval during which the managing organization assumes the defined responsibility.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameEnd Date/Time
descriptionThe interval during which the managing organization assumes the defined responsibility.
dataFormatdateTime
isNullabletrue
sourceNamemsemr_enddatetime

Traits

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

ParameterValueData typeExplanation
name"msemr_enddatetime"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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEnd Date/Time
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe interval during which the managing organization assumes the defined responsibility.
entitya 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

episodeOfCareId

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

Properties

NameValue
displayNameEpisode of Care
descriptionUnique identifier for entity instances
isPrimaryKeytrue
dataFormatguid
sourceNamemsemr_episodeofcareid

Traits

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

ParameterValueData typeExplanation
attributeEpisodeOfCare/(resolvedAttributes)/episodeOfCareIdattribute

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

ParameterValueData typeExplanation
name"msemr_episodeofcareid"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

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEpisode of Care
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier for entity instances
entitya reference to the constant entity holding the list of localized text

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

identifier

The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameEpisode Of Care Number
descriptionThe EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsemr_identifier

Traits

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

ParameterValueData typeExplanation
name"msemr_identifier"string

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEpisode Of Care Number
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.
entitya reference to the constant entity holding the list of localized text

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

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

organizationId

The organization that has assumed the specific responsibilities for the specified duration.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameOrganization
descriptionThe organization that has assumed the specific responsibilities for the specified duration.
dataFormatguid
isNullabletrue
sourceNamemsemr_organization

Traits

List of traits for the organizationId attribute are listed below.

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

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

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

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOrganization
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe organization that has assumed the specific responsibilities for the specified duration.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/Account.cdm.json/AccountaccountId
entitya 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.

ParameterValueData typeExplanation
name"msemr_organization"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

patientId

The patient who is the focus of this episode of care.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNamePatient
descriptionThe patient who is the focus of this episode of care.
dataFormatguid
isNullabletrue
sourceNamemsemr_patient

Traits

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

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPatient
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe patient who is the focus of this episode of care.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/Contact.cdm.json/ContactcontactId
entitya 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.

ParameterValueData typeExplanation
name"msemr_patient"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

startDateTime

The interval during which the managing organization assumes the defined responsibility.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameStart Date/Time
descriptionThe interval during which the managing organization assumes the defined responsibility.
dataFormatdateTime
isNullabletrue
sourceNamemsemr_startdatetime

Traits

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

ParameterValueData typeExplanation
name"msemr_startdatetime"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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStart Date/Time
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe interval during which the managing organization assumes the defined responsibility.
entitya 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

status

Current status of episode.
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameStatus
descriptionCurrent status of episode.
dataFormatint32
isNullabletrue
sourceNamemsemr_status
valueConstrainedToListtrue
defaultValue

Traits

List of traits for the status attribute are listed below.

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

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enPlanned935000000
enWaitlist935000001
enActive935000002
enOn Hold935000003
enFinished935000004
enCancelled935000005
enEntered in Error935000006
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.

ParameterValueData typeExplanation
name"msemr_status"string

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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStatus
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCurrent status of episode.
entitya reference to the constant entity holding the list of localized text

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

is.dataFormat.integer

status_display

First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue
isNullabletrue

Traits

List of traits for the status_display attribute are listed below.

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

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

means.reference.displayText
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"status"attributeNameoutput parameter naming the attribute that is being supported

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

stateCode

Status of the Episode of Care
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameStatus
descriptionStatus of the Episode of Care
dataFormatint32
sourceNamestatecode
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enActive0
enInactive1

Traits

List of traits for the stateCode attribute are listed below.

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

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enActive0
enInactive1
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.

ParameterValueData typeExplanation
attributeEpisodeOfCare/(resolvedAttributes)/stateCodeattribute

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

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStatus
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStatus of the Episode of Care
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

stateCode_display

First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

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

ParameterValueData typeExplanation
inSupportOf"stateCode"attributeNameoutput parameter naming the attribute that is being supported

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

statusCode

Reason for the status of the Episode of Care
First included in: Commoncore/EpisodeOfCare (this entity)

Properties

NameValue
displayNameStatus Reason
descriptionReason for the status of the Episode of Care
dataFormatint32
isNullabletrue
sourceNamestatuscode
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValuecorrelatedValue
enActive10
enInactive21

Traits

List of traits for the statusCode attribute are listed below.

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

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValuecorrelatedValue
enActive10
enInactive21
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

ParameterValueData typeExplanation
sourceAttribute"stateCode"attributeName

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

ParameterValueData typeExplanation
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

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStatus Reason
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enReason for the status of the Episode of Care
entitya 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/EpisodeOfCare (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue
isNullabletrue

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

ParameterValueData typeExplanation
inSupportOf"statusCode"attributeNameoutput parameter naming the attribute that is being supported

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