Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access
A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in available/ not available times.
Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.
Unique identifier of the user who created the record.
First included in: electronicMedicalRecords/HealthcareService (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 is.dataFormat.array 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
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
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.
Date and time when the record was created.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Created On
description
Date and time when the record was created.
dataFormat
dateTime
isNullable
true
sourceName
createdon
Traits
List of traits for the createdOn attribute are listed below.
is.dataFormat.date means.measurement.date is.dataFormat.time means.measurement.time means.measurement.date.creation is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"createdon"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
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.
Unique identifier of the delegate user who created the record.
First included in: electronicMedicalRecords/HealthcareService (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 is.dataFormat.array is.dataFormat.guid means.identity.entityId is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"createdonbehalfby"
string
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
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
Unique identifier of the delegate user who created the record.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
Sequence number of the import that created this record.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Import Sequence Number
description
Sequence number of the import that created this record.
dataFormat
int32
maximumValue
2147483647
minimumValue
-2147483648
isNullable
true
sourceName
importsequencenumber
Traits
List of traits for the importSequenceNumber attribute are listed below.
is.dataFormat.integer is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"importsequencenumber"
string
is.constrained
maximum length or value constraints
Parameter
Value
Data type
Explanation
minimumValue
"-2147483648"
decimal
maximumValue
"2147483647"
decimal
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
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
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.
Unique identifier of the user who modified the record.
First included in: electronicMedicalRecords/HealthcareService (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 is.dataFormat.array 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
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
Unique identifier of the user who modified 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.
Date and time when the record was modified.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Modified On
description
Date and time when the record was modified.
dataFormat
dateTime
isNullable
true
sourceName
modifiedon
Traits
List of traits for the modifiedOn attribute are listed below.
is.dataFormat.date means.measurement.date is.dataFormat.time means.measurement.time means.measurement.date.modify is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"modifiedon"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
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.
Unique identifier of the delegate user who modified the record.
First included in: electronicMedicalRecords/HealthcareService (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 is.dataFormat.array is.dataFormat.guid means.identity.entityId is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"modifiedonbehalfby"
string
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
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
Unique identifier of the delegate user who modified the record.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Appointment Required
description
Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access
dataFormat
boolean
isNullable
true
sourceName
msemr_appointmentrequired
Traits
List of traits for the appointmentRequired attribute are listed below.
is.dataFormat.boolean is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"msemr_appointmentrequired"
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 Required
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in available/ not available times.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Availability Exceptions
description
A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in available/ not available times.
dataFormat
string
maximumLength
100
isNullable
true
sourceName
msemr_availabilityexceptions
Traits
List of traits for the availabilityExceptions attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"msemr_availabilityexceptions"
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
Availability Exceptions
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 description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in available/ not available times.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
Identifies the broad category of service being performed or delivered.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Category
description
Identifies the broad category of service being performed or delivered.
dataFormat
guid
isNullable
true
sourceName
msemr_category
Traits
List of traits for the categoryId attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array 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
Category
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
Identifies the broad category of service being performed or delivered.
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.
Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Comment
description
Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.
dataFormat
string
maximumLength
100
isNullable
true
sourceName
msemr_comment
Traits
List of traits for the comment attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"msemr_comment"
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
Comment
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
Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
Does this service have specific eligibility requirements that need to be met in order to use the service?
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Eligibility
description
Does this service have specific eligibility requirements that need to be met in order to use the service?
dataFormat
guid
isNullable
true
sourceName
msemr_eligibility
Traits
List of traits for the eligibilityId attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array 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
Eligibility
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
Does this service have specific eligibility requirements that need to be met in order to use the service?
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.
Describes the eligibility conditions for the service.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Eligibility note
description
Describes the eligibility conditions for the service.
dataFormat
string
maximumLength
100
isNullable
true
sourceName
msemr_eligibilitynote
Traits
List of traits for the eligibilityNote attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"msemr_eligibilitynote"
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
Eligibility note
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
Describes the eligibility conditions for the service.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
Extra details about the service that can't be placed in the other fields.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Extra Details
description
Extra details about the service that can't be placed in the other fields.
dataFormat
string
maximumLength
100
isNullable
true
sourceName
msemr_extradetails
Traits
List of traits for the extraDetails attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"msemr_extradetails"
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
Extra Details
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
Extra details about the service that can't be placed in the other fields.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
The details of a healthcare service available at a location.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Healthcare Service
description
The details of a healthcare service available at a location.
dataFormat
string
maximumLength
100
isNullable
true
sourceName
msemr_healthcareservice
Traits
List of traits for the healthcareService attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"msemr_healthcareservice"
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
Healthcare Service
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 details of a healthcare service available at a location.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
Unique identifier for entity instances
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Healthcare Service
description
Unique identifier for entity instances
isPrimaryKey
true
dataFormat
guid
sourceName
msemr_healthcareserviceid
Traits
List of traits for the healthcareServiceId attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId is.identifiedBy
names a specifc identity attribute to use with an entity
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"msemr_healthcareserviceid"
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
Healthcare Service
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
Further description of the service as it would be presented to a consumer while searching.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Name
description
Further description of the service as it would be presented to a consumer while searching.
dataFormat
string
maximumLength
100
sourceName
msemr_name
Traits
List of traits for the name attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array 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
"required"
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
Further description of the service as it would be presented to a consumer while searching.
entity
a reference to the constant entity holding the list of localized text
The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Description
description
The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
dataFormat
string
maximumLength
100
isNullable
true
sourceName
msemr_notavailabledescription
Traits
List of traits for the notAvailableDescription attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"msemr_notavailabledescription"
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
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 closing time of day. Note: If the AllDay flag is set, then this time is ignored.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
End time with inclusive boundary, if not ongoing
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
End Datetime
description
End time with inclusive boundary, if not ongoing
dataFormat
dateTime
isNullable
true
sourceName
msemr_notavailableduringenddatetime
Traits
List of traits for the notAvailableDuringEndDateTime 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_notavailableduringenddatetime"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
End Datetime
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.
Starting time with inclusive boundary
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Start Datetime
description
Starting time with inclusive boundary
dataFormat
dateTime
isNullable
true
sourceName
msemr_notavailableduringstartdatetime
Traits
List of traits for the notAvailableDuringStartDateTime 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_notavailableduringstartdatetime"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Start Datetime
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.
The organization that provides this healthcare service.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Provided by
description
The organization that provides this healthcare service.
dataFormat
guid
isNullable
true
sourceName
msemr_providedby
Traits
List of traits for the providedById attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array 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
Provided 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
The organization that provides this healthcare service.
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.
Unique identifier for the organization
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Organization Id
description
Unique identifier for the organization
dataFormat
guid
isNullable
true
sourceName
organizationid
Traits
List of traits for the organizationId attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array 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 Id
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 organization
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.
Date and time that the record was migrated.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Record Created On
description
Date and time that the record was migrated.
dataFormat
dateTime
isNullable
true
sourceName
overriddencreatedon
Traits
List of traits for the overriddenCreatedOn attribute are listed below.
is.dataFormat.date means.measurement.date is.dataFormat.time means.measurement.time means.measurement.date.creation is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"overriddencreatedon"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
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
"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 Healthcare Service
entity
a reference to the constant entity holding the list of localized text
Reason for the status of the Healthcare Service
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Status Reason
description
Reason for the status of the Healthcare Service
dataFormat
int32
isNullable
true
sourceName
statuscode
defaultValue
languageTag
displayText
attributeValue
correlatedValue
en
Active
1
0
en
Inactive
2
1
Traits
List of traits for the statusCode attribute are listed below.
is.dataFormat.integer is.constrainedList.correlated
the values of an attribute are taken from or looked up from a fixed list of possibilities that represent correlated status
does.haveDefault
An attribute has a default value
Parameter
Value
Data type
Explanation
default
languageTag
displayText
attributeValue
correlatedValue
en
Active
1
0
en
Inactive
2
1
any
is.correlatedWith
the attribute value is correlated with the sourceAttribute
Parameter
Value
Data type
Explanation
sourceAttribute
"stateCode"
attributeName
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"statuscode"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Status Reason
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Reason for the status of the Healthcare Service
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
For internal use only.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
Time Zone Rule Version Number
description
For internal use only.
dataFormat
int32
maximumValue
2147483647
minimumValue
-1
isNullable
true
sourceName
timezoneruleversionnumber
Traits
List of traits for the timeZoneRuleVersionNumber attribute are listed below.
is.dataFormat.integer is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"timezoneruleversionnumber"
string
is.constrained
maximum length or value constraints
Parameter
Value
Data type
Explanation
minimumValue
"-1"
decimal
maximumValue
"2147483647"
decimal
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
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.
Time zone code that was in use when the record was created.
First included in: electronicMedicalRecords/HealthcareService (this entity)
Properties
Name
Value
displayName
UTC Conversion Time Zone Code
description
Time zone code that was in use when the record was created.
dataFormat
int32
maximumValue
2147483647
minimumValue
-1
isNullable
true
sourceName
utcconversiontimezonecode
Traits
List of traits for the UTCConversionTimeZoneCode attribute are listed below.
is.dataFormat.integer is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"utcconversiontimezonecode"
string
is.constrained
maximum length or value constraints
Parameter
Value
Data type
Explanation
minimumValue
"-1"
decimal
maximumValue
"2147483647"
decimal
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
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.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.