.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXidentifier.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXidentifier (base class)
    ! identifier (base class)
    see: identifier (base class); NXidentifier

.. _NXidentifier:

============
NXidentifier
============

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  An identifier for a (persistent) resource, e.g., a DOI or orcid.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. _/NXidentifier/service-field:

  .. index:: service (field)

  **service**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: The service by which the resouce can be resolved. ...

        The service by which the resouce can be resolved.
        If the service is not in the list a simple `url` may be used.
        The `url` can either be a resolving service for the `identifier`
        or a fully qualified identification in itself.

        Any of these values:

          * ``doi``

          * ``urn``

          * ``hdl``

          * ``purl``

          * ``orcid``

          * ``iso``

          * ``url``


  .. _/NXidentifier/identifier-field:

  .. index:: identifier (field)

  **identifier**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: The unique code, IRI or hash to resolve this reference. ...

        The unique code, IRI or hash to resolve this reference.
        Typically, this is stated by the service which is considered a complete
        identifier, e.g., for a DOI it's something of the form `10.1107/S1600576714027575`
        or `https://doi.org/10.1107/S1600576714027575`, which are both resolvable.

  .. _/NXidentifier/is_persistent-field:

  .. index:: is_persistent (field)

  **is_persistent**: (optional) :ref:`NX_BOOLEAN <NX_BOOLEAN>` 

    .. collapse:: True if the identifier is persistent (i.e., unique and available indefinetely) ...

        True if the identifier is persistent (i.e., unique and available indefinetely),
        False otherwise.


Hypertext Anchors
-----------------

List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.


* :ref:`/NXidentifier/identifier-field </NXidentifier/identifier-field>`
* :ref:`/NXidentifier/is_persistent-field </NXidentifier/is_persistent-field>`
* :ref:`/NXidentifier/service-field </NXidentifier/service-field>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXidentifier.nxdl.xml