nhs-notify-standards

Example data type

Example data type

$id	nhs-notify-example-event-data.schema.json
$schema	https://json-schema.org/draft/2020-12/schema

Properties

Name		Type
nhsNumber

Example

{
    "nhsNumber": "9434765919"
}

---

nhsNumber

Defined in ./nhs-number.schema.html#/properties/nhsnumber

Description	Example patient's NHS Number (accepts canonical or formatted forms).
Type	Any of:	String
		String
Required	Yes

---

Schema

{
    "$id": "nhs-notify-example-event-data.schema.json",
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "Example data type",
    "description": "Example data type",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "nhsNumber": {
            "$ref": "./nhs-number.schema.json#/properties/nhsNumber",
            "description": "Example patient's NHS Number (accepts canonical or formatted forms).",
            "examples": [
                "9434765919",
                "943 476 5919",
                "943-476-5919"
            ]
        }
    },
    "required": [
        "nhsNumber"
    ],
    "examples": [
        {
            "nhsNumber": "9434765919"
        }
    ]
}