Schemas / Person / organisation / party

rig.person.identifier

v1.0.0 · stable maturity: draft 4 fields 0 required

Fields

FieldTypeMeaning
nationalId string optional National identity number as issued
taxId string optional Tax identifier as issued (TIN, ABN, NINO, TFN)
mrn string optional Medical record number as issued
passport string optional Passport number as issued

Issued identifiers of a person. Format when present.

Field meanings follow ISO 20022 party identification slots used inside financial MX messages, plus a medical record number. This schema is those identifiers - not an MX message, not a login, and not a system + value bag.

All fields optional. Emit what the source has; omit empty strings. An empty component is invalid - attach at least one field.

Compose onto the person. Do not copy an MRN onto an encounter, and do not invent a second identifier scheme field. Name parts stay on rig.person.name.

JSON Schema

Resolves at https://rig.works/schemas/rig.person.identifier.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.person.identifier.schema.json",
  "title": "rig.person.identifier",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "nationalId": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "taxId": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "mrn": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "passport": {
      "$ref": "./_defs.schema.json#/$defs/string"
    }
  },
  "description": "Issued identifiers of a person. nationalId, taxId, mrn, passport as the source wrote them. Not a system+value bag.",
  "minProperties": 1,
  "x-rig-maturity": "draft"
}

Seen in

record-care.json · record-shop.json