NIEM / NIEM-Releases

Repository for releases of the National Information Exchange Model
https://niem.github.io/niem-releases/
88 stars 23 forks source link

Clean up definition formatting #132

Closed cdmgtri closed 4 years ago

cdmgtri commented 4 years ago

Cleaning up definition formatting across the model:

cdmgtri commented 4 years ago

Review property and type definitions for line breaks and tabs. In some places, the special characters may just need to be removed; in other places it may indicate that there is content that should be moved out of the definition and into the usage info field.

ag:AdministrativeCountyFSACode

Current definition

A county code of the administering county office. The code is used within the Farm Service Agency (FSA) to identify a county, equivalent entity, or combination thereof within the United States, its possessions, and associated areas as defined within Handbook 1-CM, Exhibit 100. Many of the code values used by are similar to County ANSI/FIPS Code, which follows the American National Standards Institute (ANSI) numeric INCITS 31-2009 and Federal Information Processing Standards Publications (FIPS Pub) 6-4 standard. The expanded even-numbered FSA codes identify counties that contain more than one office due to geographic considerations. Specific values are documented in Handbook 1-CM.

A county code of the administering county office.
  The code is used within the Farm Service Agency (FSA) to identify a county, equivalent entity, or combination thereof within the United States, its possessions, and associated areas as defined within Handbook 1-CM, Exhibit 100.
  Many of the code values used by are similar to County ANSI/FIPS Code, which follows the American National Standards Institute (ANSI) numeric INCITS 31-2009 and Federal Information Processing Standards Publications (FIPS Pub) 6-4 standard. The expanded even-numbered FSA codes identify counties that contain more than one office due to geographic considerations.
  Specific values are documented in Handbook 1-CM.

Proposed definition

A county code of the administering county office.

Proposed usage info

Remove tabs, separate lines better

The code is used within the Farm Service Agency (FSA) to identify a county, equivalent entity, or combination thereof within the United States, its possessions, and associated areas as defined within Handbook 1-CM, Exhibit 100.

Many of the code values used by are similar to County ANSI/FIPS Code, which follows the American National Standards Institute (ANSI) numeric INCITS 31-2009 and Federal Information Processing Standards Publications (FIPS Pub) 6-4 standard. The expanded even-numbered FSA codes identify counties that contain more than one office due to geographic considerations.

Specific values are documented in Handbook 1-CM.

The code is used within the Farm Service Agency (FSA) to identify a county, equivalent entity, or combination thereof within the United States, its possessions, and associated areas as defined within Handbook 1-CM, Exhibit 100.

Many of the code values used by are similar to County ANSI/FIPS Code, which follows the American National Standards Institute (ANSI) numeric INCITS 31-2009 and Federal Information Processing Standards Publications (FIPS Pub) 6-4 standard. The expanded even-numbered FSA codes identify counties that contain more than one office due to geographic considerations.

Specific values are documented in Handbook 1-CM.

ag:AdministrativeStateFSACode

Current definition

A state code of administering state office.
  State code used within the Farm Service Agency (FSA) to identify a state within the United States, United States Possessions, freely associated areas of the United States, or a combination thereof as defined within Handbook 1-CM, Exhibit 100.
  Many of the code values used by State FSA Code are similar to State ANSI/FIPS Code, which follows the American National Standards Institute (ANSI) numeric INCITS 31-2009 and Federal Information Processing Standards Publications (FIPS Pub) 6-4 standard. In some cases FSA codes are different from the ANSI/FIPS codes.
  Specific values are documented in the Handbook 1-CM, Exhibit 100.

Proposed definition

A state code of administering state office.

Proposed usage info

State code used within the Farm Service Agency (FSA) to identify a state within the United States, United States Possessions, freely associated areas of the United States, or a combination thereof as defined within Handbook 1-CM, Exhibit 100.

Many of the code values used by State FSA Code are similar to State ANSI/FIPS Code, which follows the American National Standards Institute (ANSI) numeric INCITS 31-2009 and Federal Information Processing Standards Publications (FIPS Pub) 6-4 standard. In some cases FSA codes are different from the ANSI/FIPS codes.

Specific values are documented in the Handbook 1-CM, Exhibit 100.


ag:CLUID

Current definition

A system-generated internal identifier of a common land unit (CLU). This identifier is for internal access use only.
  A CLU is the smallest unit of land that has a permanent, contiguous boundary, common land cover and land management, a common owner, and a common producer association.
  A CLU is closely related to FS's definition of 'fields', according to Handbook 2-CP. A CLU is also closely related to land units such as parcels, farmsteads, and lots that are used by NRCS, RMA and RD.
  The authoritative source of CLU Identifier is Farm Records. CLU Identifier can remain constant even if the precise geospatial shape of the CLU is slightly altered.

Proposed definition

A system-generated internal identifier of a common land unit (CLU).

Proposed usage info

This identifier is for internal access use only.

A CLU is the smallest unit of land that has a permanent, contiguous boundary, common land cover and land management, a common owner, and a common producer association.

A CLU is closely related to FS's definition of 'fields', according to Handbook 2-CP. A CLU is also closely related to land units such as parcels, farmsteads, and lots that are used by NRCS, RMA and RD.

The authoritative source of CLU Identifier is Farm Records. CLU Identifier can remain constant even if the precise geospatial shape of the CLU is slightly altered.


ag:CropYearValue

Current definition

A period of time (in year) within which the crop is normally grown and designated by the calendar year in which the crop is normally harvested.
                For crops:
                - Harvested over 2 calendar years, the crop year is the calendar year in which the majority of the crop would have been harvested.
                - Grown over more than 2 calendar years, each year in the growing period will be considered as a separate crop year designated by the calendar year in which the crop sustained a loss.
                - For which CAT coverage is available, the crop year will be as defined by such coverage.
                RMA's regulations define Crop Year as the period within which the insured crop is normally grown, regardless of whether or not it is actually grown, and designated by the calendar year in which the insured crop is normally harvested, unless otherwise specified in the Crop Provisions

Proposed definition

A period of time (in year) within which the crop is normally grown and designated by the calendar year in which the crop is normally harvested.

Proposed usage info

For crops:

  • Harvested over 2 calendar years, the crop year is the calendar year in which the majority of the crop would have been harvested.
  • Grown over more than 2 calendar years, each year in the growing period will be considered as a separate crop year designated by the calendar year in which the crop sustained a loss.
  • For which CAT coverage is available, the crop year will be as defined by such coverage.

RMA's regulations define Crop Year as the period within which the insured crop is normally grown, regardless of whether or not it is actually grown, and designated by the calendar year in which the insured crop is normally harvested, unless otherwise specified in the Crop Provisions


ag:CustomerInterAgencyIdentificationID

Current definition

A system generated, unique internal identifier used between agencies to identify a USDA customer (individual or business).
  Currently SCIMS Core Customer Identifier is the source value. This will change if a different customer unique identifier is adopted.

Proposed definition

A system generated, unique internal identifier used between agencies to identify a USDA customer (individual or business).

Proposed usage info

Currently SCIMS Core Customer Identifier is the source value. This will change if a different customer unique identifier is adopted.


ag:FarmNumberID

Current definition

An identifier assigned to all land under control of a particular operator within a particular county.
  Each County assigns Farm Numbers independently. As a result, farms in different counties might be assigned the same Farm Number; i.e, a Farm Number might be unique only within a particular county. Thus, to uniquely identify a farm, the State FSA Code and County FSA Code must be specified in combination with the Farm Number.

Proposed definition

An identifier assigned to all land under control of a particular operator within a particular county.

Proposed usage info

Each County assigns Farm Numbers independently. As a result, farms in different counties might be assigned the same Farm Number; i.e., a Farm Number might be unique only within a particular county. Thus, to uniquely identify a farm, the State FSA Code and County FSA Code must be specified in combination with the Farm Number.


ag:FieldNumberID

Current definition

An identifier number assigned to a field of land that is part of a farm tract.
  Field numbers are assigned by an FSA county office, and are unique within that offics farms. A Field Number is used in conjunction with Tract Number, State FSA Code and County FSA Code for uniqueness.
  Field number and Tract Number are not necessarily unique based upon State ANSI Code and County ANSI Code in instances where the ANSI codes are not the same as the FSA codes.

Proposed definition

An identifier number assigned to a field of land that is part of a farm tract.

Proposed usage info

Field numbers are assigned by an FSA county office, and are unique within that office's farms. A Field Number is used in conjunction with Tract Number, State FSA Code and County FSA Code for uniqueness.

Field number and Tract Number are not necessarily unique based upon State ANSI Code and County ANSI Code in instances where the ANSI codes are not the same as the FSA codes.


ag:OriginatorIdentificationID

Current definition

An identifier of the entity responsible for originating/publishing data.
  For Acreage Reporting it identifies the FSA Service Center, Approved Insurance Provider (AIP), or Third Party Site which collected and published the acreage data and any accompanying geospatial data.
  The identification consists of a prefix indicating the type of Originator, followed by an  identification that uniquely identifies the Originator for that type.

Proposed definition

An identifier of the entity responsible for originating/publishing data.

Proposed usage info

For Acreage Reporting it identifies the FSA Service Center, Approved Insurance Provider (AIP), or Third Party Site which collected and published the acreage data and any accompanying geospatial data.

The identification consists of a prefix indicating the type of Originator, followed by an identification that uniquely identifies the Originator for that type.


ag:TaxIdentificationID

Current definition

A tax identifier assigned to a specific individual, business or other entity and is used to authenticate the individual/entity for matters of taxation and other federal government business.
  Tax Identification may be a Social Security or Employer Identification number.
  Federal Tax Identification is not necessarily unique for all United States Department of Agriculture (USDA) customers unless it is combined with a Tax Identification Type Code.

Proposed definition

A tax identifier assigned to a specific individual, business or other entity and is used to authenticate the individual/entity for matters of taxation and other federal government business.

Proposed usage info

Tax Identification may be a Social Security or Employer Identification number.

Federal Tax Identification is not necessarily unique for all United States Department of Agriculture (USDA) customers unless it is combined with a Tax Identification Type Code.


ag:TractNumberID

Current definition

An identifier assigned to a unit of contiguous land that is under one ownership and that is operated as a farm or part of a farm. An owner is a person or business having deed to the land.
  Tract numbers are assigned by an FSA county office

Proposed definition

An identifier assigned to a unit of contiguous land that is under one ownership and that is operated as a farm or part of a farm. An owner is a person or business having deed to the land.

Proposed usage info

Tract numbers are assigned by an FSA county office


it:OtherChargesDeductionsAmount

Current definition

An amount added or subtracted from the total invoice price not previously taken into account when determining the Customs value.

Proposed definition

Remove the trailing line break


mo:MilitaryInstallationName

Current definition

A name of a grouping of facilities, located in the same vicinity, which support particular
functions. Installations may be elements of a base.

Proposed definition

Remove the line break


mo:SectorName

Current definition

A name of an area designated by boundaries within which a unit operates, and for which
it is responsible.

Proposed definition

Remove the line break

cdmgtri commented 4 years ago

Types with line breaks in definitions

Recommendations

ag:AcreageSubmissionFileType

A data type containing the entire set of the crops planted on a farm, itemized down to the acreage of individual fields and subfields and the individual producer stakeholders. This file set is used to transmit an acreage report from an FSA County Office, an Approved Insurance Provider (AIP), or a producer.

ag_codes:CLUIDSimpleType

A data type for system-generated internal identifier of a common land unit (CLU). This identifier is for internal access use only. A CLU is the smallest unit of land that has a permanent, contiguous boundary, common land cover and land management, a common owner, and a common producer association. A CLU is closely related to FSA's definition of 'fields', according to Handbook 2-CP. A CLU is also closely related to land units such as parcels, farmsteads, and lots that are used by NRCS, RMA and RD. The authoritative source of CLU Identifier is Farm Records. CLU Identifier can remain constant even if the precise geospatial shape of the CLU is slightly altered.

ag_codes:CropYearSimpleType

A data type to indicate a period of time (in year) within which the crop is normally grown and designated by the calendar year in which the crop is normally harvested. For crops:

ag_codes:FarmNumberIDSimpleType

A data type for identification number assigned to all land under control of a particular operator within a particular county. Each County assigns Farm Numbers independently. As a result, farms in different counties might be assigned the same Farm Number; i.e, a Farm Number might be unique only within a particular county. Thus, to uniquely identify a farm, the State FSA Code and County FSA Code must be specified in combination with the Farm Number.

ag_codes:FieldNumberIDSimpleType

A data type for identification number assigned to a field of land that is part of a farm tract. Field numbers are assigned by an FSA county office, and are unique within that office''s farms. A Field Number is used in conjunction with Tract Number, State FSA Code and County FSA Code for uniqueness. Field number and Tract Number are not necessarily unique based upon State ANSI Code and County ANSI Code in instances where the ANSI codes are not the same as the FSA codes.

ag_codes:IrrigationPracticeCodeSimpleType

A data type containing the irrigation practice code used for a unit of land with a crop. Irrigated Practice is the method of producing a crop by which water, from an adequate water source, is artificially applied in sufficient amounts by appropriate and adequate irrigation equipment and facilities and at the proper times necessary to produce one of the following:

  1. the yield expected for the area.
  2. the yield used to establish the production guarantee or amount of insurance/coverage on the irrigated acreage planted to the commodity.
  3. the producer established approved yield, as applicable. Acreage adjacent to water, such as but not limited to a pond, lake, river, stream, creek or brook, shall not be considered irrigated based solely on the proximity to the water.

ag_codes:OrganicPracticeCategoryCodeSimpleType

A data type containing certification codes used for farm acreage in regards to a system/plan of production and handling practice to produce an organic commodity. Organic practice that is Certified means a system/plan of production and handling practices to respond to site-specific conditions by integrating cultural, biological, and mechanical practices that foster cycling of resources, promote ecological balance, and conserve biodiversity, is certified by an accredited certifying agent, and used to produce an organic commodity or product according to the Organic Foods Production Act of 1990. Organic practice that is Transitional means a system/plan of production and handling practices to produce an organic commodity or product in accordance with the Organic Foods Production Act of 1990, but has not yet qualified to be designated as certified organic.

ag_codes:OriginatorIdentificationIDSimpleType

A data type for identifying the entity responsible for originating/publishing data. For Acreage Reporting it identifies the FSA Service Center, Approved Insurance Provider (AIP), or Third Party Site which collected and published the acreage data and any accompanying geospatial data. The identification consists of a prefix indicating the type of Originator, followed by an identification that uniquely identifies the Originator for that type.

ag_codes:SubfieldNumberSimpleType

A data type for alpha number that is used to uniquely identify a subfield within a field, within a tract within a farm within a state and county. Subfields are areas of a field that share a set of common planting characteristic in terms of crop, crop type, intended use, etc. By convention the first defined subfield is given a value of 'A', with subsequent subfields following in alphabetic order.

ag_codes:TractNumberIDSimpleType

A data type for identification number assigned to a unit of contiguous land that is under one ownership and that is operated as a farm or part of a farm. An owner is a person or business having deed to the land. Tract numbers are assigned by an FSA county office, and are unique within that office''s farms. A Tract Number is used in conjunction with a State FSA Code and County FSA Code for uniqueness. Tract numbers are not necessarily unique based upon State ANSI Code and County ANSI in instance where the ANSI codes are not the same as the FSA codes.

em:ExerciseCategoryCodeSimpleType and em:ExerciseCategoryCodeType

A data type for the type of exercise performed by a person, defined by U.S. DEPARTMENT OF HEALTH AND HUMAN SERVICES National Institutes of Health, National Heart, Lung, and Blood Institute

scr:FingerprintImpressionCategoryCodeSimpleType

A data type for a kind of fingerprint impression.

cdmgtri commented 4 years ago

The Harmonization work group recommends the above changes.