Identifiant externe

L'entité ExternalIdentifier permet aux créateurs de flux d'associer des ensembles arbitraires des paires source/valeur avec certains objets. ExternalIdentifier est souvent code de la juridiction dans un système externe permettant d'associer et d'objets tels que des candidats, des bureaux ou des unités géopolitiques.

Le champ Type d'une entité ExternalIdentifier permet de décrire source de l'identifiant, et non pas de l'objet identifié. Par exemple, deux de les types intégrés sont fips (abréviation de "Federal Information" Norme de traitement" le code et state. Même si les codes FIPS à deux chiffres peuvent être utilisée 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 le flux aux fins suivantes:

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

Lorsqu'elles sont utilisées pour fournir des données ou du contexte supplémentaires à un objet, les identifiants doivent utiliser un Type de other. Elles comprennent également un OtherType et un Value qui dépendent tous deux du type de données fournies. Pour une exemple de la manière dont les données peuvent être fournies de cette manière, voir Office

Attributs

Le tableau suivant décrit les attributs de ExternalIdentifier:

Attribut Requis ? Type Description
label Facultatif string É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"
        }
      ]
    }