@cef-ebsi/vcdm1.1-dc4eu-professional-suitability

Professional Suitabilty

Schema for professional suitabilty credentials for physicians

The schema is published to the Trusted Schemas Registry with the IDs:

• 0x5aab12e42c14b89e36df1b9a734a8137347c8d47ca25c7d74e68775144dbd0a1 (hexadecimal)
• z76vzVqEqLdfAwAUkdYwcWVjNCddAS86cSRsyEr2aHGRe (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Professional Suitabilty",
  "description": "Schema for professional suitabilty credentials for physicians",
  "type": "object",
  "allOf": [
    {
      "$ref": "./node_modules/@cef-ebsi/vcdm1.1-attestation-schema/schema.json"
    },
    {
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "Unique identifier for the doctor ID credential"
        },
        "type": {
          "type": "array",
          "description": "Credential type definitions",
          "items": {
            "type": "string"
          },
          "default": [
            "VerifiableCredential",
            "VerifiableAttestation",
            "ProfessionalSuitabilityCredential"
          ]
        },
        "issuer": {
          "type": "object",
          "description": "Information about the issuing institution",
          "properties": {
            "id": {
              "type": "string",
              "format": "uri",
              "description": "Unique identifier of the issuing institution"
            },
            "name": {
              "type": "object",
              "description": "Multilingual name of the issuing institution",
              "additionalProperties": {
                "type": "string"
              }
            }
          },
          "required": ["id", "name"]
        },
        "issuanceDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date when the doctor ID was issued"
        },
        "expirationDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date when the doctor ID expires"
        },
        "credentialSubject": {
          "type": "object",
          "description": "Information about the doctor and their status",
          "properties": {
            "id": {
              "type": "string",
              "format": "uri"
            },
            "givenName": {
              "description": "Current first name(s), including middle name(s) where applicable, of the user to whom the person identification data relates.",
              "type": "string"
            },
            "familyName": {
              "description": "Current last name(s) or surname(s) of the user to whom the person identification data relates.",
              "type": "string"
            },
            "legallyEntitled": {
              "description": "Defines whether the professional is considered to be qualified to practise medicine, and there is no record of the professional having been sanctioned or disqualified from practising as a doctor.",
              "type": "boolean"
            },
            "medicalRegistration": {
              "description": "National or Regional professional body to which the physician has been registered.",
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "medicalBoard": {
                    "description": "Corresponds to the regional professional body of physicians where the professional is registered.",
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": [
                        "Álava/Áraba",
                        "Albacete",
                        "Alicante",
                        "Almería",
                        "Ávila",
                        "Badajoz",
                        "Islas Baleares/Illes Balears",
                        "Barcelona",
                        "Burgos",
                        "Cáceres",
                        "Cádiz",
                        "Castellón",
                        "Ciudad Real",
                        "Córdoba",
                        "La Coruña/A Coruña",
                        "Cuenca",
                        "Gerona/Girona",
                        "Granada",
                        "Guadalajara",
                        "Guipúzcoa/Gipuzkoa",
                        "Huelva",
                        "Huesca",
                        "Jaén",
                        "León",
                        "Lérida/Lleida",
                        "La Rioja",
                        "Lugo",
                        "Madrid",
                        "Málaga",
                        "Murcia",
                        "Navarra",
                        "Orense/Ourense",
                        "Asturias",
                        "Palencia",
                        "Las Palmas",
                        "Pontevedra",
                        "Salamanca",
                        "Santa Cruz de Tenerife",
                        "Cantabria",
                        "Segovia",
                        "Sevilla",
                        "Soria",
                        "Tarragona",
                        "Teruel",
                        "Toledo",
                        "Valencia",
                        "Valladolid",
                        "Vizcaya/Bizkaia",
                        "Zamora",
                        "Zaragoza",
                        "Ceuta",
                        "Melilla"
                      ]
                    }
                  },
                  "personalAdministrativeNumber": {
                    "description": "Identification number of the registered physician.",
                    "type": "string",
                    "pattern": "([0-9]{9})"
                  },
                  "membershipStartDate": {
                    "description": "Date from which a professional has been registered to the National or Regional Physicians Body.",
                    "type": "string",
                    "format": "date-time"
                  },
                  "membershipEndDate": {
                    "description": "Date from which a professional has been deregistered to the National or Regional Physicians Body",
                    "type": "string",
                    "format": "date-time"
                  }
                }
              }
            }
          },
          "required": [
            "id",
            "givenName",
            "familyName",
            "medicalRegistration",
            "legallyEntitled"
          ]
        },
        "proof": {
          "type": "object",
          "description": "Cryptographic proof of the credential",
          "properties": {
            "type": {
              "type": "string",
              "description": "Type of proof"
            },
            "created": {
              "type": "string",
              "format": "date-time",
              "description": "Date and time when the proof was created"
            },
            "proofPurpose": {
              "type": "string",
              "description": "Purpose of the proof"
            },
            "verificationMethod": {
              "type": "string",
              "format": "uri",
              "description": "Method used to verify the proof"
            },
            "proofValue": {
              "type": "string",
              "description": "Value of the proof"
            }
          },
          "required": [
            "type",
            "created",
            "proofPurpose",
            "verificationMethod",
            "proofValue"
          ]
        }
      },
      "required": [
        "@context",
        "id",
        "type",
        "issuer",
        "issuanceDate",
        "expirationDate",
        "credentialSubject",
        "proof"
      ]
    }
  ]
}

Installation

# with npm
npm add @cef-ebsi/[email protected]

# with Yarn
yarn add @cef-ebsi/[email protected]

# with pnpm
pnpm add @cef-ebsi/[email protected]

Usage

The package exports the schema and its metadata as JavaScript objects:

import {
  schema,
  metadata,
} from "@cef-ebsi/vcdm1.1-dc4eu-professional-suitability";

// you can now use the schema and metadata

In addition, the package exports a TypeScript type corresponding to the schema:

import type { ProfessionalSuitabilty } from "@cef-ebsi/vcdm1.1-dc4eu-professional-suitability";

License

Copyright (C) 2024 European Union

This program is free software: you can redistribute it and/or modify it under the terms of the EUROPEAN UNION PUBLIC LICENCE v. 1.2 as published by the European Union.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the EUROPEAN UNION PUBLIC LICENCE v. 1.2 for further details.

You should have received a copy of the EUROPEAN UNION PUBLIC LICENCE v. 1.2. along with this program. If not, see https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12.