A Codeable Concept represents a value that is usually supplied by providing a reference to one or more terminologies, but may also be defined by the provision of text.
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
"2.1"
string
semantic version number of the entity
is.identifiedBy
names a specifc identity attribute to use with an entity
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Codeable Concept
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 Codeable Concept represents a value that is usually supplied by providing a reference to one or more terminologies, but may also be defined by the provision of text.
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.
Type of: Code-ableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies, but may also be defined by the provision of text.
Unique identifier of the user who created the record.
First included in: electronicMedicalRecords/CodeableConcept (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/CodeableConcept (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/CodeableConcept (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.
First included in: electronicMedicalRecords/CodeableConcept (this entity)
Properties
Name
Value
displayName
Entity Image
dataFormat
binary
maximumLength
9437328
isNullable
true
sourceName
entityimage
Traits
List of traits for the entityImage attribute are listed below.
is.dataFormat.byte is.dataFormat.array means.content.binary.image is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"entityimage"
string
is.constrained
maximum length or value constraints
Parameter
Value
Data type
Explanation
maximumLength
"9437328"
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
Entity Image
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
is.nullable
The attribute value may be set to NULL.
Sequence number of the import that created this record.
First included in: electronicMedicalRecords/CodeableConcept (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/CodeableConcept (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/CodeableConcept (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/CodeableConcept (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.
Code defined by a terminology system.
First included in: electronicMedicalRecords/CodeableConcept (this entity)
Properties
Name
Value
displayName
Code
description
Code defined by a terminology system.
dataFormat
string
maximumLength
100
sourceName
msemr_code
Traits
List of traits for the code 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_code"
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
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
Code defined by a terminology system.
entity
a reference to the constant entity holding the list of localized text
Unique identifier for entity instances
First included in: electronicMedicalRecords/CodeableConcept (this entity)
Properties
Name
Value
displayName
Codeable Concept
description
Unique identifier for entity instances
isPrimaryKey
true
dataFormat
guid
sourceName
msemr_codeableconceptid
Traits
List of traits for the codeableConceptId 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_codeableconceptid"
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
Codeable Concept
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
The name of the custom entity.
First included in: electronicMedicalRecords/CodeableConcept (this entity)
Properties
Name
Value
displayName
Name
description
The name of the custom entity.
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
The name of the custom entity.
entity
a reference to the constant entity holding the list of localized text
Plain text representation of the concept.
First included in: electronicMedicalRecords/CodeableConcept (this entity)
Properties
Name
Value
displayName
Text
description
Plain text representation of the concept.
dataFormat
string
maximumLength
2000
isNullable
true
sourceName
msemr_text
Traits
List of traits for the text 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_text"
string
is.constrained
maximum length or value constraints
Parameter
Value
Data type
Explanation
maximumLength
"2000"
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
Text
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
Plain text representation of the concept.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
Type of: Code-ableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies, but may also be defined by the provision of text.
First included in: electronicMedicalRecords/CodeableConcept (this entity)
Properties
Name
Value
displayName
Type
description
Type of: Code-ableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies, but may also be defined by the provision of text.
dataFormat
int32
isNullable
true
sourceName
msemr_type
valueConstrainedToList
true
defaultValue
Traits
List of traits for the type 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
Action Participant Role
935000000
en
Action Reason
935000001
en
Activity Reason
935000002
en
Additional Dosage Instruction
935000003
en
Additive Code
935000004
en
Administration Method Code
935000005
en
Administration Site Code
935000006
en
Admit Source
935000007
en
Allergy Intolerance
935000008
en
Animal Breed
935000009
en
Animal Gender
935000010
en
Animal Species
935000011
en
As Needed Reason Code
935000012
en
Body Structure
100000000
en
Care Plan Activity
935000013
en
Care Plan Activity Category
935000014
en
Care Plan Activity Outcome
935000015
en
Care Plan Category
935000016
en
Care Team Category
935000017
en
Clinical Finding
935000018
en
Clinical Impression Code
935000019
en
Clinical Impression Prognosis
935000020
en
Communication Category
935000021
en
Condition Category Code
935000022
en
Condition Code
935000023
en
Condition Outcome Code
935000024
en
Condition Severity
935000025
en
Condition Stage
935000026
en
Contact Entity Type
935000027
en
Contact Role
935000028
en
Data Requirement Code Filter Value Code
935000029
en
Definition Topic
935000030
en
Detected Issue
935000031
en
Device Component Operational Status
935000032
en
Device Component Parameter Group
935000033
en
Device Metric Type
935000034
en
Device Safety
935000035
en
Device Specification Spec Type
935000036
en
Device Type
935000037
en
Diagnosis Role
935000038
en
Diagnostic Report
935000039
en
Diet
935000040
en
Diet Code
935000041
en
Discharge Disposition
935000042
en
Encounter Reason Code
935000043
en
Encounter Type
935000044
en
Endpoint Payload Type
935000045
en
Enteral Formula Additive Type Code
935000046
en
Enteral Formula Type Code
935000047
en
Enteral Route Code
935000048
en
Episode Of Care Type
935000049
en
Event History
935000050
en
Family History Not Done Reason
935000051
en
Family Member
935000053
en
FHIR Type
935000054
en
Financial Account
935000055
en
Fluid Consistency Type Code
935000056
en
Food Type Code
935000057
en
Form Code
935000058
en
Goal Category
935000059
en
Goal Priority
935000060
en
Goal Start Event
935000061
en
Goal Target Detail
935000062
en
Group
935000063
en
Imaging Study
935000064
en
Immunization Request
935000065
en
Investigation Type
935000066
en
Jurisdiction
935000067
en
Language
935000068
en
Library
935000070
en
Link Type
935000071
en
Location Type
935000072
en
LOINC Code
935000073
en
Medication Administration Category
935000074
en
Medication As Needed Reason Code
935000075
en
Medication Code
935000076
en
Medication Container
935000077
en
Medication Ingredient
935000078
en
Medication Package Content
935000079
en
Medication Request Category
935000080
en
Medication Statement
935000081
en
Nutrient Modifier Code
935000082
en
Observation Category Code
935000083
en
Observation Component Value
935000084
en
Observation Interpretation Code
935000085
en
Observation Method
935000086
en
Observation Reference Range Applies To Code
935000087
en
Observation Reference Range Meaning Code
935000088
en
Observation Value Absent Reason
935000089
en
Observation Value Code
935000090
en
Participant Role
935000091
en
Participant Type
935000092
en
Referral Type
935000069
en
Participation Mode
935000093
en
Patient Referral Type
935000094
en
Patient Relationship Type
935000095
en
Plan Definition Action Code
935000096
en
Plan Definition Action Reason
935000097
en
Plan Definition Goal Target
935000098
en
Practice Setting Code
935000099
en
Practitioner Role
935000100
en
Practitioner Specialty
935000101
en
Priority
935000102
en
Procedure Category Code
935000103
en
Procedure Code
935000104
en
Procedure Device Action Code
935000105
en
Procedure Follow up Code
935000106
en
Procedure Outcome Code
935000107
en
Procedure Performer Role Code
935000108
en
Procedure Reason Code
935000109
en
Provenance
935000110
en
Qualification Code
935000052
en
Quantity Unit Code
935000111
en
Questionnaire
935000112
en
Questionnaire Response
935000113
en
Re-Admission Indicator
935000114
en
Reason Medication Given Code
935000116
en
Reason Medication Not Given Code
935000117
en
Referral Method
935000118
en
Request Group Action Code
935000119
en
Request Group Reason Code
935000120
en
Request Intent
935000121
en
Resource Type
935000122
en
Risk Assessment Code
935000123
en
Risk Assessment Method
935000124
en
Risk Assessment Outcome
935000125
en
Risk Assessment Reason Code
935000126
en
Route Code
935000127
en
Sequence
935000128
en
Service Category
935000129
en
Service Characteristic
935000130
en
Service Delivery Location Role Type
935000131
en
Service Eligibility
935000132
en
Service Provision Condition
935000133
en
Service Type
935000134
en
Snomed CT Medication Codes
935000135
en
Special Arrangement
935000136
en
Special Courtesy
935000137
en
Specialty
935000138
en
Specimen Collection Method
935000139
en
Specimen Container
935000140
en
Specimen Processing Procedure
935000141
en
Specimen Type
935000142
en
Structure Map
935000143
en
Substance Admin Substitution Reason
935000144
en
Substance Category Code
935000145
en
Substance Code
935000146
en
Supplement Type Code
935000147
en
Symptom Code
935000148
en
Task Business Status
935000149
en
Task Code
935000150
en
Task Input Parameter Type
935000151
en
Task Output Parameter Type
935000152
en
Task Performer Type
935000153
en
Task Reason
935000154
en
Task Status Reason
935000155
en
Texture Modified Food Type Code
935000156
en
Texture Modifier Code
935000157
en
Topic
935000158
en
Use Context
935000159
en
Value Set
935000160
en
Vision Prescription Product Code
935000161
en
Vision Prescription Reason Code
935000162
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_type"
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
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
Type of: Code-ableConcept represents a value that is usually supplied by providing a reference to one or more terminologies or ontologies, but may also be defined by the provision of text.
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 the organization
First included in: electronicMedicalRecords/CodeableConcept (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/CodeableConcept (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 Codeable Concept
entity
a reference to the constant entity holding the list of localized text
Reason for the status of the Codeable Concept
First included in: electronicMedicalRecords/CodeableConcept (this entity)
Properties
Name
Value
displayName
Status Reason
description
Reason for the status of the Codeable Concept
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 Codeable Concept
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/CodeableConcept (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/CodeableConcept (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.