Raw schema
{
"type": "object",
"properties": {
"need": {
"type": "string",
"maxLength": 200,
"description": "Condition, procedure or focus, plain English."
},
"specialty": {
"type": "string",
"maxLength": 200,
"description": "Specialty name, a word from one, or a plain word like 'eye' (see list_specialties)."
},
"place": {
"type": "string",
"maxLength": 200,
"description": "New Zealand city, suburb, or region or Health NZ district (e.g. 'Waikato', 'Hawke's Bay', 'Capital and Coast')."
},
"name": {
"type": "string",
"maxLength": 200,
"description": "Doctor's name or part of it, to check a named doctor."
},
"sector": {
"type": "string",
"enum": [
"any",
"private",
"public"
],
"description": "private = the doctor lists a private service; public = a public (Health NZ) service. Default any."
},
"child": {
"type": "boolean",
"description": "True when the patient is a child: among doctors in the same place who match the need equally well, those in paediatrics or who list children in their focus come first, then those whose services say they see children; doctors whose services list only adult ages are left out. Most listings do not say, so those doctors stay in."
},
"language": {
"type": "string",
"maxLength": 200,
"description": "Language other than English the doctor, or a small clinic (3 doctors or fewer) they work in, lists, e.g. 'Mandarin', 'Hindi', 'Samoan'."
},
"gender": {
"type": "string",
"enum": [
"female",
"male"
],
"description": "Only when the person asks. Gender is recorded for only a small share of doctors (when their Healthpoint page states it); doctors without it are left out and gender_note says how many."
},
"southern_cross_affiliated": {
"type": "boolean",
"description": "True keeps doctors whose own Healthpoint page or at least one of whose service pages says Southern Cross Affiliated Provider (cover still depends on the policy and often prior approval; confirm)."
},
"experienced_first": {
"type": "boolean",
"description": "True when the person wants an experienced or senior doctor: among doctors who match equally well, those longer on the New Zealand specialist (vocational) register come first. Time on the register is not quality, and doctors who trained overseas may have practised longer than it shows."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 10,
"description": "Default 10."
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 20,
"description": "For paging (at most 20, so 30 results in all: narrow the search instead)."
}
},
"additionalProperties": false
}