{ "openapi": "3.0.4", "info": { "title": "RSI Public Platform API", "description": "Practice-scoped scheduling API for OAuth client-credentials integrations: patient match/create, slot discovery, and appointment booking/cancel. Grants with confirmation_required (llm_agent clients) perform every mutation in two phases — a 428 challenge, then an identical resend with the confirmationToken. Errors are RFC 7807 problem+json with a stable machine `code`.", "version": "v1" }, "paths": { "/appointments": { "get": { "tags": [ "Appointments" ], "parameters": [ { "name": "PatientId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ProviderId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "LocationId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "VisitTypeId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ProcedureId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AppointmentSummaryDTOCursorPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentSummaryDTOCursorPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AppointmentSummaryDTOCursorPage" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Appointments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookAppointmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookAppointmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BookAppointmentRequest" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AppointmentBookedDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentBookedDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AppointmentBookedDTO" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "428": { "description": "Precondition Required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/appointments/{appointmentId}": { "get": { "tags": [ "Appointments" ], "parameters": [ { "name": "appointmentId", "in": "path", "required": true, "schema": { "pattern": "^apt_[0-9A-Za-z]{22}$", "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AppointmentDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AppointmentDTO" } } } } } } }, "/appointments/{appointmentId}/cancel": { "post": { "tags": [ "Appointments" ], "parameters": [ { "name": "appointmentId", "in": "path", "required": true, "schema": { "pattern": "^apt_[0-9A-Za-z]{22}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelAppointmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancelAppointmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CancelAppointmentRequest" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AppointmentLifecycleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentLifecycleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AppointmentLifecycleResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "428": { "description": "Precondition Required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/appointments/{appointmentId}/confirm": { "post": { "tags": [ "Appointments" ], "parameters": [ { "name": "appointmentId", "in": "path", "required": true, "schema": { "pattern": "^apt_[0-9A-Za-z]{22}$", "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AppointmentLifecycleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentLifecycleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AppointmentLifecycleResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/capabilities": { "get": { "tags": [ "Capabilities" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CapabilitiesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CapabilitiesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CapabilitiesResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/locations": { "get": { "tags": [ "Locations" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocationSummaryDTOCursorPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocationSummaryDTOCursorPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocationSummaryDTOCursorPage" } } } } } } }, "/locations/{locationId}": { "get": { "tags": [ "Locations" ], "parameters": [ { "name": "locationId", "in": "path", "required": true, "schema": { "pattern": "^loc_[0-9A-Za-z]{22}$", "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocationDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocationDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocationDTO" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/patients": { "get": { "tags": [ "Patients" ], "parameters": [ { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "LastName", "in": "query", "schema": { "type": "string" } }, { "name": "Dob", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Phone", "in": "query", "schema": { "type": "string" } }, { "name": "LastUpdated", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PatientSummaryDTOCursorPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PatientSummaryDTOCursorPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PatientSummaryDTOCursorPage" } } } }, "422": { "description": "Unprocessable Content", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePatientRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePatientRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePatientRequest" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PatientCreatedDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PatientCreatedDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PatientCreatedDTO" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "428": { "description": "Precondition Required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/patients/match": { "post": { "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchPatientRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MatchPatientRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MatchPatientRequest" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PatientSummaryDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PatientSummaryDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PatientSummaryDTO" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/patients/{patientId}": { "get": { "tags": [ "Patients" ], "parameters": [ { "name": "patientId", "in": "path", "required": true, "schema": { "pattern": "^pat_[0-9A-Za-z]{22}$", "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PatientDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PatientDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PatientDTO" } } } } } }, "put": { "tags": [ "Patients" ], "parameters": [ { "name": "patientId", "in": "path", "required": true, "schema": { "pattern": "^pat_[0-9A-Za-z]{22}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePatientRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePatientRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePatientRequest" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PatientUpdatedDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PatientUpdatedDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PatientUpdatedDTO" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "428": { "description": "Precondition Required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/procedures": { "get": { "tags": [ "Procedures" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProcedureSummaryDTOCursorPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProcedureSummaryDTOCursorPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProcedureSummaryDTOCursorPage" } } } } } } }, "/procedures/{procedureId}": { "get": { "tags": [ "Procedures" ], "parameters": [ { "name": "procedureId", "in": "path", "required": true, "schema": { "pattern": "^prc_[0-9A-Za-z]{22}$", "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProcedureDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProcedureDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProcedureDTO" } } } } } } }, "/providers": { "get": { "tags": [ "Providers" ], "parameters": [ { "name": "locationId", "in": "query", "schema": { "pattern": "^loc_[0-9A-Za-z]{22}$", "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderSummaryDTOCursorPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderSummaryDTOCursorPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderSummaryDTOCursorPage" } } } } } } }, "/providers/{providerId}": { "get": { "tags": [ "Providers" ], "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "pattern": "^prv_[0-9A-Za-z]{22}$", "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderDTO" } } } } } } }, "/providers/{providerId}/business-hours": { "get": { "tags": [ "Providers" ], "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "pattern": "^prv_[0-9A-Za-z]{22}$", "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProviderLocationHoursDTOCollectionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProviderLocationHoursDTOCollectionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProviderLocationHoursDTOCollectionResponse" } } } } } } }, "/slots": { "get": { "tags": [ "Slots" ], "parameters": [ { "name": "ProviderId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "LocationId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "VisitTypeId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ProcedureId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SlotDTOCursorPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SlotDTOCursorPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SlotDTOCursorPage" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/slots/{slotId}": { "get": { "tags": [ "Slots" ], "parameters": [ { "name": "slotId", "in": "path", "required": true, "schema": { "pattern": "^slt_[0-9A-Za-z]{22}$", "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SlotDetailDTO" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SlotDetailDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SlotDetailDTO" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/visit-types": { "get": { "tags": [ "VisitTypes" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VisitTypeDTOCursorPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VisitTypeDTOCursorPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VisitTypeDTOCursorPage" } } } } } } }, "/visit-types/{visitTypeId}/procedures": { "get": { "tags": [ "VisitTypes" ], "parameters": [ { "name": "visitTypeId", "in": "path", "required": true, "schema": { "pattern": "^vst_[0-9A-Za-z]{22}$", "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProcedureSummaryDTOCollectionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProcedureSummaryDTOCollectionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProcedureSummaryDTOCollectionResponse" } } } } } } } }, "components": { "schemas": { "AddressRequest": { "type": "object", "properties": { "line1": { "type": "string", "nullable": true }, "line2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AppointmentBookedDTO": { "type": "object", "properties": { "appointmentId": { "pattern": "^apt_[0-9A-Za-z]{22}$", "type": "string" } }, "additionalProperties": false }, "AppointmentDTO": { "type": "object", "properties": { "id": { "pattern": "^apt_[0-9A-Za-z]{22}$", "type": "string" }, "patientId": { "pattern": "^pat_[0-9A-Za-z]{22}$", "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true }, "providerId": { "pattern": "^prv_[0-9A-Za-z]{22}$", "type": "string" }, "providerName": { "type": "string", "nullable": true }, "locationId": { "pattern": "^loc_[0-9A-Za-z]{22}$", "type": "string" }, "locationName": { "type": "string", "nullable": true }, "locationAddress": { "type": "string", "nullable": true }, "visitTypeId": { "pattern": "^vst_[0-9A-Za-z]{22}$", "type": "string" }, "visitType": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AppointmentLifecycleResponse": { "type": "object", "properties": { "appointmentId": { "pattern": "^apt_[0-9A-Za-z]{22}$", "type": "string" }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AppointmentSummaryDTO": { "type": "object", "properties": { "id": { "pattern": "^apt_[0-9A-Za-z]{22}$", "type": "string" }, "patientId": { "pattern": "^pat_[0-9A-Za-z]{22}$", "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true }, "providerId": { "pattern": "^prv_[0-9A-Za-z]{22}$", "type": "string" }, "providerName": { "type": "string", "nullable": true }, "locationId": { "pattern": "^loc_[0-9A-Za-z]{22}$", "type": "string" }, "locationName": { "type": "string", "nullable": true }, "visitTypeId": { "pattern": "^vst_[0-9A-Za-z]{22}$", "type": "string" }, "visitType": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AppointmentSummaryDTOCursorPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AppointmentSummaryDTO" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BookAppointmentRequest": { "type": "object", "properties": { "patientId": { "pattern": "^pat_[0-9A-Za-z]{22}$", "type": "string" }, "slotId": { "pattern": "^slt_[0-9A-Za-z]{22}$", "type": "string" }, "notes": { "type": "string", "nullable": true }, "confirmationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CancelAppointmentRequest": { "type": "object", "properties": { "confirmationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CapabilitiesResponse": { "type": "object", "properties": { "capabilities": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CreatePatientRequest": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date-time", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "providerId": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/AddressRequest" }, "confirmationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HoursEntryDTO": { "type": "object", "properties": { "dayOfWeek": { "type": "string", "nullable": true }, "openTime": { "type": "string", "nullable": true }, "closeTime": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LocationDTO": { "type": "object", "properties": { "id": { "pattern": "^loc_[0-9A-Za-z]{22}$", "type": "string" }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "hours": { "type": "array", "items": { "$ref": "#/components/schemas/HoursEntryDTO" }, "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LocationSummaryDTO": { "type": "object", "properties": { "id": { "pattern": "^loc_[0-9A-Za-z]{22}$", "type": "string" }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LocationSummaryDTOCursorPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LocationSummaryDTO" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MatchPatientRequest": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "dob": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "PatientCreatedDTO": { "type": "object", "properties": { "patientId": { "pattern": "^pat_[0-9A-Za-z]{22}$", "type": "string" } }, "additionalProperties": false }, "PatientDTO": { "type": "object", "properties": { "id": { "pattern": "^pat_[0-9A-Za-z]{22}$", "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date-time", "nullable": true }, "email": { "type": "string", "nullable": true }, "mobilePhone": { "type": "string", "nullable": true }, "homePhone": { "type": "string", "nullable": true }, "workPhone": { "type": "string", "nullable": true }, "otherPhone": { "type": "string", "nullable": true }, "addressLine1": { "type": "string", "nullable": true }, "addressLine2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "mrn": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PatientSummaryDTO": { "type": "object", "properties": { "id": { "pattern": "^pat_[0-9A-Za-z]{22}$", "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date-time", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PatientSummaryDTOCursorPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PatientSummaryDTO" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PatientUpdatedDTO": { "type": "object", "properties": { "patientId": { "pattern": "^pat_[0-9A-Za-z]{22}$", "type": "string" } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProcedureDTO": { "type": "object", "properties": { "id": { "pattern": "^prc_[0-9A-Za-z]{22}$", "type": "string" }, "name": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "requireInsurance": { "type": "boolean" } }, "additionalProperties": false }, "ProcedureSummaryDTO": { "type": "object", "properties": { "id": { "pattern": "^prc_[0-9A-Za-z]{22}$", "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcedureSummaryDTOCollectionResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProcedureSummaryDTO" }, "nullable": true } }, "additionalProperties": false }, "ProcedureSummaryDTOCursorPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProcedureSummaryDTO" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ProviderDTO": { "type": "object", "properties": { "id": { "pattern": "^prv_[0-9A-Za-z]{22}$", "type": "string" }, "name": { "type": "string", "nullable": true }, "npi": { "type": "string", "nullable": true }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderLocationRefDTO" }, "nullable": true }, "prefix": { "type": "string", "nullable": true }, "credentials": { "type": "string", "nullable": true }, "biography": { "type": "string", "nullable": true }, "photo": { "type": "string", "nullable": true }, "boardCertificationYear": { "type": "integer", "format": "int32", "nullable": true }, "yearsInPractice": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ProviderLocationHoursDTO": { "type": "object", "properties": { "locationId": { "pattern": "^loc_[0-9A-Za-z]{22}$", "type": "string" }, "locationName": { "type": "string", "nullable": true }, "hours": { "type": "array", "items": { "$ref": "#/components/schemas/HoursEntryDTO" }, "nullable": true } }, "additionalProperties": false }, "ProviderLocationHoursDTOCollectionResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderLocationHoursDTO" }, "nullable": true } }, "additionalProperties": false }, "ProviderLocationRefDTO": { "type": "object", "properties": { "id": { "pattern": "^loc_[0-9A-Za-z]{22}$", "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProviderSummaryDTO": { "type": "object", "properties": { "id": { "pattern": "^prv_[0-9A-Za-z]{22}$", "type": "string" }, "name": { "type": "string", "nullable": true }, "npi": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProviderSummaryDTOCursorPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderSummaryDTO" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SlotDTO": { "type": "object", "properties": { "id": { "pattern": "^slt_[0-9A-Za-z]{22}$", "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "providerId": { "pattern": "^prv_[0-9A-Za-z]{22}$", "type": "string" }, "locationId": { "pattern": "^loc_[0-9A-Za-z]{22}$", "type": "string" }, "visitTypeId": { "pattern": "^vst_[0-9A-Za-z]{22}$", "type": "string" }, "procedureId": { "pattern": "^prc_[0-9A-Za-z]{22}$", "type": "string" } }, "additionalProperties": false }, "SlotDTOCursorPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SlotDTO" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SlotDetailDTO": { "type": "object", "properties": { "id": { "pattern": "^slt_[0-9A-Za-z]{22}$", "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "available": { "type": "boolean" }, "providerId": { "pattern": "^prv_[0-9A-Za-z]{22}$", "type": "string" }, "providerName": { "type": "string", "nullable": true }, "locationId": { "pattern": "^loc_[0-9A-Za-z]{22}$", "type": "string" }, "locationName": { "type": "string", "nullable": true }, "locationAddress": { "type": "string", "nullable": true }, "visitTypeId": { "pattern": "^vst_[0-9A-Za-z]{22}$", "type": "string" }, "visitType": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdatePatientRequest": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "providerId": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/AddressRequest" }, "confirmationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VisitTypeDTO": { "type": "object", "properties": { "id": { "pattern": "^vst_[0-9A-Za-z]{22}$", "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VisitTypeDTOCursorPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VisitTypeDTO" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Paste a raw OAuth access token (no \"Bearer \" prefix).", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "Appointments" }, { "name": "Capabilities" }, { "name": "Locations" }, { "name": "Patients" }, { "name": "Procedures" }, { "name": "Providers" }, { "name": "RedSpotInteractive.PublicApi.API, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" }, { "name": "Slots" }, { "name": "VisitTypes" } ], "servers": [ { "url": "https://sandbox.redspotinteractive.com/api", "description": "Sandbox" } ] }