Base entity from which all Industry Data Model entities are derived.
Traits
Traits for this entity are listed here.
is.CDM.entityVersion
Parameter
Value
Data type
Explanation
versionNumber
"4.3"
string
semantic version number of the entity
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Base entity from which all Industry Data Model entities are derived.
en
The household role(s) performed by the household member during the indicated period.
entity
a reference to the constant entity holding the list of localized text
minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.
Parameter
Value
Data type
Explanation
versionNumber
"1.2.3"
string
is.IDM.modelVersion
Semantic version number of the IDM.
Parameter
Value
Data type
Explanation
versionNumber
"1.6.0"
string
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
Parameter
Value
Data type
Explanation
identifier
"{62804C68-AC94-4965-9F74-6475C1D87B3D}"
string
The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.
is.nativeTo.businessArea
The name of the business area from which the entity originates.
Parameter
Value
Data type
Explanation
name
"Party"
string
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Household Member Role
entity
a reference to the constant entity holding the list of localized text
has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides or restates parts of logical schemas to produce one resolved schema.
The unique identifier of a Household.
First included in: HouseholdMemberRole (this entity)
Properties
Name
Value
displayName
Household ID
description
The unique identifier of a Household.
isPrimaryKey
true
dataFormat
int64
Traits
List of traits for the HouseholdId attribute are listed here.
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.
is.identifiedBy
Names a specific identity attribute to use with an entity.
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.
a reference to the constant entity holding the list of entity references
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Household 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
The unique identifier of a Household.
entity
a reference to the constant entity holding the list of localized text
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
Parameter
Value
Data type
Explanation
identifier
"{7FB4224B-4E65-49CA-A3AE-9A5E80BD115E}"
string
The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.
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.
The unique identifier of a Party.
First included in: HouseholdMemberRole (this entity)
Properties
Name
Value
displayName
Household Member Party ID
description
The unique identifier of a Party.
isPrimaryKey
true
dataFormat
int64
Traits
List of traits for the HouseholdMemberPartyId attribute are listed here.
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.
is.identifiedBy
Names a specific identity attribute to use with an entity.
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.
a reference to the constant entity holding the list of entity references
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Household Member Party 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
The unique identifier of a Party.
entity
a reference to the constant entity holding the list of localized text
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
Parameter
Value
Data type
Explanation
identifier
"{01BF33CC-4F53-473B-96DC-47DABF85F473}"
string
The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.
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.
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.
a reference to the constant entity holding the list of entity references
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Household Member Period 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
The period start date for which the party is a member of the household.
entity
a reference to the constant entity holding the list of localized text
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
Parameter
Value
Data type
Explanation
identifier
"{10E4EAC1-816C-4AA8-8123-87F3C2E14857}"
string
The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.
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.
a reference to the constant entity holding the list of entity references
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Household Role 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
The unique identifier of a Household Role.
entity
a reference to the constant entity holding the list of localized text
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
Parameter
Value
Data type
Explanation
identifier
"{285B0077-AFE9-464C-B3B7-3AE79FE5E828}"
string
The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.
The period end date for which the party performs the indicated household member role.
First included in: HouseholdMemberRole (this entity)
Properties
Name
Value
displayName
Period End Date
description
The period end date for which the party performs the indicated household member role.
dataFormat
date
isNullable
true
Traits
List of traits for the PeriodEndDate attribute are listed here.
is.dataFormat.date means.measurement.date has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
Parameter
Value
Data type
Explanation
identifier
"{8A0D88D2-7925-4B93-A67D-80ADAE81AED4}"
string
The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Period End 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 end date for which the party performs the indicated household member role.
entity
a reference to the constant entity holding the list of localized text
A note, comment or additional information regarding the household member role.
First included in: HouseholdMemberRole (this entity)
Properties
Name
Value
displayName
Household Member Role Note
description
A note, comment or additional information regarding the household member role.
dataFormat
string
maximumLength
2048
isNullable
true
Traits
List of traits for the HouseholdMemberRoleNote attribute are listed here.
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 should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
Parameter
Value
Data type
Explanation
identifier
"{0E4751A4-6C9E-4360-8213-AEAC44F13363}"
string
The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Household Member Role 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
A note, comment or additional information regarding the household member role.
entity
a reference to the constant entity holding the list of localized text
is.constrained
Maximum length or value constraints.
Parameter
Value
Data type
Explanation
maximumLength
"2048"
integer
is.dataFormat.character is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.