Identifiant externe

L'entité ExternalIdentifier permet aux créateurs de flux d'associer des ensembles arbitraires de paires source-valeur à certains objets. ExternalIdentifier est souvent le code d'une juridiction dans un système externe utilisé pour associer une juridiction à des objets tels que des candidats, des bureaux ou des unités géopolitiques.

Le champ Type d'une entité ExternalIdentifier permet de décrire la source de l'identifiant, et non l'objet identifié. Par exemple, deux des types intégrés sont fips, qui correspond à l'abréviation de "Federal Information Processing Standard", et state. Même si les codes FIPS à deux chiffres peuvent être utilisés pour décrire les états, la valeur Type prévue dans cette situation est fips et non state. En effet, fips décrit la source de l'identifiant.

Les identifiants externes sont utilisés dans le flux aux fins suivantes:

  • Indiquez un identifiant stable.
  • Indiquez un identifiant canonique à partir d'une ressource externe, tel qu'un identifiant de données Open Civic ou un code FIPS.
  • Fournissez des attributs supplémentaires qui ne sont pas natifs dans le schéma CDF du NIST.

Lorsqu'ils sont utilisés pour fournir des données ou du contexte supplémentaires pour un objet, les identifiants externes doivent utiliser un Type défini sur other. Elles incluent également un OtherType et un Value qui dépendent tous deux du type de données fournies. Pour découvrir comment les données peuvent être fournies de cette manière, consultez Office.

Attributs

Le tableau suivant décrit les attributs de ExternalIdentifier:

Attribut Requis ? Type Description
label Facultatif string Une étiquette informative. À utiliser selon les besoins.

Éléments

Le tableau suivant présente les éléments pour ExternalIdentifier:

Élément Multiplicité Type Description
Type 1 IdentifierType Fournit un type d'identifiant.
OtherType 0 ou 1 string Utilisé lorsque la valeur de IdentifierType est other.
Value 1 string Identifiant utilisé par la juridiction.

Exemples

XML

    <ExternalIdentifiers>
     <ExternalIdentifier>
        <Type>other</Type>
        <OtherType>stable</OtherType>
        <Value>stable-gu-0081</Value>
      </ExternalIdentifier>
      <ExternalIdentifier>
        <Type>ocd-id</Type>
        <Value>ocd-division/country:ke/county:narok</Value>
      </ExternalIdentifier>
      <ExternalIdentifier>
        <Type>national-level</Type>
        <Value>33</Value>
      </ExternalIdentifier>
    </ExternalIdentifiers>

JSON

    "ExternalIdentifiers": {
      "ExternalIdentifier" : [
        {
          "Type": "other",
          "OtherType": "stable",
          "Value": "stable-gu-0081"
        },
        {
          "Type": "ocd-id",
          "Value": "ocd-division/country:ke/county:narok"
        },
        {
          "Type": "national-level",
          "Value": "33"
        }
      ]
    }