Skip to content

Class: ResidencePermitDetailsClass

The details of a biometric residency permit as presented by reading the biometric chip data using near-field communication (NFC), reading the Machine Readable Zone (MRZ) or manually input by a user.

JSON schema: di_vocab:ResidencePermit

Examples

UK Biometric Residence Permit

URI: di_vocab:class/ResidencePermitDetailsClass

classDiagram class ResidencePermitDetailsClass click ResidencePermitDetailsClass href "../../classes/ResidencePermitDetailsClass/" DocumentDetailsClass <|-- ResidencePermitDetailsClass click DocumentDetailsClass href "../../classes/DocumentDetailsClass/" ResidencePermitDetailsClass : documentNumber ResidencePermitDetailsClass : documentType ResidencePermitDetailsClass : expiryDate ResidencePermitDetailsClass : icaoIssuerCode ResidencePermitDetailsClass : issueDate ResidencePermitDetailsClass : validFrom ResidencePermitDetailsClass : validUntil

Inheritance

Slots

Name Cardinality and Range Description Inheritance
documentType 0..1
String		 An identifier of the type of document, for example IR for Biometric Residence... direct
documentNumber 1
String		 An identifier generated for the specific document when it was issued, for exa... direct
icaoIssuerCode 1
String		 An identifier for the issuing State or Organisation of a passport as defined ... direct
issueDate 0..1
Date		 The date the document was issued by the issuing authority DocumentDetailsClass
expiryDate 1
Date		 The date the document expires DocumentDetailsClass
validFrom 0..1
Date		 ValidityClass
validUntil 0..1
Date		 ValidityClass

Usages

used by used in type used
PersonWithDocumentsClass residencePermit range ResidencePermitDetailsClass
IdentityCheckSubjectClass residencePermit range ResidencePermitDetailsClass

See Also

Identifier and Mapping Information

Schema Source

  • from schema: https://vocab.account.gov.uk/linkml/credentials-schema

Mappings

Mapping Type Mapped Value
self di_vocab:ResidencePermitDetailsClass
native di_vocab:ResidencePermitDetailsClass

LinkML Source

Direct

name: ResidencePermitDetailsClass
description: The details of a biometric residency permit as presented by reading the
  biometric chip data using near-field communication (NFC), reading the Machine Readable
  Zone (MRZ) or manually input by a user. <p>JSON schema&#58; [di_vocab:ResidencePermit](../json-schemas/ResidencePermit.json)</p>
  <p>Examples</p> <ul> <li> [UK Biometric Residence Card](../examples/ResidencePermitDetailsClass/UKBRC.json)
  </li> </ul> [UK Biometric Residence Permit](../examples/ResidencePermitDetailsClass/UKBRP.json)
  </li> </ul>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
see_also:
- ../json-schemas/ResidencePermit.json
is_a: DocumentDetailsClass
slots:
- documentType
- documentNumber
- icaoIssuerCode
slot_usage:
  expiryDate:
    name: expiryDate
    required: true

Induced

name: ResidencePermitDetailsClass
description: The details of a biometric residency permit as presented by reading the
  biometric chip data using near-field communication (NFC), reading the Machine Readable
  Zone (MRZ) or manually input by a user. <p>JSON schema&#58; [di_vocab:ResidencePermit](../json-schemas/ResidencePermit.json)</p>
  <p>Examples</p> <ul> <li> [UK Biometric Residence Card](../examples/ResidencePermitDetailsClass/UKBRC.json)
  </li> </ul> [UK Biometric Residence Permit](../examples/ResidencePermitDetailsClass/UKBRP.json)
  </li> </ul>
from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
see_also:
- ../json-schemas/ResidencePermit.json
is_a: DocumentDetailsClass
slot_usage:
  expiryDate:
    name: expiryDate
    required: true
attributes:
  documentType:
    name: documentType
    description: An identifier of the type of document, for example IR for Biometric
      Residence Permit, CR for Biometric Residence Card.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: documentType
    owner: ResidencePermitDetailsClass
    domain_of:
    - ResidencePermitDetailsClass
    range: string
  documentNumber:
    name: documentNumber
    description: An identifier generated for the specific document when it was issued,
      for example the passport number.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: documentNumber
    owner: ResidencePermitDetailsClass
    domain_of:
    - PassportDetailsClass
    - ResidencePermitDetailsClass
    - IdCardDetailsClass
    range: string
    required: true
  icaoIssuerCode:
    name: icaoIssuerCode
    description: An identifier for the issuing State or Organisation of a passport
      as defined by the [International Civil Aviation Organization (ICAO) Standard
      for Machine Readable Travel Documents](https://www.icao.int/publications/Documents/9303_p3_cons_en.pdf).
      Usually three characters.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: icaoIssuerCode
    owner: ResidencePermitDetailsClass
    domain_of:
    - PassportDetailsClass
    - ResidencePermitDetailsClass
    - IdCardDetailsClass
    range: string
    required: true
  issueDate:
    name: issueDate
    description: The date the document was issued by the issuing authority.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: issueDate
    owner: ResidencePermitDetailsClass
    domain_of:
    - DocumentDetailsClass
    range: date
  expiryDate:
    name: expiryDate
    description: The date the document expires.
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    alias: expiryDate
    owner: ResidencePermitDetailsClass
    domain_of:
    - DocumentDetailsClass
    range: date
    required: true
  validFrom:
    name: validFrom
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    slot_uri: schema:validFrom
    alias: validFrom
    owner: ResidencePermitDetailsClass
    domain_of:
    - ValidityClass
    - MitigatingCredentialClass
    range: date
  validUntil:
    name: validUntil
    from_schema: https://vocab.account.gov.uk/linkml/credentials-schema
    rank: 1000
    slot_uri: schema:validUntil
    alias: validUntil
    owner: ResidencePermitDetailsClass
    domain_of:
    - ValidityClass
    range: date