Identifiant externe

L'entité ExternalIdentifier permet aux créateurs de flux d'associer des ensembles arbitraires de paires source-valeur à certains objets. ExternalIdentifier est un code de juridiction souvent utilisé dans un système externe 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, une abréviation du code "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 pour cette situation est fips et non state. En effet, fips décrit la source de l'identifiant.

Les identifiants externes sont utilisés dans l'ensemble du flux aux fins suivantes :

  • Indiquez un identifiant stable.
  • Fournissez un identifiant canonique provenant d'une ressource externe, comme les identifiants Open Civic Data ou le code FIPS.
  • Fournissez des attributs supplémentaires qui ne sont pas natifs du schéma NIST CDF.

Lorsqu'ils sont utilisés pour fournir des données ou un contexte supplémentaires pour un objet, les identifiants externes doivent utiliser un Type de other. Ils incluent également OtherType et Value, qui dépendent tous deux du type de données fourni. Pour obtenir un exemple de la façon dont les données peuvent être fournies de cette manière, consultez Office.

Attributs

Le tableau suivant décrit les attributs de ExternalIdentifier :

Attribut Obligatoire ? Type Description
label Facultatif string Un libellé informatif. À utiliser selon les besoins.

Éléments

Le tableau suivant présente les éléments de 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"
        }
      ]
    }