{ "openapi": "3.0.4", "info": { "title": "Max Dashboard API", "description": "HTTP API for internal Max Foundation dashboard users.", "version": "current" }, "servers": [ { "url": "https://maxaid-gateway.azurewebsites.net" } ], "paths": { "/api/max/applicant/new/{programId}": { "get": { "tags": [ "Applicant" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "combineProgramId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.NewApplicantFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.NewApplicantFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.NewApplicantFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"programId\": 0,\r\n \"program\": \"string\",\r\n \"countries\": [\r\n {\r\n \"countryId\": 0,\r\n \"country\": \"string\",\r\n \"physicians\": [\r\n {\r\n \"physicianId\": 0,\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"form\": {\r\n \"programId\": 0,\r\n \"program\": \"string\",\r\n \"diagnoses\": [\r\n {\r\n \"diagnosis\": \"string\",\r\n \"labels\": [\r\n {\r\n \"treatmentLabelId\": 0,\r\n \"labelTitle\": \"string\",\r\n \"labelTitleNote\": \"string\",\r\n \"labelRef\": \"string\"\r\n }\r\n ],\r\n \"combineProgramLabels\": [\r\n {\r\n \"treatmentLabelId\": 0,\r\n \"labelTitle\": \"string\",\r\n \"labelTitleNote\": \"string\",\r\n \"labelRef\": \"string\"\r\n }\r\n ],\r\n \"questions\": [\r\n {\r\n \"labelId\": 0,\r\n \"questionText\": \"string\",\r\n \"questionFieldName\": \"string\",\r\n \"htmlElement\": \"string\",\r\n \"triggerAnswerValue\": \"string\",\r\n \"questionGroup\": \"string\",\r\n \"isMandatory\": true,\r\n \"displayOrder\": 0,\r\n \"answers\": [\r\n {\r\n \"answerText\": \"string\",\r\n \"answerValue\": \"string\",\r\n \"displayOrder\": 0\r\n }\r\n ],\r\n \"questions\": [\r\n {}\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"dosages\": [\r\n {\r\n \"dosageId\": 0,\r\n \"dosage\": \"string\"\r\n }\r\n ],\r\n \"combineProgramDosages\": [\r\n {\r\n \"dosageId\": 0,\r\n \"dosage\": \"string\"\r\n }\r\n ]\r\n },\r\n \"sdohForm\": {\r\n \"formType\": \"string\",\r\n \"fields\": [\r\n {\r\n \"name\": \"string\",\r\n \"label\": \"string\",\r\n \"type\": \"string\",\r\n \"required\": true,\r\n \"options\": [\r\n {\r\n \"value\": \"string\",\r\n \"text\": \"string\"\r\n }\r\n ],\r\n \"requiredWhen\": \"string\",\r\n \"visibleWhen\": \"string\"\r\n }\r\n ],\r\n \"diagnoses\": [\r\n {\r\n \"diagnosisId\": 0,\r\n \"diagnosis\": \"string\"\r\n }\r\n ],\r\n \"treatments\": [\r\n {\r\n \"sdohTreatmentId\": 0,\r\n \"name\": \"string\",\r\n \"diagnosisIds\": [\r\n 0\r\n ]\r\n }\r\n ],\r\n \"dosages\": [\r\n {\r\n \"dosageId\": 0,\r\n \"dosage\": \"string\",\r\n \"sdohTreatmentId\": 0\r\n }\r\n ],\r\n \"treatmentProviders\": [\r\n {\r\n \"treatmentProviderId\": 0,\r\n \"providerName\": \"string\",\r\n \"countryId\": 0\r\n }\r\n ],\r\n \"unlistedOptionValue\": 0,\r\n \"allowUnlistedDiagnosis\": true,\r\n \"allowUnlistedTreatment\": true,\r\n \"allowUnlistedTreatmentProvider\": true,\r\n \"defaultNextReviewDate\": \"2026-01-01T00:00:00Z\"\r\n },\r\n \"contactCountries\": [\r\n {\r\n \"countryId\": 0,\r\n \"country\": \"string\",\r\n \"physicians\": [\r\n {\r\n \"physicianId\": 0,\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"canCreateDiagnosis\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "post": { "tags": [ "Applicant" ], "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Applicants.CreateApplicantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Applicants.CreateApplicantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Applicants.CreateApplicantRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientApplicationResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientApplicationResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientApplicationResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"countryId\": 0,\r\n \"physicianId\": 0,\r\n \"FirstName\": \"string\",\r\n \"LastName\": \"string\",\r\n \"initials\": \"string\",\r\n \"alternateid\": \"string\",\r\n \"alternatecharname\": \"string\",\r\n \"rdsex\": \"string\",\r\n \"birthday\": 0,\r\n \"birthmonth\": 0,\r\n \"birthyear\": 0,\r\n \"Street1\": \"string\",\r\n \"Street2\": \"string\",\r\n \"City\": \"string\",\r\n \"StateProvince\": \"string\",\r\n \"PostalCode\": \"string\",\r\n \"Phone\": \"string\",\r\n \"Mobile\": \"string\",\r\n \"Fax\": \"string\",\r\n \"email\": \"string\",\r\n \"Email2\": \"string\",\r\n \"ContactFirstName\": \"string\",\r\n \"ContactLastName\": \"string\",\r\n \"ContactStreet1\": \"string\",\r\n \"ContactStreet2\": \"string\",\r\n \"ContactCity\": \"string\",\r\n \"ContactStateProvince\": \"string\",\r\n \"ContactPostalCode\": \"string\",\r\n \"ContactCountryID\": 0,\r\n \"ContactPhone\": \"string\",\r\n \"ContactMobile\": \"string\",\r\n \"ContactFax\": \"string\",\r\n \"ContactEmail\": \"string\",\r\n \"relationship\": \"string\",\r\n \"RelationshipDetails\": \"string\",\r\n \"Dosage\": \"string\",\r\n \"Diagnosis\": \"string\",\r\n \"DiagnosisDate\": \"2026-01-01T00:00:00Z\",\r\n \"Notes\": \"string\",\r\n \"ProgramID\": 0,\r\n \"treatmentidText\": \"string\",\r\n \"Treatment\": \"string\",\r\n \"CombineProgramId\": 0,\r\n \"CombineTreatmentName\": \"string\",\r\n \"CombineDosage\": \"string\",\r\n \"LabelId\": 0,\r\n \"CombineLabelId\": 0,\r\n \"PatientConsent\": true,\r\n \"HasInsurance\": true,\r\n \"InsuranceCoversTreatment\": true,\r\n \"HouseholdMembers\": \"string\",\r\n \"HouseholdIncome\": \"string\",\r\n \"MedicalHistory\": \"string\",\r\n \"Occupation\": \"string\",\r\n \"AnnualIncome\": \"string\",\r\n \"CopyOfId\": true,\r\n \"PriorTKIs\": 0,\r\n \"HadPcr\": true,\r\n \"LastPcrValue\": 0,\r\n \"PcrDate\": \"2026-01-01T00:00:00Z\",\r\n \"ReasonForNot\": \"string\",\r\n \"PhilPos\": 0,\r\n \"Bcr\": 0,\r\n \"CkitPositive\": 0,\r\n \"Unresectable\": 0,\r\n \"Metastatic\": 0,\r\n \"DiagnosticTestDone\": true,\r\n \"questionAnswers\": [\r\n {\r\n \"questionFieldName\": \"string\",\r\n \"answerValue\": \"string\"\r\n }\r\n ],\r\n \"sdoh\": {\r\n \"applicantType\": \"string\",\r\n \"gender\": \"string\",\r\n \"birthDate\": \"2026-01-01T00:00:00Z\",\r\n \"county\": \"string\",\r\n \"diagnosisId\": 0,\r\n \"otherDiagnosis\": \"string\",\r\n \"diagnosisYear\": \"string\",\r\n \"privacyPractices\": \"string\",\r\n \"who\": \"string\",\r\n \"signature\": \"string\",\r\n \"note\": \"string\",\r\n \"confidential\": true,\r\n \"primaryLanguage\": \"string\",\r\n \"ethnicity\": \"string\",\r\n \"insuranceStatus\": \"string\",\r\n \"insuranceType\": \"string\",\r\n \"citizenshipStatus\": \"string\",\r\n \"employmentStatus\": \"string\",\r\n \"occupation\": \"string\",\r\n \"preferredPronouns\": \"string\",\r\n \"annualIncomeCategory\": \"string\",\r\n \"helplineAnnualIncome\": \"string\",\r\n \"helplineOccupation\": \"string\",\r\n \"householdAdditionalInformation\": \"string\",\r\n \"sdohTreatmentId\": 0,\r\n \"otherTreatment\": \"string\",\r\n \"dosageId\": 0,\r\n \"treatmentProviderId\": 0,\r\n \"otherTreatmentProvider\": \"string\",\r\n \"consentFormSigned\": true,\r\n \"nextReviewDate\": \"2026-01-01T00:00:00Z\",\r\n \"isBeneficiary\": true,\r\n \"monthlyIncome\": 0\r\n }\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"applicantId\": 0,\r\n \"questionResponseCount\": 0,\r\n \"success\": true,\r\n \"patientId\": 0,\r\n \"pin\": \"string\",\r\n \"programId\": 0\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/sdoh/diagnoses": { "post": { "tags": [ "Applicant" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Applicants.CreateSdohDiagnosisRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Applicants.CreateSdohDiagnosisRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Applicants.CreateSdohDiagnosisRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Applicants.SdohDiagnosisOption, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Applicants.SdohDiagnosisOption, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Applicants.SdohDiagnosisOption, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"programId\": 0,\r\n \"diagnosis\": \"string\"\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"diagnosisId\": 0,\r\n \"diagnosis\": \"string\"\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/sdoh/physicians": { "get": { "tags": [ "Applicant" ], "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "CountryId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Applicants.SdohPhysicianSearchResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Applicants.SdohPhysicianSearchResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Applicants.SdohPhysicianSearchResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"items\": [\r\n {\r\n \"physicianId\": 0,\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"country\": \"string\"\r\n }\r\n ],\r\n \"hasMore\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/file-cabinet/{type}/{ownerId}": { "get": { "tags": [ "FileCabinet" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "folderTypeId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "programId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetFileResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetFileResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetFileResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": [\r\n {\r\n \"fileId\": 0,\r\n \"fileName\": \"string\",\r\n \"fileSize\": 0,\r\n \"type\": \"string\",\r\n \"title\": \"string\",\r\n \"uploadDate\": \"2026-01-01T00:00:00Z\",\r\n \"folderTypeId\": 0,\r\n \"folderTypeName\": \"string\",\r\n \"programId\": 0,\r\n \"createdBy\": \"string\"\r\n }\r\n ],\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "post": { "tags": [ "FileCabinet" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Files": { "type": "array", "items": { "type": "string", "format": "binary" } }, "FolderTypeId": { "type": "integer", "format": "int32" }, "ProgramId": { "type": "integer", "format": "int32" }, "Title": { "type": "string" } } }, "encoding": { "Files": { "style": "form" }, "FolderTypeId": { "style": "form" }, "ProgramId": { "style": "form" }, "Title": { "style": "form" } } } } }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetFileResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetFileResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetFileResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } }, "x-request-format": "{\r\n \"files\": [\r\n \"\\u003Cbinary\\u003E\"\r\n ],\r\n \"folderTypeId\": 0,\r\n \"programId\": 0,\r\n \"title\": \"string\"\r\n}", "x-response-format": "{\r\n \"data\": [\r\n {\r\n \"fileId\": 0,\r\n \"fileName\": \"string\",\r\n \"fileSize\": 0,\r\n \"type\": \"string\",\r\n \"title\": \"string\",\r\n \"uploadDate\": \"2026-01-01T00:00:00Z\",\r\n \"folderTypeId\": 0,\r\n \"folderTypeName\": \"string\",\r\n \"programId\": 0,\r\n \"createdBy\": \"string\"\r\n }\r\n ],\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/file-cabinet/{type}/{ownerId}/folders": { "get": { "tags": [ "FileCabinet" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetFolderResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetFolderResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetFolderResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": [\r\n {\r\n \"folderTypeId\": 0,\r\n \"folderTypeName\": \"string\"\r\n }\r\n ],\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "patch": { "tags": [ "FileCabinet" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.FileCabinet.UpdateFileCabinetFoldersRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.FileCabinet.UpdateFileCabinetFoldersRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.FileCabinet.UpdateFileCabinetFoldersRequest" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } }, "x-request-format": "{\r\n \"items\": [\r\n {\r\n \"fileId\": 0,\r\n \"folderTypeId\": 0,\r\n \"programId\": 0\r\n }\r\n ]\r\n}", "x-response-format": "{\r\n \"data\": true,\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/file-cabinet/{type}/{ownerId}/programs": { "get": { "tags": [ "FileCabinet" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetProgramResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetProgramResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetProgramResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": [\r\n {\r\n \"programId\": 0,\r\n \"programName\": \"string\"\r\n }\r\n ],\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/file-cabinet/{type}/{ownerId}/files/{fileId}/download": { "get": { "tags": [ "FileCabinet" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "text/json": { "schema": { "type": "string", "format": "binary" } } } } }, "x-request-format": "{}", "x-response-format": "\"\\u003Cbinary\\u003E\"" } }, "/api/max/file-cabinet/{type}/{ownerId}/files/{fileId}/view": { "get": { "tags": [ "FileCabinet" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "text/json": { "schema": { "type": "string", "format": "binary" } } } } }, "x-request-format": "{}", "x-response-format": "\"\\u003Cbinary\\u003E\"" } }, "/api/max/file-cabinet/{type}/{ownerId}/files/{fileId}": { "delete": { "tags": [ "FileCabinet" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": true,\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/file-cabinet/{type}/{ownerId}/files/{fileId}/folder": { "patch": { "tags": [ "FileCabinet" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.FileCabinet.UpdateFileCabinetFolderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.FileCabinet.UpdateFileCabinetFolderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.FileCabinet.UpdateFileCabinetFolderRequest" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } }, "x-request-format": "{\r\n \"folderTypeId\": 0,\r\n \"programId\": 0\r\n}", "x-response-format": "{\r\n \"data\": true,\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}": { "get": { "tags": [ "Institution" ], "summary": "Gets Institution Profile.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionProfileResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionProfileResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionProfileResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"institutionId\": \"string\",\r\n \"name\": \"string\",\r\n \"institutionType\": \"string\",\r\n \"department\": \"string\",\r\n \"customerNumber\": \"string\",\r\n \"supplyChainCodes\": [\r\n \"string\"\r\n ],\r\n \"phones\": [\r\n \"string\"\r\n ],\r\n \"mobile\": \"string\",\r\n \"fax\": \"string\",\r\n \"emails\": [\r\n \"string\"\r\n ],\r\n \"street1\": \"string\",\r\n \"street2\": \"string\",\r\n \"city\": \"string\",\r\n \"stateProvince\": \"string\",\r\n \"zipcode\": \"string\",\r\n \"countryId\": \"string\",\r\n \"countryName\": \"string\",\r\n \"qaValidated\": true,\r\n \"nextQaDate\": \"2026-01-01T00:00:00Z\",\r\n \"pharmacyChain\": \"string\",\r\n \"latitude\": 0,\r\n \"longitude\": 0,\r\n \"geoPrecision\": \"string\",\r\n \"treatingApproval\": {\r\n \"approved\": true,\r\n \"approvedDate\": \"2026-01-01T00:00:00Z\",\r\n \"approvedBy\": \"string\"\r\n },\r\n \"dispenseApprovals\": [\r\n {\r\n \"treatmentId\": \"string\",\r\n \"treatmentName\": \"string\",\r\n \"approvedDate\": \"2026-01-01T00:00:00Z\"\r\n }\r\n ],\r\n \"availableTreatments\": [\r\n {\r\n \"treatmentId\": \"string\",\r\n \"treatmentName\": \"string\"\r\n }\r\n ],\r\n \"diagnosticApprovals\": [\r\n {\r\n \"diagnosisId\": \"string\",\r\n \"diagnosisName\": \"string\",\r\n \"programs\": [\r\n \"string\"\r\n ],\r\n \"lastUpdated\": \"2026-01-01T00:00:00Z\"\r\n }\r\n ],\r\n \"availableDiagnoses\": [\r\n {\r\n \"diagnosisId\": \"string\",\r\n \"diagnosisName\": \"string\"\r\n }\r\n ],\r\n \"administrator\": {\r\n \"name\": \"string\",\r\n \"title\": \"string\",\r\n \"email\": \"string\",\r\n \"phone\": \"string\",\r\n \"username\": \"string\"\r\n },\r\n \"assignedDepots\": [\r\n \"string\"\r\n ],\r\n \"physicianCount\": 0,\r\n \"patientCount\": 0\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "put": { "tags": [ "Institution" ], "summary": "Updates Institution Profile.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.UpdateInstitutionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.UpdateInstitutionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.UpdateInstitutionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionProfileResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionProfileResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionProfileResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"name\": \"string\",\r\n \"department\": \"string\",\r\n \"institutionType\": \"string\",\r\n \"customerNumber\": \"string\",\r\n \"qaValidated\": true,\r\n \"nextQaDate\": \"2026-01-01T00:00:00Z\",\r\n \"pharmacyChain\": \"string\",\r\n \"street1\": \"string\",\r\n \"street2\": \"string\",\r\n \"city\": \"string\",\r\n \"stateProvince\": \"string\",\r\n \"zipcode\": \"string\",\r\n \"emails\": [\r\n \"string\"\r\n ],\r\n \"phones\": [\r\n \"string\"\r\n ],\r\n \"mobile\": \"string\",\r\n \"fax\": \"string\",\r\n \"adminName\": \"string\",\r\n \"adminEmail\": \"string\",\r\n \"latitude\": 0,\r\n \"longitude\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"institutionId\": \"string\",\r\n \"name\": \"string\",\r\n \"institutionType\": \"string\",\r\n \"department\": \"string\",\r\n \"customerNumber\": \"string\",\r\n \"supplyChainCodes\": [\r\n \"string\"\r\n ],\r\n \"phones\": [\r\n \"string\"\r\n ],\r\n \"mobile\": \"string\",\r\n \"fax\": \"string\",\r\n \"emails\": [\r\n \"string\"\r\n ],\r\n \"street1\": \"string\",\r\n \"street2\": \"string\",\r\n \"city\": \"string\",\r\n \"stateProvince\": \"string\",\r\n \"zipcode\": \"string\",\r\n \"countryId\": \"string\",\r\n \"countryName\": \"string\",\r\n \"qaValidated\": true,\r\n \"nextQaDate\": \"2026-01-01T00:00:00Z\",\r\n \"pharmacyChain\": \"string\",\r\n \"latitude\": 0,\r\n \"longitude\": 0,\r\n \"geoPrecision\": \"string\",\r\n \"treatingApproval\": {\r\n \"approved\": true,\r\n \"approvedDate\": \"2026-01-01T00:00:00Z\",\r\n \"approvedBy\": \"string\"\r\n },\r\n \"dispenseApprovals\": [\r\n {\r\n \"treatmentId\": \"string\",\r\n \"treatmentName\": \"string\",\r\n \"approvedDate\": \"2026-01-01T00:00:00Z\"\r\n }\r\n ],\r\n \"availableTreatments\": [\r\n {\r\n \"treatmentId\": \"string\",\r\n \"treatmentName\": \"string\"\r\n }\r\n ],\r\n \"diagnosticApprovals\": [\r\n {\r\n \"diagnosisId\": \"string\",\r\n \"diagnosisName\": \"string\",\r\n \"programs\": [\r\n \"string\"\r\n ],\r\n \"lastUpdated\": \"2026-01-01T00:00:00Z\"\r\n }\r\n ],\r\n \"availableDiagnoses\": [\r\n {\r\n \"diagnosisId\": \"string\",\r\n \"diagnosisName\": \"string\"\r\n }\r\n ],\r\n \"administrator\": {\r\n \"name\": \"string\",\r\n \"title\": \"string\",\r\n \"email\": \"string\",\r\n \"phone\": \"string\",\r\n \"username\": \"string\"\r\n },\r\n \"assignedDepots\": [\r\n \"string\"\r\n ],\r\n \"physicianCount\": 0,\r\n \"patientCount\": 0\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/dispense-approvals": { "post": { "tags": [ "Institution" ], "summary": "Sets Institution dispense approval.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.SetDispenseApprovalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.SetDispenseApprovalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.SetDispenseApprovalRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"treatmentId\": \"string\",\r\n \"approved\": true\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/diagnostic-approvals": { "post": { "tags": [ "Institution" ], "summary": "Sets Institution diagnostic approval.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.SetDiagnosticApprovalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.SetDiagnosticApprovalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.SetDiagnosticApprovalRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"diagnosisId\": \"string\",\r\n \"approved\": true\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/notes": { "get": { "tags": [ "Institution" ], "summary": "Gets Institution notes.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionNoteResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionNoteResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionNoteResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"items\": [\r\n {\r\n \"noteId\": \"string\",\r\n \"noteDate\": \"2026-01-01T00:00:00Z\",\r\n \"user\": \"string\",\r\n \"text\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "post": { "tags": [ "Institution" ], "summary": "Adds Institution note.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.AddInstitutionNoteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.AddInstitutionNoteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.AddInstitutionNoteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.AddInstitutionNoteResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.AddInstitutionNoteResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.AddInstitutionNoteResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"text\": \"string\"\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"noteId\": \"string\",\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/supply-alerts": { "get": { "tags": [ "Institution" ], "summary": "Gets Institution supply alerts.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionSupplyAlertResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionSupplyAlertResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionSupplyAlertResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"items\": [\r\n {\r\n \"alertId\": \"string\",\r\n \"treatmentId\": \"string\",\r\n \"treatmentName\": \"string\",\r\n \"reviewDate\": \"2026-01-01T00:00:00Z\",\r\n \"notes\": \"string\",\r\n \"createdBy\": \"string\",\r\n \"createdDate\": \"2026-01-01T00:00:00Z\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "post": { "tags": [ "Institution" ], "summary": "Adds Institution supply alert.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.AddInstitutionSupplyAlertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.AddInstitutionSupplyAlertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.AddInstitutionSupplyAlertRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.AddInstitutionSupplyAlertResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.AddInstitutionSupplyAlertResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.AddInstitutionSupplyAlertResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"treatmentId\": \"string\",\r\n \"reviewDate\": \"2026-01-01T00:00:00Z\",\r\n \"notes\": \"string\"\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"alertId\": \"string\",\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/orders": { "get": { "tags": [ "Institution" ], "summary": "Gets Institution order history.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOrderResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOrderResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOrderResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"items\": [\r\n {\r\n \"orderNumber\": \"string\",\r\n \"status\": \"string\",\r\n \"dateShipped\": \"2026-01-01T00:00:00Z\",\r\n \"dateReceived\": \"2026-01-01T00:00:00Z\",\r\n \"totalShippedQty\": 0,\r\n \"lineItems\": [\r\n {\r\n \"treatmentName\": \"string\",\r\n \"skuDescription\": \"string\",\r\n \"qtyShipped\": 0,\r\n \"qtyReceived\": 0\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/emails": { "get": { "tags": [ "Institution" ], "summary": "Gets Institution emails.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionEmailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionEmailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionEmailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"items\": [\r\n {\r\n \"emailId\": \"string\",\r\n \"sentDate\": \"2026-01-01T00:00:00Z\",\r\n \"user\": \"string\",\r\n \"subject\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/tags": { "get": { "tags": [ "Institution" ], "summary": "Gets Institution tags.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTagResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTagResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTagResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"items\": [\r\n {\r\n \"tagId\": \"string\",\r\n \"effectiveDate\": \"2026-01-01T00:00:00Z\",\r\n \"fromUser\": \"string\",\r\n \"toUser\": \"string\",\r\n \"message\": \"string\",\r\n \"reply\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/transfers": { "get": { "tags": [ "Institution" ], "summary": "Gets Institution transfers.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"items\": [\r\n {\r\n \"transferId\": \"string\",\r\n \"transferDate\": \"2026-01-01T00:00:00Z\",\r\n \"destinationInstitution\": \"string\",\r\n \"batches\": [\r\n {\r\n \"transferId\": \"string\",\r\n \"sourceInstitutionId\": \"string\",\r\n \"destinationInstitutionId\": \"string\",\r\n \"sourceInstitutionName\": \"string\",\r\n \"destinationInstitutionName\": \"string\",\r\n \"endDate\": \"2026-01-01T00:00:00Z\",\r\n \"lotNumber\": \"string\",\r\n \"treatmentName\": \"string\",\r\n \"sku\": \"string\",\r\n \"expirationDate\": \"2026-01-01T00:00:00Z\",\r\n \"quantity\": 0\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "post": { "tags": [ "Institution" ], "summary": "Revalidates source batches, destination, dates and quantities and creates all rows atomically.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.CreateInstitutionTransferRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.CreateInstitutionTransferRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.CreateInstitutionTransferRequest" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"destinationInstitutionId\": \"string\",\r\n \"startDate\": \"2026-01-01\",\r\n \"endDate\": \"2026-01-01\",\r\n \"batches\": [\r\n {\r\n \"batchId\": \"string\",\r\n \"quantity\": 0\r\n }\r\n ]\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/transfers/{transferId}": { "put": { "tags": [ "Institution" ], "summary": "Edits quantity and dates on a transfer belonging to this source or receiving institution.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "transferId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.UpdateInstitutionTransferRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.UpdateInstitutionTransferRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.UpdateInstitutionTransferRequest" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"quantity\": 0,\r\n \"startDate\": \"2026-01-01\",\r\n \"endDate\": \"2026-01-01\"\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/transfers/form": { "get": { "tags": [ "Institution" ], "summary": "Lists transferable source inventory rows for searching and adding batches.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferFormResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferFormResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferFormResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"batches\": [\r\n {\r\n \"batchId\": \"string\",\r\n \"skuId\": \"string\",\r\n \"programId\": \"string\",\r\n \"lotNumber\": \"string\",\r\n \"treatmentName\": \"string\",\r\n \"skuDescription\": \"string\",\r\n \"expirationDate\": \"2026-01-01\",\r\n \"availableQuantity\": 0\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/transfers/destinations": { "post": { "tags": [ "Institution" ], "summary": "Queries destinations eligible for every selected batch; this POST does not mutate data.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionTransferDestinationsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionTransferDestinationsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionTransferDestinationsRequest" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferDestinationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferDestinationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferDestinationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"batchIds\": [\r\n \"string\"\r\n ]\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"items\": [\r\n {\r\n \"institutionId\": \"string\",\r\n \"name\": \"string\",\r\n \"countryName\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/inventory": { "get": { "tags": [ "Institution" ], "summary": "Gets Institution inventory reports.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionInventoryReportResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionInventoryReportResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionInventoryReportResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"items\": [\r\n {\r\n \"reportDate\": \"2026-01-01T00:00:00Z\",\r\n \"rows\": [\r\n {\r\n \"inventoryReportId\": \"string\",\r\n \"programId\": \"string\",\r\n \"skuId\": \"string\",\r\n \"treatmentName\": \"string\",\r\n \"color\": \"string\",\r\n \"sku\": \"string\",\r\n \"lotNumber\": \"string\",\r\n \"expirationDate\": \"2026-01-01T00:00:00Z\",\r\n \"boxesReceivedCount\": 0,\r\n \"boxesDispensedCount\": 0,\r\n \"boxesRemainingCount\": 0,\r\n \"remaining\": 0,\r\n \"stockout\": true\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "post": { "tags": [ "Institution" ], "summary": "Creates Institution inventory report rows.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.CreateInstitutionInventoryReportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.CreateInstitutionInventoryReportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.CreateInstitutionInventoryReportRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"programId\": \"string\",\r\n \"skuId\": \"string\",\r\n \"reportDate\": \"2026-01-01T00:00:00Z\",\r\n \"items\": [\r\n {\r\n \"lotNumber\": \"string\",\r\n \"expirationDate\": \"2026-01-01T00:00:00Z\",\r\n \"boxesRemainingCount\": 0,\r\n \"stockout\": true\r\n }\r\n ]\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/inventory/form": { "get": { "tags": [ "Institution" ], "summary": "Gets Institution inventory report form options.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionInventoryFormResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionInventoryFormResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionInventoryFormResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"institutionId\": \"string\",\r\n \"countryId\": \"string\",\r\n \"skus\": [\r\n {\r\n \"programId\": \"string\",\r\n \"treatmentName\": \"string\",\r\n \"color\": \"string\",\r\n \"skuId\": \"string\",\r\n \"skuCode\": \"string\",\r\n \"skuDescription\": \"string\",\r\n \"displayName\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/inventory/date": { "put": { "tags": [ "Institution" ], "summary": "Changes an Institution inventory report date.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.ChangeInstitutionInventoryReportDateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.ChangeInstitutionInventoryReportDateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.ChangeInstitutionInventoryReportDateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"oldDate\": \"2026-01-01T00:00:00Z\",\r\n \"newDate\": \"2026-01-01T00:00:00Z\"\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/inventory/{inventoryReportId}": { "put": { "tags": [ "Institution" ], "summary": "Updates one Institution inventory report row.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "inventoryReportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.UpdateInstitutionInventoryReportItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.UpdateInstitutionInventoryReportItemRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.UpdateInstitutionInventoryReportItemRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"lotNumber\": \"string\",\r\n \"expirationDate\": \"2026-01-01T00:00:00Z\",\r\n \"boxesRemainingCount\": 0,\r\n \"stockout\": true\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "delete": { "tags": [ "Institution" ], "summary": "Deletes one Institution inventory report row.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "inventoryReportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/dispensation-uploads": { "get": { "tags": [ "Institution" ], "summary": "Gets Institution dispensation uploads.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationUploadResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationUploadResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationUploadResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"items\": [\r\n {\r\n \"uploadId\": \"string\",\r\n \"uploadDate\": \"2026-01-01T00:00:00Z\",\r\n \"uploadedBy\": \"string\",\r\n \"treatmentName\": \"string\",\r\n \"patientCount\": 0\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/dispensation-uploads/{uploadId}": { "get": { "tags": [ "Institution" ], "summary": "Gets Institution dispensation upload detail.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "uploadId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationUploadDetailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationUploadDetailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationUploadDetailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"programId\": \"string\",\r\n \"uploadId\": \"string\",\r\n \"uploadDate\": \"2026-01-01T00:00:00Z\",\r\n \"treatmentName\": \"string\",\r\n \"items\": [\r\n {\r\n \"dispensationUnit\": \"string\",\r\n \"quantity\": 0,\r\n \"recordId\": \"string\",\r\n \"patientId\": \"string\",\r\n \"skuId\": \"string\",\r\n \"patientName\": \"string\",\r\n \"skuDescription\": \"string\",\r\n \"dispenseDate\": \"2026-01-01T00:00:00Z\",\r\n \"lotNumber\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/dispensation/form": { "get": { "tags": [ "Institution" ], "summary": "Gets Institution dispensation entry options.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationFormOptionsResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationFormOptionsResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationFormOptionsResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"institutionId\": \"string\",\r\n \"treatments\": [\r\n {\r\n \"programId\": \"string\",\r\n \"treatmentName\": \"string\",\r\n \"patients\": [\r\n {\r\n \"patientId\": \"string\",\r\n \"patientName\": \"string\",\r\n \"patientPin\": \"string\"\r\n }\r\n ],\r\n \"skus\": [\r\n {\r\n \"skuCode\": \"string\",\r\n \"skuId\": \"string\",\r\n \"description\": \"string\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/dispensation": { "post": { "tags": [ "Institution" ], "summary": "Creates Institution dispensation records.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.CreateInstitutionDispensationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.CreateInstitutionDispensationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.CreateInstitutionDispensationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"programId\": \"string\",\r\n \"items\": [\r\n {\r\n \"dispensationUnit\": \"string\",\r\n \"quantity\": 0,\r\n \"patientId\": \"string\",\r\n \"skuId\": \"string\",\r\n \"dispenseDate\": \"2026-01-01T00:00:00Z\",\r\n \"lotNumber\": \"string\"\r\n }\r\n ]\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/dispensation-uploads/{uploadId}/records/{recordId}": { "put": { "tags": [ "Institution" ], "summary": "Updates one Institution dispensation record.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "uploadId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.UpdateDispensationRecordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.UpdateDispensationRecordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.UpdateDispensationRecordRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"dispensationUnit\": \"string\",\r\n \"skuId\": \"string\",\r\n \"quantity\": 0,\r\n \"dispenseDate\": \"2026-01-01T00:00:00Z\",\r\n \"lotNumber\": \"string\"\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/hss-activities": { "get": { "tags": [ "Institution" ], "summary": "Gets Institution HSS activities.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssActivityResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssActivityResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssActivityResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"items\": [\r\n {\r\n \"activityId\": \"string\",\r\n \"program\": \"string\",\r\n \"service\": \"string\",\r\n \"diagnosis\": \"string\",\r\n \"hssModel\": \"string\",\r\n \"itemDetail\": \"string\",\r\n \"totalCost\": 0,\r\n \"maxQty\": 0,\r\n \"activityDate\": \"2026-01-01T00:00:00Z\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "post": { "tags": [ "Institution" ], "summary": "Logs an HSS activity, grant, test, or equipment row.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LogHssActivityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LogHssActivityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LogHssActivityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LogHssActivityResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LogHssActivityResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LogHssActivityResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"hssModel\": \"string\",\r\n \"mode\": \"string\",\r\n \"supportedInstitutionId\": \"string\",\r\n \"program\": \"string\",\r\n \"service\": \"string\",\r\n \"diagnoses\": [\r\n \"string\"\r\n ],\r\n \"activityDate\": \"2026-01-01T00:00:00Z\",\r\n \"partner\": \"string\",\r\n \"trackingId\": \"string\",\r\n \"itemDetails\": [\r\n \"string\"\r\n ],\r\n \"status\": \"string\",\r\n \"training\": {\r\n \"physicianPersonIds\": [\r\n \"string\"\r\n ],\r\n \"physicianCount\": 0,\r\n \"labStaffCount\": 0,\r\n \"otherParticipantCount\": 0,\r\n \"trainer\": \"string\",\r\n \"description\": \"string\",\r\n \"trainingLink\": \"string\"\r\n },\r\n \"siteVisit\": {\r\n \"dayCount\": 0,\r\n \"maxParticipantCount\": 0,\r\n \"siteParticipantCount\": 0,\r\n \"description\": \"string\",\r\n \"reportLink\": \"string\"\r\n },\r\n \"costs\": {\r\n \"costModel\": \"string\",\r\n \"maxQty\": 0,\r\n \"institutionQty\": 0,\r\n \"costToMax\": 0,\r\n \"costToInstitution\": 0,\r\n \"shipping\": 0,\r\n \"otherCharges\": 0\r\n },\r\n \"testedPatientPins\": [\r\n \"string\"\r\n ]\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"activityId\": \"string\",\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/hss-physician-options": { "get": { "tags": [ "Institution" ], "summary": "Gets grouped physician options for the HSS Training form.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssPhysicianOptionResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssPhysicianOptionResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssPhysicianOptionResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"items\": [\r\n {\r\n \"personId\": \"string\",\r\n \"name\": \"string\",\r\n \"group\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/hss-activities/{activityId}": { "get": { "tags": [ "Institution" ], "summary": "Gets one HSS activity in request shape for edit mode.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "activityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssActivityDetailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssActivityDetailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssActivityDetailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"hssModel\": \"string\",\r\n \"mode\": \"string\",\r\n \"supportedInstitutionId\": \"string\",\r\n \"program\": \"string\",\r\n \"service\": \"string\",\r\n \"diagnoses\": [\r\n \"string\"\r\n ],\r\n \"activityDate\": \"2026-01-01T00:00:00Z\",\r\n \"partner\": \"string\",\r\n \"trackingId\": \"string\",\r\n \"itemDetails\": [\r\n \"string\"\r\n ],\r\n \"status\": \"string\",\r\n \"training\": {\r\n \"physicianPersonIds\": [\r\n \"string\"\r\n ],\r\n \"physicianCount\": 0,\r\n \"labStaffCount\": 0,\r\n \"otherParticipantCount\": 0,\r\n \"trainer\": \"string\",\r\n \"description\": \"string\",\r\n \"trainingLink\": \"string\"\r\n },\r\n \"siteVisit\": {\r\n \"dayCount\": 0,\r\n \"maxParticipantCount\": 0,\r\n \"siteParticipantCount\": 0,\r\n \"description\": \"string\",\r\n \"reportLink\": \"string\"\r\n },\r\n \"costs\": {\r\n \"costModel\": \"string\",\r\n \"maxQty\": 0,\r\n \"institutionQty\": 0,\r\n \"costToMax\": 0,\r\n \"costToInstitution\": 0,\r\n \"shipping\": 0,\r\n \"otherCharges\": 0\r\n },\r\n \"testedPatientPins\": [\r\n \"string\"\r\n ],\r\n \"activityId\": \"string\"\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "put": { "tags": [ "Institution" ], "summary": "Updates one HSS activity row.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "activityId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LogHssActivityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LogHssActivityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LogHssActivityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LogHssActivityResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LogHssActivityResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LogHssActivityResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"hssModel\": \"string\",\r\n \"mode\": \"string\",\r\n \"supportedInstitutionId\": \"string\",\r\n \"program\": \"string\",\r\n \"service\": \"string\",\r\n \"diagnoses\": [\r\n \"string\"\r\n ],\r\n \"activityDate\": \"2026-01-01T00:00:00Z\",\r\n \"partner\": \"string\",\r\n \"trackingId\": \"string\",\r\n \"itemDetails\": [\r\n \"string\"\r\n ],\r\n \"status\": \"string\",\r\n \"training\": {\r\n \"physicianPersonIds\": [\r\n \"string\"\r\n ],\r\n \"physicianCount\": 0,\r\n \"labStaffCount\": 0,\r\n \"otherParticipantCount\": 0,\r\n \"trainer\": \"string\",\r\n \"description\": \"string\",\r\n \"trainingLink\": \"string\"\r\n },\r\n \"siteVisit\": {\r\n \"dayCount\": 0,\r\n \"maxParticipantCount\": 0,\r\n \"siteParticipantCount\": 0,\r\n \"description\": \"string\",\r\n \"reportLink\": \"string\"\r\n },\r\n \"costs\": {\r\n \"costModel\": \"string\",\r\n \"maxQty\": 0,\r\n \"institutionQty\": 0,\r\n \"costToMax\": 0,\r\n \"costToInstitution\": 0,\r\n \"shipping\": 0,\r\n \"otherCharges\": 0\r\n },\r\n \"testedPatientPins\": [\r\n \"string\"\r\n ]\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"activityId\": \"string\",\r\n \"success\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/institution/{institutionId}/country-institutions": { "get": { "tags": [ "Institution" ], "summary": "Gets country-map data for the institution's country.", "parameters": [ { "name": "institutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.CountryInstitutionsResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.CountryInstitutionsResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.CountryInstitutionsResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"countryId\": \"string\",\r\n \"countryName\": \"string\",\r\n \"items\": [\r\n {\r\n \"institutionId\": \"string\",\r\n \"name\": \"string\",\r\n \"institutionType\": \"string\",\r\n \"latitude\": 0,\r\n \"longitude\": 0,\r\n \"geoPrecision\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/lpc/dashboard/summary": { "get": { "tags": [ "LPC" ], "summary": "Returns the current LPC's summary, or 404 when their profile is unavailable.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCDashboardSummaryResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCDashboardSummaryResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCDashboardSummaryResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"countries\": [\r\n {\r\n \"countryId\": 0,\r\n \"countryName\": \"string\",\r\n \"clinicCount\": 0\r\n }\r\n ],\r\n \"treatmentPrograms\": [\r\n {\r\n \"programId\": 0,\r\n \"programName\": \"string\",\r\n \"color\": \"string\",\r\n \"webColor\": \"string\",\r\n \"activePatients\": 0,\r\n \"closedPatients\": 0,\r\n \"pendingPatients\": 0,\r\n \"deniedPatients\": 0,\r\n \"globalActivePatients\": 0,\r\n \"programCapacity\": 0,\r\n \"utilizationPercentage\": 0\r\n }\r\n ],\r\n \"supportPrograms\": [\r\n {\r\n \"programId\": 0,\r\n \"programName\": \"string\",\r\n \"color\": \"string\",\r\n \"webColor\": \"string\",\r\n \"activePatients\": 0,\r\n \"closedPatients\": 0,\r\n \"pendingPatients\": 0,\r\n \"deniedPatients\": 0,\r\n \"globalActivePatients\": 0,\r\n \"programCapacity\": 0,\r\n \"utilizationPercentage\": 0\r\n }\r\n ],\r\n \"lpcName\": \"string\",\r\n \"activePatients\": 0,\r\n \"totalPatientsHelped\": 0,\r\n \"refreshedAt\": \"2026-01-01T00:00:00Z\",\r\n \"queueCounts\": {\r\n \"pendingInventoryInstitutions\": 0,\r\n \"patientVerification\": 0,\r\n \"pendingApplications\": 0,\r\n \"myRequests\": 0,\r\n \"tfrFollowup\": 0,\r\n \"dayByDayFollowup\": 0,\r\n \"scheduledOrders\": 0,\r\n \"pendingOrders\": 0,\r\n \"fabhaltaPatientsPastDueCount\": 0,\r\n \"helplinePatientsFollowupCount\": 0\r\n }\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/lpc/dashboard/queues/pending-inventory": { "get": { "tags": [ "LPC" ], "summary": "Lists overdue inventory-report rows for current LPC-scoped clinics, with optional pagination.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"items\": [\r\n \"string\"\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/lpc/dashboard/queues/patient-verification": { "get": { "tags": [ "LPC" ], "summary": "Lists Patient Verification with the standard LPC-scoped filters and optional pagination.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"items\": [\r\n \"string\"\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/lpc/dashboard/queues/pending-applications": { "get": { "tags": [ "LPC" ], "summary": "Lists Pending Application; supports My Patients search, sort, Filters and optional paging.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"items\": [\r\n \"string\"\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/lpc/dashboard/queues/my-requests": { "get": { "tags": [ "LPC" ], "summary": "Lists Requests I Submitted; supports My Patients search, sort, Filters and optional paging.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"items\": [\r\n \"string\"\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/lpc/dashboard/queues/tfr-followup": { "get": { "tags": [ "LPC" ], "summary": "Lists Treatment-Free Remission Follow-up; supports My Patients search, sort, Filters and optional paging.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"items\": [\r\n \"string\"\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/lpc/dashboard/queues/day-by-day-followup": { "get": { "tags": [ "LPC" ], "summary": "Lists active, due Day by Day cases in the authenticated LPC's region, grouped by patient in SQL.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"items\": [\r\n \"string\"\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/lpc/dashboard/queues/scheduled-orders": { "get": { "tags": [ "LPC" ], "summary": "Lists Scheduled Outbound Orders; supports My Patients search, sort, Filters and optional paging.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"items\": [\r\n \"string\"\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/lpc/dashboard/queues/pending-orders": { "get": { "tags": [ "LPC" ], "summary": "Lists legacy pending deliveries/discrepancies; document-approval classification remains unconfirmed.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"items\": [\r\n \"string\"\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/lpc/dashboard/queues/fabhalta-followup": { "get": { "tags": [ "LPC" ], "summary": "Lists Fabhalta Patients Follow-up; supports My Patients search, sort, Filters and optional paging.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"items\": [\r\n \"string\"\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/lpc/dashboard/queues/helpline-followup": { "get": { "tags": [ "LPC" ], "summary": "Lists active, due HELPLine cases owned through the trusted PO or MaxStation username, grouped by patient.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"items\": [\r\n \"string\"\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/swagger/format-preview.js": { "get": { "tags": [ "Max.Dashboard.Api" ], "responses": { "200": { "description": "OK" } }, "x-request-format": "{}", "x-response-format": "{}" } }, "/swagger/format-preview.css": { "get": { "tags": [ "Max.Dashboard.Api" ], "responses": { "200": { "description": "OK" } }, "x-request-format": "{}", "x-response-format": "{}" } }, "/": { "get": { "tags": [ "Max.Dashboard.Api" ], "responses": { "200": { "description": "OK" } }, "x-request-format": "{}", "x-response-format": "{}" } }, "/api/max/patient/{patientId}/{programId}/review": { "get": { "tags": [ "Patient" ], "summary": "Loads the physician-compatible review form with additional MAX staff controls.", "parameters": [ { "name": "patientId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.MaxPatientReviewForm, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.MaxPatientReviewForm, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.MaxPatientReviewForm, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"patientId\": 0,\r\n \"programId\": 0,\r\n \"aeEmail\": \"string\",\r\n \"lastDispensationDate\": \"2026-01-01T00:00:00Z\",\r\n \"nextReviewDate\": \"2026-01-01T00:00:00Z\",\r\n \"message\": {\r\n \"type\": \"string\",\r\n \"text\": \"string\"\r\n },\r\n \"dosageOptions\": [\r\n {\r\n \"value\": \"string\",\r\n \"text\": \"string\",\r\n \"selected\": true\r\n }\r\n ],\r\n \"combineTreatmentDosageOptions\": [\r\n {\r\n \"value\": \"string\",\r\n \"text\": \"string\",\r\n \"selected\": true\r\n }\r\n ],\r\n \"diagnosis\": \"string\",\r\n \"currentDosage\": \"string\",\r\n \"combineTreatmentId\": 0,\r\n \"combineTreatmentCurrentDosage\": \"string\",\r\n \"pendingTreatmentActivityId\": 0,\r\n \"receivedMethodOptions\": [\r\n \"string\"\r\n ],\r\n \"adverseEventReceivedMethodOptions\": [\r\n \"string\"\r\n ],\r\n \"allowSourceDocument\": true,\r\n \"sourceDocuments\": [\r\n {\r\n \"id\": 0,\r\n \"fileName\": \"string\"\r\n }\r\n ],\r\n \"pcrDocuments\": [\r\n {\r\n \"id\": 0,\r\n \"fileName\": \"string\"\r\n }\r\n ],\r\n \"requiresTreatmentRelationship\": true,\r\n \"treatmentRelationships\": [\r\n \"string\"\r\n ],\r\n \"labelId\": 0,\r\n \"labelOptions\": [\r\n {\r\n \"treatmentLabelId\": 0,\r\n \"labelTitle\": \"string\",\r\n \"labelTitleNote\": \"string\",\r\n \"labelRef\": \"string\"\r\n }\r\n ],\r\n \"hasValidFinancialEvaluation\": true,\r\n \"canSubmit\": true,\r\n \"isPatientOnTreatmentForTfr\": true,\r\n \"clinicalResponse\": {\r\n \"hematologicalResponse\": \"string\",\r\n \"hasCytogeneticTest\": true,\r\n \"cytogeneticTestDate\": \"2026-01-01T00:00:00Z\",\r\n \"cytogeneticResponse\": \"string\",\r\n \"hasMolecularTest\": true,\r\n \"molecularTestDate\": \"2026-01-01T00:00:00Z\",\r\n \"molecularResponse\": \"string\",\r\n \"tumorResponse\": \"string\",\r\n \"medicationCompliance\": \"string\",\r\n \"visitCompliance\": \"string\"\r\n },\r\n \"pcrResults\": [\r\n {\r\n \"resultDate\": \"2026-01-01T00:00:00Z\",\r\n \"quantitativeResult\": 0,\r\n \"isUndetectable\": true,\r\n \"attachmentId\": 0\r\n }\r\n ],\r\n \"clinicalOptions\": {\r\n \"hematologicalResponses\": [\r\n \"string\"\r\n ],\r\n \"cytogeneticResponses\": [\r\n \"string\"\r\n ],\r\n \"molecularResponses\": [\r\n \"string\"\r\n ],\r\n \"tumorResponses\": [\r\n \"string\"\r\n ],\r\n \"complianceOptions\": [\r\n \"string\"\r\n ]\r\n }\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "post": { "tags": [ "Patient" ], "summary": "Records the staff review through the shared physician workflow with transactional EF persistence.", "parameters": [ { "name": "patientId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Patients.MaxPatientReviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Patients.MaxPatientReviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Patients.MaxPatientReviewRequest" } } } }, "responses": { "200": { "description": "OK" } }, "x-request-format": "{\r\n \"continueTreatment\": true,\r\n \"hasFinancialOrInsuranceStatusChanged\": true,\r\n \"dosage\": \"string\",\r\n \"combineTreatmentDosage\": \"string\",\r\n \"nextReviewDate\": \"2026-01-01T00:00:00Z\",\r\n \"physicianRequested\": true,\r\n \"receivedMethod\": \"string\",\r\n \"labelId\": 0,\r\n \"adverseEvent\": {\r\n \"details\": \"string\",\r\n \"dateLearned\": \"2026-01-01T00:00:00Z\",\r\n \"learnedFromPhysician\": true,\r\n \"receivedMethod\": \"string\",\r\n \"treatmentRelated\": \"string\",\r\n \"sourceDocumentId\": 0\r\n },\r\n \"clinicalResponse\": {\r\n \"hematologicalResponse\": \"string\",\r\n \"hasCytogeneticTest\": true,\r\n \"cytogeneticTestDate\": \"2026-01-01T00:00:00Z\",\r\n \"cytogeneticResponse\": \"string\",\r\n \"hasMolecularTest\": true,\r\n \"molecularTestDate\": \"2026-01-01T00:00:00Z\",\r\n \"molecularResponse\": \"string\",\r\n \"tumorResponse\": \"string\",\r\n \"medicationCompliance\": \"string\",\r\n \"visitCompliance\": \"string\"\r\n },\r\n \"pcrResults\": [\r\n {\r\n \"resultDate\": \"2026-01-01T00:00:00Z\",\r\n \"quantitativeResult\": 0,\r\n \"isUndetectable\": true,\r\n \"attachmentId\": 0\r\n }\r\n ]\r\n}", "x-response-format": "{\n \"message\": \"No response body\"\n}" } }, "/api/max/patient/{patientId}/{programId}/close-request": { "get": { "tags": [ "Patient" ], "summary": "Loads the read-only close-request form using the current MAX staff access rules.", "parameters": [ { "name": "patientId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.MaxPatientCloseRequestForm, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.MaxPatientCloseRequestForm, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.MaxPatientCloseRequestForm, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"closeReasons\": [\r\n {\r\n \"value\": \"string\",\r\n \"text\": \"string\"\r\n }\r\n ],\r\n \"adverseEventEmail\": \"string\",\r\n \"treatmentName\": \"string\",\r\n \"combineTreatmentName\": \"string\",\r\n \"treatmentFreeRemission\": {\r\n \"isApplicable\": true\r\n },\r\n \"receivedMethodOptions\": [\r\n \"string\"\r\n ],\r\n \"allowSourceDocument\": true,\r\n \"requiresTreatmentRelationship\": true,\r\n \"treatmentRelationships\": [\r\n \"string\"\r\n ],\r\n \"sourceDocuments\": [\r\n {\r\n \"id\": 0,\r\n \"fileName\": \"string\"\r\n }\r\n ],\r\n \"openRequestId\": 0\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "post": { "tags": [ "Patient" ], "summary": "Creates an unresolved close request and optional AE; patient/program status remains unchanged.", "parameters": [ { "name": "patientId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Patients.MaxPatientCloseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Patients.MaxPatientCloseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Patients.MaxPatientCloseRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientCloseRequestResult, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientCloseRequestResult, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientCloseRequestResult, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"closureReason\": \"string\",\r\n \"physicianRequested\": true,\r\n \"receivedMethod\": \"string\",\r\n \"isAdverseEventRelated\": true,\r\n \"attemptTreatmentFreeRemission\": true,\r\n \"adverseEvent\": {\r\n \"description\": \"string\",\r\n \"dateLearned\": \"2026-01-01T00:00:00Z\",\r\n \"learnedFromPhysician\": true,\r\n \"receivedMethod\": \"string\",\r\n \"treatmentRelated\": \"string\",\r\n \"sourceDocumentId\": 0\r\n }\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"requestId\": 0,\r\n \"adverseEventId\": 0,\r\n \"nextApplicationProgramId\": 0,\r\n \"status\": \"string\"\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/patient/apply/{programId}": { "get": { "tags": [ "Patient" ], "summary": "Gets Patient Apply Form.", "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientApplyFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientApplyFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientApplyFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"programId\": 0,\r\n \"program\": \"string\",\r\n \"diagnoses\": [\r\n {\r\n \"diagnosis\": \"string\",\r\n \"labels\": [\r\n {\r\n \"treatmentLabelId\": 0,\r\n \"labelTitle\": \"string\",\r\n \"labelTitleNote\": \"string\",\r\n \"labelRef\": \"string\"\r\n }\r\n ],\r\n \"combineProgramLabels\": [\r\n {\r\n \"treatmentLabelId\": 0,\r\n \"labelTitle\": \"string\",\r\n \"labelTitleNote\": \"string\",\r\n \"labelRef\": \"string\"\r\n }\r\n ],\r\n \"questions\": [\r\n {\r\n \"labelId\": 0,\r\n \"questionText\": \"string\",\r\n \"questionFieldName\": \"string\",\r\n \"htmlElement\": \"string\",\r\n \"triggerAnswerValue\": \"string\",\r\n \"questionGroup\": \"string\",\r\n \"isMandatory\": true,\r\n \"displayOrder\": 0,\r\n \"answers\": [\r\n {\r\n \"answerText\": \"string\",\r\n \"answerValue\": \"string\",\r\n \"displayOrder\": 0\r\n }\r\n ],\r\n \"questions\": [\r\n {}\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"dosages\": [\r\n {\r\n \"dosageId\": 0,\r\n \"dosage\": \"string\"\r\n }\r\n ],\r\n \"combineProgramDosages\": [\r\n {\r\n \"dosageId\": 0,\r\n \"dosage\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/patient/apply/{programId}/{combineProgramId}": { "get": { "tags": [ "Patient" ], "summary": "Gets Patient Apply Form.", "parameters": [ { "name": "programId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "combineProgramId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientApplyFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientApplyFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientApplyFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"programId\": 0,\r\n \"program\": \"string\",\r\n \"diagnoses\": [\r\n {\r\n \"diagnosis\": \"string\",\r\n \"labels\": [\r\n {\r\n \"treatmentLabelId\": 0,\r\n \"labelTitle\": \"string\",\r\n \"labelTitleNote\": \"string\",\r\n \"labelRef\": \"string\"\r\n }\r\n ],\r\n \"combineProgramLabels\": [\r\n {\r\n \"treatmentLabelId\": 0,\r\n \"labelTitle\": \"string\",\r\n \"labelTitleNote\": \"string\",\r\n \"labelRef\": \"string\"\r\n }\r\n ],\r\n \"questions\": [\r\n {\r\n \"labelId\": 0,\r\n \"questionText\": \"string\",\r\n \"questionFieldName\": \"string\",\r\n \"htmlElement\": \"string\",\r\n \"triggerAnswerValue\": \"string\",\r\n \"questionGroup\": \"string\",\r\n \"isMandatory\": true,\r\n \"displayOrder\": 0,\r\n \"answers\": [\r\n {\r\n \"answerText\": \"string\",\r\n \"answerValue\": \"string\",\r\n \"displayOrder\": 0\r\n }\r\n ],\r\n \"questions\": [\r\n {}\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"dosages\": [\r\n {\r\n \"dosageId\": 0,\r\n \"dosage\": \"string\"\r\n }\r\n ],\r\n \"combineProgramDosages\": [\r\n {\r\n \"dosageId\": 0,\r\n \"dosage\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/patient/application": { "post": { "tags": [ "Patient" ], "summary": "Creates Patient Application.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Patients.CreatePatientApplicationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Patients.CreatePatientApplicationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Patients.CreatePatientApplicationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientApplicationResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientApplicationResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientApplicationResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"countryId\": 0,\r\n \"physicianId\": 0,\r\n \"FirstName\": \"string\",\r\n \"LastName\": \"string\",\r\n \"initials\": \"string\",\r\n \"alternateid\": \"string\",\r\n \"alternatecharname\": \"string\",\r\n \"rdsex\": \"string\",\r\n \"birthday\": 0,\r\n \"birthmonth\": 0,\r\n \"birthyear\": 0,\r\n \"Street1\": \"string\",\r\n \"Street2\": \"string\",\r\n \"City\": \"string\",\r\n \"StateProvince\": \"string\",\r\n \"PostalCode\": \"string\",\r\n \"Phone\": \"string\",\r\n \"Mobile\": \"string\",\r\n \"Fax\": \"string\",\r\n \"email\": \"string\",\r\n \"Email2\": \"string\",\r\n \"ContactFirstName\": \"string\",\r\n \"ContactLastName\": \"string\",\r\n \"ContactStreet1\": \"string\",\r\n \"ContactStreet2\": \"string\",\r\n \"ContactCity\": \"string\",\r\n \"ContactStateProvince\": \"string\",\r\n \"ContactPostalCode\": \"string\",\r\n \"ContactCountryID\": 0,\r\n \"ContactPhone\": \"string\",\r\n \"ContactMobile\": \"string\",\r\n \"ContactFax\": \"string\",\r\n \"ContactEmail\": \"string\",\r\n \"relationship\": \"string\",\r\n \"RelationshipDetails\": \"string\",\r\n \"Dosage\": \"string\",\r\n \"Diagnosis\": \"string\",\r\n \"DiagnosisDate\": \"2026-01-01T00:00:00Z\",\r\n \"Notes\": \"string\",\r\n \"ProgramID\": 0,\r\n \"treatmentidText\": \"string\",\r\n \"Treatment\": \"string\",\r\n \"CombineProgramId\": 0,\r\n \"CombineTreatmentName\": \"string\",\r\n \"CombineDosage\": \"string\",\r\n \"LabelId\": 0,\r\n \"CombineLabelId\": 0,\r\n \"PatientConsent\": true,\r\n \"HasInsurance\": true,\r\n \"InsuranceCoversTreatment\": true,\r\n \"HouseholdMembers\": \"string\",\r\n \"HouseholdIncome\": \"string\",\r\n \"MedicalHistory\": \"string\",\r\n \"Occupation\": \"string\",\r\n \"AnnualIncome\": \"string\",\r\n \"CopyOfId\": true,\r\n \"PriorTKIs\": 0,\r\n \"HadPcr\": true,\r\n \"LastPcrValue\": 0,\r\n \"PcrDate\": \"2026-01-01T00:00:00Z\",\r\n \"ReasonForNot\": \"string\",\r\n \"PhilPos\": 0,\r\n \"Bcr\": 0,\r\n \"CkitPositive\": 0,\r\n \"Unresectable\": 0,\r\n \"Metastatic\": 0,\r\n \"DiagnosticTestDone\": true,\r\n \"questionAnswers\": [\r\n {\r\n \"questionFieldName\": \"string\",\r\n \"answerValue\": \"string\"\r\n }\r\n ]\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"applicantId\": 0,\r\n \"questionResponseCount\": 0,\r\n \"success\": true,\r\n \"patientId\": 0,\r\n \"pin\": \"string\",\r\n \"programId\": 0\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/application/{applicationId}/documents": { "get": { "tags": [ "Patient" ], "summary": "Gets Patient Application Documents.", "parameters": [ { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientApplicationDocumentsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientApplicationDocumentsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientApplicationDocumentsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true,\r\n \"applicationId\": \"string\",\r\n \"patientName\": \"string\",\r\n \"treatment\": \"string\",\r\n \"status\": \"string\",\r\n \"submittedDate\": \"string\",\r\n \"missingDocuments\": [\r\n \"string\"\r\n ],\r\n \"files\": [\r\n {\r\n \"fileId\": \"string\",\r\n \"fileName\": \"string\",\r\n \"fileCategory\": \"string\",\r\n \"uploadedAt\": \"string\",\r\n \"sizeBytes\": 0,\r\n \"mimeType\": \"string\",\r\n \"url\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/cml-monitoring/pcr-due-patients": { "get": { "tags": [ "Patient" ], "summary": "Gets Pcr Due Patients.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PcrDuePatientsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PcrDuePatientsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PcrDuePatientsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"items\": [\r\n {\r\n \"pin\": \"string\",\r\n \"patientName\": \"string\",\r\n \"treatment\": \"string\",\r\n \"lastPcrDate\": \"string\",\r\n \"nextPcrDueInMonths\": 0,\r\n \"nextPcrDueDate\": \"string\",\r\n \"patientId\": \"string\",\r\n \"programId\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/pcr-results/past-due": { "get": { "tags": [ "Patient" ], "summary": "Gets Pcr Past Due Patients.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.Patients.PcrPastDuePatientResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.Patients.PcrPastDuePatientResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.Patients.PcrPastDuePatientResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": [\r\n {\r\n \"pin\": \"string\",\r\n \"patient\": \"string\",\r\n \"treatment\": \"string\",\r\n \"lastPcrDate\": \"string\",\r\n \"nextPcrDueInMonths\": 0,\r\n \"nextPcrDueDate\": \"string\",\r\n \"patientId\": 0,\r\n \"programId\": 0\r\n }\r\n ],\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/patient/{patientId}/{programId}/reactivation": { "get": { "tags": [ "Patient" ], "summary": "Gets Patient Reactivation Form.", "parameters": [ { "name": "patientId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientReactivationFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientReactivationFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientReactivationFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"reactivateReasons\": [\r\n {\r\n \"value\": \"string\",\r\n \"text\": \"string\",\r\n \"selected\": true\r\n }\r\n ],\r\n \"dosageOptions\": [\r\n {\r\n \"value\": \"string\",\r\n \"text\": \"string\",\r\n \"selected\": true\r\n }\r\n ],\r\n \"combineDosageOptions\": [\r\n {\r\n \"value\": \"string\",\r\n \"text\": \"string\",\r\n \"selected\": true\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" }, "post": { "tags": [ "Patient" ], "summary": "Reactivates Patient or creates a reactivation request based on the logged-in MAX role.", "parameters": [ { "name": "patientId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Patients.ReactivatePatientRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Patients.ReactivatePatientRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Patients.ReactivatePatientRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.ReactivatePatientResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.ReactivatePatientResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.ReactivatePatientResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"reactivateReason\": \"string\",\r\n \"restartTreatment\": true,\r\n \"hasFinancialOrInsuranceStatusChanged\": true,\r\n \"dosage\": \"string\",\r\n \"combineTreatmentDosage\": \"string\",\r\n \"physicianRequested\": true,\r\n \"receivedBy\": \"string\",\r\n \"endDate\": \"2026-01-01T00:00:00Z\",\r\n \"requestId\": 0,\r\n \"resupply\": true\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true,\r\n \"status\": \"string\",\r\n \"requestId\": 0\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/cml-monitoring/{patientId}/pcr-results": { "get": { "tags": [ "Patient" ], "summary": "Gets Patient Pcr Results.", "parameters": [ { "name": "patientId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientPcrResultsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientPcrResultsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientPcrResultsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"patientId\": \"string\",\r\n \"items\": [\r\n {\r\n \"pcrResultsId\": \"string\",\r\n \"pcrDate\": \"string\",\r\n \"pcrResultType\": \"string\",\r\n \"result\": \"string\",\r\n \"redFlag\": true,\r\n \"treatmentName\": \"string\",\r\n \"programColor\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/patients/needing-review": { "get": { "tags": [ "Patient" ], "summary": "Gets Patients Needing Review.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientsNeedingReviewResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientsNeedingReviewResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientsNeedingReviewResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"items\": [\r\n {\r\n \"patientId\": \"string\",\r\n \"programId\": \"string\",\r\n \"pin\": \"string\",\r\n \"patientName\": \"string\",\r\n \"treatment\": \"string\",\r\n \"dosage\": \"string\",\r\n \"birthDate\": \"string\",\r\n \"dateEntered\": \"string\",\r\n \"scheduledCloseDate\": \"string\",\r\n \"message\": {\r\n \"type\": \"string\",\r\n \"text\": \"string\"\r\n }\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/pcr-results": { "post": { "tags": [ "Patient" ], "summary": "Creates Pcr Result.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Patients.CreatePcrResultRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Patients.CreatePcrResultRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Application.Contracts.Patients.CreatePcrResultRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePcrResultResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePcrResultResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePcrResultResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"patientId\": \"string\",\r\n \"date\": \"string\",\r\n \"result\": \"string\"\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true,\r\n \"pcrResultId\": \"string\"\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/patient/{patientId}/{programId}/pcr-result": { "post": { "tags": [ "Patient" ], "summary": "Creates Patient Pcr Results.", "parameters": [ { "name": "patientId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "ResultType": { "type": "string" }, "ResultDate": { "type": "string", "format": "date-time" }, "PcrResult": { "type": "number", "format": "double" }, "IsUndetectable": { "type": "boolean" }, "QualitativeResult": { "type": "string" }, "NextPcrDueInMonths": { "type": "integer", "format": "int32" }, "File": { "type": "string", "format": "binary" } } }, "encoding": { "ResultType": { "style": "form" }, "ResultDate": { "style": "form" }, "PcrResult": { "style": "form" }, "IsUndetectable": { "style": "form" }, "QualitativeResult": { "style": "form" }, "NextPcrDueInMonths": { "style": "form" }, "File": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientPcrResultsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientPcrResultsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientPcrResultsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"resultType\": \"string\",\r\n \"resultDate\": \"2026-01-01T00:00:00Z\",\r\n \"pcrResult\": 0,\r\n \"isUndetectable\": true,\r\n \"qualitativeResult\": \"string\",\r\n \"nextPcrDueInMonths\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true,\r\n \"message\": \"string\"\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/patient/{patientId}/pcr-result/{pcrResultId}": { "put": { "tags": [ "Patient" ], "summary": "Updates Patient Pcr Results.", "parameters": [ { "name": "patientId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pcrResultId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "ResultType": { "type": "string" }, "ResultDate": { "type": "string", "format": "date-time" }, "PcrResult": { "type": "number", "format": "double" }, "IsUndetectable": { "type": "boolean" }, "QualitativeResult": { "type": "string" }, "NextPcrDueInMonths": { "type": "integer", "format": "int32" }, "File": { "type": "string", "format": "binary" } } }, "encoding": { "ResultType": { "style": "form" }, "ResultDate": { "style": "form" }, "PcrResult": { "style": "form" }, "IsUndetectable": { "style": "form" }, "QualitativeResult": { "style": "form" }, "NextPcrDueInMonths": { "style": "form" }, "File": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientPcrResultsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientPcrResultsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientPcrResultsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"resultType\": \"string\",\r\n \"resultDate\": \"2026-01-01T00:00:00Z\",\r\n \"pcrResult\": 0,\r\n \"isUndetectable\": true,\r\n \"qualitativeResult\": \"string\",\r\n \"nextPcrDueInMonths\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true,\r\n \"message\": \"string\"\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/patient/{patientId}/pcr-results/{pcrResultId}": { "delete": { "tags": [ "Patient" ], "summary": "Deletes Patient Pcr Result.", "parameters": [ { "name": "patientId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pcrResultId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.DeletePatientPcrResultResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.DeletePatientPcrResultResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.DeletePatientPcrResultResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"pcrResultId\": 0,\r\n \"deleted\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/applications/{applicationId}/documents": { "post": { "tags": [ "Patient" ], "summary": "Uploads Application Document.", "parameters": [ { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Files": { "type": "array", "items": { "type": "string", "format": "binary" } }, "FileCategory": { "type": "string" }, "Title": { "type": "string" } } }, "encoding": { "File": { "style": "form" }, "Files": { "style": "form" }, "FileCategory": { "style": "form" }, "Title": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.UploadApplicationDocumentResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.UploadApplicationDocumentResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.UploadApplicationDocumentResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"file\": \"\\u003Cbinary\\u003E\",\r\n \"files\": [\r\n \"\\u003Cbinary\\u003E\"\r\n ],\r\n \"fileCategory\": \"string\",\r\n \"title\": \"string\"\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"success\": true,\r\n \"documentId\": \"string\",\r\n \"uploadedCount\": 0,\r\n \"files\": [\r\n {\r\n \"attachmentId\": \"string\",\r\n \"fileName\": \"string\",\r\n \"fileSize\": 0,\r\n \"type\": \"string\",\r\n \"contentType\": \"string\",\r\n \"storagePath\": \"string\"\r\n }\r\n ],\r\n \"remainingMissingDocuments\": [\r\n \"string\"\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/patient/{patientId}/{programId}/profile": { "get": { "tags": [ "PatientProfile" ], "summary": "Uses the same patient/program route parameters and response contract as the physician profile.", "parameters": [ { "name": "patientId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "programId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientProfileResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientProfileResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientProfileResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"patientId\": 0,\r\n \"programId\": 0,\r\n \"combineProgramId\": 0,\r\n \"isPrimaryTreatment\": true,\r\n \"patientPin\": \"string\",\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"initials\": \"string\",\r\n \"alternateId\": \"string\",\r\n \"alternateCharName\": \"string\",\r\n \"sexCode\": \"string\",\r\n \"sexName\": \"string\",\r\n \"birthDate\": \"2026-01-01T00:00:00Z\",\r\n \"isPediatric\": true,\r\n \"phone\": \"string\",\r\n \"mobile\": \"string\",\r\n \"fax\": \"string\",\r\n \"email\": \"string\",\r\n \"email2\": \"string\",\r\n \"allowSmsWhatsapp\": true,\r\n \"street1\": \"string\",\r\n \"street2\": \"string\",\r\n \"city\": \"string\",\r\n \"district\": \"string\",\r\n \"stateProvince\": \"string\",\r\n \"postalCode\": \"string\",\r\n \"mailingAddress\": \"string\",\r\n \"countryId\": 0,\r\n \"countryName\": \"string\",\r\n \"countryStatus\": \"string\",\r\n \"pediatricAge\": 0,\r\n \"patientProgramStatus\": \"string\",\r\n \"statusReason\": \"string\",\r\n \"closedNotes\": \"string\",\r\n \"intakeDate\": \"2026-01-01T00:00:00Z\",\r\n \"initialApprovalDate\": \"2026-01-01T00:00:00Z\",\r\n \"treatmentStartDate\": \"2026-01-01T00:00:00Z\",\r\n \"treatmentDateLabel\": \"string\",\r\n \"currentTreatmentActivityStartDate\": \"2026-01-01T00:00:00Z\",\r\n \"currentReviewEndDate\": \"2026-01-01T00:00:00Z\",\r\n \"closedDate\": \"2026-01-01T00:00:00Z\",\r\n \"deniedDate\": \"2026-01-01T00:00:00Z\",\r\n \"profileMainDate\": \"2026-01-01T00:00:00Z\",\r\n \"profileMainDateLabel\": \"string\",\r\n \"treatmentName\": \"string\",\r\n \"programName\": \"string\",\r\n \"programColor\": \"string\",\r\n \"currentDosage\": \"string\",\r\n \"originalRequestedDosage\": \"string\",\r\n \"originalApprovedDosage\": \"string\",\r\n \"combineTreatmentName\": \"string\",\r\n \"combineProgramColor\": \"string\",\r\n \"combineCurrentDosage\": \"string\",\r\n \"combineOriginalRequestedDosage\": \"string\",\r\n \"isPatientOnTreatmentForTfr\": true,\r\n \"diagnosis\": \"string\",\r\n \"diagnosisDate\": \"2026-01-01T00:00:00Z\",\r\n \"showGeographicDemographicInformationButton\": true,\r\n \"showLogClinicalDataButton\": true,\r\n \"currentCmlPhase\": \"string\",\r\n \"priorTkis\": \"string\",\r\n \"isPhiladelphiaPositive\": true,\r\n \"hasBcr\": true,\r\n \"isCkitPositive\": true,\r\n \"isUnresectable\": true,\r\n \"isMetastatic\": true,\r\n \"treatmentLabelTitle\": \"string\",\r\n \"treatmentLabelNote\": \"string\",\r\n \"treatmentLabelReference\": \"string\",\r\n \"combineTreatmentLabelTitle\": \"string\",\r\n \"closeRequestInProgress\": true,\r\n \"wasPreviouslyOnTreatment\": true,\r\n \"isCopyOfIdOnFile\": true,\r\n \"isDiagnosticTestOnFile\": true,\r\n \"isPatientConsentSigned\": true,\r\n \"isFormerGipap\": true,\r\n \"hasInsurance\": true,\r\n \"doesInsuranceCoverTreatment\": true,\r\n \"annualIncome\": \"string\",\r\n \"occupation\": \"string\",\r\n \"questionResponses\": [\r\n {\r\n \"questionText\": \"string\",\r\n \"questionFieldName\": \"string\",\r\n \"selectedAnswerText\": \"string\",\r\n \"answerColor\": \"string\",\r\n \"displayOrder\": 0,\r\n \"answerValue\": \"string\",\r\n \"answerDisplayText\": \"string\",\r\n \"responseValue\": \"string\"\r\n }\r\n ],\r\n \"clinicalInformation\": {\r\n \"responses\": [\r\n \"string\"\r\n ]\r\n },\r\n \"otherPrograms\": [\r\n {\r\n \"programName\": \"string\",\r\n \"programID\": 0,\r\n \"combineProgramID\": 0,\r\n \"color\": \"string\",\r\n \"status\": \"string\"\r\n }\r\n ],\r\n \"availablePrograms\": [\r\n {\r\n \"program\": \"string\",\r\n \"programID\": 0\r\n }\r\n ],\r\n \"dispenserNames\": \"string\",\r\n \"physicianNames\": \"string\",\r\n \"programOfficerNames\": \"string\",\r\n \"maxStationNames\": \"string\",\r\n \"contactNames\": \"string\",\r\n \"availableActions\": [\r\n {\r\n \"actionCode\": \"string\",\r\n \"requestId\": 0\r\n }\r\n ],\r\n \"journey\": [\r\n {\r\n \"event\": \"string\",\r\n \"date\": \"2026-01-01T00:00:00Z\",\r\n \"detail\": \"string\"\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/profile": { "get": { "tags": [ "Profile" ], "summary": "Gets .", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.MaxUserProfileResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.MaxUserProfileResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.MaxUserProfileResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"personId\": 0,\r\n \"userName\": \"string\",\r\n \"fullName\": \"string\",\r\n \"roles\": [\r\n \"string\"\r\n ],\r\n \"isAuthenticated\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/profile/admin-check": { "get": { "tags": [ "Profile" ], "summary": "Runs admin check.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.MaxAuthorizationProbeResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.MaxAuthorizationProbeResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.MaxAuthorizationProbeResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"allowed\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/totals": { "get": { "tags": [ "Reports" ], "summary": "Totals; returns only authorized data with database filtering, ordering, counts and paging.", "parameters": [ { "name": "TreatmentIds", "in": "query", "description": "Comma-separated program or program.partner identifiers; zero selects authorized treatments.", "schema": { "type": "string" } }, { "name": "CountryId", "in": "query", "description": "Optional country filter; zero means all authorized countries.", "schema": { "type": "integer", "format": "int32" } }, { "name": "RegionId", "in": "query", "description": "Optional region filter.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Diagnosis", "in": "query", "description": "Optional exact diagnosis label.", "schema": { "type": "string" } }, { "name": "Breakdown", "in": "query", "description": "StatusTotals, DiagnosisTotals, DiagToApproval, TimeOnTreatment or TimeOnTreatmentBreakdown.", "schema": { "type": "string" } }, { "name": "ByCountry", "in": "query", "description": "Include country in grouping.", "schema": { "type": "boolean" } }, { "name": "ByDiagnosis", "in": "query", "description": "Include diagnosis in grouping except in diagnosis-column mode.", "schema": { "type": "boolean" } }, { "name": "SnapshotDate", "in": "query", "description": "Optional historical snapshot day.", "schema": { "type": "string", "format": "date-time" } }, { "name": "LessThanYear", "in": "query", "description": "Include this calendar-month treatment duration band; bands may overlap.", "schema": { "type": "boolean" } }, { "name": "OneToThreeYears", "in": "query", "description": "Include this calendar-month treatment duration band; bands may overlap.", "schema": { "type": "boolean" } }, { "name": "OneToFiveYears", "in": "query", "description": "Include this calendar-month treatment duration band; bands may overlap.", "schema": { "type": "boolean" } }, { "name": "ThreeToFiveYears", "in": "query", "description": "Include this calendar-month treatment duration band; bands may overlap.", "schema": { "type": "boolean" } }, { "name": "FiveToTenYears", "in": "query", "description": "Include this calendar-month treatment duration band; bands may overlap.", "schema": { "type": "boolean" } }, { "name": "OverFiveYears", "in": "query", "description": "Include this calendar-month treatment duration band; bands may overlap.", "schema": { "type": "boolean" } }, { "name": "OverTenYears", "in": "query", "description": "Include this calendar-month treatment duration band; bands may overlap.", "schema": { "type": "boolean" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.TotalsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.TotalsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.TotalsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"request\": {\r\n \"treatmentIds\": \"string\",\r\n \"countryId\": 0,\r\n \"regionId\": 0,\r\n \"diagnosis\": \"string\",\r\n \"breakdown\": \"string\",\r\n \"byCountry\": true,\r\n \"byDiagnosis\": true,\r\n \"snapshotDate\": \"2026-01-01T00:00:00Z\",\r\n \"lessThanYear\": true,\r\n \"oneToThreeYears\": true,\r\n \"oneToFiveYears\": true,\r\n \"threeToFiveYears\": true,\r\n \"fiveToTenYears\": true,\r\n \"overFiveYears\": true,\r\n \"overTenYears\": true\r\n },\r\n \"list\": {\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n }\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"columns\": [\r\n \"string\"\r\n ],\r\n \"items\": [\r\n {\r\n \"treatment\": \"string\",\r\n \"country\": \"string\",\r\n \"diagnosis\": \"string\",\r\n \"active\": 0,\r\n \"closed\": 0,\r\n \"denied\": 0,\r\n \"pending\": 0,\r\n \"averageMonthsDiagnosisToApproval\": 0,\r\n \"averageMonthsOnTreatment\": 0,\r\n \"lessThanYear\": 0,\r\n \"oneToThreeYears\": 0,\r\n \"oneToFiveYears\": 0,\r\n \"threeToFiveYears\": 0,\r\n \"fiveToTenYears\": 0,\r\n \"overFiveYears\": 0,\r\n \"overTenYears\": 0,\r\n \"diagnosisCounts\": [\r\n {\r\n \"diagnosisId\": 0,\r\n \"diagnosis\": \"string\",\r\n \"active\": 0\r\n }\r\n ]\r\n }\r\n ],\r\n \"summaries\": {}\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/my-patients": { "get": { "tags": [ "Reports" ], "summary": "My Patients; returns only authorized data with database filtering, ordering, counts and paging.", "parameters": [ { "name": "ProgramId", "in": "query", "description": "Optional regular or SDOH program; zero includes both authorized sources.", "schema": { "type": "integer", "format": "int32" } }, { "name": "CombineTreatmentId", "in": "query", "description": "Optional regular treatment partner.", "schema": { "type": "integer", "format": "int32" } }, { "name": "CountryId", "in": "query", "description": "Optional current patient country.", "schema": { "type": "integer", "format": "int32" } }, { "name": "RegionId", "in": "query", "description": "Optional current patient region.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PhysicianId", "in": "query", "description": "Optional primary physician identity.", "schema": { "type": "integer", "format": "int32" } }, { "name": "InstitutionId", "in": "query", "description": "Optional primary institution identity.", "schema": { "type": "integer", "format": "int32" } }, { "name": "PoId", "in": "query", "description": "Optional program officer filter; cannot replace mandatory assignment scope.", "schema": { "type": "integer", "format": "int32" } }, { "name": "DiagnosisId", "in": "query", "description": "Optional regular diagnosis identifier.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Diagnosis", "in": "query", "description": "Optional exact diagnosis label for both sources.", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "description": "Enrollment status; SDOH uses current status unless a snapshot is selected.", "schema": { "type": "string" } }, { "name": "NeedingReapproval", "in": "query", "description": "Only regular active enrollments whose next review is due.", "schema": { "type": "boolean" } }, { "name": "SnapshotDate", "in": "query", "description": "Regular snapshot day and SDOH snapshot month.", "schema": { "type": "string", "format": "date-time" } }, { "name": "Source", "in": "query", "description": "All, Treatment or Sdoh; a narrowing source selector.", "schema": { "type": "string" } }, { "name": "NeedId", "in": "query", "description": "Optional Helpline need filter; zero includes all needs.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MyPatientsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MyPatientsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MyPatientsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"request\": {\r\n \"programId\": 0,\r\n \"combineTreatmentId\": 0,\r\n \"countryId\": 0,\r\n \"regionId\": 0,\r\n \"physicianId\": 0,\r\n \"institutionId\": 0,\r\n \"poId\": 0,\r\n \"diagnosisId\": 0,\r\n \"diagnosis\": \"string\",\r\n \"status\": \"string\",\r\n \"needingReapproval\": true,\r\n \"snapshotDate\": \"2026-01-01T00:00:00Z\",\r\n \"source\": \"string\",\r\n \"needId\": 0\r\n },\r\n \"list\": {\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n }\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"columns\": [\r\n \"string\"\r\n ],\r\n \"items\": [\r\n {\r\n \"patientId\": 0,\r\n \"pin\": \"string\",\r\n \"patientName\": \"string\",\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"countryId\": 0,\r\n \"country\": \"string\",\r\n \"regionId\": 0,\r\n \"region\": \"string\",\r\n \"diagnosis\": \"string\",\r\n \"treatments\": [\r\n {\r\n \"countryId\": 0,\r\n \"regionId\": 0,\r\n \"institutionId\": 0,\r\n \"physicianId\": 0,\r\n \"poId\": 0,\r\n \"primaryMaxStationId\": 0,\r\n \"patientOnTreatmentForTFR\": true,\r\n \"treatment\": \"string\",\r\n \"color\": \"string\",\r\n \"region\": \"string\",\r\n \"po\": \"string\",\r\n \"caseNote\": \"string\",\r\n \"countryName\": \"string\",\r\n \"institution\": \"string\",\r\n \"programId\": 0,\r\n \"combineTreatmentId\": 0,\r\n \"physician\": \"string\",\r\n \"physCount\": 0,\r\n \"pin\": \"string\",\r\n \"patientId\": 0,\r\n \"patientName\": \"string\",\r\n \"sex\": \"string\",\r\n \"status\": \"string\",\r\n \"initials\": \"string\",\r\n \"alternateId\": \"string\",\r\n \"diagnosis\": \"string\",\r\n \"currentDosage\": \"string\",\r\n \"lastReview\": \"2026-01-01T00:00:00Z\",\r\n \"nextReview\": \"2026-01-01T00:00:00Z\",\r\n \"birthDate\": \"2026-01-01T00:00:00Z\",\r\n \"ageAtDiagnosis\": 0,\r\n \"intakeDate\": \"2026-01-01T00:00:00Z\",\r\n \"iaDate\": \"2026-01-01T00:00:00Z\",\r\n \"monthsTreatment\": 0,\r\n \"treatmentStartDate\": \"2026-01-01T00:00:00Z\",\r\n \"diagnosisDate\": \"2026-01-01T00:00:00Z\",\r\n \"monthsToApproval\": 0,\r\n \"lastDispensationDate\": \"2026-01-01T00:00:00Z\",\r\n \"closedDate\": \"2026-01-01T00:00:00Z\",\r\n \"closedReason\": \"string\",\r\n \"notes\": \"string\",\r\n \"reactivationDate\": \"2026-01-01T00:00:00Z\",\r\n \"deniedDate\": \"2026-01-01T00:00:00Z\",\r\n \"denyReason\": \"string\",\r\n \"occupation\": \"string\",\r\n \"annualIncome\": \"string\",\r\n \"street1\": \"string\",\r\n \"street2\": \"string\",\r\n \"city\": \"string\",\r\n \"stateProvince\": \"string\",\r\n \"postalCode\": \"string\",\r\n \"phone\": \"string\",\r\n \"fax\": \"string\",\r\n \"mobile\": \"string\",\r\n \"email\": \"string\",\r\n \"email2\": \"string\",\r\n \"patientConsent\": \"string\",\r\n \"copyOfId\": \"string\",\r\n \"labelId\": \"string\",\r\n \"primaryMaxStation\": \"string\"\r\n }\r\n ],\r\n \"sdohPrograms\": [\r\n {\r\n \"patientId\": 0,\r\n \"programId\": 0,\r\n \"programName\": \"string\",\r\n \"pin\": \"string\",\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"gender\": \"string\",\r\n \"status\": \"string\",\r\n \"currentStatus\": \"string\",\r\n \"countryId\": 0,\r\n \"country\": \"string\",\r\n \"regionId\": 0,\r\n \"region\": \"string\",\r\n \"diagnosis\": \"string\",\r\n \"iaDate\": \"2026-01-01T00:00:00Z\",\r\n \"createDate\": \"2026-01-01T00:00:00Z\",\r\n \"poId\": 0,\r\n \"maxStationId\": 0,\r\n \"physician\": \"string\",\r\n \"birthDate\": \"2026-01-01T00:00:00Z\",\r\n \"treatment\": \"string\",\r\n \"dosage\": \"string\",\r\n \"treatmentProviderName\": \"string\",\r\n \"consentFormSigned\": \"string\",\r\n \"needs\": \"string\",\r\n \"treatmentName\": \"string\",\r\n \"sdohTreatmentId\": 0,\r\n \"helplineNeedIds\": \"string\",\r\n \"isMaxGps\": true,\r\n \"primaryLanguage\": \"string\",\r\n \"ethnicity\": \"string\",\r\n \"insuranceStatus\": \"string\",\r\n \"insuranceType\": \"string\",\r\n \"citizenshipStatus\": \"string\",\r\n \"employmentStatus\": \"string\",\r\n \"preferredPronouns\": \"string\",\r\n \"annualIncomeCategory\": \"string\",\r\n \"location\": \"string\",\r\n \"interactionsCount\": 0,\r\n \"interactionTotalTime\": \"string\",\r\n \"occupation\": \"string\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"summaries\": {}\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/activity": { "get": { "tags": [ "Reports" ], "summary": "Activity; returns only authorized data with database filtering, ordering, counts and paging.", "parameters": [ { "name": "ProgramId", "in": "query", "description": "Required regular treatment identifier.", "schema": { "type": "integer", "format": "int32" } }, { "name": "CombineTreatmentId", "in": "query", "description": "Optional combination treatment partner.", "schema": { "type": "integer", "format": "int32" } }, { "name": "CountryId", "in": "query", "description": "Optional country; selecting a country also groups totals by institution and physician.", "schema": { "type": "integer", "format": "int32" } }, { "name": "StartDate", "in": "query", "description": "Required inclusive first report date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDate", "in": "query", "description": "Required last report date; source-specific boundaries are retained.", "schema": { "type": "string", "format": "date-time" } }, { "name": "Breakdown", "in": "query", "description": "Totals, Approvals, Reapprovals, Closures, Reactivations or Denials.", "schema": { "type": "string" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.ActivityReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.ActivityReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.ActivityReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"request\": {\r\n \"programId\": 0,\r\n \"combineTreatmentId\": 0,\r\n \"countryId\": 0,\r\n \"startDate\": \"2026-01-01T00:00:00Z\",\r\n \"endDate\": \"2026-01-01T00:00:00Z\",\r\n \"breakdown\": \"string\"\r\n },\r\n \"list\": {\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n }\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"columns\": [\r\n \"string\"\r\n ],\r\n \"items\": [\r\n {\r\n \"country\": \"string\",\r\n \"institution\": \"string\",\r\n \"physician\": \"string\",\r\n \"patientId\": 0,\r\n \"pin\": \"string\",\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"initials\": \"string\",\r\n \"alternateId\": \"string\",\r\n \"diagnosis\": \"string\",\r\n \"date\": \"2026-01-01T00:00:00Z\",\r\n \"dosage\": \"string\",\r\n \"nextReview\": \"2026-01-01T00:00:00Z\",\r\n \"reason\": \"string\",\r\n \"notes\": \"string\",\r\n \"approvals\": 0,\r\n \"reapprovals\": 0,\r\n \"closures\": 0,\r\n \"reactivations\": 0,\r\n \"denials\": 0\r\n }\r\n ],\r\n \"summaries\": {}\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/order-status": { "get": { "tags": [ "Reports" ], "summary": "Order Status; returns only authorized data with database filtering, ordering, counts and paging.", "parameters": [ { "name": "PendingShipmentOnly", "in": "query", "description": "Source blue-grid narrowing: no shipment date and status is not Closed.", "schema": { "type": "boolean" } }, { "name": "CountryId", "in": "query", "description": "Optional authorized country.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.OrderStatusReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.OrderStatusReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.OrderStatusReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"request\": {\r\n \"pendingShipmentOnly\": true,\r\n \"countryId\": 0\r\n },\r\n \"list\": {\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n }\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"columns\": [\r\n \"string\"\r\n ],\r\n \"items\": [\r\n {\r\n \"orderId\": 0,\r\n \"orderPlacedDate\": \"2026-01-01T00:00:00Z\",\r\n \"transactionId\": \"string\",\r\n \"productOrderNo\": \"string\",\r\n \"status\": \"string\",\r\n \"orderStatus\": \"string\",\r\n \"countryId\": 0,\r\n \"country\": \"string\",\r\n \"region\": \"string\",\r\n \"institutionId\": 0,\r\n \"institutionName\": \"string\",\r\n \"customerId\": \"string\",\r\n \"clinicAdmin\": \"string\",\r\n \"clinicAdminUsername\": \"string\",\r\n \"orderShipDate\": \"2026-01-01T00:00:00Z\",\r\n \"shipmentTrackNo\": \"string\",\r\n \"dateReceived\": \"2026-01-01T00:00:00Z\",\r\n \"receivedBy\": \"string\",\r\n \"orderQtyMismatch\": 0,\r\n \"clinicAttachmentsId\": 0,\r\n \"fileName\": \"string\",\r\n \"hasNotes\": true,\r\n \"expiredBatches\": 0,\r\n \"expiringBatches\": 0,\r\n \"orderItems\": [\r\n {\r\n \"orderItemId\": 0,\r\n \"skuId\": 0,\r\n \"skuCode\": \"string\",\r\n \"treatment\": \"string\",\r\n \"qtyOrdered\": 0,\r\n \"qtyShipped\": 0,\r\n \"qtyReceived\": 0,\r\n \"batches\": [\r\n {\r\n \"batchNumber\": \"string\",\r\n \"batchQty\": 0,\r\n \"batchExpiry\": \"2026-01-01T00:00:00Z\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"summaries\": {}\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/mas-institutions": { "get": { "tags": [ "Reports" ], "summary": "MAS Institutions; returns only authorized data with database filtering, ordering, counts and paging.", "parameters": [ { "name": "ProgramId", "in": "query", "description": "Optional treatment for dispensing/pharmacy; treating retains its program-independent source rule.", "schema": { "type": "integer", "format": "int32" } }, { "name": "InstitutionType", "in": "query", "description": "treating, dispensing or pharmacy.", "schema": { "type": "string" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"request\": {\r\n \"programId\": 0,\r\n \"institutionType\": \"string\"\r\n },\r\n \"list\": {\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n }\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"columns\": [\r\n \"string\"\r\n ],\r\n \"items\": [\r\n {\r\n \"institutionId\": 0,\r\n \"region\": \"string\",\r\n \"country\": \"string\",\r\n \"clinic\": \"string\",\r\n \"institutionName\": \"string\",\r\n \"type\": \"string\",\r\n \"nextQaValidation\": \"2026-01-01T00:00:00Z\",\r\n \"isTreatInst\": \"string\",\r\n \"trApprovedList\": \"string\"\r\n }\r\n ],\r\n \"summaries\": {}\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/dispensation": { "get": { "tags": [ "Reports" ], "summary": "Dispensation Report; returns only authorized data with database filtering, ordering, counts and paging.", "parameters": [ { "name": "ProgramId", "in": "query", "description": "Optional program; zero selects all authorized treatments.", "schema": { "type": "integer", "format": "int32" } }, { "name": "CountryIds", "in": "query", "description": "Optional comma-separated narrowing country identifiers.", "schema": { "type": "string" } }, { "name": "StartDate", "in": "query", "description": "Required inclusive dispensation start date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDate", "in": "query", "description": "Required inclusive end instant normalized to midnight, matching the legacy report.", "schema": { "type": "string", "format": "date-time" } }, { "name": "Breakdown", "in": "query", "description": "Totals, CompleteList or PatientsNotDispensed.", "schema": { "type": "string" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.DispensationReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.DispensationReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.DispensationReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"request\": {\r\n \"programId\": 0,\r\n \"countryIds\": \"string\",\r\n \"startDate\": \"2026-01-01T00:00:00Z\",\r\n \"endDate\": \"2026-01-01T00:00:00Z\",\r\n \"breakdown\": \"string\"\r\n },\r\n \"list\": {\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n }\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"columns\": [\r\n \"string\"\r\n ],\r\n \"items\": [\r\n {\r\n \"treatment\": \"string\",\r\n \"region\": \"string\",\r\n \"country\": \"string\",\r\n \"institutionId\": 0,\r\n \"clinic\": \"string\",\r\n \"patientId\": 0,\r\n \"pin\": \"string\",\r\n \"programId\": 0,\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"initialApproval\": \"2026-01-01T00:00:00Z\",\r\n \"reactivationDate\": \"2026-01-01T00:00:00Z\",\r\n \"currentDosage\": \"string\",\r\n \"dailyMgBasedOn120Days\": 0,\r\n \"daysSupplyBasedOnRx\": 0,\r\n \"unit\": \"string\",\r\n \"skuCode1\": \"string\",\r\n \"skuDescription1\": \"string\",\r\n \"skuDispensed1\": 0,\r\n \"skuCode2\": \"string\",\r\n \"skuDescription2\": \"string\",\r\n \"skuDispensed2\": 0,\r\n \"dispenseDate\": \"2026-01-01T00:00:00Z\",\r\n \"createdBy\": \"string\",\r\n \"activePatients\": 0,\r\n \"dispensedToDistinctPatients\": 0,\r\n \"lastOrderReceivedDate\": \"2026-01-01T00:00:00Z\",\r\n \"skuTotals\": [\r\n {\r\n \"skuId\": 0,\r\n \"skuCode\": \"string\",\r\n \"description\": \"string\",\r\n \"boxes\": 0\r\n }\r\n ]\r\n }\r\n ],\r\n \"summaries\": {}\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/sdoh-totals": { "get": { "tags": [ "Reports" ], "summary": "SDOH Totals; returns only authorized data with database filtering, ordering, counts and paging.", "parameters": [ { "name": "ProgramId", "in": "query", "description": "Required SDOH program; 42 Helpline, 47 MAX GPS and 43 Day By Day use dedicated source views.", "schema": { "type": "integer", "format": "int32" } }, { "name": "CountryId", "in": "query", "description": "Optional authorized country.", "schema": { "type": "integer", "format": "int32" } }, { "name": "RegionId", "in": "query", "description": "Optional authorized region.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Diagnosis", "in": "query", "description": "Optional exact diagnosis label.", "schema": { "type": "string" } }, { "name": "Treatment", "in": "query", "description": "Optional Day By Day treatment filter.", "schema": { "type": "string" } }, { "name": "NeedIds", "in": "query", "description": "Optional Helpline need identifiers.", "schema": { "type": "string" } }, { "name": "Breakdown", "in": "query", "description": "Comma-separated approved grouping fields.", "schema": { "type": "string" } }, { "name": "SnapshotDate", "in": "query", "description": "Optional month snapshot; takes priority over date range.", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDate", "in": "query", "description": "Optional inclusive historical-row start instant; requires EndDate.", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDate", "in": "query", "description": "Optional inclusive historical-row end instant; range mode returns active counts only.", "schema": { "type": "string", "format": "date-time" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"request\": {\r\n \"programId\": 0,\r\n \"countryId\": 0,\r\n \"regionId\": 0,\r\n \"diagnosis\": \"string\",\r\n \"treatment\": \"string\",\r\n \"needIds\": \"string\",\r\n \"breakdown\": \"string\",\r\n \"snapshotDate\": \"2026-01-01T00:00:00Z\",\r\n \"startDate\": \"2026-01-01T00:00:00Z\",\r\n \"endDate\": \"2026-01-01T00:00:00Z\"\r\n },\r\n \"list\": {\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n }\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"columns\": [\r\n \"string\"\r\n ],\r\n \"items\": [\r\n {\r\n \"programName\": \"string\",\r\n \"region\": \"string\",\r\n \"country\": \"string\",\r\n \"diagnosis\": \"string\",\r\n \"treatment\": \"string\",\r\n \"treatmentProvider\": \"string\",\r\n \"need\": \"string\",\r\n \"active\": 0,\r\n \"closed\": 0\r\n }\r\n ],\r\n \"summaries\": {}\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/pinc-logs": { "get": { "tags": [ "Reports" ], "summary": "PINC Logs; returns only authorized data with database filtering, ordering, counts and paging.", "parameters": [ { "name": "StartDate", "in": "query", "description": "Required first source report date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDate", "in": "query", "description": "Required last source report date; PINC procedure calls add one day.", "schema": { "type": "string", "format": "date-time" } }, { "name": "CountryId", "in": "query", "description": "Required for NotContacted; optional narrowing filter for other modes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Breakdown", "in": "query", "description": "Contacts, Advocacy, MASContacts or NotContacted.", "schema": { "type": "string" } }, { "name": "GroupBy", "in": "query", "description": "Region, Country or User; MASContacts user mode retains UserCountry source grouping.", "schema": { "type": "string" } }, { "name": "IgnoreAttemptedCalls", "in": "query", "description": "MASContacts source attempted-call exclusion.", "schema": { "type": "boolean" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.PincLogsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.PincLogsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.PincLogsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{\r\n \"request\": {\r\n \"startDate\": \"2026-01-01T00:00:00Z\",\r\n \"endDate\": \"2026-01-01T00:00:00Z\",\r\n \"countryId\": 0,\r\n \"breakdown\": \"string\",\r\n \"groupBy\": \"string\",\r\n \"ignoreAttemptedCalls\": true\r\n },\r\n \"list\": {\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n }\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"columns\": [\r\n \"string\"\r\n ],\r\n \"items\": [\r\n {\r\n \"region\": \"string\",\r\n \"country\": \"string\",\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"username\": \"string\",\r\n \"currentStatus\": \"string\",\r\n \"totalContacts\": 0,\r\n \"distinctPatients\": 0,\r\n \"attemptedCall\": 0,\r\n \"email\": 0,\r\n \"fax\": 0,\r\n \"inPerson\": 0,\r\n \"mail\": 0,\r\n \"phone\": 0,\r\n \"text\": 0,\r\n \"advocacy\": 0,\r\n \"distinctAdvocacyPatients\": 0,\r\n \"referral\": 0,\r\n \"distinctReferPatients\": 0,\r\n \"totalActive\": 0,\r\n \"contacted\": 0,\r\n \"percentage\": 0,\r\n \"treatment\": \"string\",\r\n \"pin\": \"string\",\r\n \"contactType\": \"string\",\r\n \"patientId\": 0,\r\n \"programId\": 0\r\n }\r\n ],\r\n \"summaries\": {}\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/totals/filters": { "get": { "tags": [ "Reports" ], "summary": "Returns every database-backed and fixed legacy filter choice for Totals.", "parameters": [ { "name": "programId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "countryId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "regionId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.TotalsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.TotalsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.TotalsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"programs\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\",\r\n \"programId\": 0,\r\n \"combineTreatmentId\": 0,\r\n \"programType\": \"string\",\r\n \"isMas\": true,\r\n \"mainTreatment\": \"string\"\r\n }\r\n ],\r\n \"countries\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"regions\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"diagnoses\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"snapshots\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"breakdowns\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"groupingOptions\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"durationBands\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"flags\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"defaults\": {\r\n \"treatmentIds\": \"string\",\r\n \"countryId\": 0,\r\n \"regionId\": 0,\r\n \"diagnosis\": \"string\",\r\n \"breakdown\": \"string\",\r\n \"byCountry\": true,\r\n \"byDiagnosis\": true,\r\n \"snapshotDate\": \"2026-01-01T00:00:00Z\",\r\n \"lessThanYear\": true,\r\n \"oneToThreeYears\": true,\r\n \"oneToFiveYears\": true,\r\n \"threeToFiveYears\": true,\r\n \"fiveToTenYears\": true,\r\n \"overFiveYears\": true,\r\n \"overTenYears\": true\r\n }\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/my-patients/filters": { "get": { "tags": [ "Reports" ], "summary": "Returns every database-backed and fixed legacy filter choice for MyPatients.", "parameters": [ { "name": "programId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "countryId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "regionId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "source", "in": "query", "schema": { "type": "string", "default": "All" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MyPatientsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MyPatientsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MyPatientsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"programs\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\",\r\n \"programId\": 0,\r\n \"combineTreatmentId\": 0,\r\n \"programType\": \"string\",\r\n \"isMas\": true,\r\n \"mainTreatment\": \"string\"\r\n }\r\n ],\r\n \"countries\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"regions\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"institutions\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"physicians\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"programOfficers\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"diagnoses\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"sdohDiagnoses\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"snapshots\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"sdohSnapshots\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"needs\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"statuses\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"sdohStatuses\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"sources\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"flags\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"defaults\": {\r\n \"programId\": 0,\r\n \"combineTreatmentId\": 0,\r\n \"countryId\": 0,\r\n \"regionId\": 0,\r\n \"physicianId\": 0,\r\n \"institutionId\": 0,\r\n \"poId\": 0,\r\n \"diagnosisId\": 0,\r\n \"diagnosis\": \"string\",\r\n \"status\": \"string\",\r\n \"needingReapproval\": true,\r\n \"snapshotDate\": \"2026-01-01T00:00:00Z\",\r\n \"source\": \"string\",\r\n \"needId\": 0\r\n }\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/activity/filters": { "get": { "tags": [ "Reports" ], "summary": "Returns every database-backed and fixed legacy filter choice for Activity.", "parameters": [ { "name": "programId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "countryId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "regionId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.ActivityReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.ActivityReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.ActivityReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"programs\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\",\r\n \"programId\": 0,\r\n \"combineTreatmentId\": 0,\r\n \"programType\": \"string\",\r\n \"isMas\": true,\r\n \"mainTreatment\": \"string\"\r\n }\r\n ],\r\n \"countries\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"breakdowns\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"defaults\": {\r\n \"programId\": 0,\r\n \"combineTreatmentId\": 0,\r\n \"countryId\": 0,\r\n \"startDate\": \"2026-01-01T00:00:00Z\",\r\n \"endDate\": \"2026-01-01T00:00:00Z\",\r\n \"breakdown\": \"string\"\r\n }\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/order-status/filters": { "get": { "tags": [ "Reports" ], "summary": "Returns every database-backed and fixed legacy filter choice for OrderStatus.", "parameters": [ { "name": "countryId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.OrderStatusReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.OrderStatusReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.OrderStatusReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"countries\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"regions\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"institutions\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"statuses\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"orderStatuses\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"flags\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"defaults\": {\r\n \"pendingShipmentOnly\": true,\r\n \"countryId\": 0\r\n }\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/mas-institutions/filters": { "get": { "tags": [ "Reports" ], "summary": "Returns every database-backed and fixed legacy filter choice for MasInstitutions.", "parameters": [ { "name": "programId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "countryId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "regionId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"programs\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\",\r\n \"programId\": 0,\r\n \"combineTreatmentId\": 0,\r\n \"programType\": \"string\",\r\n \"isMas\": true,\r\n \"mainTreatment\": \"string\"\r\n }\r\n ],\r\n \"institutionTypes\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"defaults\": {\r\n \"programId\": 0,\r\n \"institutionType\": \"string\"\r\n }\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/dispensation/filters": { "get": { "tags": [ "Reports" ], "summary": "Returns every database-backed and fixed legacy filter choice for Dispensation.", "parameters": [ { "name": "programId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "countryId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "regionId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.DispensationReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.DispensationReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.DispensationReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"programs\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\",\r\n \"programId\": 0,\r\n \"combineTreatmentId\": 0,\r\n \"programType\": \"string\",\r\n \"isMas\": true,\r\n \"mainTreatment\": \"string\"\r\n }\r\n ],\r\n \"countries\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"breakdowns\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"defaults\": {\r\n \"programId\": 0,\r\n \"countryIds\": \"string\",\r\n \"startDate\": \"2026-01-01T00:00:00Z\",\r\n \"endDate\": \"2026-01-01T00:00:00Z\",\r\n \"breakdown\": \"string\"\r\n }\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/sdoh-totals/filters": { "get": { "tags": [ "Reports" ], "summary": "Returns every database-backed and fixed legacy filter choice for SdohTotals.", "parameters": [ { "name": "programId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "countryId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "regionId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"dateRange\": {\r\n \"startDate\": \"2026-01-01T00:00:00Z\",\r\n \"endDate\": \"2026-01-01T00:00:00Z\",\r\n \"isEnabled\": true\r\n },\r\n \"programs\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\",\r\n \"programId\": 0,\r\n \"combineTreatmentId\": 0,\r\n \"programType\": \"string\",\r\n \"isMas\": true,\r\n \"mainTreatment\": \"string\"\r\n }\r\n ],\r\n \"countries\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"regions\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"diagnoses\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"snapshots\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"treatments\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"needs\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"groupings\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"flags\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"defaults\": {\r\n \"programId\": 0,\r\n \"countryId\": 0,\r\n \"regionId\": 0,\r\n \"diagnosis\": \"string\",\r\n \"treatment\": \"string\",\r\n \"needIds\": \"string\",\r\n \"breakdown\": \"string\",\r\n \"snapshotDate\": \"2026-01-01T00:00:00Z\",\r\n \"startDate\": \"2026-01-01T00:00:00Z\",\r\n \"endDate\": \"2026-01-01T00:00:00Z\"\r\n }\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/reports/pinc-logs/filters": { "get": { "tags": [ "Reports" ], "summary": "Returns every database-backed and fixed legacy filter choice for PincLogs.", "parameters": [ { "name": "programId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "countryId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "regionId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.PincLogsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.PincLogsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.PincLogsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"countries\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"breakdowns\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"groupings\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"flags\": [\r\n {\r\n \"value\": \"string\",\r\n \"label\": \"string\"\r\n }\r\n ],\r\n \"defaults\": {\r\n \"startDate\": \"2026-01-01T00:00:00Z\",\r\n \"endDate\": \"2026-01-01T00:00:00Z\",\r\n \"countryId\": 0,\r\n \"breakdown\": \"string\",\r\n \"groupBy\": \"string\",\r\n \"ignoreAttemptedCalls\": true\r\n }\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/tags/users/{personId}": { "get": { "tags": [ "Tags" ], "summary": "Lists a selected internal user's tags, equivalent to the legacy dashboard user selector.", "parameters": [ { "name": "personId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "tab", "in": "query", "schema": { "type": "string" } }, { "name": "programId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\n \"message\": \"No response body\"\n}" } }, "/api/max/tags/{tagId}": { "get": { "tags": [ "Tags" ], "summary": "Tag information and resolution permissions. Does not mark the tag as read.", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.TagItem, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.TagItem, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.TagItem, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } }, "x-request-format": "{}", "x-response-format": "{\r\n \"data\": {\r\n \"createdDate\": \"2026-01-01T00:00:00Z\",\r\n \"outboundOrderId\": 0,\r\n \"isRead\": true,\r\n \"canResolve\": true,\r\n \"tagId\": 0,\r\n \"fromUsername\": \"string\",\r\n \"fromName\": \"string\",\r\n \"toUsername\": \"string\",\r\n \"toName\": \"string\",\r\n \"patientId\": 0,\r\n \"patientName\": \"string\",\r\n \"pin\": \"string\",\r\n \"patientProgramId\": 0,\r\n \"institutionId\": 0,\r\n \"institutionName\": \"string\",\r\n \"programId\": 0,\r\n \"treatment\": \"string\",\r\n \"color\": \"string\",\r\n \"webColor\": \"string\",\r\n \"effectiveDate\": \"2026-01-01T00:00:00Z\",\r\n \"status\": \"string\",\r\n \"resolveDate\": \"2026-01-01T00:00:00Z\",\r\n \"resolveNotes\": \"string\",\r\n \"tagNotes\": \"string\",\r\n \"tagType\": \"string\",\r\n \"resolved\": true\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/tags/context": { "get": { "tags": [ "Tags" ], "summary": "Patient, institution, or supply-chain tags for the corresponding page.", "parameters": [ { "name": "patientId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "institutionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "programId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "outboundOrderId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "x-request-format": "{}", "x-response-format": "{\n \"message\": \"No response body\"\n}" } }, "/api/max/tags/form": { "get": { "tags": [ "Tags" ], "summary": "Recipients, treatments and approved institutions for creating a tag.", "responses": { "200": { "description": "OK" } }, "x-request-format": "{}", "x-response-format": "{\n \"message\": \"No response body\"\n}" } }, "/api/max/tags/patients": { "get": { "tags": [ "Tags" ], "summary": "Finds up to 50 patients by PIN, first name, or last name prefix.", "parameters": [ { "name": "prefix", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-request-format": "{}", "x-response-format": "{\n \"message\": \"No response body\"\n}" } }, "/api/max/tags": { "post": { "tags": [ "Tags" ], "summary": "Creates a tag with the signed-in user as sender.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.CreateTagRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.CreateTagRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.CreateTagRequest" } } } }, "responses": { "200": { "description": "OK" } }, "x-request-format": "{\r\n \"toUsername\": \"string\",\r\n \"tagNotes\": \"string\",\r\n \"effectiveDate\": \"2026-01-01T00:00:00Z\",\r\n \"patientId\": 0,\r\n \"institutionId\": 0,\r\n \"programId\": 0,\r\n \"outboundOrderId\": 0\r\n}", "x-response-format": "{\n \"message\": \"No response body\"\n}" }, "get": { "tags": [ "Tags" ], "summary": "Lists the signed-in user's tags with optional tab, program, filters, ordering and pagination.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "Filters", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "tab", "in": "query", "schema": { "type": "string" } }, { "name": "programId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.TagPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.TagPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.TagPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-request-format": "{\r\n \"searchTerm\": \"string\",\r\n \"sortBy\": \"string\",\r\n \"sortDirection\": \"string\",\r\n \"filters\": [\r\n {\r\n \"column\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"pageSize\": 0,\r\n \"page\": 0\r\n}", "x-response-format": "{\r\n \"data\": {\r\n \"totalCount\": 0,\r\n \"page\": 0,\r\n \"pageSize\": 0,\r\n \"items\": [\r\n {\r\n \"createdDate\": \"2026-01-01T00:00:00Z\",\r\n \"outboundOrderId\": 0,\r\n \"isRead\": true,\r\n \"canResolve\": true,\r\n \"tagId\": 0,\r\n \"fromUsername\": \"string\",\r\n \"fromName\": \"string\",\r\n \"toUsername\": \"string\",\r\n \"toName\": \"string\",\r\n \"patientId\": 0,\r\n \"patientName\": \"string\",\r\n \"pin\": \"string\",\r\n \"patientProgramId\": 0,\r\n \"institutionId\": 0,\r\n \"institutionName\": \"string\",\r\n \"programId\": 0,\r\n \"treatment\": \"string\",\r\n \"color\": \"string\",\r\n \"webColor\": \"string\",\r\n \"effectiveDate\": \"2026-01-01T00:00:00Z\",\r\n \"status\": \"string\",\r\n \"resolveDate\": \"2026-01-01T00:00:00Z\",\r\n \"resolveNotes\": \"string\",\r\n \"tagNotes\": \"string\",\r\n \"tagType\": \"string\",\r\n \"resolved\": true\r\n }\r\n ]\r\n },\r\n \"success\": true,\r\n \"message\": \"string\"\r\n}" } }, "/api/max/tags/{tagId}/hide": { "post": { "tags": [ "Tags" ], "summary": "All=true hides both copies; All=false hides only the sender's copy.", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.HideTagRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.HideTagRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.HideTagRequest" } } } }, "responses": { "200": { "description": "OK" } }, "x-request-format": "{\r\n \"all\": true\r\n}", "x-response-format": "{\n \"message\": \"No response body\"\n}" } }, "/api/max/tags/{tagId}/resolve": { "post": { "tags": [ "Tags" ], "summary": "Resolves an incoming tag with reply notes as its recipient.", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.ResolveTagRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.ResolveTagRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.ResolveTagRequest" } } } }, "responses": { "200": { "description": "OK" } }, "x-request-format": "{\r\n \"resolveNotes\": \"string\"\r\n}", "x-response-format": "{\n \"message\": \"No response body\"\n}" } }, "/api/max/tags/{tagId}/mark-resolved": { "post": { "tags": [ "Tags" ], "summary": "Resolves without a reply and hides the sender's resolved notification.", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "x-request-format": "{}", "x-response-format": "{\n \"message\": \"No response body\"\n}" } }, "/api/max/tags/{tagId}/read": { "post": { "tags": [ "Tags" ], "summary": "Records the recipient's read action separately from read-only tag details.", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "x-request-format": "{}", "x-response-format": "{\n \"message\": \"No response body\"\n}" } } }, "components": { "schemas": { "Application.Contracts.Applicants.CreateApplicantRequest": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "physicianId": { "type": "integer", "format": "int32" }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "initials": { "type": "string", "nullable": true }, "alternateid": { "type": "string", "nullable": true }, "alternatecharname": { "type": "string", "nullable": true }, "rdsex": { "type": "string", "nullable": true }, "birthday": { "type": "integer", "format": "int32" }, "birthmonth": { "type": "integer", "format": "int32" }, "birthyear": { "type": "integer", "format": "int32" }, "Street1": { "type": "string", "nullable": true }, "Street2": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "StateProvince": { "type": "string", "nullable": true }, "PostalCode": { "type": "string", "nullable": true }, "Phone": { "type": "string", "nullable": true }, "Mobile": { "type": "string", "nullable": true }, "Fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "Email2": { "type": "string", "nullable": true }, "ContactFirstName": { "type": "string", "nullable": true }, "ContactLastName": { "type": "string", "nullable": true }, "ContactStreet1": { "type": "string", "nullable": true }, "ContactStreet2": { "type": "string", "nullable": true }, "ContactCity": { "type": "string", "nullable": true }, "ContactStateProvince": { "type": "string", "nullable": true }, "ContactPostalCode": { "type": "string", "nullable": true }, "ContactCountryID": { "type": "integer", "format": "int32", "nullable": true }, "ContactPhone": { "type": "string", "nullable": true }, "ContactMobile": { "type": "string", "nullable": true }, "ContactFax": { "type": "string", "nullable": true }, "ContactEmail": { "type": "string", "nullable": true }, "relationship": { "type": "string", "nullable": true }, "RelationshipDetails": { "type": "string", "nullable": true }, "Dosage": { "type": "string", "nullable": true }, "Diagnosis": { "type": "string", "nullable": true }, "DiagnosisDate": { "type": "string", "format": "date-time", "nullable": true }, "Notes": { "type": "string", "nullable": true }, "ProgramID": { "type": "integer", "format": "int32" }, "treatmentidText": { "type": "string", "nullable": true }, "Treatment": { "type": "string", "nullable": true }, "CombineProgramId": { "type": "integer", "format": "int32", "nullable": true }, "CombineTreatmentName": { "type": "string", "nullable": true }, "CombineDosage": { "type": "string", "nullable": true }, "LabelId": { "type": "integer", "format": "int32", "nullable": true }, "CombineLabelId": { "type": "integer", "format": "int32", "nullable": true }, "PatientConsent": { "type": "boolean" }, "HasInsurance": { "type": "boolean" }, "InsuranceCoversTreatment": { "type": "boolean" }, "HouseholdMembers": { "type": "string", "nullable": true }, "HouseholdIncome": { "type": "string", "nullable": true }, "MedicalHistory": { "type": "string", "nullable": true }, "Occupation": { "type": "string", "nullable": true }, "AnnualIncome": { "type": "string", "nullable": true }, "CopyOfId": { "type": "boolean" }, "PriorTKIs": { "type": "integer", "format": "int32", "nullable": true }, "HadPcr": { "type": "boolean" }, "LastPcrValue": { "type": "number", "format": "double", "nullable": true }, "PcrDate": { "type": "string", "format": "date-time", "nullable": true }, "ReasonForNot": { "type": "string", "nullable": true }, "PhilPos": { "type": "integer", "format": "int32", "nullable": true }, "Bcr": { "type": "integer", "format": "int32", "nullable": true }, "CkitPositive": { "type": "integer", "format": "int32", "nullable": true }, "Unresectable": { "type": "integer", "format": "int32", "nullable": true }, "Metastatic": { "type": "integer", "format": "int32", "nullable": true }, "DiagnosticTestDone": { "type": "boolean" }, "questionAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientApplicationQuestionAnswerRequest" } }, "sdoh": { "$ref": "#/components/schemas/Domain.SdohApplicants.SdohApplicantDetails" } }, "additionalProperties": false }, "Application.Contracts.Applicants.CreateSdohDiagnosisRequest": { "type": "object", "properties": { "programId": { "type": "integer", "format": "int32" }, "diagnosis": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Applicants.SdohApplicantFormResponse": { "type": "object", "properties": { "formType": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Applicants.SdohFormField" } }, "diagnoses": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Applicants.SdohDiagnosisOption" } }, "treatments": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Applicants.SdohTreatmentOption" } }, "dosages": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Applicants.SdohDosageOption" } }, "treatmentProviders": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Applicants.SdohProviderOption" } }, "unlistedOptionValue": { "type": "integer", "format": "int32" }, "allowUnlistedDiagnosis": { "type": "boolean" }, "allowUnlistedTreatment": { "type": "boolean" }, "allowUnlistedTreatmentProvider": { "type": "boolean" }, "defaultNextReviewDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Applicants.SdohDiagnosisOption": { "type": "object", "properties": { "diagnosisId": { "type": "integer", "format": "int32" }, "diagnosis": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Applicants.SdohDosageOption": { "type": "object", "properties": { "dosageId": { "type": "integer", "format": "int32" }, "dosage": { "type": "string" }, "sdohTreatmentId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Application.Contracts.Applicants.SdohFormField": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "required": { "type": "boolean" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Applicants.SdohFormOption" }, "nullable": true }, "requiredWhen": { "type": "string", "nullable": true }, "visibleWhen": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Applicants.SdohFormOption": { "type": "object", "properties": { "value": { "type": "string" }, "text": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Applicants.SdohPhysicianSearchOption": { "type": "object", "properties": { "physicianId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "country": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Applicants.SdohPhysicianSearchResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Applicants.SdohPhysicianSearchOption" } }, "hasMore": { "type": "boolean" } }, "additionalProperties": false }, "Application.Contracts.Applicants.SdohProviderOption": { "type": "object", "properties": { "treatmentProviderId": { "type": "integer", "format": "int32" }, "providerName": { "type": "string" }, "countryId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Applicants.SdohTreatmentOption": { "type": "object", "properties": { "sdohTreatmentId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "diagnosisIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "Application.Contracts.FileCabinet.FileCabinetClassification": { "type": "object", "properties": { "fileId": { "type": "integer", "format": "int32" }, "folderTypeId": { "type": "integer", "format": "int32" }, "programId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.FileCabinet.FileCabinetFileResponse": { "type": "object", "properties": { "fileId": { "type": "integer", "format": "int32" }, "fileName": { "type": "string" }, "fileSize": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "title": { "type": "string" }, "uploadDate": { "type": "string", "format": "date-time", "nullable": true }, "folderTypeId": { "type": "integer", "format": "int32" }, "folderTypeName": { "type": "string", "nullable": true }, "programId": { "type": "integer", "format": "int32", "nullable": true }, "createdBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.FileCabinet.FileCabinetFolderResponse": { "type": "object", "properties": { "folderTypeId": { "type": "integer", "format": "int32" }, "folderTypeName": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.FileCabinet.FileCabinetProgramResponse": { "type": "object", "properties": { "programId": { "type": "integer", "format": "int32" }, "programName": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.FileCabinet.UpdateFileCabinetFolderRequest": { "type": "object", "properties": { "folderTypeId": { "type": "integer", "format": "int32" }, "programId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.FileCabinet.UpdateFileCabinetFoldersRequest": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.FileCabinet.FileCabinetClassification" } } }, "additionalProperties": false }, "Application.Contracts.FileCabinet.UploadFileCabinetForm": { "type": "object", "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" } }, "folderTypeId": { "type": "integer", "format": "int32" }, "programId": { "type": "integer", "format": "int32", "nullable": true }, "title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.ApplicantCountryOption": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "country": { "type": "string" }, "physicians": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.ApplicantPhysicianOption" } } }, "additionalProperties": false }, "Application.Contracts.Patients.ApplicantPhysicianOption": { "type": "object", "properties": { "physicianId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Patients.ApplyFormDiagnosisLabelResponse": { "type": "object", "properties": { "treatmentLabelId": { "type": "integer", "format": "int32" }, "labelTitle": { "type": "string" }, "labelTitleNote": { "type": "string" }, "labelRef": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Patients.ApplyFormDiagnosisResponse": { "type": "object", "properties": { "diagnosis": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.ApplyFormDiagnosisLabelResponse" } }, "combineProgramLabels": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.ApplyFormDiagnosisLabelResponse" } }, "questions": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.ProgramQuestions.ProgramQuestionDto" } } }, "additionalProperties": false }, "Application.Contracts.Patients.ApplyFormDosageResponse": { "type": "object", "properties": { "dosageId": { "type": "integer", "format": "int32" }, "dosage": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Patients.CloseFormOption": { "type": "object", "properties": { "value": { "type": "string" }, "text": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Patients.CreatePatientApplicationRequest": { "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "physicianId": { "type": "integer", "format": "int32" }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "initials": { "type": "string", "nullable": true }, "alternateid": { "type": "string", "nullable": true }, "alternatecharname": { "type": "string", "nullable": true }, "rdsex": { "type": "string", "nullable": true }, "birthday": { "type": "integer", "format": "int32" }, "birthmonth": { "type": "integer", "format": "int32" }, "birthyear": { "type": "integer", "format": "int32" }, "Street1": { "type": "string", "nullable": true }, "Street2": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "StateProvince": { "type": "string", "nullable": true }, "PostalCode": { "type": "string", "nullable": true }, "Phone": { "type": "string", "nullable": true }, "Mobile": { "type": "string", "nullable": true }, "Fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "Email2": { "type": "string", "nullable": true }, "ContactFirstName": { "type": "string", "nullable": true }, "ContactLastName": { "type": "string", "nullable": true }, "ContactStreet1": { "type": "string", "nullable": true }, "ContactStreet2": { "type": "string", "nullable": true }, "ContactCity": { "type": "string", "nullable": true }, "ContactStateProvince": { "type": "string", "nullable": true }, "ContactPostalCode": { "type": "string", "nullable": true }, "ContactCountryID": { "type": "integer", "format": "int32", "nullable": true }, "ContactPhone": { "type": "string", "nullable": true }, "ContactMobile": { "type": "string", "nullable": true }, "ContactFax": { "type": "string", "nullable": true }, "ContactEmail": { "type": "string", "nullable": true }, "relationship": { "type": "string", "nullable": true }, "RelationshipDetails": { "type": "string", "nullable": true }, "Dosage": { "type": "string", "nullable": true }, "Diagnosis": { "type": "string", "nullable": true }, "DiagnosisDate": { "type": "string", "format": "date-time", "nullable": true }, "Notes": { "type": "string", "nullable": true }, "ProgramID": { "type": "integer", "format": "int32" }, "treatmentidText": { "type": "string", "nullable": true }, "Treatment": { "type": "string", "nullable": true }, "CombineProgramId": { "type": "integer", "format": "int32", "nullable": true }, "CombineTreatmentName": { "type": "string", "nullable": true }, "CombineDosage": { "type": "string", "nullable": true }, "LabelId": { "type": "integer", "format": "int32", "nullable": true }, "CombineLabelId": { "type": "integer", "format": "int32", "nullable": true }, "PatientConsent": { "type": "boolean" }, "HasInsurance": { "type": "boolean" }, "InsuranceCoversTreatment": { "type": "boolean" }, "HouseholdMembers": { "type": "string", "nullable": true }, "HouseholdIncome": { "type": "string", "nullable": true }, "MedicalHistory": { "type": "string", "nullable": true }, "Occupation": { "type": "string", "nullable": true }, "AnnualIncome": { "type": "string", "nullable": true }, "CopyOfId": { "type": "boolean" }, "PriorTKIs": { "type": "integer", "format": "int32", "nullable": true }, "HadPcr": { "type": "boolean" }, "LastPcrValue": { "type": "number", "format": "double", "nullable": true }, "PcrDate": { "type": "string", "format": "date-time", "nullable": true }, "ReasonForNot": { "type": "string", "nullable": true }, "PhilPos": { "type": "integer", "format": "int32", "nullable": true }, "Bcr": { "type": "integer", "format": "int32", "nullable": true }, "CkitPositive": { "type": "integer", "format": "int32", "nullable": true }, "Unresectable": { "type": "integer", "format": "int32", "nullable": true }, "Metastatic": { "type": "integer", "format": "int32", "nullable": true }, "DiagnosticTestDone": { "type": "boolean" }, "questionAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientApplicationQuestionAnswerRequest" } } }, "additionalProperties": false }, "Application.Contracts.Patients.CreatePatientApplicationResponse": { "type": "object", "properties": { "applicantId": { "type": "integer", "format": "int32" }, "questionResponseCount": { "type": "integer", "format": "int32" }, "success": { "type": "boolean" }, "patientId": { "type": "integer", "format": "int32", "nullable": true }, "pin": { "type": "string", "nullable": true }, "programId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.CreatePatientPcrResultsRequest": { "type": "object", "properties": { "resultType": { "type": "string" }, "resultDate": { "type": "string", "format": "date-time", "nullable": true }, "pcrResult": { "type": "number", "format": "double", "nullable": true }, "isUndetectable": { "type": "boolean" }, "qualitativeResult": { "type": "string", "nullable": true }, "nextPcrDueInMonths": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.CreatePatientPcrResultsResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Patients.CreatePcrResultRequest": { "type": "object", "properties": { "patientId": { "type": "string" }, "date": { "type": "string" }, "result": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Patients.CreatePcrResultResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "pcrResultId": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Patients.DeletePatientPcrResultResponse": { "type": "object", "properties": { "pcrResultId": { "type": "integer", "format": "int32" }, "deleted": { "type": "boolean" } }, "additionalProperties": false }, "Application.Contracts.Patients.MaxPatientCloseRequestForm": { "type": "object", "properties": { "closeReasons": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.CloseFormOption" } }, "adverseEventEmail": { "type": "string" }, "treatmentName": { "type": "string" }, "combineTreatmentName": { "type": "string" }, "treatmentFreeRemission": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientCloseTreatmentFreeRemissionSection" }, "receivedMethodOptions": { "type": "array", "items": { "type": "string" } }, "allowSourceDocument": { "type": "boolean" }, "requiresTreatmentRelationship": { "type": "boolean" }, "treatmentRelationships": { "type": "array", "items": { "type": "string" } }, "sourceDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientSourceDocumentOption" } }, "openRequestId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.MaxPatientReviewForm": { "type": "object", "properties": { "patientId": { "type": "integer", "format": "int32" }, "programId": { "type": "integer", "format": "int32" }, "aeEmail": { "type": "string" }, "lastDispensationDate": { "type": "string", "format": "date-time", "nullable": true }, "nextReviewDate": { "type": "string", "format": "date-time" }, "message": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientAlertMessageResponse" }, "dosageOptions": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.ValueTextOptionResponse" } }, "combineTreatmentDosageOptions": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.ValueTextOptionResponse" } }, "diagnosis": { "type": "string" }, "currentDosage": { "type": "string" }, "combineTreatmentId": { "type": "integer", "format": "int32", "nullable": true }, "combineTreatmentCurrentDosage": { "type": "string", "nullable": true }, "pendingTreatmentActivityId": { "type": "integer", "format": "int32", "nullable": true }, "receivedMethodOptions": { "type": "array", "items": { "type": "string" } }, "adverseEventReceivedMethodOptions": { "type": "array", "items": { "type": "string" } }, "allowSourceDocument": { "type": "boolean" }, "sourceDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientSourceDocumentOption" } }, "pcrDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientSourceDocumentOption" } }, "requiresTreatmentRelationship": { "type": "boolean" }, "treatmentRelationships": { "type": "array", "items": { "type": "string" } }, "labelId": { "type": "integer", "format": "int32", "nullable": true }, "labelOptions": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.ApplyFormDiagnosisLabelResponse" } }, "hasValidFinancialEvaluation": { "type": "boolean" }, "canSubmit": { "type": "boolean" }, "isPatientOnTreatmentForTfr": { "type": "boolean" }, "clinicalResponse": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientReviewClinicalResponse" }, "pcrResults": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientReviewPcrResult" } }, "clinicalOptions": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientReviewClinicalOptions" } }, "additionalProperties": false }, "Application.Contracts.Patients.MaxPatientReviewRequest": { "type": "object", "properties": { "continueTreatment": { "type": "boolean" }, "hasFinancialOrInsuranceStatusChanged": { "type": "boolean" }, "dosage": { "type": "string" }, "combineTreatmentDosage": { "type": "string", "nullable": true }, "nextReviewDate": { "type": "string", "format": "date-time" }, "physicianRequested": { "type": "boolean", "nullable": true }, "receivedMethod": { "type": "string" }, "labelId": { "type": "integer", "format": "int32", "nullable": true }, "adverseEvent": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientReviewAdverseEvent" }, "clinicalResponse": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientReviewClinicalResponse" }, "pcrResults": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientReviewPcrResult" } } }, "additionalProperties": false }, "Application.Contracts.Patients.NewApplicantFormResponse": { "type": "object", "properties": { "programId": { "type": "integer", "format": "int32" }, "program": { "type": "string" }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.ApplicantCountryOption" } }, "form": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientApplyFormResponse" }, "sdohForm": { "$ref": "#/components/schemas/Application.Contracts.Applicants.SdohApplicantFormResponse" }, "contactCountries": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.ApplicantCountryOption" }, "nullable": true }, "canCreateDiagnosis": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientAlertMessageResponse": { "type": "object", "properties": { "type": { "type": "string" }, "text": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientApplicationDocumentsResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "applicationId": { "type": "string" }, "patientName": { "type": "string" }, "treatment": { "type": "string" }, "status": { "type": "string" }, "submittedDate": { "type": "string" }, "missingDocuments": { "type": "array", "items": { "type": "string" } }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientApplicationFileResponse" } } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientApplicationFileResponse": { "type": "object", "properties": { "fileId": { "type": "string" }, "fileName": { "type": "string" }, "fileCategory": { "type": "string" }, "uploadedAt": { "type": "string" }, "sizeBytes": { "type": "integer", "format": "int64" }, "mimeType": { "type": "string" }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientApplicationQuestionAnswerRequest": { "type": "object", "properties": { "questionFieldName": { "type": "string" }, "answerValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientApplyFormResponse": { "type": "object", "properties": { "programId": { "type": "integer", "format": "int32" }, "program": { "type": "string" }, "diagnoses": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.ApplyFormDiagnosisResponse" } }, "dosages": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.ApplyFormDosageResponse" } }, "combineProgramDosages": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.ApplyFormDosageResponse" } } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientCloseRequestResult": { "type": "object", "properties": { "requestId": { "type": "integer", "format": "int32" }, "adverseEventId": { "type": "integer", "format": "int32", "nullable": true }, "nextApplicationProgramId": { "type": "integer", "format": "int32", "nullable": true }, "status": { "type": "string", "readOnly": true } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientCloseTreatmentFreeRemissionSection": { "type": "object", "properties": { "isApplicable": { "type": "boolean" } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientJourneyItemResponse": { "type": "object", "properties": { "event": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "detail": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientNeedingReviewItemResponse": { "type": "object", "properties": { "patientId": { "type": "string" }, "programId": { "type": "string" }, "pin": { "type": "string" }, "patientName": { "type": "string" }, "treatment": { "type": "string" }, "dosage": { "type": "string" }, "birthDate": { "type": "string" }, "dateEntered": { "type": "string" }, "scheduledCloseDate": { "type": "string" }, "message": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientAlertMessageResponse" } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientPcrResultItemResponse": { "type": "object", "properties": { "pcrResultsId": { "type": "string" }, "pcrDate": { "type": "string" }, "pcrResultType": { "type": "string" }, "result": { "type": "string" }, "redFlag": { "type": "boolean" }, "treatmentName": { "type": "string" }, "programColor": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientPcrResultsResponse": { "type": "object", "properties": { "patientId": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientPcrResultItemResponse" } } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientProfileAvailableActionResponse": { "type": "object", "properties": { "actionCode": { "type": "string" }, "requestId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientProfileAvailableProgramResponse": { "type": "object", "properties": { "program": { "type": "string" }, "programID": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientProfileClinicalInformationResponse": { "type": "object", "properties": { "responses": { "type": "array", "items": { } } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientProfileOtherProgramResponse": { "type": "object", "properties": { "programName": { "type": "string" }, "programID": { "type": "integer", "format": "int32" }, "combineProgramID": { "type": "integer", "format": "int32", "nullable": true }, "color": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientProfileQuestionResponse": { "type": "object", "properties": { "questionText": { "type": "string", "nullable": true }, "questionFieldName": { "type": "string", "nullable": true }, "selectedAnswerText": { "type": "string", "nullable": true }, "answerColor": { "type": "string", "nullable": true }, "displayOrder": { "type": "integer", "format": "int32" }, "answerValue": { "type": "string", "nullable": true }, "answerDisplayText": { "type": "string", "nullable": true }, "responseValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientProfileResponse": { "type": "object", "properties": { "patientId": { "type": "integer", "format": "int32" }, "programId": { "type": "integer", "format": "int32" }, "combineProgramId": { "type": "integer", "format": "int32", "nullable": true }, "isPrimaryTreatment": { "type": "boolean" }, "patientPin": { "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "initials": { "type": "string", "nullable": true }, "alternateId": { "type": "string", "nullable": true }, "alternateCharName": { "type": "string", "nullable": true }, "sexCode": { "type": "string", "nullable": true }, "sexName": { "type": "string", "nullable": true }, "birthDate": { "type": "string", "format": "date-time", "nullable": true }, "isPediatric": { "type": "boolean" }, "phone": { "type": "string", "nullable": true }, "mobile": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "email2": { "type": "string", "nullable": true }, "allowSmsWhatsapp": { "type": "boolean", "nullable": true }, "street1": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "district": { "type": "string", "nullable": true }, "stateProvince": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "mailingAddress": { "type": "string", "nullable": true }, "countryId": { "type": "integer", "format": "int32" }, "countryName": { "type": "string", "nullable": true }, "countryStatus": { "type": "string", "nullable": true }, "pediatricAge": { "type": "integer", "format": "int32" }, "patientProgramStatus": { "type": "string", "nullable": true }, "statusReason": { "type": "string", "nullable": true }, "closedNotes": { "type": "string", "nullable": true }, "intakeDate": { "type": "string", "format": "date-time", "nullable": true }, "initialApprovalDate": { "type": "string", "format": "date-time", "nullable": true }, "treatmentStartDate": { "type": "string", "format": "date-time", "nullable": true }, "treatmentDateLabel": { "type": "string" }, "currentTreatmentActivityStartDate": { "type": "string", "format": "date-time", "nullable": true }, "currentReviewEndDate": { "type": "string", "format": "date-time", "nullable": true }, "closedDate": { "type": "string", "format": "date-time", "nullable": true }, "deniedDate": { "type": "string", "format": "date-time", "nullable": true }, "profileMainDate": { "type": "string", "format": "date-time", "nullable": true }, "profileMainDateLabel": { "type": "string", "nullable": true }, "treatmentName": { "type": "string", "nullable": true }, "programName": { "type": "string", "nullable": true }, "programColor": { "type": "string", "nullable": true }, "currentDosage": { "type": "string", "nullable": true }, "originalRequestedDosage": { "type": "string", "nullable": true }, "originalApprovedDosage": { "type": "string", "nullable": true }, "combineTreatmentName": { "type": "string", "nullable": true }, "combineProgramColor": { "type": "string", "nullable": true }, "combineCurrentDosage": { "type": "string", "nullable": true }, "combineOriginalRequestedDosage": { "type": "string", "nullable": true }, "isPatientOnTreatmentForTfr": { "type": "boolean" }, "diagnosis": { "type": "string", "nullable": true }, "diagnosisDate": { "type": "string", "format": "date-time", "nullable": true }, "showGeographicDemographicInformationButton": { "type": "boolean" }, "showLogClinicalDataButton": { "type": "boolean" }, "currentCmlPhase": { "type": "string", "nullable": true }, "priorTkis": { "type": "string", "nullable": true }, "isPhiladelphiaPositive": { "type": "boolean", "nullable": true }, "hasBcr": { "type": "boolean", "nullable": true }, "isCkitPositive": { "type": "boolean", "nullable": true }, "isUnresectable": { "type": "boolean", "nullable": true }, "isMetastatic": { "type": "boolean", "nullable": true }, "treatmentLabelTitle": { "type": "string", "nullable": true }, "treatmentLabelNote": { "type": "string", "nullable": true }, "treatmentLabelReference": { "type": "string", "nullable": true }, "combineTreatmentLabelTitle": { "type": "string", "nullable": true }, "closeRequestInProgress": { "type": "boolean", "nullable": true }, "wasPreviouslyOnTreatment": { "type": "boolean" }, "isCopyOfIdOnFile": { "type": "boolean" }, "isDiagnosticTestOnFile": { "type": "boolean" }, "isPatientConsentSigned": { "type": "boolean" }, "isFormerGipap": { "type": "boolean", "nullable": true }, "hasInsurance": { "type": "boolean", "nullable": true }, "doesInsuranceCoverTreatment": { "type": "boolean", "nullable": true }, "annualIncome": { "type": "string", "nullable": true }, "occupation": { "type": "string", "nullable": true }, "questionResponses": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientProfileQuestionResponse" } }, "clinicalInformation": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientProfileClinicalInformationResponse" }, "otherPrograms": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientProfileOtherProgramResponse" } }, "availablePrograms": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientProfileAvailableProgramResponse" } }, "dispenserNames": { "type": "string", "nullable": true }, "physicianNames": { "type": "string", "nullable": true }, "programOfficerNames": { "type": "string", "nullable": true }, "maxStationNames": { "type": "string", "nullable": true }, "contactNames": { "type": "string", "nullable": true }, "availableActions": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientProfileAvailableActionResponse" } }, "journey": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientJourneyItemResponse" } } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientReactivationFormResponse": { "type": "object", "properties": { "reactivateReasons": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.ValueTextOptionResponse" } }, "dosageOptions": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.ValueTextOptionResponse" } }, "combineDosageOptions": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.ValueTextOptionResponse" } } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientReviewAdverseEvent": { "type": "object", "properties": { "details": { "type": "string" }, "dateLearned": { "type": "string", "format": "date-time" }, "learnedFromPhysician": { "type": "boolean", "nullable": true }, "receivedMethod": { "type": "string" }, "treatmentRelated": { "type": "string", "nullable": true }, "sourceDocumentId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientReviewClinicalOptions": { "type": "object", "properties": { "hematologicalResponses": { "type": "array", "items": { "type": "string" } }, "cytogeneticResponses": { "type": "array", "items": { "type": "string" } }, "molecularResponses": { "type": "array", "items": { "type": "string" } }, "tumorResponses": { "type": "array", "items": { "type": "string" } }, "complianceOptions": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientReviewClinicalResponse": { "type": "object", "properties": { "hematologicalResponse": { "type": "string" }, "hasCytogeneticTest": { "type": "boolean", "nullable": true }, "cytogeneticTestDate": { "type": "string", "format": "date-time", "nullable": true }, "cytogeneticResponse": { "type": "string", "nullable": true }, "hasMolecularTest": { "type": "boolean", "nullable": true }, "molecularTestDate": { "type": "string", "format": "date-time", "nullable": true }, "molecularResponse": { "type": "string", "nullable": true }, "tumorResponse": { "type": "string", "nullable": true }, "medicationCompliance": { "type": "string" }, "visitCompliance": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientReviewPcrResult": { "type": "object", "properties": { "resultDate": { "type": "string", "format": "date-time" }, "quantitativeResult": { "type": "number", "format": "double", "nullable": true }, "isUndetectable": { "type": "boolean" }, "attachmentId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientSourceDocumentOption": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "fileName": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Patients.PatientsNeedingReviewResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientNeedingReviewItemResponse" } } }, "additionalProperties": false }, "Application.Contracts.Patients.PcrDuePatientItemResponse": { "type": "object", "properties": { "pin": { "type": "string" }, "patientName": { "type": "string" }, "treatment": { "type": "string" }, "lastPcrDate": { "type": "string" }, "nextPcrDueInMonths": { "type": "integer", "format": "int32" }, "nextPcrDueDate": { "type": "string" }, "patientId": { "type": "string" }, "programId": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.Patients.PcrDuePatientsResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PcrDuePatientItemResponse" } } }, "additionalProperties": false }, "Application.Contracts.Patients.PcrPastDuePatientResponse": { "type": "object", "properties": { "pin": { "type": "string" }, "patient": { "type": "string" }, "treatment": { "type": "string" }, "lastPcrDate": { "type": "string" }, "nextPcrDueInMonths": { "type": "integer", "format": "int32" }, "nextPcrDueDate": { "type": "string" }, "patientId": { "type": "integer", "format": "int32" }, "programId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Application.Contracts.Patients.ReactivatePatientRequest": { "type": "object", "properties": { "reactivateReason": { "type": "string" }, "restartTreatment": { "type": "boolean" }, "hasFinancialOrInsuranceStatusChanged": { "type": "boolean" }, "dosage": { "type": "string" }, "combineTreatmentDosage": { "type": "string", "nullable": true }, "physicianRequested": { "type": "boolean" }, "receivedBy": { "type": "string", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "requestId": { "type": "integer", "format": "int32", "nullable": true }, "resupply": { "type": "boolean" } }, "additionalProperties": false }, "Application.Contracts.Patients.ReactivatePatientResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "status": { "type": "string" }, "requestId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.UploadApplicationDocumentForm": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "nullable": true }, "files": { "type": "array", "items": { "type": "string", "format": "binary" } }, "fileCategory": { "type": "string" }, "title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Application.Contracts.Patients.UploadApplicationDocumentResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "documentId": { "type": "string" }, "uploadedCount": { "type": "integer", "format": "int32" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.UploadedFileResponse" } }, "remainingMissingDocuments": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "Application.Contracts.Patients.UploadedFileResponse": { "type": "object", "properties": { "attachmentId": { "type": "string" }, "fileName": { "type": "string" }, "fileSize": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "contentType": { "type": "string" }, "storagePath": { "type": "string" } }, "additionalProperties": false }, "Application.Contracts.ProgramQuestions.ProgramQuestionAnswerDto": { "type": "object", "properties": { "answerText": { "type": "string" }, "answerValue": { "type": "string" }, "displayOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Application.Contracts.ProgramQuestions.ProgramQuestionDto": { "type": "object", "properties": { "labelId": { "type": "integer", "format": "int32", "nullable": true }, "questionText": { "type": "string" }, "questionFieldName": { "type": "string" }, "htmlElement": { "type": "string" }, "triggerAnswerValue": { "type": "string" }, "questionGroup": { "type": "string" }, "isMandatory": { "type": "boolean" }, "displayOrder": { "type": "integer", "format": "int32" }, "answers": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.ProgramQuestions.ProgramQuestionAnswerDto" } }, "questions": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.ProgramQuestions.ProgramQuestionDto" } } }, "additionalProperties": false }, "Application.Contracts.ValueTextOptionResponse": { "type": "object", "properties": { "value": { "type": "string" }, "text": { "type": "string" }, "selected": { "type": "boolean" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Applicants.SdohDiagnosisOption, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Applicants.SdohDiagnosisOption" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Applicants.SdohPhysicianSearchResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Applicants.SdohPhysicianSearchResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientApplicationResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.CreatePatientApplicationResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePatientPcrResultsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.CreatePatientPcrResultsResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.CreatePcrResultResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.CreatePcrResultResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.DeletePatientPcrResultResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.DeletePatientPcrResultResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.MaxPatientCloseRequestForm, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.MaxPatientCloseRequestForm" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.MaxPatientReviewForm, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.MaxPatientReviewForm" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.NewApplicantFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.NewApplicantFormResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientApplicationDocumentsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientApplicationDocumentsResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientApplyFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientApplyFormResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientCloseRequestResult, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientCloseRequestResult" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientPcrResultsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientPcrResultsResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientProfileResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientProfileResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientReactivationFormResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientReactivationFormResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PatientsNeedingReviewResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.PatientsNeedingReviewResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.PcrDuePatientsResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.PcrDuePatientsResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.ReactivatePatientResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.ReactivatePatientResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Application.Contracts.Patients.UploadApplicationDocumentResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application.Contracts.Patients.UploadApplicationDocumentResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.AddInstitutionNoteResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.AddInstitutionNoteResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.AddInstitutionSupplyAlertResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.AddInstitutionSupplyAlertResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.CountryInstitutionsResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.CountryInstitutionsResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationFormOptionsResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionDispensationFormOptionsResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationUploadDetailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionDispensationUploadDetailResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssActivityDetailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionHssActivityDetailResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionInventoryFormResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionInventoryFormResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationUploadResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationUploadResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionEmailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionEmailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssActivityResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssActivityResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssPhysicianOptionResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssPhysicianOptionResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionInventoryReportResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionInventoryReportResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionNoteResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionNoteResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOrderResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOrderResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionSupplyAlertResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionSupplyAlertResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTagResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTagResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferDestinationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferDestinationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOperationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionOperationResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionProfileResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionProfileResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferFormResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionTransferFormResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCDashboardSummaryResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LPCDashboardSummaryResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LPCQueuePage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LPCQueuePage" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.LogHssActivityResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LogHssActivityResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.MaxAuthorizationProbeResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.MaxAuthorizationProbeResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.MaxUserProfileResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.MaxUserProfileResponse" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.ActivityReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ActivityReportFilters" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.ActivityReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ActivityReportPage" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.DispensationReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.DispensationReportFilters" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.DispensationReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.DispensationReportPage" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportFilters" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportPage" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MyPatientsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.MyPatientsReportFilters" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.MyPatientsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.MyPatientsReportPage" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.OrderStatusReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.OrderStatusReportFilters" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.OrderStatusReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.OrderStatusReportPage" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.PincLogsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.PincLogsReportFilters" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.PincLogsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.PincLogsReportPage" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportFilters" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportPage" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.TotalsReportFilters, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.TotalsReportFilters" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.Reports.TotalsReportPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.TotalsReportPage" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.TagItem, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.TagItem" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[Max.Dashboard.Api.Contracts.TagPage, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.TagPage" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": { "type": "object", "properties": { "data": { "type": "boolean" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetFileResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.FileCabinet.FileCabinetFileResponse" }, "nullable": true }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetFolderResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.FileCabinet.FileCabinetFolderResponse" }, "nullable": true }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.FileCabinet.FileCabinetProgramResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.FileCabinet.FileCabinetProgramResponse" }, "nullable": true }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Application.WebApi.ApiResponse`1[[System.Collections.Generic.IReadOnlyList`1[[Application.Contracts.Patients.PcrPastDuePatientResponse, Application, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Application.Contracts.Patients.PcrPastDuePatientResponse" }, "nullable": true }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "additionalProperties": false }, "Domain.ListFilter": { "type": "object", "properties": { "column": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Domain.ListRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "sortBy": { "type": "string", "nullable": true }, "sortDirection": { "type": "string", "nullable": true }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListFilter" }, "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "nullable": true }, "page": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Domain.SdohApplicants.SdohApplicantDetails": { "type": "object", "properties": { "applicantType": { "type": "string" }, "gender": { "type": "string", "nullable": true }, "birthDate": { "type": "string", "format": "date-time", "nullable": true }, "county": { "type": "string", "nullable": true }, "diagnosisId": { "type": "integer", "format": "int32", "nullable": true }, "otherDiagnosis": { "type": "string", "nullable": true }, "diagnosisYear": { "type": "string", "nullable": true }, "privacyPractices": { "type": "string", "nullable": true }, "who": { "type": "string", "nullable": true }, "signature": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "confidential": { "type": "boolean" }, "primaryLanguage": { "type": "string", "nullable": true }, "ethnicity": { "type": "string", "nullable": true }, "insuranceStatus": { "type": "string", "nullable": true }, "insuranceType": { "type": "string", "nullable": true }, "citizenshipStatus": { "type": "string", "nullable": true }, "employmentStatus": { "type": "string", "nullable": true }, "occupation": { "type": "string", "nullable": true }, "preferredPronouns": { "type": "string", "nullable": true }, "annualIncomeCategory": { "type": "string", "nullable": true }, "helplineAnnualIncome": { "type": "string", "nullable": true }, "helplineOccupation": { "type": "string", "nullable": true }, "householdAdditionalInformation": { "type": "string", "nullable": true }, "sdohTreatmentId": { "type": "integer", "format": "int32", "nullable": true }, "otherTreatment": { "type": "string", "nullable": true }, "dosageId": { "type": "integer", "format": "int32" }, "treatmentProviderId": { "type": "integer", "format": "int32", "nullable": true }, "otherTreatmentProvider": { "type": "string", "nullable": true }, "consentFormSigned": { "type": "boolean" }, "nextReviewDate": { "type": "string", "format": "date-time", "nullable": true }, "isBeneficiary": { "type": "boolean" }, "monthlyIncome": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.AddInstitutionNoteRequest": { "type": "object", "properties": { "text": { "type": "string" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.AddInstitutionNoteResponse": { "type": "object", "properties": { "noteId": { "type": "string" }, "success": { "type": "boolean" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.AddInstitutionSupplyAlertRequest": { "type": "object", "properties": { "treatmentId": { "type": "string" }, "reviewDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.AddInstitutionSupplyAlertResponse": { "type": "object", "properties": { "alertId": { "type": "string" }, "success": { "type": "boolean" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.ChangeInstitutionInventoryReportDateRequest": { "type": "object", "properties": { "oldDate": { "type": "string", "format": "date-time" }, "newDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.CountryInstitutionsResponse": { "type": "object", "properties": { "countryId": { "type": "string" }, "countryName": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionMapPointResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.CreateInstitutionDispensationRequest": { "type": "object", "properties": { "programId": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionDispensationItemRequest" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.CreateInstitutionInventoryReportRequest": { "type": "object", "properties": { "programId": { "type": "string" }, "skuId": { "type": "string" }, "reportDate": { "type": "string", "format": "date-time" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionInventoryReportItemRequest" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.CreateInstitutionTransferRequest": { "type": "object", "properties": { "destinationInstitutionId": { "type": "string" }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true }, "batches": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionTransferSelectionRequest" }, "nullable": true } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.CreateTagRequest": { "required": [ "tagNotes", "toUsername" ], "type": "object", "properties": { "toUsername": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Recipient account selected from the tag form's users." }, "tagNotes": { "minLength": 1, "type": "string", "description": "Required message; newlines are normalized to the legacy stored format." }, "effectiveDate": { "type": "string", "description": "Optional activation time; defaults to the current local date.", "format": "date-time", "nullable": true }, "patientId": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Optional patient association; zero is treated as absent.", "format": "int32", "nullable": true }, "institutionId": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Optional institution association; zero is treated as absent.", "format": "int32", "nullable": true }, "programId": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Optional treatment association; zero or null means all treatments.", "format": "int32", "nullable": true }, "outboundOrderId": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Optional supply-chain shipment association; zero is treated as absent.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Tag content and optional context; sender identity comes from authenticated claims." }, "Max.Dashboard.Api.Contracts.HideTagRequest": { "type": "object", "properties": { "all": { "type": "boolean" } }, "additionalProperties": false, "description": "All hides both copies by default; false suppresses only the sender's notification." }, "Max.Dashboard.Api.Contracts.InstitutionAdministratorResponse": { "type": "object", "properties": { "name": { "type": "string" }, "title": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionApprovalInfoResponse": { "type": "object", "properties": { "approved": { "type": "boolean" }, "approvedDate": { "type": "string", "format": "date-time", "nullable": true }, "approvedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionDiagnosisOptionResponse": { "type": "object", "properties": { "diagnosisId": { "type": "string" }, "diagnosisName": { "type": "string" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionDiagnosticApprovalResponse": { "type": "object", "properties": { "diagnosisId": { "type": "string" }, "diagnosisName": { "type": "string" }, "programs": { "type": "array", "items": { "type": "string" } }, "lastUpdated": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionDispensationFormOptionsResponse": { "type": "object", "properties": { "institutionId": { "type": "string" }, "treatments": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionDispensationFormTreatmentResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionDispensationFormPatientResponse": { "type": "object", "properties": { "patientId": { "type": "string" }, "patientName": { "type": "string" }, "patientPin": { "type": "string" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionDispensationFormSkuResponse": { "type": "object", "properties": { "skuCode": { "type": "string" }, "skuId": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionDispensationFormTreatmentResponse": { "type": "object", "properties": { "programId": { "type": "string" }, "treatmentName": { "type": "string" }, "patients": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionDispensationFormPatientResponse" } }, "skus": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionDispensationFormSkuResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionDispensationItemRequest": { "type": "object", "properties": { "dispensationUnit": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "patientId": { "type": "string" }, "skuId": { "type": "string" }, "dispenseDate": { "type": "string", "format": "date-time" }, "lotNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionDispensationRecordResponse": { "type": "object", "properties": { "dispensationUnit": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "recordId": { "type": "string" }, "patientId": { "type": "string" }, "skuId": { "type": "string" }, "patientName": { "type": "string" }, "skuDescription": { "type": "string" }, "dispenseDate": { "type": "string", "format": "date-time" }, "lotNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionDispensationUploadDetailResponse": { "type": "object", "properties": { "programId": { "type": "string" }, "uploadId": { "type": "string" }, "uploadDate": { "type": "string", "format": "date-time" }, "treatmentName": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionDispensationRecordResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionDispensationUploadResponse": { "type": "object", "properties": { "uploadId": { "type": "string" }, "uploadDate": { "type": "string", "format": "date-time" }, "uploadedBy": { "type": "string" }, "treatmentName": { "type": "string" }, "patientCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionDispenseApprovalResponse": { "type": "object", "properties": { "treatmentId": { "type": "string" }, "treatmentName": { "type": "string" }, "approvedDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionEmailResponse": { "type": "object", "properties": { "emailId": { "type": "string" }, "sentDate": { "type": "string", "format": "date-time" }, "user": { "type": "string" }, "subject": { "type": "string" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionHssActivityDetailResponse": { "type": "object", "properties": { "hssModel": { "type": "string", "nullable": true }, "mode": { "type": "string" }, "supportedInstitutionId": { "type": "string", "nullable": true }, "program": { "type": "string" }, "service": { "type": "string" }, "diagnoses": { "type": "array", "items": { "type": "string" } }, "activityDate": { "type": "string", "format": "date-time" }, "partner": { "type": "string", "nullable": true }, "trackingId": { "type": "string", "nullable": true }, "itemDetails": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "nullable": true }, "training": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LogHssTrainingDetailsRequest" }, "siteVisit": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LogHssSiteVisitDetailsRequest" }, "costs": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LogHssCostsRequest" }, "testedPatientPins": { "type": "array", "items": { "type": "string" } }, "activityId": { "type": "string" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionHssActivityResponse": { "type": "object", "properties": { "activityId": { "type": "string" }, "program": { "type": "string" }, "service": { "type": "string" }, "diagnosis": { "type": "string" }, "hssModel": { "type": "string", "nullable": true }, "itemDetail": { "type": "string", "nullable": true }, "totalCost": { "type": "number", "format": "double", "nullable": true }, "maxQty": { "type": "integer", "format": "int32", "nullable": true }, "activityDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionHssPhysicianOptionResponse": { "type": "object", "properties": { "personId": { "type": "string" }, "name": { "type": "string" }, "group": { "type": "string" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionInventoryFormResponse": { "type": "object", "properties": { "institutionId": { "type": "string" }, "countryId": { "type": "string" }, "skus": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionInventorySkuOptionResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionInventoryReportItemRequest": { "type": "object", "properties": { "lotNumber": { "type": "string", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "boxesRemainingCount": { "type": "integer", "format": "int32", "nullable": true }, "stockout": { "type": "boolean" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionInventoryReportResponse": { "type": "object", "properties": { "reportDate": { "type": "string", "format": "date-time" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionInventoryRowResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionInventoryRowResponse": { "type": "object", "properties": { "inventoryReportId": { "type": "string" }, "programId": { "type": "string" }, "skuId": { "type": "string" }, "treatmentName": { "type": "string" }, "color": { "type": "string", "nullable": true }, "sku": { "type": "string" }, "lotNumber": { "type": "string" }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "boxesReceivedCount": { "type": "integer", "format": "int32", "nullable": true }, "boxesDispensedCount": { "type": "integer", "format": "int32", "nullable": true }, "boxesRemainingCount": { "type": "integer", "format": "int32", "nullable": true }, "remaining": { "type": "integer", "format": "int32" }, "stockout": { "type": "boolean" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionInventorySkuOptionResponse": { "type": "object", "properties": { "programId": { "type": "string" }, "treatmentName": { "type": "string" }, "color": { "type": "string", "nullable": true }, "skuId": { "type": "string" }, "skuCode": { "type": "string" }, "skuDescription": { "type": "string" }, "displayName": { "type": "string" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionDispensationUploadResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionDispensationUploadResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionEmailResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionEmailResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssActivityResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionHssActivityResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionHssPhysicianOptionResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionHssPhysicianOptionResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionInventoryReportResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionInventoryReportResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionNoteResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionNoteResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionOrderResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionOrderResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionSupplyAlertResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionSupplyAlertResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTagResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionTagResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferDestinationResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionTransferDestinationResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionItemsResponse`1[[Max.Dashboard.Api.Contracts.InstitutionTransferResponse, Max.Dashboard.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionTransferResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionMapPointResponse": { "type": "object", "properties": { "institutionId": { "type": "string" }, "name": { "type": "string" }, "institutionType": { "type": "string", "nullable": true }, "latitude": { "type": "number", "format": "double", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true }, "geoPrecision": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionNoteResponse": { "type": "object", "properties": { "noteId": { "type": "string" }, "noteDate": { "type": "string", "format": "date-time", "nullable": true }, "user": { "type": "string" }, "text": { "type": "string" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionOperationResponse": { "type": "object", "properties": { "success": { "type": "boolean" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionOrderLineItemResponse": { "type": "object", "properties": { "treatmentName": { "type": "string" }, "skuDescription": { "type": "string" }, "qtyShipped": { "type": "integer", "format": "int32" }, "qtyReceived": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionOrderResponse": { "type": "object", "properties": { "orderNumber": { "type": "string" }, "status": { "type": "string" }, "dateShipped": { "type": "string", "format": "date-time" }, "dateReceived": { "type": "string", "format": "date-time", "nullable": true }, "totalShippedQty": { "type": "integer", "format": "int32" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionOrderLineItemResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionProfileResponse": { "type": "object", "properties": { "institutionId": { "type": "string" }, "name": { "type": "string" }, "institutionType": { "type": "string" }, "department": { "type": "string", "nullable": true }, "customerNumber": { "type": "string", "nullable": true }, "supplyChainCodes": { "type": "array", "items": { "type": "string" } }, "phones": { "type": "array", "items": { "type": "string" } }, "mobile": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "emails": { "type": "array", "items": { "type": "string" } }, "street1": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "stateProvince": { "type": "string", "nullable": true }, "zipcode": { "type": "string", "nullable": true }, "countryId": { "type": "string" }, "countryName": { "type": "string" }, "qaValidated": { "type": "boolean" }, "nextQaDate": { "type": "string", "format": "date-time", "nullable": true }, "pharmacyChain": { "type": "string", "nullable": true }, "latitude": { "type": "number", "format": "double", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true }, "geoPrecision": { "type": "string", "nullable": true }, "treatingApproval": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionApprovalInfoResponse" }, "dispenseApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionDispenseApprovalResponse" } }, "availableTreatments": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionTreatmentOptionResponse" } }, "diagnosticApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionDiagnosticApprovalResponse" } }, "availableDiagnoses": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionDiagnosisOptionResponse" } }, "administrator": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionAdministratorResponse" }, "assignedDepots": { "type": "array", "items": { "type": "string" } }, "physicianCount": { "type": "integer", "format": "int32" }, "patientCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Represents Institution Profile." }, "Max.Dashboard.Api.Contracts.InstitutionSupplyAlertResponse": { "type": "object", "properties": { "alertId": { "type": "string" }, "treatmentId": { "type": "string" }, "treatmentName": { "type": "string" }, "reviewDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionTagResponse": { "type": "object", "properties": { "tagId": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "fromUser": { "type": "string" }, "toUser": { "type": "string" }, "message": { "type": "string" }, "reply": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionTransferBatchResponse": { "type": "object", "properties": { "transferId": { "type": "string" }, "sourceInstitutionId": { "type": "string" }, "destinationInstitutionId": { "type": "string" }, "sourceInstitutionName": { "type": "string" }, "destinationInstitutionName": { "type": "string" }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "lotNumber": { "type": "string" }, "treatmentName": { "type": "string" }, "sku": { "type": "string" }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "quantity": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionTransferDestinationResponse": { "type": "object", "properties": { "institutionId": { "type": "string" }, "name": { "type": "string" }, "countryName": { "type": "string" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionTransferDestinationsRequest": { "type": "object", "properties": { "batchIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionTransferFormResponse": { "type": "object", "properties": { "batches": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionTransferOptionResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionTransferOptionResponse": { "type": "object", "properties": { "batchId": { "type": "string" }, "skuId": { "type": "string" }, "programId": { "type": "string" }, "lotNumber": { "type": "string" }, "treatmentName": { "type": "string" }, "skuDescription": { "type": "string" }, "expirationDate": { "type": "string", "format": "date", "nullable": true }, "availableQuantity": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "A source inventory row offered for transfer. IDs are server-authored strings." }, "Max.Dashboard.Api.Contracts.InstitutionTransferResponse": { "type": "object", "properties": { "transferId": { "type": "string" }, "transferDate": { "type": "string", "format": "date-time" }, "destinationInstitution": { "type": "string" }, "batches": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.InstitutionTransferBatchResponse" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionTransferSelectionRequest": { "type": "object", "properties": { "batchId": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.InstitutionTreatmentOptionResponse": { "type": "object", "properties": { "treatmentId": { "type": "string" }, "treatmentName": { "type": "string" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.LPCCountryResponse": { "type": "object", "properties": { "countryId": { "type": "integer", "description": "Country identifier from tblCountry.", "format": "int32" }, "countryName": { "type": "string", "description": "Country display name." }, "clinicCount": { "type": "integer", "description": "Distinct patient/physician institutions in this country; may be zero for the LPC's own country.", "format": "int32" } }, "additionalProperties": false, "description": "One country and its distinct treating-institution count within the LPC's scope." }, "Max.Dashboard.Api.Contracts.LPCDashboardSummaryResponse": { "type": "object", "properties": { "countries": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LPCCountryResponse" }, "description": "Country rows with distinct institution counts; the LPC's own country is first." }, "treatmentPrograms": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LPCTreatmentProgramResponse" }, "description": "Assigned MAS programs with status counts, colors, and global capacity utilization." }, "supportPrograms": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LPCSupportProgramResponse" }, "description": "Assigned SDOH programs and TFR (17), with status counts and global capacity utilization." }, "lpcName": { "type": "string", "description": "LPC display name; serialized as lpcName." }, "activePatients": { "type": "integer", "description": "Number of distinct assigned patients with an active enrollment.", "format": "int32" }, "totalPatientsHelped": { "type": "integer", "description": "Total supported people assigned to the LPC, including Active and Closed enrollments.", "format": "int32", "nullable": true }, "refreshedAt": { "type": "string", "description": "UTC time when response calculation completed, not a transactional snapshot timestamp.", "format": "date-time" }, "queueCounts": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LPCQueueCountsResponse" } }, "additionalProperties": false, "description": "Headline statistics and queue counts returned by GET /api/max/lpc/dashboard/summary." }, "Max.Dashboard.Api.Contracts.LPCQueueCountsResponse": { "type": "object", "properties": { "pendingInventoryInstitutions": { "type": "integer", "description": "Distinct approved current clinics with an active MAS enrollment and an existing inventory report older than ninety days.", "format": "int32" }, "patientVerification": { "type": "integer", "description": "Active MAS patient/program cases without dispensation or approved review for at least six calendar months.", "format": "int32" }, "pendingApplications": { "type": "integer", "description": "Nondeleted, untransferred applicants in the LPC's country, with no patient record.", "format": "int32" }, "myRequests": { "type": "integer", "description": "Distinct pending requests for patients in the LPC's shared scope, regardless of submitter.", "format": "int32" }, "tfrFollowup": { "type": "integer", "description": "Distinct TFR patient PINs with reviews due within 15 days, including already-overdue reviews.", "format": "int32" }, "dayByDayFollowup": { "type": "integer", "description": "Distinct active day-by-day patients due today or earlier in the LPC's country region.", "format": "int32" }, "scheduledOrders": { "type": "integer", "description": "Distinct active outbound orders awaiting PO quantity verification at scoped patients' institutions.", "format": "int32" }, "pendingOrders": { "type": "integer", "description": "Sum of legacy good and bad pending delivery-order counts within shared LPC patient scope.", "format": "int32" }, "fabhaltaPatientsPastDueCount": { "type": "integer", "description": "Distinct active Fabhalta patients whose expected contact date is today or earlier.", "format": "int32" }, "helplinePatientsFollowupCount": { "type": "integer", "description": "Distinct active helpline patients assigned to the LPC's username with follow-up due today or earlier.", "format": "int32" } }, "additionalProperties": false, "description": "Queue counts calculated from the configured LPC-specific SQL statements." }, "Max.Dashboard.Api.Contracts.LPCQueuePage": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Number of filtered work items before pagination.", "format": "int32" }, "page": { "type": "integer", "description": "One-based requested page, including pages beyond the last row.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Effective page size; Int32.MaxValue denotes an unbounded request, following the shared ListQuery convention.", "format": "int32" }, "items": { "type": "array", "items": { }, "description": "Typed queue projections, serialized using their concrete contract properties." } }, "additionalProperties": false, "description": "Standard list envelope; totalCount counts filtered rows before SQL pagination." }, "Max.Dashboard.Api.Contracts.LPCSupportProgramResponse": { "type": "object", "properties": { "programId": { "type": "integer", "description": "Stable program identifier; treatment-free remission uses 17.", "format": "int32" }, "programName": { "type": "string", "description": "Program display name using the same fallback as treatment programs." }, "color": { "type": "string", "description": "Stored program color name; null when no color is configured.", "nullable": true }, "webColor": { "type": "string", "description": "Stored web color for rendering; null when not configured.", "nullable": true }, "activePatients": { "type": "integer", "description": "Distinct assigned people actively enrolled in this program, excluding deleted records.", "format": "int32" }, "closedPatients": { "type": "integer", "description": "Distinct assigned people whose enrollment in this program is Closed.", "format": "int32" }, "pendingPatients": { "type": "integer", "description": "Distinct assigned people whose enrollment in this program is Pending; excludes web applicants.", "format": "int32" }, "deniedPatients": { "type": "integer", "description": "Distinct assigned people whose enrollment in this program is Denied.", "format": "int32" }, "globalActivePatients": { "type": "integer", "description": "Distinct active patients in this program globally, independent of LPC assignments.", "format": "int32" }, "programCapacity": { "type": "integer", "description": "Configured global capacity from tblProgram.ProgramLimit; zero means no configured capacity.", "format": "int32" }, "utilizationPercentage": { "type": "number", "description": "Global active patients divided by positive capacity times 100, rounded to two decimals; otherwise null.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "One assigned SDOH or TFR program with LPC status counts and global utilization." }, "Max.Dashboard.Api.Contracts.LPCTreatmentProgramResponse": { "type": "object", "properties": { "programId": { "type": "integer", "description": "Stable program identifier from tblProgram.", "format": "int32" }, "programName": { "type": "string", "description": "Program display name, using the established treatment-name fallback." }, "color": { "type": "string", "description": "Stored program color name; null when no color is configured.", "nullable": true }, "webColor": { "type": "string", "description": "Stored web color for rendering; null when not configured.", "nullable": true }, "activePatients": { "type": "integer", "description": "Distinct assigned people actively enrolled in this program, excluding deleted records.", "format": "int32" }, "closedPatients": { "type": "integer", "description": "Distinct assigned people whose enrollment in this program is Closed.", "format": "int32" }, "pendingPatients": { "type": "integer", "description": "Distinct assigned people whose enrollment in this program is Pending; excludes web applicants.", "format": "int32" }, "deniedPatients": { "type": "integer", "description": "Distinct assigned people whose enrollment in this program is Denied.", "format": "int32" }, "globalActivePatients": { "type": "integer", "description": "Distinct active patients in this program globally, independent of LPC assignments.", "format": "int32" }, "programCapacity": { "type": "integer", "description": "Configured global capacity from tblProgram.ProgramLimit; zero means no configured capacity.", "format": "int32" }, "utilizationPercentage": { "type": "number", "description": "Global active patients divided by positive capacity times 100, rounded to two decimals; otherwise null.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "One assigned MAS program with LPC status counts and global utilization." }, "Max.Dashboard.Api.Contracts.LogHssActivityRequest": { "type": "object", "properties": { "hssModel": { "type": "string", "nullable": true }, "mode": { "type": "string" }, "supportedInstitutionId": { "type": "string", "nullable": true }, "program": { "type": "string" }, "service": { "type": "string" }, "diagnoses": { "type": "array", "items": { "type": "string" } }, "activityDate": { "type": "string", "format": "date-time" }, "partner": { "type": "string", "nullable": true }, "trackingId": { "type": "string", "nullable": true }, "itemDetails": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "nullable": true }, "training": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LogHssTrainingDetailsRequest" }, "siteVisit": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LogHssSiteVisitDetailsRequest" }, "costs": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.LogHssCostsRequest" }, "testedPatientPins": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.LogHssActivityResponse": { "type": "object", "properties": { "activityId": { "type": "string" }, "success": { "type": "boolean" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.LogHssCostsRequest": { "type": "object", "properties": { "costModel": { "type": "string", "nullable": true }, "maxQty": { "type": "integer", "format": "int32", "nullable": true }, "institutionQty": { "type": "integer", "format": "int32", "nullable": true }, "costToMax": { "type": "number", "format": "double", "nullable": true }, "costToInstitution": { "type": "number", "format": "double", "nullable": true }, "shipping": { "type": "number", "format": "double", "nullable": true }, "otherCharges": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.LogHssSiteVisitDetailsRequest": { "type": "object", "properties": { "dayCount": { "type": "integer", "format": "int32", "nullable": true }, "maxParticipantCount": { "type": "integer", "format": "int32", "nullable": true }, "siteParticipantCount": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string", "nullable": true }, "reportLink": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.LogHssTrainingDetailsRequest": { "type": "object", "properties": { "physicianPersonIds": { "type": "array", "items": { "type": "string" } }, "physicianCount": { "type": "integer", "format": "int32", "nullable": true }, "labStaffCount": { "type": "integer", "format": "int32", "nullable": true }, "otherParticipantCount": { "type": "integer", "format": "int32", "nullable": true }, "trainer": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "trainingLink": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.MaxAuthorizationProbeResponse": { "type": "object", "properties": { "allowed": { "type": "boolean" } }, "additionalProperties": false, "description": "Represents the response for Max Authorization Probe." }, "Max.Dashboard.Api.Contracts.MaxUserProfileResponse": { "type": "object", "properties": { "personId": { "type": "integer", "format": "int32" }, "userName": { "type": "string" }, "fullName": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "isAuthenticated": { "type": "boolean" } }, "additionalProperties": false, "description": "Represents the response for Max User Profile." }, "Max.Dashboard.Api.Contracts.Patients.MaxPatientCloseAdverseEvent": { "type": "object", "properties": { "description": { "type": "string", "description": "Clinical narrative appended to the case-closure AE report." }, "dateLearned": { "type": "string", "description": "Date staff learned about the event, supplied in ISO 8601 format.", "format": "date-time" }, "learnedFromPhysician": { "type": "boolean", "description": "True for physician, false for patient/caregiver; omission is invalid.", "nullable": true }, "receivedMethod": { "type": "string", "description": "How staff received the AE report, independently of the close request." }, "treatmentRelated": { "type": "string", "description": "Yes, No, or Unsure for programs 12 and 13.", "nullable": true }, "sourceDocumentId": { "type": "integer", "description": "Optional valid patient-linked document selected from the GET form.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Staff AE description and provenance; source documents refer to existing patient files." }, "Max.Dashboard.Api.Contracts.Patients.MaxPatientCloseRequest": { "type": "object", "properties": { "closureReason": { "type": "string", "description": "One of the current program's GET closeReasons values." }, "physicianRequested": { "type": "boolean", "description": "Whether the treating physician requested closure; must be supplied explicitly.", "nullable": true }, "receivedMethod": { "type": "string", "description": "How staff received the closure request." }, "isAdverseEventRelated": { "type": "boolean", "description": "Whether the request involves an AE; death also requires AE reporting." }, "attemptTreatmentFreeRemission": { "type": "boolean", "description": "Requests a frontend handoff to program 17, subject to legacy TFR eligibility." }, "adverseEvent": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Patients.MaxPatientCloseAdverseEvent" } }, "additionalProperties": false, "description": "Physician-compatible closure request with the additional facts collected by MaxStation staff." }, "Max.Dashboard.Api.Contracts.Reports.ActivityReportFilters": { "type": "object", "properties": { "programs": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportProgramFilterOption" }, "description": "Source-derived Programs choices, including documented all/select sentinels." }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Countries choices, including documented all/select sentinels." }, "breakdowns": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Breakdowns choices, including documented all/select sentinels." }, "defaults": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ActivityReportRequest" } }, "additionalProperties": false, "description": "Complete selector data and initial request values for the Activity report." }, "Max.Dashboard.Api.Contracts.Reports.ActivityReportPage": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Filtered main-report row count before paging.", "format": "int32" }, "page": { "type": "integer", "description": "One-based effective page.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Effective size; omitted request size means Int32.MaxValue.", "format": "int32" }, "columns": { "type": "array", "items": { "type": "string" }, "description": "Ordered plain-data field names retained for frontend grids and frontend exports." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ActivityReportRow" }, "description": "Typed database-mapped rows in deterministic SQL order." }, "summaries": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.NoReportSummaries" } }, "additionalProperties": false, "description": "Physician-compatible page of Activity data for grids and frontend exports." }, "Max.Dashboard.Api.Contracts.Reports.ActivityReportRequest": { "type": "object", "properties": { "programId": { "type": "integer", "description": "Required regular treatment identifier.", "format": "int32" }, "combineTreatmentId": { "type": "integer", "description": "Optional combination treatment partner.", "format": "int32" }, "countryId": { "type": "integer", "description": "Optional country; selecting a country also groups totals by institution and physician.", "format": "int32" }, "startDate": { "type": "string", "description": "Required inclusive first report date.", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "Required last report date; source-specific boundaries are retained.", "format": "date-time", "nullable": true }, "breakdown": { "type": "string", "description": "Totals, Approvals, Reapprovals, Closures, Reactivations or Denials." } }, "additionalProperties": false, "description": "Business filters for Activity; authenticated account and roles are never request inputs." }, "Max.Dashboard.Api.Contracts.Reports.ActivityReportRow": { "type": "object", "properties": { "country": { "type": "string", "description": "Country from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "institution": { "type": "string", "description": "Institution from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "physician": { "type": "string", "description": "Physician from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "patientId": { "type": "integer", "description": "PatientId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "pin": { "type": "string", "description": "Pin from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "firstName": { "type": "string", "description": "FirstName from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "lastName": { "type": "string", "description": "LastName from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "initials": { "type": "string", "description": "Initials from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "alternateId": { "type": "string", "description": "AlternateId from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "diagnosis": { "type": "string", "description": "Diagnosis from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "date": { "type": "string", "description": "Date from the selected legacy projection; unavailable breakdown fields remain null.", "format": "date-time", "nullable": true }, "dosage": { "type": "string", "description": "Dosage from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "nextReview": { "type": "string", "description": "NextReview from the selected legacy projection; unavailable breakdown fields remain null.", "format": "date-time", "nullable": true }, "reason": { "type": "string", "description": "Reason from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "notes": { "type": "string", "description": "Notes from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "approvals": { "type": "integer", "description": "Approvals from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "reapprovals": { "type": "integer", "description": "Reapprovals from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "closures": { "type": "integer", "description": "Closures from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "reactivations": { "type": "integer", "description": "Reactivations from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "denials": { "type": "integer", "description": "Denials from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Typed Activity row; presentation and navigation links belong to the frontend." }, "Max.Dashboard.Api.Contracts.Reports.DiagnosisCount": { "type": "object", "properties": { "diagnosisId": { "type": "integer", "description": "DiagnosisId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32" }, "diagnosis": { "type": "string", "description": "Diagnosis from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "active": { "type": "integer", "description": "Active from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32" } }, "additionalProperties": false, "description": "One approved diagnosis column from Totals, represented as typed data." }, "Max.Dashboard.Api.Contracts.Reports.DispensationReportFilters": { "type": "object", "properties": { "programs": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportProgramFilterOption" }, "description": "Source-derived Programs choices, including documented all/select sentinels." }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Countries choices, including documented all/select sentinels." }, "breakdowns": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Breakdowns choices, including documented all/select sentinels." }, "defaults": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.DispensationReportRequest" } }, "additionalProperties": false, "description": "Complete selector data and initial request values for the Dispensation report." }, "Max.Dashboard.Api.Contracts.Reports.DispensationReportPage": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Filtered main-report row count before paging.", "format": "int32" }, "page": { "type": "integer", "description": "One-based effective page.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Effective size; omitted request size means Int32.MaxValue.", "format": "int32" }, "columns": { "type": "array", "items": { "type": "string" }, "description": "Ordered plain-data field names retained for frontend grids and frontend exports." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.DispensationReportRow" }, "description": "Typed database-mapped rows in deterministic SQL order." }, "summaries": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.NoReportSummaries" } }, "additionalProperties": false, "description": "Physician-compatible page of Dispensation Report data for grids and frontend exports." }, "Max.Dashboard.Api.Contracts.Reports.DispensationReportRequest": { "type": "object", "properties": { "programId": { "type": "integer", "description": "Optional program; zero selects all authorized treatments.", "format": "int32" }, "countryIds": { "type": "string", "description": "Optional comma-separated narrowing country identifiers.", "nullable": true }, "startDate": { "type": "string", "description": "Required inclusive dispensation start date.", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "Required inclusive end instant normalized to midnight, matching the legacy report.", "format": "date-time", "nullable": true }, "breakdown": { "type": "string", "description": "Totals, CompleteList or PatientsNotDispensed." } }, "additionalProperties": false, "description": "Business filters for Dispensation Report; authenticated account and roles are never request inputs." }, "Max.Dashboard.Api.Contracts.Reports.DispensationReportRow": { "type": "object", "properties": { "treatment": { "type": "string", "description": "Treatment from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "region": { "type": "string", "description": "Region from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "country": { "type": "string", "description": "Country from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "institutionId": { "type": "integer", "description": "InstitutionId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "clinic": { "type": "string", "description": "Clinic from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "patientId": { "type": "integer", "description": "PatientId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "pin": { "type": "string", "description": "Pin from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "programId": { "type": "integer", "description": "ProgramId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "firstName": { "type": "string", "description": "FirstName from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "lastName": { "type": "string", "description": "LastName from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "initialApproval": { "type": "string", "description": "InitialApproval from the selected legacy projection; unavailable breakdown fields remain null.", "format": "date-time", "nullable": true }, "reactivationDate": { "type": "string", "description": "ReactivationDate from the selected legacy projection; unavailable breakdown fields remain null.", "format": "date-time", "nullable": true }, "currentDosage": { "type": "string", "description": "CurrentDosage from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "dailyMgBasedOn120Days": { "type": "integer", "description": "DailyMgBasedOn120Days from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "daysSupplyBasedOnRx": { "type": "integer", "description": "DaysSupplyBasedOnRx from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "unit": { "type": "string", "description": "Unit from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "skuCode1": { "type": "string", "description": "SkuCode1 from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "skuDescription1": { "type": "string", "description": "SkuDescription1 from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "skuDispensed1": { "type": "integer", "description": "SkuDispensed1 from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "skuCode2": { "type": "string", "description": "SkuCode2 from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "skuDescription2": { "type": "string", "description": "SkuDescription2 from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "skuDispensed2": { "type": "integer", "description": "SkuDispensed2 from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "dispenseDate": { "type": "string", "description": "DispenseDate from the selected legacy projection; unavailable breakdown fields remain null.", "format": "date-time", "nullable": true }, "createdBy": { "type": "string", "description": "CreatedBy from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "activePatients": { "type": "integer", "description": "ActivePatients from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "dispensedToDistinctPatients": { "type": "integer", "description": "DispensedToDistinctPatients from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "lastOrderReceivedDate": { "type": "string", "description": "LastOrderReceivedDate from the selected legacy projection; unavailable breakdown fields remain null.", "format": "date-time", "nullable": true }, "skuTotals": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.DispensationSkuTotal" }, "description": "SkuTotals from the selected legacy projection; unavailable breakdown fields remain null." } }, "additionalProperties": false, "description": "Typed Dispensation Report row; presentation and navigation links belong to the frontend." }, "Max.Dashboard.Api.Contracts.Reports.DispensationSkuTotal": { "type": "object", "properties": { "skuId": { "type": "integer", "description": "SkuId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32" }, "skuCode": { "type": "string", "description": "SkuCode from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "description": { "type": "string", "description": "Description from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "boxes": { "type": "number", "description": "Boxes from the selected legacy projection; unavailable breakdown fields remain null.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "One authorized SKU column and its legacy dispensed-box sum." }, "Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportFilters": { "type": "object", "properties": { "programs": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportProgramFilterOption" }, "description": "Source-derived Programs choices, including documented all/select sentinels." }, "institutionTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived InstitutionTypes choices, including documented all/select sentinels." }, "defaults": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportRequest" } }, "additionalProperties": false, "description": "Complete selector data and initial request values for the MasInstitutions report." }, "Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportPage": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Filtered main-report row count before paging.", "format": "int32" }, "page": { "type": "integer", "description": "One-based effective page.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Effective size; omitted request size means Int32.MaxValue.", "format": "int32" }, "columns": { "type": "array", "items": { "type": "string" }, "description": "Ordered plain-data field names retained for frontend grids and frontend exports." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportRow" }, "description": "Typed database-mapped rows in deterministic SQL order." }, "summaries": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.NoReportSummaries" } }, "additionalProperties": false, "description": "Physician-compatible page of MAS Institutions data for grids and frontend exports." }, "Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportRequest": { "type": "object", "properties": { "programId": { "type": "integer", "description": "Optional treatment for dispensing/pharmacy; treating retains its program-independent source rule.", "format": "int32" }, "institutionType": { "type": "string", "description": "treating, dispensing or pharmacy." } }, "additionalProperties": false, "description": "Business filters for MAS Institutions; authenticated account and roles are never request inputs." }, "Max.Dashboard.Api.Contracts.Reports.MasInstitutionsReportRow": { "type": "object", "properties": { "institutionId": { "type": "integer", "description": "InstitutionId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32" }, "region": { "type": "string", "description": "Region from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "country": { "type": "string", "description": "Country from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "clinic": { "type": "string", "description": "Clinic from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "institutionName": { "type": "string", "description": "InstitutionName from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "type": { "type": "string", "description": "Type from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "nextQaValidation": { "type": "string", "description": "NextQaValidation from the selected legacy projection; unavailable breakdown fields remain null.", "format": "date-time", "nullable": true }, "isTreatInst": { "type": "string", "description": "IsTreatInst from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "trApprovedList": { "type": "string", "description": "TrApprovedList from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true } }, "additionalProperties": false, "description": "Typed MAS Institutions row; presentation and navigation links belong to the frontend." }, "Max.Dashboard.Api.Contracts.Reports.MyPatientReportItem": { "type": "object", "properties": { "countryId": { "type": "integer", "description": "Current country identity for navigation; historical rows retain current geography as in the source.", "format": "int32" }, "regionId": { "type": "integer", "description": "Current country's optional region identity, paired with Region.", "format": "int32", "nullable": true }, "institutionId": { "type": "integer", "description": "Current primary institution identity; null when the report displays its missing-institution placeholder.", "format": "int32", "nullable": true }, "physicianId": { "type": "integer", "description": "Current primary physician identity; null when no primary physician exists.", "format": "int32", "nullable": true }, "poId": { "type": "integer", "description": "Current primary program officer identity paired with PO, independent of the optional PoId filter.", "format": "int32", "nullable": true }, "primaryMaxStationId": { "type": "integer", "description": "Primary station identity only for the source's explicit non-India country column.", "format": "int32", "nullable": true }, "patientOnTreatmentForTFR": { "type": "boolean", "description": "TFR treatment state; the frontend renders the former star indicator without HTML.", "nullable": true }, "treatment": { "type": "string", "description": "Current primary treatment label, including the source combination label.", "nullable": true }, "color": { "type": "string", "description": "Source treatment color value for frontend presentation.", "nullable": true }, "region": { "type": "string", "description": "Region label, with the source dash for a missing region.", "nullable": true }, "po": { "type": "string", "description": "Primary program officer label, with the source dash for a missing PO.", "nullable": true }, "caseNote": { "type": "string", "description": "Empty legacy case-note editor value; reading this report never writes a note.", "nullable": true }, "countryName": { "type": "string", "description": "Current patient country label, including for historical snapshots.", "nullable": true }, "institution": { "type": "string", "description": "Current primary institution label or the source missing-institution placeholder.", "nullable": true }, "programId": { "type": "integer", "description": "Enrollment program identifier for navigation and subsequent explicit commands.", "format": "int32" }, "combineTreatmentId": { "type": "integer", "description": "Requested partner treatment identifier, retaining the legacy projection.", "format": "int32" }, "physician": { "type": "string", "description": "Current primary physician label or the source missing-physician placeholder.", "nullable": true }, "physCount": { "type": "integer", "description": "Count of all patient physician assignments, as in the source report.", "format": "int32" }, "pin": { "type": "string", "description": "Plain patient PIN, preserving leading zeroes.", "nullable": true }, "patientId": { "type": "integer", "description": "Patient navigation identity; links are built by the frontend.", "format": "int32" }, "patientName": { "type": "string", "description": "Source concatenation of patient first and last name, retaining SQL null behavior.", "nullable": true }, "sex": { "type": "string", "description": "Source patient sex value.", "nullable": true }, "status": { "type": "string", "description": "Current or historical enrollment status according to the selected source.", "nullable": true }, "initials": { "type": "string", "description": "Source patient initials.", "nullable": true }, "alternateId": { "type": "string", "description": "Source patient alternate identifier.", "nullable": true }, "diagnosis": { "type": "string", "description": "Source diagnosis label.", "nullable": true }, "currentDosage": { "type": "string", "description": "Snapshot dosage for historical reads; most recent review dosage for live reads.", "nullable": true }, "lastReview": { "type": "string", "description": "Selected treatment activity creation date, returned as a date without display formatting.", "format": "date-time", "nullable": true }, "nextReview": { "type": "string", "description": "Selected treatment activity end date, returned as a date without display formatting.", "format": "date-time", "nullable": true }, "birthDate": { "type": "string", "description": "Patient birth date, without the legacy locale-specific string formatting.", "format": "date-time", "nullable": true }, "ageAtDiagnosis": { "type": "integer", "description": "Integer calendar-month difference from birth to diagnosis divided by twelve.", "format": "int32", "nullable": true }, "intakeDate": { "type": "string", "description": "Enrollment intake date retained by the selected source.", "format": "date-time", "nullable": true }, "iaDate": { "type": "string", "description": "Enrollment initial approval date retained by the selected source.", "format": "date-time", "nullable": true }, "monthsTreatment": { "type": "integer", "description": "Calendar months from treatment start or approval to snapshot time, current time, or closure according to source status.", "format": "int32", "nullable": true }, "treatmentStartDate": { "type": "string", "description": "Source treatment start date; TFR presentation labels are handled by the frontend.", "format": "date-time", "nullable": true }, "diagnosisDate": { "type": "string", "description": "Patient diagnosis date.", "format": "date-time", "nullable": true }, "monthsToApproval": { "type": "integer", "description": "Calendar months from diagnosis to treatment start, falling back to initial approval.", "format": "int32", "nullable": true }, "lastDispensationDate": { "type": "string", "description": "Most recent dispensation for the row program, including for historical reads as in the source.", "format": "date-time", "nullable": true }, "closedDate": { "type": "string", "description": "Selected closure date; snapshots use the source ClosedDetailId treatment-activity join.", "format": "date-time", "nullable": true }, "closedReason": { "type": "string", "description": "Selected closure reason.", "nullable": true }, "notes": { "type": "string", "description": "Selected closure notes as stored plain data.", "nullable": true }, "reactivationDate": { "type": "string", "description": "Reactivation date joined through the selected closure.", "format": "date-time", "nullable": true }, "deniedDate": { "type": "string", "description": "Denial date for this patient and program.", "format": "date-time", "nullable": true }, "denyReason": { "type": "string", "description": "Denial reason for this patient and program.", "nullable": true }, "occupation": { "type": "string", "description": "Source patient occupation.", "nullable": true }, "annualIncome": { "type": "string", "description": "Source annual income text, including undisclosed values.", "nullable": true }, "street1": { "type": "string", "description": "First address line.", "nullable": true }, "street2": { "type": "string", "description": "Second address line.", "nullable": true }, "city": { "type": "string", "description": "Patient city.", "nullable": true }, "stateProvince": { "type": "string", "description": "Patient state or province.", "nullable": true }, "postalCode": { "type": "string", "description": "Patient postal code.", "nullable": true }, "phone": { "type": "string", "description": "Patient telephone.", "nullable": true }, "fax": { "type": "string", "description": "Patient fax.", "nullable": true }, "mobile": { "type": "string", "description": "Patient mobile telephone.", "nullable": true }, "email": { "type": "string", "description": "Patient email.", "nullable": true }, "email2": { "type": "string", "description": "Secondary patient email.", "nullable": true }, "patientConsent": { "type": "string", "description": "Yes for source consent equal to one; otherwise No, including null.", "nullable": true }, "copyOfId": { "type": "string", "description": "Yes for source copy-of-ID equal to one; otherwise No, including null.", "nullable": true }, "labelId": { "type": "string", "description": "Legacy Yes/No label-presence value; zero still counts as a present label.", "nullable": true }, "primaryMaxStation": { "type": "string", "description": "Primary MaxStation label only when a non-India country is explicitly selected; otherwise null.", "nullable": true } }, "additionalProperties": false, "description": "Complete internal MyPatients projection with plain values and explicit patient/program navigation identities." }, "Max.Dashboard.Api.Contracts.Reports.MyPatientsReportFilters": { "type": "object", "properties": { "programs": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportProgramFilterOption" }, "description": "Source-derived Programs choices, including documented all/select sentinels." }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Countries choices, including documented all/select sentinels." }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Regions choices, including documented all/select sentinels." }, "institutions": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Institutions choices, including documented all/select sentinels." }, "physicians": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Physicians choices, including documented all/select sentinels." }, "programOfficers": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived ProgramOfficers choices, including documented all/select sentinels." }, "diagnoses": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Diagnoses choices, including documented all/select sentinels." }, "sdohDiagnoses": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived SdohDiagnoses choices, including documented all/select sentinels." }, "snapshots": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Snapshots choices, including documented all/select sentinels." }, "sdohSnapshots": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived SdohSnapshots choices, including documented all/select sentinels." }, "needs": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Needs choices, including documented all/select sentinels." }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Statuses choices, including documented all/select sentinels." }, "sdohStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived SdohStatuses choices, including documented all/select sentinels." }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Sources choices, including documented all/select sentinels." }, "flags": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Flags choices, including documented all/select sentinels." }, "defaults": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.MyPatientsReportRequest" } }, "additionalProperties": false, "description": "Complete selector data and initial request values for the MyPatients report." }, "Max.Dashboard.Api.Contracts.Reports.MyPatientsReportPage": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Filtered main-report row count before paging.", "format": "int32" }, "page": { "type": "integer", "description": "One-based effective page.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Effective size; omitted request size means Int32.MaxValue.", "format": "int32" }, "columns": { "type": "array", "items": { "type": "string" }, "description": "Ordered plain-data field names retained for frontend grids and frontend exports." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.MyPatientsReportRow" }, "description": "Typed database-mapped rows in deterministic SQL order." }, "summaries": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.NoReportSummaries" } }, "additionalProperties": false, "description": "Physician-compatible page of My Patients data for grids and frontend exports." }, "Max.Dashboard.Api.Contracts.Reports.MyPatientsReportRequest": { "type": "object", "properties": { "programId": { "type": "integer", "description": "Optional regular or SDOH program; zero includes both authorized sources.", "format": "int32" }, "combineTreatmentId": { "type": "integer", "description": "Optional regular treatment partner.", "format": "int32" }, "countryId": { "type": "integer", "description": "Optional current patient country.", "format": "int32" }, "regionId": { "type": "integer", "description": "Optional current patient region.", "format": "int32" }, "physicianId": { "type": "integer", "description": "Optional primary physician identity.", "format": "int32" }, "institutionId": { "type": "integer", "description": "Optional primary institution identity.", "format": "int32" }, "poId": { "type": "integer", "description": "Optional program officer filter; cannot replace mandatory assignment scope.", "format": "int32" }, "diagnosisId": { "type": "integer", "description": "Optional regular diagnosis identifier.", "format": "int32" }, "diagnosis": { "type": "string", "description": "Optional exact diagnosis label for both sources.", "nullable": true }, "status": { "type": "string", "description": "Enrollment status; SDOH uses current status unless a snapshot is selected.", "nullable": true }, "needingReapproval": { "type": "boolean", "description": "Only regular active enrollments whose next review is due." }, "snapshotDate": { "type": "string", "description": "Regular snapshot day and SDOH snapshot month.", "format": "date-time", "nullable": true }, "source": { "type": "string", "description": "All, Treatment or Sdoh; a narrowing source selector." }, "needId": { "type": "integer", "description": "Optional Helpline need filter; zero includes all needs.", "format": "int32" } }, "additionalProperties": false, "description": "Business filters for My Patients; authenticated account and roles are never request inputs." }, "Max.Dashboard.Api.Contracts.Reports.MyPatientsReportRow": { "type": "object", "properties": { "patientId": { "type": "integer", "description": "PatientId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32" }, "pin": { "type": "string", "description": "Pin from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "patientName": { "type": "string", "description": "PatientName from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "firstName": { "type": "string", "description": "FirstName from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "lastName": { "type": "string", "description": "LastName from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "countryId": { "type": "integer", "description": "CountryId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32" }, "country": { "type": "string", "description": "Country from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "regionId": { "type": "integer", "description": "RegionId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "region": { "type": "string", "description": "Region from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "diagnosis": { "type": "string", "description": "Diagnosis from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "treatments": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.MyPatientReportItem" }, "description": "Treatments from the selected legacy projection; unavailable breakdown fields remain null." }, "sdohPrograms": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.SdohPatientReportItem" }, "description": "SdohPrograms from the selected legacy projection; unavailable breakdown fields remain null." } }, "additionalProperties": false, "description": "Typed My Patients row; presentation and navigation links belong to the frontend." }, "Max.Dashboard.Api.Contracts.Reports.NoReportSummaries": { "type": "object", "additionalProperties": false, "description": "Preserves an empty summaries object for reports with only one source dataset." }, "Max.Dashboard.Api.Contracts.Reports.OrderStatusReportFilters": { "type": "object", "properties": { "countries": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Countries choices, including documented all/select sentinels." }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Regions choices, including documented all/select sentinels." }, "institutions": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Institutions choices, including documented all/select sentinels." }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Statuses choices, including documented all/select sentinels." }, "orderStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived OrderStatuses choices, including documented all/select sentinels." }, "flags": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Flags choices, including documented all/select sentinels." }, "defaults": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.OrderStatusReportRequest" } }, "additionalProperties": false, "description": "Complete selector data and initial request values for the OrderStatus report." }, "Max.Dashboard.Api.Contracts.Reports.OrderStatusReportPage": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Filtered main-report row count before paging.", "format": "int32" }, "page": { "type": "integer", "description": "One-based effective page.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Effective size; omitted request size means Int32.MaxValue.", "format": "int32" }, "columns": { "type": "array", "items": { "type": "string" }, "description": "Ordered plain-data field names retained for frontend grids and frontend exports." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.OrderStatusReportRow" }, "description": "Typed database-mapped rows in deterministic SQL order." }, "summaries": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.NoReportSummaries" } }, "additionalProperties": false, "description": "Physician-compatible page of Order Status data for grids and frontend exports." }, "Max.Dashboard.Api.Contracts.Reports.OrderStatusReportRequest": { "type": "object", "properties": { "pendingShipmentOnly": { "type": "boolean", "description": "Source blue-grid narrowing: no shipment date and status is not Closed." }, "countryId": { "type": "integer", "description": "Optional authorized country.", "format": "int32" } }, "additionalProperties": false, "description": "Business filters for Order Status; authenticated account and roles are never request inputs." }, "Max.Dashboard.Api.Contracts.Reports.OrderStatusReportRow": { "type": "object", "properties": { "orderId": { "type": "integer", "description": "OrderId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32" }, "orderPlacedDate": { "type": "string", "description": "OrderPlacedDate from the selected legacy projection; unavailable breakdown fields remain null.", "format": "date-time", "nullable": true }, "transactionId": { "type": "string", "description": "TransactionId from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "productOrderNo": { "type": "string", "description": "ProductOrderNo from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "status": { "type": "string", "description": "Status from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "orderStatus": { "type": "string", "description": "OrderStatus from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "countryId": { "type": "integer", "description": "CountryId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32" }, "country": { "type": "string", "description": "Country from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "region": { "type": "string", "description": "Region from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "institutionId": { "type": "integer", "description": "InstitutionId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32" }, "institutionName": { "type": "string", "description": "InstitutionName from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "customerId": { "type": "string", "description": "CustomerId from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "clinicAdmin": { "type": "string", "description": "ClinicAdmin from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "clinicAdminUsername": { "type": "string", "description": "ClinicAdminUsername from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "orderShipDate": { "type": "string", "description": "OrderShipDate from the selected legacy projection; unavailable breakdown fields remain null.", "format": "date-time", "nullable": true }, "shipmentTrackNo": { "type": "string", "description": "ShipmentTrackNo from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "dateReceived": { "type": "string", "description": "DateReceived from the selected legacy projection; unavailable breakdown fields remain null.", "format": "date-time", "nullable": true }, "receivedBy": { "type": "string", "description": "ReceivedBy from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "orderQtyMismatch": { "type": "integer", "description": "OrderQtyMismatch from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32" }, "clinicAttachmentsId": { "type": "integer", "description": "ClinicAttachmentsId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "fileName": { "type": "string", "description": "FileName from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "hasNotes": { "type": "boolean", "description": "HasNotes from the selected legacy projection; unavailable breakdown fields remain null." }, "expiredBatches": { "type": "integer", "description": "ExpiredBatches from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "expiringBatches": { "type": "integer", "description": "ExpiringBatches from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "orderItems": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportOrderItem" }, "description": "OrderItems from the selected legacy projection; unavailable breakdown fields remain null." } }, "additionalProperties": false, "description": "Typed Order Status row; presentation and navigation links belong to the frontend." }, "Max.Dashboard.Api.Contracts.Reports.PincLogsReportFilters": { "type": "object", "properties": { "countries": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Countries choices, including documented all/select sentinels." }, "breakdowns": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Breakdowns choices, including documented all/select sentinels." }, "groupings": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Groupings choices, including documented all/select sentinels." }, "flags": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Flags choices, including documented all/select sentinels." }, "defaults": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.PincLogsReportRequest" } }, "additionalProperties": false, "description": "Complete selector data and initial request values for the PincLogs report." }, "Max.Dashboard.Api.Contracts.Reports.PincLogsReportPage": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Filtered main-report row count before paging.", "format": "int32" }, "page": { "type": "integer", "description": "One-based effective page.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Effective size; omitted request size means Int32.MaxValue.", "format": "int32" }, "columns": { "type": "array", "items": { "type": "string" }, "description": "Ordered plain-data field names retained for frontend grids and frontend exports." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.PincLogsReportRow" }, "description": "Typed database-mapped rows in deterministic SQL order." }, "summaries": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.NoReportSummaries" } }, "additionalProperties": false, "description": "Physician-compatible page of PINC Logs data for grids and frontend exports." }, "Max.Dashboard.Api.Contracts.Reports.PincLogsReportRequest": { "type": "object", "properties": { "startDate": { "type": "string", "description": "Required first source report date.", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "Required last source report date; PINC procedure calls add one day.", "format": "date-time", "nullable": true }, "countryId": { "type": "integer", "description": "Required for NotContacted; optional narrowing filter for other modes.", "format": "int32" }, "breakdown": { "type": "string", "description": "Contacts, Advocacy, MASContacts or NotContacted." }, "groupBy": { "type": "string", "description": "Region, Country or User; MASContacts user mode retains UserCountry source grouping." }, "ignoreAttemptedCalls": { "type": "boolean", "description": "MASContacts source attempted-call exclusion." } }, "additionalProperties": false, "description": "Business filters for PINC Logs; authenticated account and roles are never request inputs." }, "Max.Dashboard.Api.Contracts.Reports.PincLogsReportRow": { "type": "object", "properties": { "region": { "type": "string", "description": "Region from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "country": { "type": "string", "description": "Country from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "firstName": { "type": "string", "description": "FirstName from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "lastName": { "type": "string", "description": "LastName from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "username": { "type": "string", "description": "Username from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "currentStatus": { "type": "string", "description": "CurrentStatus from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "totalContacts": { "type": "integer", "description": "TotalContacts from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "distinctPatients": { "type": "integer", "description": "DistinctPatients from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "attemptedCall": { "type": "integer", "description": "AttemptedCall from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "email": { "type": "integer", "description": "Email from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "fax": { "type": "integer", "description": "Fax from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "inPerson": { "type": "integer", "description": "InPerson from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "mail": { "type": "integer", "description": "Mail from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "phone": { "type": "integer", "description": "Phone from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "text": { "type": "integer", "description": "Text from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "advocacy": { "type": "integer", "description": "Advocacy from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "distinctAdvocacyPatients": { "type": "integer", "description": "DistinctAdvocacyPatients from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "referral": { "type": "integer", "description": "Referral from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "distinctReferPatients": { "type": "integer", "description": "DistinctReferPatients from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "totalActive": { "type": "integer", "description": "TotalActive from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "contacted": { "type": "integer", "description": "Contacted from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "percentage": { "type": "number", "description": "Percentage from the selected legacy projection; unavailable breakdown fields remain null.", "format": "double", "nullable": true }, "treatment": { "type": "string", "description": "Treatment from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "pin": { "type": "string", "description": "Pin from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "contactType": { "type": "string", "description": "ContactType from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "patientId": { "type": "integer", "description": "PatientId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "programId": { "type": "integer", "description": "ProgramId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Typed PINC Logs row; presentation and navigation links belong to the frontend." }, "Max.Dashboard.Api.Contracts.Reports.ReportFilterDateRange": { "type": "object", "properties": { "startDate": { "type": "string", "description": "Inclusive initial start date shown in the picker.", "format": "date-time" }, "endDate": { "type": "string", "description": "Inclusive initial end date shown in the picker.", "format": "date-time" }, "isEnabled": { "type": "boolean", "description": "False until the user selects the legacy Patients Helped/Active at Any Time checkbox." } }, "additionalProperties": false, "description": "Source date picker defaults without implicitly enabling an optional report date-range filter." }, "Max.Dashboard.Api.Contracts.Reports.ReportFilterOption": { "type": "object", "properties": { "value": { "type": "string", "description": "String representation sent in the matching report input; empty snapshot values mean null." }, "label": { "type": "string", "description": "Plain display text from the legacy catalogue or view." } }, "additionalProperties": false, "description": "A selector or checkbox value with its source-derived display label; values are API request values." }, "Max.Dashboard.Api.Contracts.Reports.ReportOrderBatch": { "type": "object", "properties": { "batchNumber": { "type": "string", "description": "BatchNumber from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "batchQty": { "type": "number", "description": "BatchQty from the selected legacy projection; unavailable breakdown fields remain null.", "format": "double", "nullable": true }, "batchExpiry": { "type": "string", "description": "BatchExpiry from the selected legacy projection; unavailable breakdown fields remain null.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Read-only Order Status batch details from the source grid expansion." }, "Max.Dashboard.Api.Contracts.Reports.ReportOrderItem": { "type": "object", "properties": { "orderItemId": { "type": "integer", "description": "OrderItemId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32" }, "skuId": { "type": "integer", "description": "SkuId from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32" }, "skuCode": { "type": "string", "description": "SkuCode from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "treatment": { "type": "string", "description": "Treatment from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "qtyOrdered": { "type": "integer", "description": "QtyOrdered from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "qtyShipped": { "type": "integer", "description": "QtyShipped from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "qtyReceived": { "type": "integer", "description": "QtyReceived from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "batches": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportOrderBatch" }, "description": "Batches from the selected legacy projection; unavailable breakdown fields remain null." } }, "additionalProperties": false, "description": "Read-only expanded Order Status line with shipment quantities." }, "Max.Dashboard.Api.Contracts.Reports.ReportProgramFilterOption": { "type": "object", "properties": { "value": { "type": "string", "description": "Legacy selection value, using a dot for a combination; use the explicit IDs for API requests." }, "label": { "type": "string", "description": "Source treatment or SDOH program label." }, "programId": { "type": "integer", "description": "Program identifier, or zero for an all/select sentinel.", "format": "int32" }, "combineTreatmentId": { "type": "integer", "description": "Optional regular treatment partner; send CombineTreatmentId independently where supported.", "format": "int32", "nullable": true }, "programType": { "type": "string", "description": "Treatment or SDOH; empty for an all/select sentinel." }, "isMas": { "type": "boolean", "description": "Whether the source treatment belongs to the MAS selection shortcut." }, "mainTreatment": { "type": "string", "description": "Uncombined treatment label used by the Dispensation selector.", "nullable": true } }, "additionalProperties": false, "description": "A treatment/program selection with explicit IDs, avoiding parsing legacy dot/plus combination encodings." }, "Max.Dashboard.Api.Contracts.Reports.SdohPatientReportItem": { "type": "object", "properties": { "patientId": { "type": "integer", "description": "Source PatientId value; unavailable branch-specific values remain null.", "format": "int32" }, "programId": { "type": "integer", "description": "Source ProgramId value; unavailable branch-specific values remain null.", "format": "int32" }, "programName": { "type": "string", "description": "Source ProgramName value; unavailable branch-specific values remain null.", "nullable": true }, "pin": { "type": "string", "description": "Source Pin value; unavailable branch-specific values remain null.", "nullable": true }, "firstName": { "type": "string", "description": "Source FirstName value; unavailable branch-specific values remain null.", "nullable": true }, "lastName": { "type": "string", "description": "Source LastName value; unavailable branch-specific values remain null.", "nullable": true }, "gender": { "type": "string", "description": "Source Gender value; unavailable branch-specific values remain null.", "nullable": true }, "status": { "type": "string", "description": "Source Status value; unavailable branch-specific values remain null.", "nullable": true }, "currentStatus": { "type": "string", "description": "Source CurrentStatus value; unavailable branch-specific values remain null.", "nullable": true }, "countryId": { "type": "integer", "description": "Source CountryId value; unavailable branch-specific values remain null.", "format": "int32", "nullable": true }, "country": { "type": "string", "description": "Source Country value; unavailable branch-specific values remain null.", "nullable": true }, "regionId": { "type": "integer", "description": "Source RegionId value; unavailable branch-specific values remain null.", "format": "int32", "nullable": true }, "region": { "type": "string", "description": "Source Region value; unavailable branch-specific values remain null.", "nullable": true }, "diagnosis": { "type": "string", "description": "Source Diagnosis value; unavailable branch-specific values remain null.", "nullable": true }, "iaDate": { "type": "string", "description": "Source IADate value; unavailable branch-specific values remain null.", "format": "date-time", "nullable": true }, "createDate": { "type": "string", "description": "Source CreateDate value; unavailable branch-specific values remain null.", "format": "date-time", "nullable": true }, "poId": { "type": "integer", "description": "Source PoId value; unavailable branch-specific values remain null.", "format": "int32", "nullable": true }, "maxStationId": { "type": "integer", "description": "Source MaxStationId value; unavailable branch-specific values remain null.", "format": "int32", "nullable": true }, "physician": { "type": "string", "description": "Source Physician value; unavailable branch-specific values remain null.", "nullable": true }, "birthDate": { "type": "string", "description": "Source BirthDate value; unavailable branch-specific values remain null.", "format": "date-time", "nullable": true }, "treatment": { "type": "string", "description": "Source Treatment value; unavailable branch-specific values remain null.", "nullable": true }, "dosage": { "type": "string", "description": "Source Dosage value; unavailable branch-specific values remain null.", "nullable": true }, "treatmentProviderName": { "type": "string", "description": "Source TreatmentProviderName value; unavailable branch-specific values remain null.", "nullable": true }, "consentFormSigned": { "type": "string", "description": "Source ConsentFormSigned value; unavailable branch-specific values remain null.", "nullable": true }, "needs": { "type": "string", "description": "Source Needs value; unavailable branch-specific values remain null.", "nullable": true }, "treatmentName": { "type": "string", "description": "Source TreatmentName value; unavailable branch-specific values remain null.", "nullable": true }, "sdohTreatmentId": { "type": "integer", "description": "Source SdohTreatmentId value; unavailable branch-specific values remain null.", "format": "int32", "nullable": true }, "helplineNeedIds": { "type": "string", "description": "Source HelplineNeedIds value; unavailable branch-specific values remain null.", "nullable": true }, "isMaxGps": { "type": "boolean", "description": "Source IsMaxGps value; unavailable branch-specific values remain null.", "nullable": true }, "primaryLanguage": { "type": "string", "description": "Source PrimaryLanguage value; unavailable branch-specific values remain null.", "nullable": true }, "ethnicity": { "type": "string", "description": "Source Ethnicity value; unavailable branch-specific values remain null.", "nullable": true }, "insuranceStatus": { "type": "string", "description": "Source InsuranceStatus value; unavailable branch-specific values remain null.", "nullable": true }, "insuranceType": { "type": "string", "description": "Source InsuranceType value; unavailable branch-specific values remain null.", "nullable": true }, "citizenshipStatus": { "type": "string", "description": "Source CitizenshipStatus value; unavailable branch-specific values remain null.", "nullable": true }, "employmentStatus": { "type": "string", "description": "Source EmploymentStatus value; unavailable branch-specific values remain null.", "nullable": true }, "preferredPronouns": { "type": "string", "description": "Source PreferredPronouns value; unavailable branch-specific values remain null.", "nullable": true }, "annualIncomeCategory": { "type": "string", "description": "Source AnnualIncomeCategory value; unavailable branch-specific values remain null.", "nullable": true }, "location": { "type": "string", "description": "Source Location value; unavailable branch-specific values remain null.", "nullable": true }, "interactionsCount": { "type": "integer", "description": "Source InteractionsCount value; unavailable branch-specific values remain null.", "format": "int32", "nullable": true }, "interactionTotalTime": { "type": "string", "description": "Source InteractionTotalTime value; unavailable branch-specific values remain null.", "nullable": true }, "occupation": { "type": "string", "description": "Helpline patient occupation, retained from the source view and optional grid column.", "nullable": true } }, "additionalProperties": false, "description": "Plain typed union of the legacy SDOH My Patients projections; view-generated random identities are excluded." }, "Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportFilters": { "type": "object", "properties": { "dateRange": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterDateRange" }, "programs": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportProgramFilterOption" }, "description": "Source-derived Programs choices, including documented all/select sentinels." }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Countries choices, including documented all/select sentinels." }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Regions choices, including documented all/select sentinels." }, "diagnoses": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Diagnoses choices, including documented all/select sentinels." }, "snapshots": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Snapshots choices, including documented all/select sentinels." }, "treatments": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Treatments choices, including documented all/select sentinels." }, "needs": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Needs choices, including documented all/select sentinels." }, "groupings": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Groupings choices, including documented all/select sentinels." }, "flags": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Flags choices, including documented all/select sentinels." }, "defaults": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportRequest" } }, "additionalProperties": false, "description": "Complete selector data and initial request values for the SdohTotals report." }, "Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportPage": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Filtered main-report row count before paging.", "format": "int32" }, "page": { "type": "integer", "description": "One-based effective page.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Effective size; omitted request size means Int32.MaxValue.", "format": "int32" }, "columns": { "type": "array", "items": { "type": "string" }, "description": "Ordered plain-data field names retained for frontend grids and frontend exports." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportRow" }, "description": "Typed database-mapped rows in deterministic SQL order." }, "summaries": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.NoReportSummaries" } }, "additionalProperties": false, "description": "Physician-compatible page of SDOH Totals data for grids and frontend exports." }, "Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportRequest": { "type": "object", "properties": { "programId": { "type": "integer", "description": "Required SDOH program; 42 Helpline, 47 MAX GPS and 43 Day By Day use dedicated source views.", "format": "int32" }, "countryId": { "type": "integer", "description": "Optional authorized country.", "format": "int32" }, "regionId": { "type": "integer", "description": "Optional authorized region.", "format": "int32" }, "diagnosis": { "type": "string", "description": "Optional exact diagnosis label." }, "treatment": { "type": "string", "description": "Optional Day By Day treatment filter." }, "needIds": { "type": "string", "description": "Optional Helpline need identifiers.", "nullable": true }, "breakdown": { "type": "string", "description": "Comma-separated approved grouping fields." }, "snapshotDate": { "type": "string", "description": "Optional month snapshot; takes priority over date range.", "format": "date-time", "nullable": true }, "startDate": { "type": "string", "description": "Optional inclusive historical-row start instant; requires EndDate.", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "Optional inclusive historical-row end instant; range mode returns active counts only.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Business filters for SDOH Totals; authenticated account and roles are never request inputs." }, "Max.Dashboard.Api.Contracts.Reports.SdohTotalsReportRow": { "type": "object", "properties": { "programName": { "type": "string", "description": "ProgramName from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "region": { "type": "string", "description": "Region from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "country": { "type": "string", "description": "Country from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "diagnosis": { "type": "string", "description": "Diagnosis from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "treatment": { "type": "string", "description": "Treatment from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "treatmentProvider": { "type": "string", "description": "TreatmentProvider from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "need": { "type": "string", "description": "Need from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "active": { "type": "integer", "description": "Active from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32" }, "closed": { "type": "integer", "description": "Closed from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Typed SDOH Totals row; presentation and navigation links belong to the frontend." }, "Max.Dashboard.Api.Contracts.Reports.TotalsReportFilters": { "type": "object", "properties": { "programs": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportProgramFilterOption" }, "description": "Source-derived Programs choices, including documented all/select sentinels." }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Countries choices, including documented all/select sentinels." }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Regions choices, including documented all/select sentinels." }, "diagnoses": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Diagnoses choices, including documented all/select sentinels." }, "snapshots": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Snapshots choices, including documented all/select sentinels." }, "breakdowns": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Breakdowns choices, including documented all/select sentinels." }, "groupingOptions": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived GroupingOptions choices, including documented all/select sentinels." }, "durationBands": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived DurationBands choices, including documented all/select sentinels." }, "flags": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.ReportFilterOption" }, "description": "Source-derived Flags choices, including documented all/select sentinels." }, "defaults": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.TotalsReportRequest" } }, "additionalProperties": false, "description": "Complete selector data and initial request values for the Totals report." }, "Max.Dashboard.Api.Contracts.Reports.TotalsReportPage": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Filtered main-report row count before paging.", "format": "int32" }, "page": { "type": "integer", "description": "One-based effective page.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Effective size; omitted request size means Int32.MaxValue.", "format": "int32" }, "columns": { "type": "array", "items": { "type": "string" }, "description": "Ordered plain-data field names retained for frontend grids and frontend exports." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.TotalsReportRow" }, "description": "Typed database-mapped rows in deterministic SQL order." }, "summaries": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.NoReportSummaries" } }, "additionalProperties": false, "description": "Physician-compatible page of Totals data for grids and frontend exports." }, "Max.Dashboard.Api.Contracts.Reports.TotalsReportRequest": { "type": "object", "properties": { "treatmentIds": { "type": "string", "description": "Comma-separated program or program.partner identifiers; zero selects authorized treatments." }, "countryId": { "type": "integer", "description": "Optional country filter; zero means all authorized countries.", "format": "int32" }, "regionId": { "type": "integer", "description": "Optional region filter.", "format": "int32" }, "diagnosis": { "type": "string", "description": "Optional exact diagnosis label.", "nullable": true }, "breakdown": { "type": "string", "description": "StatusTotals, DiagnosisTotals, DiagToApproval, TimeOnTreatment or TimeOnTreatmentBreakdown." }, "byCountry": { "type": "boolean", "description": "Include country in grouping." }, "byDiagnosis": { "type": "boolean", "description": "Include diagnosis in grouping except in diagnosis-column mode." }, "snapshotDate": { "type": "string", "description": "Optional historical snapshot day.", "format": "date-time", "nullable": true }, "lessThanYear": { "type": "boolean", "description": "Include this calendar-month treatment duration band; bands may overlap." }, "oneToThreeYears": { "type": "boolean", "description": "Include this calendar-month treatment duration band; bands may overlap." }, "oneToFiveYears": { "type": "boolean", "description": "Include this calendar-month treatment duration band; bands may overlap." }, "threeToFiveYears": { "type": "boolean", "description": "Include this calendar-month treatment duration band; bands may overlap." }, "fiveToTenYears": { "type": "boolean", "description": "Include this calendar-month treatment duration band; bands may overlap." }, "overFiveYears": { "type": "boolean", "description": "Include this calendar-month treatment duration band; bands may overlap." }, "overTenYears": { "type": "boolean", "description": "Include this calendar-month treatment duration band; bands may overlap." } }, "additionalProperties": false, "description": "Business filters for Totals; authenticated account and roles are never request inputs." }, "Max.Dashboard.Api.Contracts.Reports.TotalsReportRow": { "type": "object", "properties": { "treatment": { "type": "string", "description": "Treatment from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "country": { "type": "string", "description": "Country from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "diagnosis": { "type": "string", "description": "Diagnosis from the selected legacy projection; unavailable breakdown fields remain null.", "nullable": true }, "active": { "type": "integer", "description": "Active from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "closed": { "type": "integer", "description": "Closed from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "denied": { "type": "integer", "description": "Denied from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "pending": { "type": "integer", "description": "Pending from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "averageMonthsDiagnosisToApproval": { "type": "integer", "description": "AverageMonthsDiagnosisToApproval from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "averageMonthsOnTreatment": { "type": "integer", "description": "AverageMonthsOnTreatment from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "lessThanYear": { "type": "integer", "description": "LessThanYear from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "oneToThreeYears": { "type": "integer", "description": "OneToThreeYears from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "oneToFiveYears": { "type": "integer", "description": "OneToFiveYears from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "threeToFiveYears": { "type": "integer", "description": "ThreeToFiveYears from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "fiveToTenYears": { "type": "integer", "description": "FiveToTenYears from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "overFiveYears": { "type": "integer", "description": "OverFiveYears from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "overTenYears": { "type": "integer", "description": "OverTenYears from the selected legacy projection; unavailable breakdown fields remain null.", "format": "int32", "nullable": true }, "diagnosisCounts": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.Reports.DiagnosisCount" }, "description": "DiagnosisCounts from the selected legacy projection; unavailable breakdown fields remain null." } }, "additionalProperties": false, "description": "Typed Totals row; presentation and navigation links belong to the frontend." }, "Max.Dashboard.Api.Contracts.ResolveTagRequest": { "type": "object", "properties": { "resolveNotes": { "type": "string" } }, "additionalProperties": false, "description": "Required reply notes for resolving a tag with a response." }, "Max.Dashboard.Api.Contracts.SetDiagnosticApprovalRequest": { "type": "object", "properties": { "diagnosisId": { "type": "string" }, "approved": { "type": "boolean" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.SetDispenseApprovalRequest": { "type": "object", "properties": { "treatmentId": { "type": "string" }, "approved": { "type": "boolean" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.TagItem": { "type": "object", "properties": { "createdDate": { "type": "string", "description": "Stored creation time, without timezone conversion.", "format": "date-time", "nullable": true }, "outboundOrderId": { "type": "integer", "description": "Optional shipment identity for supply-chain navigation.", "format": "int32", "nullable": true }, "isRead": { "type": "boolean", "description": "Whether the recipient has read the tag." }, "canResolve": { "type": "boolean", "description": "True when unresolved and addressed to the account used for this projection." }, "tagId": { "type": "integer", "description": "Tag identity; TagType distinguishes incoming and sent copies in All.", "format": "int32" }, "fromUsername": { "type": "string", "description": "Sender's account name.", "nullable": true }, "fromName": { "type": "string", "description": "Sender's display name.", "nullable": true }, "toUsername": { "type": "string", "description": "Recipient's account name.", "nullable": true }, "toName": { "type": "string", "description": "Recipient's display name.", "nullable": true }, "patientId": { "type": "integer", "description": "Optional patient navigation identity.", "format": "int32", "nullable": true }, "patientName": { "type": "string", "description": "Patient name as plain text.", "nullable": true }, "pin": { "type": "string", "description": "Patient identification number.", "nullable": true }, "patientProgramId": { "type": "integer", "description": "Legacy patient-link treatment identity, which may differ from the tag's ProgramId.", "format": "int32", "nullable": true }, "institutionId": { "type": "integer", "description": "Optional institution navigation identity.", "format": "int32", "nullable": true }, "institutionName": { "type": "string", "description": "Institution name as plain text.", "nullable": true }, "programId": { "type": "integer", "description": "Null denotes a tag applying across programs.", "format": "int32", "nullable": true }, "treatment": { "type": "string", "description": "Program's treatment label, preserving the source field.", "nullable": true }, "color": { "type": "string", "description": "Legacy treatment color.", "nullable": true }, "webColor": { "type": "string", "description": "Web treatment color.", "nullable": true }, "effectiveDate": { "type": "string", "description": "Stored effective timestamp; no timezone conversion is applied.", "format": "date-time", "nullable": true }, "status": { "type": "string", "description": "Resolved, Read, or Unread; null if the stored flags are null.", "nullable": true }, "resolveDate": { "type": "string", "description": "Stored resolution date; absent for received unresolved rows.", "format": "date-time", "nullable": true }, "resolveNotes": { "type": "string", "description": "Original resolution notes.", "nullable": true }, "tagNotes": { "type": "string", "description": "Original tag notes.", "nullable": true }, "tagType": { "type": "string", "description": "Source category: unresolved, resolved, or sent." }, "resolved": { "type": "boolean", "description": "Original resolution flag.", "nullable": true } }, "additionalProperties": false, "description": "Read projection of a tag; notes retain their stored contents and require safe client rendering." }, "Max.Dashboard.Api.Contracts.TagPage": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Number of matching rows before pagination.", "format": "int32" }, "page": { "type": "integer", "description": "One-based page; always one when requesting all records.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Applied size, or Int32.MaxValue for all records.", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Max.Dashboard.Api.Contracts.TagItem" }, "description": "Typed rows in the requested order." } }, "additionalProperties": false, "description": "A user-scoped page of dashboard tags, without legacy navigation HTML." }, "Max.Dashboard.Api.Contracts.UpdateDispensationRecordRequest": { "type": "object", "properties": { "dispensationUnit": { "type": "string", "nullable": true }, "skuId": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "dispenseDate": { "type": "string", "format": "date-time" }, "lotNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.UpdateInstitutionInventoryReportItemRequest": { "type": "object", "properties": { "lotNumber": { "type": "string", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "boxesRemainingCount": { "type": "integer", "format": "int32", "nullable": true }, "stockout": { "type": "boolean" } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.UpdateInstitutionRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "institutionType": { "type": "string", "nullable": true }, "customerNumber": { "type": "string", "nullable": true }, "qaValidated": { "type": "boolean", "nullable": true }, "nextQaDate": { "type": "string", "format": "date-time", "nullable": true }, "pharmacyChain": { "type": "string", "nullable": true }, "street1": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "stateProvince": { "type": "string", "nullable": true }, "zipcode": { "type": "string", "nullable": true }, "emails": { "type": "array", "items": { "type": "string" }, "nullable": true }, "phones": { "type": "array", "items": { "type": "string" }, "nullable": true }, "mobile": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "adminName": { "type": "string", "nullable": true }, "adminEmail": { "type": "string", "nullable": true }, "latitude": { "type": "number", "format": "double", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Max.Dashboard.Api.Contracts.UpdateInstitutionTransferRequest": { "type": "object", "properties": { "quantity": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "Microsoft.AspNetCore.Mvc.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": { } }, "System.Void": { "type": "object", "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "JWT Authorization header using the Bearer scheme.", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "Applicant", "description": "Starts MAS applications and program-specific SDOH patient intakes." }, { "name": "FileCabinet" }, { "name": "Institution", "description": "Exposes HTTP endpoints for Institution workflows." }, { "name": "LPC", "description": "Exposes the authenticated LPC dashboard summary and JSON queue lists." }, { "name": "Max.Dashboard.Api" }, { "name": "Patient", "description": "Exposes HTTP endpoints for Patient workflows." }, { "name": "PatientProfile", "description": "Exposes the shared patient profile to internal audiences, including Region Heads, without widening write policies." }, { "name": "Profile", "description": "Exposes HTTP endpoints for Profile workflows." }, { "name": "Reports", "description": "Eight read-only reports for MaxStation, Program Officers, Region Heads and Administrators." }, { "name": "Tags", "description": "Shared dashboard tags for authenticated internal users, including MaxStation accounts." } ] }