Restricted reference types

Some reference types are required for Network MDM features; many are used for address cleansing.

These reference types are considered restricted because codes should not inactivated. Their use might not be apparent but they can be integral to how your data is processed.

Example

If the MERGED_INTO code for the RecordState reference type is inactivated, no records can be merged.

The merge instruction will fail, job errors will exist in the administrator inbox, and the records will not merge. This is because the losing record in a merge is assigned the MERGED_INTO code for the record state.

Important You can edit a reference type that isn't read-only; however, if it is considered restricted (see the lists below), adding and inactivating codes is not recommended.

Read-only reference types

Codes cannot be added or inactivated for read-only reference types.

The Import button on the Reference Codes page is dimmed to prevent users from editing the codes.

List of restricted types

Reference types that are not read-only can also be considered as restricted; codes should not be added, updated, or inactivated.

OpenData 1.0 and 2.0 data model schema

The following reference lists are restricted for OpenData 1.0 and 2.0 fields.

Reference Type Read-Only?
AcademicStatus
AddressCBSA
AddressDPVConfIndicator
AddressDPVFootnotes
AddressFootnotes  
AddressISO31663  
AddressISO3166n  
AddressRecordType  
AddressReturnCode  
AddressVerificationStatus  
BooleanReference  
CollabAgree
CompLicenseEligibility
CountRange
CtrlSubPrescriptive
CtrlSubSampling
DataRemovalReason
EntityType  
HCOHierarchyType
HCOOwnership
HCPGender
HCPStatusReason
IdentifierPriority
IssuerName
KeyStatus
LicenseCertification
LicenseDEACode
LicenseDEAPaymentIndicator
LicenseEligibility
LicenseNameLocal
LicenseStatusCondition
LicenseSubType
ObjectCategoryType
ParentAddressSyncReference  
RecordOwnerType  
RecordState  
RelationStatus
SpecialtyLocal
ThirdPartySystemOwner  

Restricted Common Data Architecture (CDA) reference types

All restricted CDA reference type are read-only.

Reference Type Field Object
AddressCountryCDA country_cda__v HCP, HCO, Address
AddressStateCDA state_cda__v HCP, HCO, Address
AdopterTypeCDA adopter_type_cda__v HCP
AgeRangeCDA age_range_cda__v HCP
HCPSpecialtyCDA all_spec_cda__v HCP
HCPSpecialtyGroupCDA all_spec_group_cda__v HCP
LanguageCDA language_cda__v HCP
LevelCDA level_cda__v HCP
StatusCDA status_cda__v HCP, HCO, Address

For more information, see Reference types for CDA fields.