Raw schema
{
"type": "object",
"properties": {
"date": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Appointment date/time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"created": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Created (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"part_status": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "The patient's participation status, e.g. booked, arrived, cancelled."
},
"patient": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "Patient id."
},
"practitioner": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "Practitioner id, e.g. PR-123."
},
"practitioner_role": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "PractitionerRole id."
},
"organization": {
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_/-]{0,127}(,[A-Za-z0-9][A-Za-z0-9_/-]{0,127}){0,19}$",
"description": "The clinic (Organization) id including its prefix."
},
"id": {
"description": "One id or several separated by commas, for example 1,2,3.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}(,[A-Za-z0-9][A-Za-z0-9_-]{0,63}){0,49}$"
},
"last_updated": {
"type": "string",
"pattern": "^(eq|ne|gt|lt|ge|le)?\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le)."
},
"sort": {
"description": "Sort order: date, -date (\"-\" = descending).",
"type": "string",
"enum": [
"date",
"-date"
]
},
"include": {
"description": "Also return related resources in \"included\": any of Appointment:patient, Appointment:practitioner-role.",
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"Appointment:patient",
"Appointment:practitioner-role"
]
}
},
"include_iterate": {
"description": "Also return resources related to an included one (needs the matching include): any of PractitionerRole:practitioner, PractitionerRole:organization.",
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"PractitionerRole:practitioner",
"PractitionerRole:organization"
]
}
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"count": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}