HISPID 5 for HISPID Users

From HISCOM

Jump to: navigation, search

HISPID 5 for HISPID Users describes the HISPID 5 XML Schema in terms of HISPID 3 and HISPID 4 element by element. It documents the decisions made at the HISPID/ABCD Workshop.

HISPID has an almost 20 year history. First released in 1989, HISPID was subsequently released as version 3 in a published book in 1996, and the following version 4 appeared online in 2000. Versions 3 and 4 were based on the ASN.1 format, however HISPID 5 makes a break from this and is implemented in XML. HISPID 5 is available as a download, with examples as noted at HISPID 5.

Contents

Document Terminology and Conventions

HISPID 3 and HISPID 4 used the term "field" (or "transfer code") to identify the same thing that the term "element" does in HISPID 5, ABCD and XML in general. Thus a "field" (or "transfer code") in previous versions of HISPID is equivalent to an "element" in HISPID 5 and ABCD. Links to the documentation for ABCD are provided on the shortest XPath possible to maintain readability of this document. In some cases, it may not be possible to know exactly which element we refer to without following the link to the ABCD documentation.

Wherever possible, we have used a standard terminology throughout this document to make it easier to read. The 6 phrases below are used to define the type of change that has occurred in HISPID 5.

New HISPID Element
An element that is new to HISPID in general — an element that was missing in HISPID 3 or 4. The following elements are new HISPID elements: cid2, depdet, depsou and NameFormula.
Extension to ABCD in HISPID 5
An element that corrects a deficiency in ABCD by extending ABCD in our HISPID 5 extension Schema. The element previously existed in HISPID. The following elements are extensions to ABCD in HISPID 5: dont, form, fre, latdeg, latdir, latmin, latsec, londeg, londir, lonmin, lonsec, noncom, numshe, phe, posint, prohis, prot, pru, soil, sub, tcul and veg.
HISPID 5 Restriction
An element exists in ABCD that has the same meaning as an element in HISPID, but a controlled vocabulary has been added to the ABCD element in the HISPID 5 extension Schema to make the element behave more like HISPID. The HISPID 5 document will not validate correctly if a term other than those documented is used. The following elements are restrictions in HISPID 5: det, geosou, idql, spql, tql, tsta and vlev.
HISPID 5 Suggested Restriction
An element exists in ABCD that has the same meaning as an element in HISPID, but a decision on a controlled vocabulary has not been made, and thus the terms in the vocabulary are a recommendation rather than a requirement. The following elements are suggested restrictions in HISPID 5: altdet, altsou, ckin, cou, depdet, depsou, desrep, loades, loadis, poscul, posnat, sgn and vou.
Excluded from HISPID 5
An element from an earlier HISPID version that has been deliberately removed from HISPID 5. The following elements are excluded from HISPID 5: basnam2, basnam3, credat, creins, crenam, daturl, fileaction, filedescriptor, genhy2, isp2au, isp2hy2, isp2rkhy2, isp2rk, isp2, isphy2, isprkhy2, modins, modnam, numrecords, numrep, sphy2, tql2, tql3, tsta2 and tsta3.
Unavailable in HISPID 5
An element that is not available in HISPID 5, but is likely to be a deficiency of HISPID 5. The following elements are currently unavailable in HISPID 5: cper.

File Identifier Group

startfile

Start of HISPID 3 File. Maps to the opening tag of the DataSets element, the root element of HISPID 5 and ABCD.

endfile

End of HISPID 3 File. Maps to the closing tag of the DataSets element.

version

Version of File. Defined by the HISPID 5 Schema's default namespace e.g. http://www.chah.org.au/schemas/hispid/5.

numrecords

Number of Records in File. Excluded from HISPID 5 because it can be generated programmatically, and thus is redundant.

datefile

Date of File. Maps to DateModified.

institute

Name of Institution Supplying Information. Maps to Owner/Organisation.

contact

Contact Name. Maps to ContentContact/Name and TechnicalContact/Name. It is common to supply both.

address

Address of Institution Sending File. Maps to ContentContact/Address and TechnicalContact/Address. It is common to supply both.

phone

Telephone Number of Institution. Maps to ContentContact/Phone and TechnicalContact/Phone. It is common to supply both.

fax

Facsimile Number of Institution. Maps to TelephoneNumber/Number + TelephoneNumber/Device = fax.

email

Email Address of Institution. Maps to ContentContact/Email and TechnicalContact/Email. It is common to supply both.

nonstandard

Non-Standard Option. The way that non-standard content is transferred has changed markedly in HISPID 5. Use ABCD's extension mechanism, as we have done in HISPID 5.

fileaction

File Action Flag. Excluded from HISPID 5 because only the receiving institution knows for certain whether the data needs to be deleted, inserted or updated in its database.

filedescriptor

File Descriptor Flag. Excluded from HISPID 5.

content

Description of File Contents and Other Comments. Maps to Metadata/Description/Representation/Details. However, Metadata/Description/Representation/Title is a mandatory field in ABCD, so this must also be supplied.

daturl

Data Set URL. Excluded from HISPID 5. The nearest equivalent field is DatasetGUID, however the purpose of each is sufficiently different that daturl is excluded.

Accession Identifier Group

{

Start of HISPID 3 Record. Maps to the opening tag of the Unit element.

}

End of HISPID 3 Record. Maps to the closing tag of the Unit element.

insid

Institution Code. Maps to SourceInstitutionID.

accid

Accession Identifier. Maps to UnitID.

Basis of Record Group

recsou

Source of Record Flag. Maps to RecordBasis.

The vocabulary used in HISPID 5 is that of ABCD. The vocabulary and a mapping from the older HISPID vocabulary is as follows:

  • PreservedSpecimen : HISPID 3 = Collection
  • LivingSpecimen : HISPID 3 has no equivalent
  • FossilSpecimen : HISPID 3 has no equivalent
  • OtherSpecimen : HISPID 3 has no equivalent
  • HumanObservation : HISPID 3 = Observation
  • MachineObservation : HISPID 3 = Observation
  • DrawingOrPhotograph : HISPID 3 = Photograph
  • MultimediaObject : HISPID 3 has no equivalent

Record Identification Group

supfam

Suprafamilial Group Name. Maps to HigherTaxonName + HigherTaxonRank = phylum (for example).

HISPID 5 and ABCD can transfer as many higher taxon names as exist for the taxon, which removes the limitation in HISPID 3/4 of exactly one higher taxon name. If a taxon is determined only to a genus or higher rank then the GenusOrMonomial element must be filled.

fam

Family Name. Maps to HigherTaxonName + HigherTaxonRank = familia. See note under supfam.

supgenrk

Suprageneric Group Rank. Maps to HigherTaxonRank = supergenus when used concurrently with a suprageneric group name in HigherTaxonName See notes under supfam and supgen.

supgen

Suprageneric Group Name. Maps to HigherTaxonName + HigherTaxonRank = supergenus. See note under supfam.

hyb

Hybrid Flag (for named hybrids and graft chimeras). Maps to HybridFlag + [http://wiki.tdwg.org/twiki/bin/view/ABCD/AbcdConcept0311 HybridFlag[@insertionpoint]] = 1.

HISPID 3/4 assumes a genus-level hybrid, while HISPID 5 and ABCD have no such restriction. Use the HISPID 3/4 vocabulary.

NameFormula

New HISPID Element. NameFormula permits the exchange of hybrid and other name formulas for the names of complex intergrades and hybrids. Supply the full hybrid or other formula as-is in this element.

For example:

...
<UnitExtension>
    <HispidIdentification>
        <NameFormula>Prostanthera cuneata x Prostanthera lasianthos var. subcoriacea</NameFormula>
    </HispidIdentification>
</UnitExtension>
...

or:

...
<UnitExtension>
    <HispidIdentification>
        <NameFormula>Magnolia campbellii subsp mollicomata x Magnolia sprengeri var. diva</NameFormula>
    </HispidIdentification>
</UnitExtension>
...

gen

Genus Name. Maps to GenusOrMonomial.

genhy2

Second Hybrid Genus Name. Excluded from HISPID 5, see NameFormula.

subgen

Subgeneric Group Name. Maps to HigherTaxonName + HigherTaxonRank = subgenus. See note under supfam.

spql

Species Qualifier. Maps to NameAddendum.

HISPID 5 Restriction. The vocabulary of the ABCD field is restricted to the following values, which match the vocabulary of earlier HISPID versions:

  • agg. (an aggregate species)
  • s. lat. (aggregate species - sensu lato)
  • s. str. (segregate species - sensu stricto)

sp

Species Epithet. Maps to FirstEpithet.

sphy2

Second Hybrid Species Epithet. Excluded from HISPID 5, see NameFormula.

spau

Species Author. Maps to AuthorTeamParenthesis + AuthorTeam. Only the lowest level is included in ABCD.

isprk

Infraspecific Rank. Maps to Rank. Only lowest level rank is included in ABCD.

isprkhy2

Second Hybrid Infraspecific Rank Flag. Excluded from HISPID 5, see NameFormula.

isp

Infraspecific Epithet. Maps to InfraspecificEpithet.

isphy2

Second Hybrid Infraspecific Epithet. Excluded from HISPID 5, see NameFormula.

ispau

Infraspecific Author. Maps to AuthorTeamParenthesis + AuthorTeam. Only lowest level authorship is included in ABCD.

isp2rk

Second Infraspecific Rank Flag. Excluded from HISPID 5: Only lowest level rank is included in ABCD.

isp2rkhy2

Second Hybrid of the Second Infraspecific Rank Flag. Excluded from HISPID 5, see NameFormula.

isp2

Second Infraspecific Epithet. Excluded from HISPID 5: Only lowest ranked name is included in ABCD.

isp2hy2

Second Hybrid of the Second Infraspecific Epithet. Excluded from HISPID 5, see NameFormula.

isp2au

Second Infraspecific Author. Excluded from HISPID 5: Only lowest ranked name is included in ABCD.

vernam

Vernacular Names. Maps to InformalNameString.

Each individual vernacular name is supplied in a separate InformalNameString element.

culgnam

Cultivar Group Name. Maps to CultivarGroupName.

culnam

Cultivar Name. Maps to CultivarName.

tranam

Trade Designation Name. Maps to TradeDesignationName.

fulnam

Full Name. Maps to FullScientificNameString.

namcom

Name Comments. Maps to NameComments. See also idcom (aka namcom2.

Typification Group

tql

Type Qualifier Flag. Maps to DoubtfulFlag.

HISPID 5 Restriction. The vocabulary of the ABCD field is restricted to the following values, which are similar to the vocabulary of earlier HISPID versions:

  • possibly
  • probably
  • ?
  • not

One of the above values is supplied in one DoubtfulFlag element, however DoubtfulFlag can be repeated as many times as necessary to supply all the type qualifier flags attributed to one specimen.

tsta

Type Status. Maps to TypeStatus.

HISPID 5 Restriction. The vocabulary of the ABCD field is restricted to the following values, which are similar to the vocabulary of earlier HISPID versions:

  • epitype
  • holotype
  • isotype
  • isolectotype
  • isoneotype
  • isoparatype
  • isoparalectotype
  • isosyntype
  • kleptotype
  • lectotype
  • neotype
  • paratype
  • paralectotype
  • syntype
  • topotype
  • type (type material of unknown status)

One of the above values is supplied in one TypeStatus element, however TypeStatus can be repeated as many times as necessary to supply all the type status values attributed to one specimen.

basnam

Basionym. Maps to TypifiedName/FullScientificNameString.

One basionym is supplied in one Basionym element, however Basionym can be repeated as many times as necessary to supply all the basionyms attributed to one specimen.

tql2

Second Most Recent Type Qualifier. Excluded from HISPID 5, see tql.

tsta2

Second Most Recent Type Status. Excluded from HISPID 5, see tsta.

basnam2

Second Most Recent Basionym. Excluded from HISPID 5, see basnam.

tql3

Third Most Recent Type Qualifier. Excluded from HISPID 5, see tql.

tsta3

Third Most Recent Type Status. Excluded from HISPID 5, see tsta.

basnam3

Third Most Recent Basionym. Excluded from HISPID 5, see basnam.

Verification Group

vlev

Verification Level Flag. Maps to VerificationLevel.

HISPID 5 Restriction. The vocabulary of the ABCD field is restricted to the following values, which are similar to the vocabulary of earlier HISPID versions:

  • 0 - (zero) The name of the record has not been checked by any authority - includes temporary sorting determinations
  • 1 - The name of the record determined by comparison with other named plants
  • 2 - The name of the record determined by a taxonomist or by other competent persons using herbarium and/or library and/or documented living material
  • 3 - The name of the plant determined by taxonomist engaged in systematic revision of the group
  • 4 - The record is part of type gathering or propagated from type material by asexual methods

vnam

Verifier's Name. Maps to IdentifiersText. If the verifier's name can be atomised, it is preferrable to use the set of sub-elements rooted at Identifier.

vdat

Verification Date. Maps to ISODateTimeBegin using a different date format specification.

texvdat

Text Verification Date. Maps to DateText.

vlit

Verification Literature. Maps to TitleCitation.

vhist

Verification History. Maps to IdentificationHistory. If the verification history can be atomised, it is preferrable to use the set of sub-elements rooted at Identifications.

det

Determinavit. Maps to IdentifierRole.

HISPID 5 Restriction. The vocabulary of the ABCD field is restricted to the following values, which are similar to the vocabulary of earlier HISPID versions:

  • conf. - confirmavit (identifier has agreed with i.e. confirmed the identification).
  • cit. - citavit (used when a specimen is cited in a publication).
  • det. - determinavit (the identifier has determined the identification).
  • scrips. - scripsit (identification communicated in written correspondence).
  • vid. - vidit (identification seen and communicated verbally).
  • upg. - upgrade (taxonomic update based on literature - where specimen not cited).
  • tss. - temporary sorting slip (used to temporarily name a specimen prior to critical examination).

rkql

Rank Qualifier Flag. Maps to [http://wiki.tdwg.org/twiki/bin/view/ABCD/AbcdConcept0333 IdentificationQualifier[@insertionpoint]].

There is a different vocabulary between HISPID and ABCD, but it is possible to map between the two. This is tricky because it depends on the level to which the specimen has been identified. The mapping would be:

  • B : no mapping possible (don't supply a value)
  • F : 1 (because if identified to family this has to be included in FullScientificNameString see HigherTaxa)
  • G : 1
  • S : 2
  • I : 3
  • J : (if there was a 4 in ABCD it would map to this, as a result no value should be supplied)
  • C : no mapping possible (don't supply a value)

idql

Identification Qualifier. Maps to IdentificationQualifier.

HISPID 5 Restriction. The vocabulary of the ABCD field is restricted to the following values, which are similar to the vocabulary of earlier HISPID versions:

  • aff. - Akin to or bordering
  • cf. - Compare with
  • incorrect - Incorrect
  • forsan - Perhaps
  • near - Close to
  • ? - Questionable

idcom

Identification Comments. Was new in HISPID 4 but is currently unavailable in HISPID 5. The transfer code namcom was used twice in HISPID 3, once for comments on the name and once for comments on the identification. In some drafts of HISPID, particularly the HISPID 3 book, this element has been referred to as namcom2.

namcom2

A synonym for Identification Comments.

Location Group

cou

Country. Maps to Gathering/Country/Name.

HISPID 5 Suggested Restriction. The vocabulary of the ABCD element should be restricted to full official country names in maxed case as used in ISO 3166-1. This restriction is by agreement, as it is not enforced in the schema, but it may be in future versions.

iso

ISO code for Country of Origin. Maps to Gathering/Country/ISO3166Code. HISPID constrained the data to the 2-letter ISO3166 value, where ABCD suggests that any of the 2, 3 or 4 letter ISO3166 values is acceptable. Use the full range of values allowed by ABCD in HISPID 5.

wgs

World Geographic Scheme. Maps to AreaCodeStandard = (for example) TDWG World Geographical Scheme for Recording Plant Distributions version 1 + AreaCode. Both values are required.

pru

Primary Subdivision of Country of Origin. Maps to an extension to ABCD in HISPID 5. PrimaryRecordingUnit permits the exchange of the same information as HISPID 3 and 4: The primary recording unit which is the highest order subdivision recognised by the Country of Origin (usually a state or province).

Provide the complete 4-level Geographical scheme (refer Table 4 in Hollis & Brummitt, 1992), the official (frequently political) abbreviations used within the Country of Origin (rather than those of Hollis & Brummitt (1992)), or the name of the state or province in full, e.g. New South Wales. Where full names are used, supply the data in mixed case rather than capitals or lowercase.

ABCD can be made to store a similar value by using AreaName + AreaClass = state or province. It is useful to supply these two elements as well as the HISPID 5 extension element to maximise the compatibility of your document with ABCD.

sru

Secondary Subdivision of Country of Origin. Maps to AreaClass = Australian Herbarium Region + AreaName.

When transferring data related to other standard subdivisions of Australia, use AreaClass with a standard area class name, such as:

  • IBRA - Interim Biogeographic Regionalisation for Australia
  • IMCRA - Interim Marine and Coastal Regionalisation for Australia
  • LGA - Local Government Association

The abbreviated form should be used if it is widely understood.

sgu

Special Geographic Unit. Maps to AreaClass = Special Geographic Unit + AreaName. See sru.

loc

Locality. Maps to LocalityText. If no locality is available, return the exact phrase without locality.

alt

Altitude. Maps to Altitude/MeasurementOrFactAtomised/LowerValue + Altitude/MeasurementOrFactAtomised/UnitOfMeasurement = metres.

altacy

Accuracy of Altitude. Maps to Altitude/MeasurementOrFactAtomised/Accuracy. Note that ABCD has a single accuracy element whereas HISPID has accuracy for upper and lower values. Use the ABCD approach when supplying data in HISPID 5.

altx

Maximum Altitude. Maps to Altitude/MeasurementOrFactAtomised/UpperValue.

altacyx

Accuracy of Maximum Altitude. Maps to Altitude/MeasurementOrFactAtomised/Accuracy. Note that ABCD has a single accuracy element whereas HISPID has accuracy for upper and lower values. Use the ABCD approach when supplying data in HISPID 5.

altsou

Source of Altitude Accuracy Flag. Maps to Altitude/MeasurementOrFactAtomised/MeasuredBy.

HISPID 5 Suggested Restriction. The vocabulary of the ABCD element should be restricted to the following values, which are similar to the vocabulary of earlier HISPID versions:

  • collector - The specimen collector made the measurement
  • compiler - The record compiler made the measurement
  • automatically generated - The measurement was generated by an automated process, such as a BIOCLIM analysis.

This restriction is not enforced in the schema because ABCD uses the same MeasurementOrFactAtomised structure as a base type for a number of elements, and changing it would cause unrelated elements to be unnecessarily restricted.

altdet

Method of Altitude Determination. Maps to Altitude/MeasurementOrFactAtomised/Method.

HISPID 5 Suggested Restriction. The vocabulary of the ABCD element should be restricted to the following values, which are similar to the vocabulary of earlier HISPID versions:

  • dem - Digital Elevation Model
  • gps - Global Positioning System (GPS) unit
  • field estimate
  • altimeter
  • map
  • unknown

This restriction is not enforced in the schema because ABCD uses the same MeasurementOrFactAtomised structure as a base type for a number of elements, and changing it would cause unrelated elements to be unnecessarily restricted.

dep

Depth. Maps to Depth/MeasurementOrFactAtomised/LowerValue + Depth/MeasurementOrFactAtomised/UnitOfMeasurement = metres.

depacy

Accuracy of Depth. Maps to Depth/MeasurementOrFactAtomised/Accuracy. Note that ABCD has a single accuracy element whereas HISPID has accuracy for upper and lower values. Use the ABCD approach when supplying data in HISPID 5.

depx

Maximum Depth. Maps to Depth/MeasurementOrFactAtomised/UpperValue.

depacyx

Accuracy of Maximum Depth. Maps to Depth/MeasurementOrFactAtomised/Accuracy. Note that ABCD has a single accuracy element whereas HISPID has accuracy for upper and lower values. Use the ABCD approach when supplying data in HISPID 5.

depsou

Source of Depth Accuracy Flag. New HISPID Element. This element was never made available in HISPID, but is documented here as ABCD makes it possible to supply this information. Maps to Depth/MeasurementOrFactAtomised/MeasuredBy.

HISPID 5 Suggested Restriction. The vocabulary of the ABCD element should be restricted to the following values, which are similar to the vocabulary of earlier HISPID versions:

  • collector - The specimen collector made the measurement
  • compiler - The record compiler made the measurement
  • automatically generated - The measurement was generated by an automated process, such as a BIOCLIM analysis.

This restriction is not enforced in the schema because ABCD uses the same MeasurementOrFactAtomised structure as a base type for a number of elements, and changing it would cause unrelated elements to be unnecessarily restricted.

depdet

Method of Depth Determination. New HISPID Element. This element was never made available in HISPID, but is documented here as ABCD makes it possible to supply this information. Maps to Depth/MeasurementOrFactAtomised/Method.

HISPID 5 Suggested Restriction. The vocabulary of the ABCD element should be restricted to the following values, which are similar to the vocabulary of earlier HISPID versions:

  • dem - Digital Elevation Model
  • gps - Global Positioning System (GPS) unit
  • field estimate
  • altimeter
  • map
  • unknown

This restriction is not enforced in the schema because ABCD uses the same MeasurementOrFactAtomised structure as a base type for a number of elements, and changing it would cause unrelated elements to be unnecessarily restricted.

Geographical Coordinates

Geographical coordinates can be supplied in several ways in HISPID 5, as decimal degrees using the standard ABCD elements, as UTM coordinates using the standard ABCD elements, or in the HISPID 5 extension in degrees, minutes and seconds. In most cases it is preferrable to transfer data in decimal degrees using the ABCD decimal degrees. In cases where verbatim degrees, minutes and seconds must be transferred, supply this data using the HISPID 5 extension CoordinatesDMS in addition to the data in decimal degrees.

See the following HISPID elements for specific information:

It may additionally be useful in some circumstances to transfer degrees, minutes, seconds in a concatenated manner in the CoordinatesText element e.g. 32,25,,S,112,32,12,E,GDA94. Note the use of commas to separate the individual elements in order, even if a value is missing latdeg,latmin,latsec,latdir,londeg,lonmin,lonsec,londir,spadat. The spatial datum is very useful in this context to ensure that even concatenated data can be used in mapping tools and other geographical analyses. Note that using this element may considerably limit the utility of the data, as it requires extra work to source and reuse data supplied in this manner. For UTM data, if it is not possible to atomise this data fully, the UTM elements may also be usefully concatenated and supplied using UTMText, e.g. GDA94,,347000,S5739000 composed of the elements: sgp,sgz,sge,sgn. The use of CoordinatesText and UTMText should be used only when absolutely necessary to ensure the outgoing data is understandable by as many clients as possible.

latdeg

Latitude, Degree. Maps to LatitudeDecimal in decimal degrees format.

The degrees of latitude of the collection locality whether supplied by the collector or derived from other information. When the degrees of latitude must be supplied as a verbatim integer, rather than a decimal, use the extension to ABCD in HISPID 5: HispidGathering/CoordinatesDMS/LatitudeDegrees. This element maps exactly to the older HISPID element, and is retained in HISPID 5 for the purpose of transferring data verbatim.

See also Geographical Coordinates.

latmin

Latitude, Minutes. Maps to LatitudeDecimal in decimal degrees format.

The minutes of latitude of the collection locality whether supplied by the collector or derived from other information. When the minutes of latitude must be supplied as a verbatim integer, rather than a decimal, use the extension to ABCD in HISPID 5: HispidGathering/CoordinatesDMS/LatitudeMinutes. This element maps exactly to the older HISPID element, and is retained in HISPID 5 for the purpose of transferring data verbatim.

See also Geographical Coordinates.

latsec

Latitude, Seconds. Maps to LatitudeDecimal in decimal degrees format.

The integer seconds of latitude of the collection locality whether supplied by the collector or derived from other information. When the seconds of latitude must be supplied as a verbatim integer, rather than a decimal, use the extension to ABCD in HISPID 5: HispidGathering/CoordinatesDMS/LatitudeSeconds. This element maps exactly to the older HISPID element, and is retained in HISPID 5 for the purpose of transferring data verbatim.

See also Geographical Coordinates.

latdir

Latitude, Direction Flag. Maps to LatitudeDecimal in decimal degrees format.

The abbreviated direction of latitude of the collection locality, relative to the equator, whether supplied by the collector or derived from other information. In decimal degrees, the direction of latitude is indicated by using a positive decimal to indicate the northern hemisphere or a negative decimal to indicate the southern hemisphere.

When the direction of latitude must be supplied as a verbatim string, use the extension to ABCD in HISPID 5: HispidGathering/CoordinatesDMS/LatitudeDirection. This element maps exactly to the older HISPID element, and is retained in HISPID 5 for the purpose of transferring data verbatim. The vocabulary of this element is:

  • N
  • S

See also Geographical Coordinates.

londeg

Longitude, Degree. Maps to LongitudeDecimal in decimal degrees format.

The degrees of longitude of the collection locality whether supplied by the collector or derived from other information. When the degrees of longitude must be supplied as a verbatim integer, rather than a decimal, use the extension to ABCD in HISPID 5: HispidGathering/CoordinatesDMS/LongitudeDegrees. This element maps exactly to the older HISPID element, and is retained in HISPID 5 for the purpose of transferring data verbatim.

See also Geographical Coordinates.

lonmin

Longitude, Minutes. Maps to LongitudeDecimal in decimal degrees format.

The minutes of longitude of the collection locality whether supplied by the collector or derived from other information. When the minutes of longitude must be supplied as a verbatim integer, rather than a decimal, use the extension to ABCD in HISPID 5: HispidGathering/CoordinatesDMS/LongitudeMinutes. This element maps exactly to the older HISPID element, and is retained in HISPID 5 for the purpose of transferring data verbatim.

See also Geographical Coordinates.

lonsec

Longitude, Seconds. Maps to LongitudeDecimal in decimal degrees format.

The seconds of longitude of the collection locality whether supplied by the collector or derived from other information. When the seconds of longitude must be supplied as a verbatim integer, rather than a decimal, use the extension to ABCD in HISPID 5: HispidGathering/CoordinatesDMS/LongitudeSeconds. This element maps exactly to the older HISPID element, and is retained in HISPID 5 for the purpose of transferring data verbatim.

See also Geographical Coordinates.

londir

Longitude, Direction Flag. Maps to LongitudeDecimal in decimal degrees format.

The abbreviated direction of longitude of the collection locality, relative to Greenwich, whether supplied by the collector or derived from other information. In decimal degrees, the direction of longitude is indicated by using a positive decimal to indicate the eastern hemisphere or a negative decimal to indicate the western hemisphere.

When the direction of longitude must be supplied as a verbatim string, use the extension to ABCD in HISPID 5: HispidGathering/CoordinatesDMS/LongitudeDirection. This element maps exactly to the older HISPID element, and is retained in HISPID 5 for the purpose of transferring data verbatim. The vocabulary of this element is:

  • E
  • W

See also Geographical Coordinates.

spadat

Spatial Datum. Was new in HISPID 4. Maps to SpatialDatum. Use only accepted datum abbreviations, e.g. AGD66, AGD84, WGS84, GDA94.

See also Geographical Coordinates.

sgp

Spatial Grid, Projection. Maps to UTMDatum.

See also Geographical Coordinates.

spapro

A synonym for sgp. See also Geographical Coordinates.

sgz

Spatial Grid Zone. Was new in HISPID 4. Maps to UTMZone.

The numerical Zone corresponding to the central meridian and origin upon which the easting is based. Supply an integer between 1 and 60 inclusive.

See also Geographical Coordinates.

sge

Spatial Grid, Easting. Maps to UTMEasting.

The Map Grid Easting reference of the locality from which the plant specimen was collected. Supply any valid grid reference, in metres. Note that no hemisphere is required, as the spatial grid zone caters for this. See sgz.

See also Geographical Coordinates.

sgn

Spatial Grid, Northing. Maps to UTMNS + UTMNorthing. UTMNS represents the hemisphere of the associated northing.

HISPID 5 Suggested Restriction. The vocabulary of the UTMNS element should be restricted to the values N and S in uppercase. This restriction is by agreement, as it is not enforced in the schema, but it may be in future versions.

See also Geographical Coordinates.

geoacy

Accuracy of Geocode. Maps to CoordinateErrorDistanceInMeters.

The level to which the accuracy of the latitude and longitude of the collected specimen is known, in metres. Note that applications should take into account any rounding done for coordinates. Historically, Australian herbaria have used classes of geocode accuracy to record the accuracy in metres.

See also Geographical Coordinates.

geosou

Source of Geocode Precision. Maps to CoordinateMethod.

An indication of the type measuring system used to generate the geocode, which can be used to infer an understanding of the accuracy (i.e. veracity) of the measurement.

HISPID 5 Restriction. The vocabulary of the ABCD element is restricted to the following values, which are similar to the vocabulary of earlier HISPID versions:

  • collector
  • compiler
  • generalised arbitrary point
  • automatically generated
  • gps
  • topo
  • unknown

Note that the vocabulary of this element has been extended in HISPID 5.

nnp

Nearest Named Place. Maps to NearNamedPlace.

The nearest named place to the locality of the collection taken from a 1:100,000 topographic map series. Supply any valid place name using conventional mixed case for the full name of the place. If no value is available, use the phrase not available.

Habitat Group

hab

Habitat. Maps to Gathering/Biotope/Text.

A free text description of the habitat of the location in which this specimen was collected, including the geology and soil type in which the plant grows, as well as the associated species of the plant community. Note that this information is usually provided by the original collector.

top

Topography. Maps to /Gathering/AreaDetail.

A free text description of the topography of the habitat from which the specimen was collected. Information in this element includes landform, situation and the like.

asp

Aspect. Maps to Gathering/Aspect/Ordination.

The abbreviated aspect or outlook of the site from which the plant was collected.

This is a situation where HISPID has a larger vocabulary than ABCD. The ABCD element limits the vocabulary to:

  • N
  • S
  • E
  • W
  • NE
  • SE
  • NW
  • SW
  • Open
  • Closed

The other terms formerly allowed in HISPID are not defined in either HISPID 5 or ABCD, and thus should not be used:

  • NNE
  • ESE
  • ESE
  • SSE
  • NNW
  • WNW
  • WSW
  • SSW

sub

Substrate. Maps to an extension to ABCD in HISPID 5: /HispidUnit/HispidGathering/Substrate.

A free text description of the substrate or parent rock material in the habitat from which the specimen was collected. This should not include soil type, as that is catered for separately.

For compatibility with ABCD it may be preferrable to supply data in the following manner: Gathering/Biotope/MeasurementsOrFacts/MeasurementOrFactAtomised/Parameter = substrate + Gathering/Biotope/MeasurementsOrFacts/MeasurementOrFactAtomised/LowerValue + Gathering/Biotope/MeasurementsOrFacts/MeasurementOrFactAtomised/IsQuantitative = false.

soil

Soil Type. Maps to an extension to ABCD in HISPID 5: /HispidUnit/HispidGathering/SoilType.

A free text description of the surface soil type from which the specimen was collected.

For compatibility with ABCD it may be preferrable to supply data in the following manner: Gathering/Biotope/MeasurementsOrFacts/MeasurementOrFactAtomised/Parameter = soil + Gathering/Biotope/MeasurementsOrFacts/MeasurementOrFactAtomised/LowerValue + /Gathering/Biotope/MeasurementsOrFacts/MeasurementOrFactAtomised/IsQuantitative = false.

veg

Vegetation. Maps to an extension to ABCD in HISPID 5: /HispidUnit/HispidGathering/Vegetation.

A free text description of the vegetation from which the specimen was collected.

For compatibility with ABCD it may preferrable to supply data in the following manner: Gathering/Biotope/MeasurementsOrFacts/MeasurementOrFactAtomised/Parameter = vegetation + Gathering/Biotope/MeasurementsOrFacts/MeasurementOrFactAtomised/LowerValue + Gathering/Biotope/MeasurementsOrFacts/MeasurementOrFactAtomised/IsQuantitative = false

asspp

Associated Species. Maps to ABCD in several places, depending on whether it is possible to atomise the data or not. For an atomised list of associated species, use Gathering/Synecology/AssociatedTaxa supplying one AssociatedTaxa element per taxon name. For a free text listing, used Gathering/Synecology/Comment.

Collection Group

cnam

Primary Collector's Name(s). Maps to ABCD in several places, depending on the level to which it is possible to atomise the data.

The name of the person or persons who made the collection from the wild of this specimen, and whose collection number is cited in Collector's Identifier. See also secondary collector's names, for which the same element structures are used with a minor difference. See also 'Per' Collector, which is accommodated in this element structure with a minor difference.

In AgentText, format the names of people according to HISPID, namely surname, initial. For all other elements, follow ABCD usage.

Records are sorted using the primarycollector attribute and continues with the sequence attribute. The sequence attribute starts at 1 and increments once for each individual collector.

Highly Atomised

For a highly atomised list of collector's names, use the Person and Organisation structures within GatheringAgent. All of the following elements should be set once for each primary collector.

Example 1:

...
<Agents>
    <GatheringAgent primarycollector="true" sequence="1">
        <Person>
            <FullName>W. Bauerlen</FullName>
            <SortingName>Bauerlen, W.</SortingName>
            <AtomisedName>
                <InheritedName>Bauerlen</InheritedName>
                <GivenNames>W.</GivenNames>
            </AtomisedName>
        </Person>
    </GatheringAgent>
    <GatheringAgent primarycollector="false" sequence="2">
        <Person>
            <FullName>C.G.G.J van Steenis</FullName>
            <SortingName>van Steenis, C.G.G.J</SortingName>
            <AtomisedName>
                <InheritedName>Steenis</InheritedName>
                <Prefix>van</Prefix>
                <GivenNames>C.G.G.J</GivenNames>
            </AtomisedName>
        </Person>
    </GatheringAgent>
</Agents>
...

Moderately Atomised

For a moderately atomised list of collector's names, use the repeating element GatheringAgent. All 3 of the following elements under GatheringAgent should be set once for each primary collector.

Example 2:

...
<Agents>
	<GatheringAgent primarycollector="true" sequence="1">
		<AgentText>Bauerlen, W.</AgentText>
	</GatheringAgent>
    <GatheringAgent primarycollector="false" sequence="2">
        <AgentText>Steenis, C.G.G.J. van</AgentText>
    </GatheringAgent>
</Agents>
...

Free Text

For a free text listing of primary collector's names, use Gathering/Agents/GatheringAgentsText. This is particularly useful when the collectors can not be broken into individual names. It may be useful to concatenate using semicolons for ease of reuse of this textual data, but if this is not possible, supply the original concatenated text unchanged.

Example 3:

...
<Agents>
    <GatheringAgentsText>Bauerlen, W.; Steenis, C.G.G.J. van</GatheringAgentsText>
</Agents>
...

cid

Collector's Identifier. Maps to CollectorsFieldNumber.

The sequential or other identifier given to the specimen at the time of collection by the primary collector(s), usually as on specimen label.

cnam2

Secondary Collector's Name. Maps as per Primary Collector's Name(s) except that [http://wiki.tdwg.org/twiki/bin/view/ABCD/AbcdConcept0891 Gathering/Agents/GatheringAgent[@primarycollector]] is supplied with a value of false for each secondary collector.

See cnam.

cid2

Secondary Collector's Identifier. New HISPID Element. Maps to a HispidUnit/SecondaryCollectorIdentifier.

In some cases, secondary collectors assign their own collection identifier to the collection event separate from the identifier given by the Primary Collector. It is thus useful to record this information separately from the Primary Collector's identifier.

cper

'Per' Collector. Unavailable in ABCD or HISPID 5. (Although a draft PerCollector element exists in HISPID 5 that has not yet been sufficiently cleaned up for general use.)

Amateur or casual collector who collected the specimen on behalf of the primary collector.

See Primary Collector's Name(s), which outlines the element structure used to codify a collector's name. A 'Per' Collector should be accommodated by appending (per) to the name of the last collector in the repeatable Agents/GatheringAgent (that with the largest @sequence attribute).

Example 1:

...
<Agents>
    <GatheringAgent primarycollector="true" sequence="1">
        <Person>
            <FullName>W. Bauerlen (per)</FullName>
            <SortingName>Bauerlen, W.</SortingName>
            <AtomisedName>
                <InheritedName>Bauerlen</InheritedName>
                <GivenNames>W.</GivenNames>
            </AtomisedName>
        </Person>
    </GatheringAgent>
</Agents>
...

Example 2:

...
<Agents>
	<GatheringAgent primarycollector="true" sequence="1">
		<AgentText>Bauerlen, W. (per)</AgentText>
	</GatheringAgent>
</Agents>
...


A boolean percollector attribute might reasonably be added to Agents/GatheringAgent in ABCD to enable this data to be more easily transferred.

cdat

Collection Date. Maps to Gathering/DateTime/ISODateTimeBegin.

The date on which this specimen was collected. If a second collection date is provided (see Second Collection Date), then this element contains the earlier collection date.

Examples:

  • 2005-11-01 for 1 November 2005
  • 1937-03 for an unknown day in March 1937
  • 1899 for an unknown day and month in 1899

Note that ABCD allows time information to be supplied also, for example 2005-11-01T15:23.