nhs-notify-standards

NHS Common Types v1.0.0

Reusable types for NHS Notify payload schemas.

$id	nhs-number.schema.json
$schema	https://json-schema.org/draft/2020-12/schema

Properties

Name		Type
nhsNumber	Any of:	String
		String

Example

{
    "nhsNumber": "9434765919"
}

Example

{
    "nhsNumber": "943 476 5919"
}

---

nhsNumber

Description	NHS Number provided either as canonical 10 digits or human-entered formatted variant (3-3-4 with optional spaces/hyphens).
Type	Any of:	String
		String
Required	Yes

nhsNumber.0

Description	NHS Number (10 digits; last digit is a Modulus-11 check digit).
Type	String
Format	nhs-number
Pattern	^[0-9]{10}$
Examples	9434765919 1234567890

nhsNumber.1

Description	Human-entered NHS Number (accepts 3-3-4 with optional spaces or hyphens).
Type	String
Format	nhs-number
Pattern	^(?:[0-9]{3}[- ]?[0-9]{3}[- ]?[0-9]{4})$
Examples	943 476 5919 943-476-5919 9434765919

---

Schema

{
    "$id": "nhs-number.schema.json",
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "NHS Common Types v1.0.0",
    "description": "Reusable types for NHS Notify payload schemas.",
    "type": "object",
    "properties": {
        "nhsNumber": {
            "anyOf": [
                {
                    "$ref": "#/$defs/NhsNumber10"
                },
                {
                    "$ref": "#/$defs/NhsNumberFormatted"
                }
            ],
            "description": "NHS Number provided either as canonical 10 digits or human-entered formatted variant (3-3-4 with optional spaces/hyphens).",
            "examples": [
                "9434765919",
                "943 476 5919",
                "943-476-5919"
            ]
        }
    },
    "required": [
        "nhsNumber"
    ],
    "$defs": {
        "NhsNumber10": {
            "$comment": "Canonical stored form: exactly 10 digits (no spaces or hyphens).\n10-digit requirement and check-digit semantics come from the NHS Data Dictionary.\nRef: NHS Number attribute & algorithm (Modulus 11).",
            "type": "string",
            "description": "NHS Number (10 digits; last digit is a Modulus-11 check digit).",
            "pattern": "^[0-9]{10}$",
            "format": "nhs-number",
            "examples": [
                "9434765919",
                "1234567890"
            ]
        },
        "NhsNumberFormatted": {
            "$comment": "UI/ingress tolerant form: allows 3-3-4 with optional spaces/hyphens. Still only digits once separators are removed.\nDisplay guidance to use 3-3-4 spacing; systems should accept flexible input.",
            "type": "string",
            "description": "Human-entered NHS Number (accepts 3-3-4 with optional spaces or hyphens).",
            "pattern": "^(?:[0-9]{3}[- ]?[0-9]{3}[- ]?[0-9]{4})$",
            "format": "nhs-number",
            "examples": [
                "943 476 5919",
                "943-476-5919",
                "9434765919"
            ]
        },
        "NhsNumber": {
            "$comment": "Strong type: canonical 10 digits + checksum verified via custom format. Note: 'format' requires runtime support to assert it.",
            "allOf": [
                {
                    "$ref": "#/$defs/NhsNumber10"
                },
                {
                    "format": "nhs-number",
                    "nhsChecksum": true
                }
            ],
            "description": "NHS Number with Mod-11 checksum enforcement.",
            "examples": [
                "9434765919"
            ]
        }
    },
    "examples": [
        {
            "nhsNumber": "9434765919"
        },
        {
            "nhsNumber": "943 476 5919"
        }
    ]
}