Provider

pydantic model Provider[source]

A provider.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Show JSON schema

{
   "title": "Provider",
   "description": "A provider.",
   "type": "object",
   "properties": {
      "code": {
         "description": "A locally unique code within the prefix for the provider",
         "title": "Code",
         "type": "string"
      },
      "name": {
         "description": "Name of the provider",
         "title": "Name",
         "type": "string"
      },
      "description": {
         "description": "Description of the provider",
         "title": "Description",
         "type": "string"
      },
      "homepage": {
         "description": "Homepage of the provider",
         "title": "Homepage",
         "type": "string"
      },
      "uri_format": {
         "description": "The URI format string, which must have at least one ``$1`` in it. Note that this field is generic enough to accept IRIs. See the URI specification (https://www.rfc-editor.org/rfc/rfc3986) and IRI specification (https://www.ietf.org/rfc/rfc3987.txt) for more information.",
         "title": "URI Format",
         "type": "string"
      },
      "first_party": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Annotates whether a provider is from the first-party organization",
         "title": "First Party"
      },
      "publications": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Publication"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A list of publications about the provider. See the `indra` provider for `hgnc` for an example.",
         "title": "Publications"
      }
   },
   "$defs": {
      "Publication": {
         "description": "Metadata about a publication.",
         "properties": {
            "pubmed": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The PubMed identifier for the article",
               "title": "PubMed"
            },
            "doi": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The DOI for the article. DOIs are case insensitive, so these are required by the Bioregistry to be standardized to their lowercase form.",
               "title": "DOI"
            },
            "pmc": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The PubMed Central identifier for the article",
               "title": "PMC"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The title of the article",
               "title": "Title"
            },
            "year": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The year the article was published",
               "title": "Year"
            }
         },
         "title": "Publication",
         "type": "object"
      }
   },
   "required": [
      "code",
      "name",
      "description",
      "homepage",
      "uri_format"
   ]
}

Fields:

code (str)
description (str)
first_party (bool | None)
homepage (str)
name (str)
publications (List[bioregistry.schema.struct.Publication] | None)
uri_format (str)

field code: str [Required]: A locally unique code within the prefix for the provider

field description: str [Required]: Description of the provider

field first_party: bool | None = None: Annotates whether a provider is from the first-party organization

field homepage: str [Required]: Homepage of the provider

field name: str [Required]: Name of the provider

field publications: List['Publication'] | None = None: A list of publications about the provider. See the indra provider for hgnc for an example.

field uri_format: str [Required]: The URI format string, which must have at least one $1 in it. Note that this field is generic enough to accept IRIs. See the URI specification (https://www.rfc-editor.org/rfc/rfc3986) and IRI specification (https://www.ietf.org/rfc/rfc3987.txt) for more information.

resolve(identifier: str) → str[source]

Resolve the identifier into a URI.

Parameters:: identifier – The identifier in the semantic space
Returns:: The URI for the identifier