Referral Request in Commoncore

Artículo
02/22/2022

Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.

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 /ReferralRequest.cdm.json/ReferralRequest /hasAttributes/attributesAddedAtThisScope

entity

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

Parameter	Value	Data type	Explanation
attribute	ReferralRequest/(resolvedAttributes)/referralRequestId	attribute

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

Parameter	Value	Data type	Explanation
attribute	ReferralRequest/(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	Referral Request

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	Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.

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

Attributes

Name	Description	First Included in Instance
createdOn	Date and time when the record was created.	Commoncore/ReferralRequest
createdBy	Unique identifier of the user who created the record.	Commoncore/ReferralRequest
modifiedOn	Date and time when the record was modified.	Commoncore/ReferralRequest
modifiedBy	Unique identifier of the user who modified the record.	Commoncore/ReferralRequest
createdOnBehalfBy	Unique identifier of the delegate user who created the record.	Commoncore/ReferralRequest
modifiedOnBehalfBy	Unique identifier of the delegate user who modified the record.	Commoncore/ReferralRequest
overriddenCreatedOn	Date and time that the record was migrated.	Commoncore/ReferralRequest
importSequenceNumber	Sequence number of the import that created this record.	Commoncore/ReferralRequest
ownerId	Owner Id	Commoncore/ReferralRequest
ownerIdType	The type of owner, either User or Team.	Commoncore/ReferralRequest
owningBusinessUnit	Unique identifier for the business unit that owns the record	Commoncore/ReferralRequest
owningUser	Unique identifier for the user that owns the record.	Commoncore/ReferralRequest
owningTeam	Unique identifier for the team that owns the record.	Commoncore/ReferralRequest
timeZoneRuleVersionNumber	For internal use only.	Commoncore/ReferralRequest
UTCConversionTimeZoneCode	Time zone code that was in use when the record was created.	Commoncore/ReferralRequest
versionNumber	Version Number	Commoncore/ReferralRequest
appointmentEMRId		Commoncore/ReferralRequest
authoredOn	Date/DateTime of creation for draft requests and date of activation for active requests.	Commoncore/ReferralRequest
basedOnReferralId		Commoncore/ReferralRequest
contextType	The encounter at which the request for referral or transfer of care is initiated.	Commoncore/ReferralRequest
contextType_display		Commoncore/ReferralRequest
description	The reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.	Commoncore/ReferralRequest
groupIdentifier	The business identifier of the logical ""grouping"" request/order that this referral is a part of.	Commoncore/ReferralRequest
initiatingEncounterId		Commoncore/ReferralRequest
initiatingEpisodeOfCareId		Commoncore/ReferralRequest
intent	Distinguishes the "level" of authorization/demand implicit in this request.	Commoncore/ReferralRequest
intent_display		Commoncore/ReferralRequest
name	The name of the custom entity.	Commoncore/ReferralRequest
occurencePeriodEndDate	End time with inclusive boundary, if not ongoing.	Commoncore/ReferralRequest
occurencePeriodStartDate	Starting time with inclusive boundary.	Commoncore/ReferralRequest
occurrenceDate	The period of time within which the services identified in the referral/transfer of care is specified or required to occur.	Commoncore/ReferralRequest
occurrenceType	The type of the period of time within which the services identified in the referral/transfer of care is specified or required to occur.	Commoncore/ReferralRequest
occurrenceType_display		Commoncore/ReferralRequest
practitionerSpecialtyId	Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.	Commoncore/ReferralRequest
priority	An indication of the urgency of referral (or where applicable the type of transfer of care) request.	Commoncore/ReferralRequest
priority_display		Commoncore/ReferralRequest
referralRequestId	Unique identifier for entity instances	Commoncore/ReferralRequest
referralRequestNumber	Business identifier that uniquely identifies the referral/care transfer request instance.	Commoncore/ReferralRequest
requesterAgent	The device, practitioner, etc. who initiated the request.	Commoncore/ReferralRequest
requesterAgent_display		Commoncore/ReferralRequest
requesterAgentDeviceId	This resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity.	Commoncore/ReferralRequest
requesterAgentOrganizationId	A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments.	Commoncore/ReferralRequest
requesterAgentPatientId	Demographics and other administrative information about an individual or animal receiving care or other health-related services.	Commoncore/ReferralRequest
requesterAgentPractitionerId	A person who is directly or indirectly involved in the provisioning of healthcare.	Commoncore/ReferralRequest
requesterAgentRelatedPersonId	Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.	Commoncore/ReferralRequest
requesterOnBehalfOfId	This resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity.	Commoncore/ReferralRequest
requestorId	Unique identifier of the requestor for the item.	Commoncore/ReferralRequest
type		Commoncore/ReferralRequest
status	The status of the authorization/intention reflected by the referral request record.	Commoncore/ReferralRequest
status_display		Commoncore/ReferralRequest
subject	The patient who is the subject of a referral or transfer of care request.	Commoncore/ReferralRequest
subject_display		Commoncore/ReferralRequest
subjectContextEncounterId	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.	Commoncore/ReferralRequest
subjectContextEpisodeOfCareId	An association between a patient and an organization / healthcare provider(s) during which time encounters may occur.	Commoncore/ReferralRequest
subjectGroupId	Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized.	Commoncore/ReferralRequest
subjectPatientId	The patient who is the subject of a referral or transfer of care request.	Commoncore/ReferralRequest
typeId	An indication of the type of referral (or where applicable the type of transfer of care) request.	Commoncore/ReferralRequest
stateCode	Status of the Referral Request	Commoncore/ReferralRequest
stateCode_display		Commoncore/ReferralRequest
statusCode	Reason for the status of the Referral Request	Commoncore/ReferralRequest
statusCode_display		Commoncore/ReferralRequest

createdOn

Date and time when the record was created.
First included in: Commoncore/ReferralRequest (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/ReferralRequest (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/ReferralRequest (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/ReferralRequest (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/ReferralRequest (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/ReferralRequest (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/ReferralRequest (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

Sequence number of the import that created this record.
First included in: Commoncore/ReferralRequest (this entity)

Properties

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

Traits

List of traits for the importSequenceNumber attribute are listed below.

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

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.
en	Sequence number of the import 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/ReferralRequest (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/ReferralRequest (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/ReferralRequest (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/ReferralRequest (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/ReferralRequest (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/ReferralRequest (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/ReferralRequest (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/ReferralRequest (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

First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Appointment (EMR)
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

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

authoredOn

Date/DateTime of creation for draft requests and date of activation for active requests.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Authored On
description	Date/DateTime of creation for draft requests and date of activation for active requests.
dataFormat	dateTime
isNullable	true
sourceName	msemr_authoredon

Traits

List of traits for the authoredOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

Parameter	Value	Data type	Explanation
name	"msemr_authoredon"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Authored 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/DateTime of creation for draft requests and date of activation for active requests.

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

basedOnReferralId

First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Based On (Referral)
dataFormat	guid
isNullable	true
sourceName	msemr_basedonreferral

Traits

List of traits for the basedOnReferralId 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	Based On (Referral)

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/ReferralRequest.cdm.json/ReferralRequest	referralRequestId

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

contextType

The encounter at which the request for referral or transfer of care is initiated.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name

Value

displayName

Referral Request Context

description

The encounter at which the request for referral or transfer of care is initiated.

dataFormat

int32

isNullable

true

sourceName

msemr_contexttype

valueConstrainedToList

true

defaultValue

languageTag	displayText	attributeValue
en	Encounter	935000000
en	Episode of Care	935000001

Traits

List of traits for the contextType attribute are listed below.

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

Parameter

Value

Data type

Explanation

default

languageTag	displayText	attributeValue
en	Encounter	935000000
en	Episode of Care	935000001

any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

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

Parameter	Value	Data type	Explanation
name	"msemr_contexttype"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Referral Request Context

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 encounter at which the request for referral or transfer of care is initiated.

entity

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

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

is.dataFormat.integer

contextType_display

First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the contextType_display attribute are listed below.

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

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

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

is.addedInSupportOf

Parameter	Value	Data type	Explanation
inSupportOf	"contextType"	attributeName	output parameter naming the attribute that is being supported

description

The reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Description
description	The reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.
dataFormat	string
maximumLength	1000
isNullable	true
sourceName	msemr_description

Traits

List of traits for the description attribute are listed below.

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

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

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

Parameter	Value	Data type	Explanation
name	"msemr_description"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"1000"	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	Description

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 reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.

entity

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

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

groupIdentifier

The business identifier of the logical ""grouping"" request/order that this referral is a part of.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Group Identifier
description	The business identifier of the logical ""grouping"" request/order that this referral is a part of.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_groupidentifier

Traits

List of traits for the groupIdentifier attribute are listed below.

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

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

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

Parameter	Value	Data type	Explanation
name	"msemr_groupidentifier"	string

is.constrained
maximum length or value constraints

Parameter	Value	Data type	Explanation
maximumLength	"100"	integer

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Group Identifier

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 business identifier of the logical ""grouping"" request/order that this referral is a part of.

entity

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

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

initiatingEncounterId

First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Initiating Encounter
dataFormat	guid
isNullable	true
sourceName	msemr_initiatingencounter

Traits

List of traits for the initiatingEncounterId 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	Initiating 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_initiatingencounter"	string

initiatingEpisodeOfCareId

First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Initiating Episode of Care
dataFormat	guid
isNullable	true
sourceName	msemr_initiatingepisodeofcare

Traits

List of traits for the initiatingEpisodeOfCareId 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	Initiating 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_initiatingepisodeofcare"	string

intent

Distinguishes the "level" of authorization/demand implicit in this request.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name

Value

displayName

Referral Request Intent

description

Distinguishes the "level" of authorization/demand implicit in this request.

dataFormat

int32

isNullable

true

sourceName

msemr_intent

valueConstrainedToList

true

defaultValue

Traits

List of traits for the intent 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	Proposal	935000000
en	Plan	935000001
en	Order	935000002

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_intent"	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	Referral Request Intent

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	Distinguishes the "level" of authorization/demand implicit in this request.

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

intent_display

First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

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

name

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

occurencePeriodEndDate

End time with inclusive boundary, if not ongoing.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Occurrence End Date
description	End time with inclusive boundary, if not ongoing.
dataFormat	dateTime
isNullable	true
sourceName	msemr_occurenceperiodenddate

Traits

List of traits for the occurencePeriodEndDate 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_occurenceperiodenddate"	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	Occurrence End Date

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	End time with inclusive boundary, if not ongoing.

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

occurencePeriodStartDate

Starting time with inclusive boundary.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Occurrence Start Date
description	Starting time with inclusive boundary.
dataFormat	dateTime
isNullable	true
sourceName	msemr_occurenceperiodstartdate

Traits

List of traits for the occurencePeriodStartDate 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_occurenceperiodstartdate"	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	Occurrence Start Date

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	Starting time with inclusive boundary.

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

occurrenceDate

The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Occurrence Date
description	The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
dataFormat	dateTime
isNullable	true
sourceName	msemr_occurrencedate

Traits

List of traits for the occurrenceDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

Parameter	Value	Data type	Explanation
name	"msemr_occurrencedate"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Occurrence Date

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 period of time within which the services identified in the referral/transfer of care is specified or required to occur.

entity

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

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

is.dataFormat.time
is.dataFormat.date

occurrenceType

The type of the period of time within which the services identified in the referral/transfer of care is specified or required to occur.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name

Value

displayName

Occurrence Type

description

The type of the period of time within which the services identified in the referral/transfer of care is specified or required to occur.

dataFormat

int32

isNullable

true

sourceName

msemr_occurrencetype

valueConstrainedToList

true

defaultValue

languageTag	displayText	attributeValue
en	Date	935000000
en	Period	935000001

Traits

List of traits for the occurrenceType attribute are listed below.

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

Parameter

Value

Data type

Explanation

default

languageTag	displayText	attributeValue
en	Date	935000000
en	Period	935000001

any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

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

Parameter	Value	Data type	Explanation
name	"msemr_occurrencetype"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Occurrence 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 the period of time within which the services identified in the referral/transfer of care is specified or required to occur.

entity

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

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

is.dataFormat.integer

occurrenceType_display

First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the occurrenceType_display attribute are listed below.

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

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

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

is.addedInSupportOf

Parameter	Value	Data type	Explanation
inSupportOf	"occurrenceType"	attributeName	output parameter naming the attribute that is being supported

practitionerSpecialtyId

Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Practitioner Specialty
description	Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
dataFormat	guid
isNullable	true
sourceName	msemr_practitionerspecialty

Traits

List of traits for the practitionerSpecialtyId 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	Practitioner Specialty

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	Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.

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

priority

An indication of the urgency of referral (or where applicable the type of transfer of care) request.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name

Value

displayName

Referral Request Priority

description

An indication of the urgency of referral (or where applicable the type of transfer of care) request.

dataFormat

int32

isNullable

true

sourceName

msemr_priority

valueConstrainedToList

true

defaultValue

languageTag	displayText	attributeValue
en	Routine	935000000
en	Urgent	935000001
en	Stat	935000003
en	Asap	935000002

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	Routine	935000000
en	Urgent	935000001
en	Stat	935000003
en	Asap	935000002

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	Referral Request 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	An indication of the urgency of referral (or where applicable the type of transfer of care) request.

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

referralRequestId

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

Properties

Name	Value
displayName	Referral Request
description	Unique identifier for entity instances
isPrimaryKey	true
dataFormat	guid
sourceName	msemr_referralrequestid

Traits

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

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

Parameter	Value	Data type	Explanation
name	"msemr_referralrequestid"	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	Referral Request

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

referralRequestNumber

Business identifier that uniquely identifies the referral/care transfer request instance.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Referral Request Number
description	Business identifier that uniquely identifies the referral/care transfer request instance.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msemr_referralrequestnumber

Traits

List of traits for the referralRequestNumber 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_referralrequestnumber"	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	Referral Request 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	Business identifier that uniquely identifies the referral/care transfer request instance.

entity

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

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

requesterAgent

The device, practitioner, etc. who initiated the request.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name

Value

displayName

Requester Agent

description

The device, practitioner, etc. who initiated the request.

dataFormat

int32

isNullable

true

sourceName

msemr_requesteragent

valueConstrainedToList

true

defaultValue

languageTag	displayText	attributeValue
en	Practitioner	935000000
en	Organization	935000001
en	Patient	935000002
en	Related Person	935000003
en	Device	935000004

Traits

List of traits for the requesterAgent 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	Practitioner	935000000
en	Organization	935000001
en	Patient	935000002
en	Related Person	935000003
en	Device	935000004

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_requesteragent"	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	Requester Agent

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 device, practitioner, etc. who initiated the request.

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

requesterAgent_display

First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

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

requesterAgentDeviceId

This resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Device
description	This resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity.
dataFormat	guid
isNullable	true
sourceName	msemr_requesteragentdevice

Traits

List of traits for the requesterAgentDeviceId attribute are listed below.

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

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

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Device

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	This resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity.

entity

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

Parameter

Value

Data type

Explanation

entityReferences

entityReference	attributeReference
/Healthcare/Foundational/Commoncore/Device.cdm.json/Device	deviceId

entity

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

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

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

Parameter	Value	Data type	Explanation
name	"msemr_requesteragentdevice"	string

requesterAgentOrganizationId

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Organization
description	A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments.
dataFormat	guid
isNullable	true
sourceName	msemr_requesteragentorganization

Traits

List of traits for the requesterAgentOrganizationId attribute are listed below.

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

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

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Organization

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 formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments.

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

requesterAgentPatientId

Demographics and other administrative information about an individual or animal receiving care or other health-related services.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Patient
description	Demographics and other administrative information about an individual or animal receiving care or other health-related services.
dataFormat	guid
isNullable	true
sourceName	msemr_requesteragentpatient

Traits

List of traits for the requesterAgentPatientId attribute are listed below.

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

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

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

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	Demographics and other administrative information about an individual or animal receiving care or other health-related services.

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

requesterAgentPractitionerId

A person who is directly or indirectly involved in the provisioning of healthcare.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Practitioner
description	A person who is directly or indirectly involved in the provisioning of healthcare.
dataFormat	guid
isNullable	true
sourceName	msemr_requesteragentpractitioner

Traits

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

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 person who is directly or indirectly involved in the provisioning of healthcare.

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

requesterAgentRelatedPersonId

Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Related Person
description	Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
dataFormat	guid
isNullable	true
sourceName	msemr_requesteragentrelatedperson

Traits

List of traits for the requesterAgentRelatedPersonId attribute are listed below.

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

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

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Related Person

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	Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

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

requesterOnBehalfOfId

Properties

Name	Value
displayName	Requester on behalf of
description	This resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity.
dataFormat	guid
isNullable	true
sourceName	msemr_requesteronbehalfof

Traits

List of traits for the requesterOnBehalfOfId attribute are listed below.

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

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

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Requester 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	This resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity.

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

requestorId

Unique identifier of the requestor for the item.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Requestor
description	Unique identifier of the requestor for the item.
dataFormat	guid
isNullable	true
sourceName	msemr_requestor

Traits

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

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 requestor for the item.

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
/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_requestor"	string

type

First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
dataFormat	string

Traits

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

status

The status of the authorization/intention reflected by the referral request record.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name

Value

displayName

Referral Request Status

description

The status of the authorization/intention reflected by the referral request record.

dataFormat

int32

isNullable

true

sourceName

msemr_status

valueConstrainedToList

true

defaultValue

languageTag	displayText	attributeValue
en	Draft	935000000
en	Active	935000001
en	Suspended	935000002
en	Cancelled	935000003
en	Completed	935000004
en	Entered-In-Error	935000005
en	Unknown	935000006

Traits

List of traits for the status attribute are listed below.

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

Parameter

Value

Data type

Explanation

default

languageTag	displayText	attributeValue
en	Draft	935000000
en	Active	935000001
en	Suspended	935000002
en	Cancelled	935000003
en	Completed	935000004
en	Entered-In-Error	935000005
en	Unknown	935000006

any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

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

Parameter	Value	Data type	Explanation
name	"msemr_status"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Referral Request 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	The status of the authorization/intention reflected by the referral request 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.dataFormat.integer

status_display

First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the status_display attribute are listed below.

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

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

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

is.addedInSupportOf

Parameter	Value	Data type	Explanation
inSupportOf	"status"	attributeName	output parameter naming the attribute that is being supported

subject

The patient who is the subject of a referral or transfer of care request.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name

Value

displayName

Referral Request Subject

description

The patient who is the subject of a referral or transfer of care request.

dataFormat

int32

isNullable

true

sourceName

msemr_subject

valueConstrainedToList

true

defaultValue

languageTag	displayText	attributeValue
en	Patient	935000000
en	Group	935000001

Traits

List of traits for the subject 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	Patient	935000000
en	Group	935000001

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_subject"	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	Referral Request Subject

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 who is the subject of a referral or transfer of care request.

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

subject_display

First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

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

subjectContextEncounterId

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.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Encounter
description	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.
dataFormat	guid
isNullable	true
sourceName	msemr_subjectcontextencounter

Traits

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

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

subjectContextEpisodeOfCareId

An association between a patient and an organization / healthcare provider(s) during which time encounters may occur.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Episode of Care
description	An association between a patient and an organization / healthcare provider(s) during which time encounters may occur.
dataFormat	guid
isNullable	true
sourceName	msemr_subjectcontextepisodeofcare

Traits

List of traits for the subjectContextEpisodeOfCareId 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	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	An association between a patient and an organization / healthcare provider(s) during which time encounters may occur.

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

subjectGroupId

Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Subject (Group)
description	Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized.
dataFormat	guid
isNullable	true
sourceName	msemr_subjectgroup

Traits

List of traits for the subjectGroupId attribute are listed below.

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

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

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Subject (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	Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized.

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

subjectPatientId

The patient who is the subject of a referral or transfer of care request.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Subject (Patient)
description	The patient who is the subject of a referral or transfer of care request.
dataFormat	guid
isNullable	true
sourceName	msemr_subjectpatient

Traits

List of traits for the subjectPatientId attribute are listed below.

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

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

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

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 who is the subject of a referral or transfer of care request.

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

typeId

An indication of the type of referral (or where applicable the type of transfer of care) request.
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name	Value
displayName	Referral Request Type
description	An indication of the type of referral (or where applicable the type of transfer of care) request.
dataFormat	guid
isNullable	true
sourceName	msemr_type

Traits

List of traits for the typeId attribute are listed below.

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

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

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

Parameter	Value	Data type	Explanation
style	"single"	string

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

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

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

Parameter

Value

Data type

Explanation

localizedDisplayText

languageTag	displayText
en	Referral Request 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	An indication of the type of referral (or where applicable the type of transfer of care) request.

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

stateCode

Status of the Referral Request
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name

Value

displayName

Status

description

Status of the Referral Request

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	ReferralRequest/(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 Referral Request

entity

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

is.dataFormat.integer

stateCode_display

First included in: Commoncore/ReferralRequest (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 Referral Request
First included in: Commoncore/ReferralRequest (this entity)

Properties

Name

Value

displayName

Referral Request Status

description

Reason for the status of the Referral Request

dataFormat

int32

isNullable

true

sourceName

statuscode

valueConstrainedToList

true

defaultValue

languageTag	displayText	attributeValue	correlatedValue
en	Proposal	1	0
en	Plan	935000000	0
en	Original Order	935000001	0
en	Reflex Order	935000002	0
en	Instance Order	935000003	0
en	Option	935000004	0
en	Inactive	2	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	Proposal	1	0
en	Plan	935000000	0
en	Original Order	935000001	0
en	Reflex Order	935000002	0
en	Instance Order	935000003	0
en	Option	935000004	0
en	Inactive	2	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	Referral Request 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	Reason for the status of the Referral Request

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

Compartir a través de

Referral Request 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