Move code elements to code namespaces

[cdmgtri]

NIEM currently only locates code types in code namespaces. The Harmonization Workgroup recommends moving code elements to the code namespaces as well.

Pros:

• This would reduce the size of Core.
• This would help NIEM to scale better as more code sets are added.
• Moving code elements out of Core would make sure that they are not locked in minor releases and can be easily updated annually without the need for Core Supplements.

Cons:

• This would embed NIEM-specific semantics in code namespaces. Code namespaces currently capture basic type information, plus code values and definitions that are taken directly from the source. Adding elements and creating substitutions embeds NIEM semantics that do not come from the original sources.

Additional things to consider:

• New abstract elements may need to be added to support substitutions.
• Element names may need to be adjusted to remove qualifiers that are no longer necessary (e.g., nc:LocationStateUSPostalServiceCode => usps:LocationStateCode).
• Consider if additional support is needed to help users to selected between similar elements names that exist in different namespaces.
  • Adjust element definitions to include source info?
  • Make sure the namespace definitions are clear and that the SSGT UI makes this information easy to see when reviewing results.

[webb]

NTAC recommends moving only elements that use the representation pattern as described in the NDR:

• Properties that need this level of flexibility should be given a type that uses the representation pattern.
  • For example, nc:LocationState is already done this way, with type nc:StateType containing an element nc:StateRepresentation.
• Elements of code types should be moved into the namespace of the code type and (when possible) given names corresponding to the code type.
  • For example, element nc:LocationStateUSPostalServiceCode of type usps:USStateCodeType should be moved into the usps namespace and renamed to usps:USStateCode, substitutable for nc:StateRepresentation. The NTAC does not recommend that semantic elements (with more complicated or specific meaning) be moved into code namespaces.
• For example, elements nc:DocumentLanguageCode, nc:PublicServiceLanguageCode, and biom:DomniantSpokenLanguageCode should not be moved into the namespace of its type, iso_639-3:LanguageCodeType.
  • However, an element iso_639-3:LanguageCode should reside in the namespace of the code type.

[cdmgtri]

Candidate elements to move to code namespaces

Education

Substitution group nc:EducationLevelRepresentation

• nc:EducationLevelBLSCode => bls:EducationLevelCode
• nc:EducationLevelOPMCode => opm:EducationLevelCode

Canada Post and USPS

Substitution group nc:StateRepresentation

• nc:StateCanadaCode => can:ProvinceCode (*)
• nc:StateUSPSCode => usps:StateCode

(*) Note: NIEM Core and domains are using the term "State" consistently. This does not extend to code namespaces, which NIEM tries to represent as close to the original source as possible.

Substitution group nc:StreetCategoryAbstract

• nc:StreetCategoryCanadaPostCode => can:StreetCategoryCode
• nc:StreetCategoryUSPSCode => usps:StreetCategoryCode

New type nc:StreetDirectionalType with substitution group nc:StreetDirectionalRepresentation

• nc:StreetPostdirectionalCanadaPostCode => can:StreetDirectionalCode
• nc:StreetPredirectionalCanadaPostCode - (same generic new element in can as above)
• nc:StreetPostdirectionalUSPSCode => usps:StreetDirectionalCode
• nc:StreetPredirectionalUSPSCode - (same generic new element in usps as above)

Additionally, will need to create two new elements to capture pre- and post-directional semantics:

• nc:StreetPredirectional (nc:StreetDirectionalType)
• nc:StreetPostdirectional (nc:StreetDirectionalType)

Commodity

Substitution group nc:ItemCategoryAbstract

• nc:CommodityCategoryCode => commodity:CommodityCategoryCode
• nc:ElectronicEquipmentCategoryCode => commodity:ElectronicEquipmentCategoryCode
• nc:ElectronicInstrumentCategoryCode => commodity:ElectronicInstrumentCategoryCode
• nc:MachineryCategoryCode => commodity:MachineryCategoryCode

DEA

Substitution group nc:DEAClassScheduleAbstract

• nc:DEAClassScheduleCode => dea:ClassScheduleCode

Substitution group nc:SubstanceAbstract

• nc:DrugCode = dea:DrugCode

DoD JCS Pub 2.0

Substitution group nc:DocumentIntelligenceCategoryAbstract

• nc:DocumentIntelligenceCategoryCode => dod_jcs-pub2.0:DocumentIntelligenceCategoryCode

DOL

Substitution group nc:EmployeeOccupationAbstract

• nc:EmployeeOccupationCode => dol:EmployeeOccupationCode
• nc:EmployeeOccupationCategoryCode=> dol:EmployeeOccupationCategoryCode
• nc:EmployeeOccupationGeneralCategoryCode => dol:EmployeeOccupationGeneralCategoryCode
• nc:EmployeeOccupationSubCategoryCode => dol:EmployeeOccupationSubCategoryCode

FIPS

Substitution group nc:AddressCountyAbstract

• nc:LocationCountyCode => fips:LocationCountyCode

Substitution group nc:StateRepresentation

• nc:StateFIPSCode => fips:StateCode

GENC

Substitution group nc:CountryRepresentation

• nc:CountryGENCAlpha2Code => genc:CountryAlpha2Code
• nc:CountryGENCAlpha3Code => genc:CountryAlpha3Code
• nc:CountryGENCNumericCode => genc:CountryNumericCode

Substitution group nc:StateRepresentation

• nc:StateGENCCode => genc:StateCode

Hazmat

Substitution group nc:HazmatAbstract

• nc:HazardousMaterialCode => hazmat:HazardousMaterialCode

HL7

Substitution group nc:PersonReligionAbstract

• nc:PersonReligionCode => hl7:ReligionCode

ISO 3166

Substitution group nc:CountryRepresentation

• nc:CountryISO3166Alpha2Code => iso_3166:CountryAlpha2Code
• nc:CountryISO3166Alpha3Code => iso_3166:CountryAlpha3Code
• nc:CountryISO3166NumericCode => iso_3166:CountryNumericCode

Substitution group nc:StateRepresentation

• nc:StateISO3166Code => iso_3166:StateCode

ISO 4217

Substitution group nc:CurrencyAbstract

• nc:CurrencyCode => iso_4217:CurrencyCode

ISO 639-3

New type (nc:LanguageType) with substitution group nc:LanguageAbstract

• nc:LanguageCode => iso_639-3:LanguageCode
• nc:DocumentLanguageCode => nc:DocumentLanguage (nc:LanguageType)
• nc:PublicServiceLanguageCode => nc:PublicServiceLanguage (nc:LanguageType)

NCES

Substitution group nc:EducationQualificationAbstract

• nc:EducationQualificationCode (nces:CIP2DigitCodeType) => nces:CIP2DigitCode

NGA

Substitution group nc:DirectionDatumAbstract - new

• nc:DirectionDatumCode => nga:DirectionDatumCode

Substitution group nc:LocationHeightVerticalDatumAbstract

• nc:LocationHeightVerticalDatumCode => nga:VerticalDatumCode

OCCS

Note: Same code set is used for both nc:FacilityCategoryCode and nc:FacilityUsageCode.

Create new type nc:FacilityUsageType with substitution group nc:FacilityUsageAbstract

• nc:FacilityCategoryCode (occs:FacilityUsageCodeType) => nc:FacilityCategory (nc:FacilityUsageType)

Substitution group nc:FacilityUsageAbstract

• nc:FacilityUsageCode (occs:FacilityUsageCodeType) => occs:FacilityUsageCode
• nc:FacilityUsageLevel1Code => occs:FacilityUsageLevel1Code
• nc:FacilityUsageLevel2Code => occs:FacilityUsageLevel2Code
• nc:FacilityUsageLevel3Code => occs:FacilityUsageLevel3Code
• nc:FacilityUsageLevel4Code => occs:FacilityUsageLevel4Code

UNECE

Substitution group nc:LengthUnitAbstract

• nc:LengthUnitCode (unece:LengthUnitCodeType) => unece:LengthUnitCode

Substitution group nc:SpeedUnitAbstract

• nc:SpeedUnitCode (unece:VelocityCodeType) => unece:VelocityCode

Substitution group nc:TemperatureUnitAbstract

• nc:TemperatureUnitCode (unece:TemperatureUnitCodeType) => unece:TemperatureUnitCode

Substitution group nc:TimeUnitAbstract

• nc:TimeUnitCode (unece:TimeUnitCodeType) => unece:TimeUnitCode

Substitution group nc:VolumeUnitAbstract

• nc:VolumeUnitCode (unece:VolumeUnitCodeType) => unece:VolumeUnitCode

Substitution group nc:WeightUnitAbstract

• nc:WeightUnitCode (unece:MassCodeType) => unece:MassCode

xCard

Substitution group nc:TelephoneNumberCategoryAbstract

• nc:TelephoneNumberCategoryCode => xCard:TelephoneNumberCategoryCode

[cdmgtri]

The Harmonization Workgroup recommends making the proposed changes.

[cdmgtri]

The OmniClass standard which we use for the facility codes labels these as "functions", not "usages" or "categories". Updated nc:FacilityUsageType and the OCCS components accordingly.

Replaced nc:DocumentLanguageAbstract in nc:DocumentType with nc:DocumentLanguage.

Replaced j:ProgramSupportedAlternativeLanguageAbstract in j:ProgramAugmentationType with j:ProgramSupportedAlternativeLanguage.