{"swagger":"2.0","info":{"version":"v1","title":"HealthCloud API","description":"# Introduction\r\n\r\nWelcome to the HealthCloud API! You can use our API to access HC API endpoints.\r\n\r\nHealthCloud exposes a Swagger UI which can be accessed at /swagger.\r\n\r\nThe Swagger can be used with http://editor.swagger.io/ to generate client proxy code in many different development languages.\r\n# Authorization\r\n\r\n To be able to integrate with the HealthCloud SSO platform the developer needs to follow a few steps.\r\n\r\nStep 1 – Follow the [Apply for access link](https://app.healthcloudsa.com/IntegratedSystemRequest) to register for your API credentials.\r\n\r\nStep 2 – You will receive an email once your application is approved with your api credentials.\r\n\r\nStep 3 – You can configure your callback URL and maintain your credentials by following Maintain Credentials.\r\n\r\nStep 4 - Implementation.\r\n\r\n# Implementation\r\n\r\nThe HC System requires the API Key, a CorrelationId and passphrase, to be sent in the Headers with every request, this will be used to identify the calling system and to prevent Replay attacks.\r\n\r\n* The CorrelationId is a concatenated string of the current UTC Date Time in the format of “yyyyMMddHHmm” and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z). This should give a total length of 44 characters.\r\n\r\n* The next step is to create a HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId from 1 above and your secret.\r\n\r\n* Lastly convert this HASH value to a base64 string and pass it to the server as your passphrase.\r\n\r\n Replace the {YOUR API KEY} and {YOUR SECRET} with your own.\r\n\r\n* The Following Headers must be included with every request:\r\n\r\n\t* HC_API_KEY\r\n\t* HC_CORRELATION_ID\r\n\t* HC_PASSPHRASE \r\n","x-logo":{"url":"https://app.healthcloudsa.com/public/content/images/healthcloud_api_logo.png","backgroundColor":"#FFFFFF","altText":"HealthCloud logo"}},"paths":{"/api/ActivityProfile/RegisterNewProfile":{"post":{"tags":["ActivityProfile"],"summary":"Register New Profile","description":"Will create a new profile and link the scheme code(s) (Category codes) to the profile.","operationId":"RegisterNewProfile","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.ActivityProfileRegisterModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.ActivityProfileResultModel"}}}}},"/api/ActivityProfile/UpdateSchemes":{"post":{"tags":["ActivityProfile"],"summary":"Update Schemes","description":"Will update the linked scheme member code(s) (Category codes). All codes not in the list will be removed and all new codes will be added. After calling this method the only codes linked will be the codes passed in the request.","operationId":"UpdateSchemes","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.ActivityProfileRegisterModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.ActivityProfileResultModel"}}}}},"/api/ActivityProfile/UpdateClientProfile":{"post":{"tags":["ActivityProfile"],"summary":"Update Client Profile","description":"Will update the client profile code and merge the old and new profile data if the new profile code is already on the system.","operationId":"UpdateClientProfile","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.ActivityProfileUpdateModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.ActivityProfileUpdateResultModel"}}}}},"/api/ActivityProfile/DeregisterScheme":{"post":{"tags":["ActivityProfile"],"summary":"Deregister Scheme","description":"Will remove the scheme code(s) (Category codes) from the profile. Once the last code is removed the entire profile will be deleted including all activity data for the profile.","operationId":"DeregisterScheme","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.DeregisterProfileFromSchemeRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.DeleteProfileResultModel"}}}}},"/api/ActivityProfile/RequestDeviceLinkURL":{"post":{"tags":["ActivityProfile"],"summary":"Request Device Link URL","description":"Will return a URL to the calling system to link devices. This URL will be unique and will only work for a single call. Please do not store this URL for future requests.","operationId":"ActivityProfileRequestDeviceLinkURL","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.ActivityDeviceLinkURLRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.ActivityDeviceLinkURLResultModel"}}}}},"/api/ActivityProfile/ProfileIdLookup":{"post":{"tags":["ActivityProfile"],"summary":"Profile Id Lookup","description":"Returns the HealthCloud Profile ID for a client profile code.","operationId":"ProfileIdLookup","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.ActivityProfileModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.ProfileIdLookupResultModel"}}}}},"/api/ActivityProfile/DailySummaryGet":{"post":{"tags":["ActivityProfile"],"summary":"Daily Activity Summary","description":"Returns the Daily Summary records for a profile. Please note the JSON response object here will also be used to PUSH data to the PUSH URL.","operationId":"DailySummaryGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.ActivityProfileDailySummaryRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.ActivityProfileDailySummaryResponseModel"}}}}},"/api/ActivityProfile/InactiveDevicesGet":{"post":{"tags":["ActivityProfile"],"summary":"Inactive Fitness Devices","description":"Returns the list of devices that are not active anymore e.g. Disabled or in an Error state.","operationId":"InactiveDevicesGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.ActivityProfileModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.InactiveDevicesResultModel"}}}}}},"/api/Custom/PatientWellnessRecordSave":{"post":{"tags":["Custom"],"summary":"Patient Wellness Record Save","description":"Saves the patient's new information and health data as a new record, this method is intended to be used only for Wellness Events.","operationId":"PatientWellnessRecordSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.WellnessEventModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.WellnessEventModel"}}}}},"/api/Custom/WellnessPatientRegister":{"post":{"tags":["Custom"],"summary":"Wellness Patient Register.","description":"Registers the patient on the HealthCloud System, this method is intended to be used only for Wellness Events.","operationId":"WellnessPatientRegister","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.PatientWellnessRegisterModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.PatientRegistrationResultModel"}}}}},"/api/Custom/GarminStressDataGet":{"post":{"tags":["Custom"],"summary":"Garmin Stress Data Get","description":"A custom method to get the number of Garmin devices linked to a profile and return the last three days stress data.","operationId":"GarminStressDataGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.StressRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.GarminStressDataModel"}}}}},"/api/Custom/UploadPointOfCareTestResult":{"post":{"tags":["Custom"],"summary":"Point of Care Test Result Submission","description":"A custom method to upload Point of Care Device Test Results","operationId":"CustomUploadPointOfCareTestResult","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.PointOfCareRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.PointOfCareResponseModel"}}}}},"/api/Custom/GetLancetDataAsync":{"post":{"tags":["Custom"],"summary":"Get Lancet Patient Data","description":"Gets the patient's data from Lancet.","operationId":"GetLancetDataAsync","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.Lancet.LancetPatientQueryRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRPatientSummary"}}}}},"/api/EHRMasterData/CodeSystemList":{"post":{"tags":["EHRMasterData"],"summary":"Code System List","description":"The method will return a list of all available Code Systems that has been added to the system.","operationId":"CodeSystemList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.CodeSystemModel"}}}}}},"/api/EHRMasterData/BloodTypeList":{"post":{"tags":["EHRMasterData"],"summary":"Blood Types","description":"The method will return a list of all available blood types that has been added to the system.","operationId":"BloodTypeList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.BloodTypeModel"}}}}}},"/api/EHRMasterData/AllergyList":{"post":{"tags":["EHRMasterData"],"summary":"Allergy List","description":"The method will return a list of all available allergies that has been added to the system.","operationId":"AllergyList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.AllergyModel"}}}}}},"/api/EHRMasterData/BiometricList":{"post":{"tags":["EHRMasterData"],"summary":"Biometric List","description":"The method will return a list of all available biometrics that has been added to the system.","operationId":"BiometricList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.BiometricModel"}}}}}},"/api/EHRMasterData/RelationshipList":{"post":{"tags":["EHRMasterData"],"summary":"Relationship List","description":"The method will return a list of all available relationships that has been added to the system.","operationId":"RelationshipList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.RelationshipModel"}}}}}},"/api/EHRMasterData/ProcedureList":{"post":{"tags":["EHRMasterData"],"summary":"Procedure List","description":"The method will return a list of all available procedures that has been added to the system.","operationId":"ProcedureList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.ProcedureModel"}}}}}},"/api/EHRMasterData/ResultList":{"post":{"tags":["EHRMasterData"],"summary":"Result List","description":"The method will return a list of all available result types that has been added to the system.","operationId":"ResultList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.ResultModel"}}}}}},"/api/ElectronicHealthRecord/PatientProfileSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Patient Profile Save","description":"The method allows the user to save the patient's profile information.","operationId":"PatientProfileSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRPatientSaveModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.PatientAddResultModel"}}}}},"/api/ElectronicHealthRecord/TobaccoUsageGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Tobacco Usage Get","description":"This method returns the details of the patient's tobacco usage.","operationId":"TobaccoUsageGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.TobaccoUsageModel"}}}}}},"/api/ElectronicHealthRecord/TobaccoUsageSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Tobacco Usage Save","description":"This allows the user to save the details of the patient's tobacco usage.","operationId":"TobaccoUsageSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.TobaccoUsageModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.TobaccoUsageModel"}}}}},"/api/ElectronicHealthRecord/AlcoholUsageGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Alcohol Usage Get","description":"This method returns the details of the patient's alcohol usage.","operationId":"AlcoholUsageGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.AlcoholUsageModel"}}}}}},"/api/ElectronicHealthRecord/AlcoholUsageSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Alcohol Usage Save","description":"This allows the user to save the details of the patient's alcohol usage.","operationId":"AlcoholUsageSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.AlcoholUsageModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.AlcoholUsageModel"}}}}},"/api/ElectronicHealthRecord/PatientContactSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Patient Contact Save","description":"This method allows the care professional to add a new contact to the patient's profile","operationId":"EHRPatientContactSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.PatientContactModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.PatientContactModel"}}}}},"/api/ElectronicHealthRecord/PatientEncounterSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Patient Encounter Save","description":"This lets the user save a patient's encounter.","operationId":"PatientEncounterSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.PatientEncounterModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.PatientEncounterModel"}}}}},"/api/ElectronicHealthRecord/PatientEncounterGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Patient Encounter Get","description":"The method that allows the user to retrieve a patient's encounter.","operationId":"PatientEncounterGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.PatientEncounterGetModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.PatientEncounterModel"}}}}}},"/api/ElectronicHealthRecord/EncounterProviderSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Encounter Provider Save","description":"This allows the user to link a provider to an existing encounter.","operationId":"EncounterProviderSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EncounterProviderModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EncounterProviderModel"}}}}},"/api/ElectronicHealthRecord/EncounterNoteSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Encounter Note Save","description":"The method that allows the user to save notes of an encounter.","operationId":"EncounterNoteSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EncounterNoteModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EncounterNoteModel"}}}}},"/api/ElectronicHealthRecord/EncounterNoteGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Encounter Note Get","description":"The method that allows the user to retrieve a note's detail of an encounter.","operationId":"EncounterNoteGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EncounterNoteModel"}}}}}},"/api/ElectronicHealthRecord/FamilyHistorySave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Family History Save","description":"This method lets the user save Family history details of a patient.","operationId":"FamilyHistorySave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.FamilyHistoryModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.FamilyHistoryModel"}}}}},"/api/ElectronicHealthRecord/FamilyHistoryGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Family History Get","description":"This method lets the user get details of a specific family history record","operationId":"FamilyHistoryGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.FamilyHistoryModel"}}}}}},"/api/ElectronicHealthRecord/PatientAllergySave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Patient Allergy Save","description":"This method lets the user save a patient's allergy details.","operationId":"PatientAllergySave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.PatientAllergyModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.PatientAllergyModel"}}}}},"/api/ElectronicHealthRecord/PatientAllergyGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Patient Allergy Get","description":"This allows the user the retrieve the details of a patient's allergy","operationId":"PatientAllergyGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.PatientAllergyModel"}}}}}},"/api/ElectronicHealthRecord/PatientVitalSignsSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Patient Vital Signs Save","description":"The method that allows the user to save a patient's vital signs.","operationId":"PatientVitalSignsSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.PatientVitalSignModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.PatientVitalSignModel"}}}}},"/api/ElectronicHealthRecord/VitalSignsGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Patient Vital Signs Get","description":"The method that allows the user to retrieve the details of a patient's vital signs.","operationId":"VitalSignsGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.PatientVitalSignModel"}}}}}},"/api/ElectronicHealthRecord/ObservationSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Observation Save","description":"The method that allows the user to save observation details of an encounter.","operationId":"ObservationSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.ObservationModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.ObservationModel"}}}}},"/api/ElectronicHealthRecord/ObservationGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Observation Get","description":"The method that allows the user to retrieve observation details of an encounter.","operationId":"ObservationGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.ObservationModel"}}}}}},"/api/ElectronicHealthRecord/ProviderProcedureSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Provider Procedure Save","description":"The method that allows the user to save provider procedure details of an encounter.","operationId":"ProviderProcedureSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.ProviderProcedureModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.ProviderProcedureModel"}}}}},"/api/ElectronicHealthRecord/EncounterProceduresGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Provider Procedure Get","description":"The method that allows the user to retrieve provider procedure details of an encounter.","operationId":"EncounterProceduresGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.ProviderProcedureModel"}}}}}},"/api/ElectronicHealthRecord/EncounterDiagnosisSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Encounter Diagnosis Save","description":"The method that allows the user to save the diagnosis details of an encounter.","operationId":"EncounterDiagnosisSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EncounterDiagnosisModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EncounterDiagnosisModel"}}}}},"/api/ElectronicHealthRecord/EncounterDiagnosisGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Encounter Diagnosis Get","description":"The method that allows the user to retrieve the diagnosis details of an encounter.","operationId":"EncounterDiagnosisGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EncounterDiagnosisModel"}}}}}},"/api/ElectronicHealthRecord/DiagnosisMedicationSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Diagnosis Medication Save","description":"The method that allows the user to save the medication details of a diagnosis.","operationId":"DiagnosisMedicationSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.DiagnosisMedicationModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.DiagnosisMedicationModel"}}}}},"/api/ElectronicHealthRecord/DiagnosisMedicationGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Diagnosis Medication Get","description":"The method that allows the user to retrieve the medication details of a diagnosis.","operationId":"DiagnosisMedicationGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.DiagnosisMedicationModel"}}}}}},"/api/ElectronicHealthRecord/EncounterImmunizationsSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Encounter Immunizations Save","description":"The method that allows the user to save the immunization details of an encounter.","operationId":"EncounterImmunizationsSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EncounterImmunizationModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EncounterImmunizationModel"}}}}},"/api/ElectronicHealthRecord/ImmunizationsGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Encounter Immunizations Get","description":"The method that allows the user to retrieve the immunization details of an encounter.","operationId":"ImmunizationsGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EncounterImmunizationModel"}}}}}},"/api/ElectronicHealthRecord/ProcedureResultSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Procedure Result Save","description":"The method that allows the user to save the result details of a procedure.","operationId":"ProcedureResultSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.ProcedureResultModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.ProcedureResultModel"}}}}},"/api/ElectronicHealthRecord/ProcedureResultGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Procedure Result Get","description":"The method that allows the user to retrieve the result details of a procedure.","operationId":"ProcedureResultGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.ProcedureResultModel"}}}}}},"/api/ElectronicHealthRecord/CarePlanSave":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Care Plan Save","description":"The method that allows the user to save the details of a care plan for a patient.","operationId":"CarePlanSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.CarePlanModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.CarePlanModel"}}}}},"/api/ElectronicHealthRecord/CarePlanGet":{"post":{"tags":["ElectronicHealthRecord"],"summary":"Care Plan Get","description":"The method that allows the user to retrieve the details of a care plan for a patient.","operationId":"CarePlanGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.EHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.CarePlanModel"}}}}}},"/api/HCCActivity/SleepGet":{"post":{"tags":["HCCActivity"],"summary":"Sleep Get","description":"Returns Sleep data obtained from fitness devices connected to the profile.","operationId":"SleepGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.RequestModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.SleepDataForPatientModel"}}}}}},"/api/HCCActivity/HeartRateGet":{"post":{"tags":["HCCActivity"],"summary":"Heart Rate Get","description":"Returns Heart Rate data obtained from fitness devices connected to the profile.","operationId":"HeartRateGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.RequestModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.HearthRateDataForPatientModel"}}}}}},"/api/HCCActivity/CaloriesGet":{"post":{"tags":["HCCActivity"],"summary":"Calories Get","description":"Returns Heart Rate data obtained from fitness devices connected to the profile.","operationId":"CaloriesGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.RequestModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.CaloriesDataForPatientModel"}}}}}},"/api/HCCActivity/StepsGet":{"post":{"tags":["HCCActivity"],"summary":"Steps Get","description":"Returns Step data obtained from fitness devices connected to the profile.","operationId":"StepsGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.RequestModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.StepDataForPatientModel"}}}}}},"/api/HCCActivity/DistanceGet":{"post":{"tags":["HCCActivity"],"summary":"DistanceGet","description":"Returns Distance data obtained from fitness devices connected to the profile.","operationId":"DistanceGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.RequestModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.DistanceDataForPatientModel"}}}}}},"/api/HCCActivity/StressDataGet":{"post":{"tags":["HCCActivity"],"summary":"Stress Data Get","description":"Returns Stress data obtained from fitness devices connected to the profile.","operationId":"StressDataGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.RequestModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.StressDataModel"}}}}}},"/api/HCCActivity/GetPatientDeviceCount":{"post":{"tags":["HCCActivity"],"summary":"Device Count","description":"Returns the amount of devices linked to the patient","operationId":"GetPatientDeviceCount","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.ProfileIdModel"}}],"responses":{"200":{"description":"Success","schema":{"format":"int32","type":"integer"}}}}},"/api/HCCActivity/InactiveDevicesGet":{"post":{"tags":["HCCActivity"],"summary":"Inactive Devices Get","description":"Returns a list of all the inactive devices linked to the patient's profile","operationId":"ActivityProfileInactiveDevicesGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.ProfileIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.PatientInactiveDevicesResultModel"}}}}}},"/api/HCCActivity/GetFitnessDeviceStatus":{"post":{"tags":["HCCActivity"],"summary":"Fitness Device Status","description":"Returns the status of the specified device","operationId":"GetFitnessDeviceStatus","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ApiRequestIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.DeviceStatusResultModel"}}}}},"/api/HCCCareProvider/ProfileGet":{"post":{"tags":["HCCCareProvider"],"summary":"Healthcare Provider Profile Get","description":"This API endpoint will return a Healthcare Providers profile information.","operationId":"HealthCareProfessionalProfileGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.CareProvider.CareProviderProfileRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.CareProvider.CareProviderProfileModel"}}}}},"/api/HCCCareProvider/Register":{"post":{"tags":["HCCCareProvider"],"summary":"Healthcare Provider Register","description":"The method will create a new Healthcare Provider record in the HealthCloud database.","operationId":"HealthCareProfessionalRegister","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.CareProvider.CareProviderRegisterModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.CareProvider.CareProviderRegisterResultModel"}}}}},"/api/HCCCareProvider/ProfileUpdate":{"post":{"tags":["HCCCareProvider"],"summary":"Healthcare Provider Profile Update","description":"This API endpoint will update an existing Healthcare Providers profile.","operationId":"HealthCareProfessionalProfileUpdate","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.CareProvider.CareProviderProfileUpdateModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.CareProvider.CareProviderProfileModel"}}}}},"/api/HCCCareProvider/PatientSearch":{"post":{"tags":["HCCCareProvider"],"summary":"Patient Search","description":"This method will return a list of patients based on the search criteria","operationId":"PatientSearch","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.CareProvider.CareProviderPatientSearchModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.GridResultModel`1[[HealthCloud.Models.Api.CareProvider.PatientSearchResult, HealthCloud, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"}}}}},"/api/HCCCareProvider/PatientBookingSearch":{"post":{"tags":["HCCCareProvider"],"summary":"Patient Booking Search","description":"This method will return a list of bookings based on the search criteria","operationId":"CareProviderPatientBookingSearch","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.CareProvider.CareProviderBookingSearchModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.GridResultModel`1[[HealthCloud.Models.Api.CareProvider.CareProviderBookingResultModel, HealthCloud, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"}}}}},"/api/HCCCareProvider/GetCareProviderAvailableTimeSlots":{"post":{"tags":["HCCCareProvider"],"summary":"Healthcare Provider Available Timeslots","description":"This API endpoint will return a Healthcare Providers available timeslots for a specified date.","operationId":"GetCareProviderAvailableTimeSlots","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.CareProvider.AvailableTimeSlotRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.CareProvider.CareProviderAvailableTimeSlotModel"}}}}},"/api/HCCMasterData/ProvinceList":{"post":{"tags":["HCCMasterData"],"summary":"Get Province List","description":"This API endpoint will return a list of Key Value Pairs for Provinces","operationId":"ProvinceList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.ProvinceModel"}}}}}},"/api/HCCMasterData/TimeSlotList":{"post":{"tags":["HCCMasterData"],"summary":"Get TimeSlot List","description":"This API endpoint will return a list of Key Value Pairs for TimeSlot","operationId":"TimeSlotList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.TimeSlotModel"}}}}}},"/api/HCCMasterData/LanguageList":{"post":{"tags":["HCCMasterData"],"summary":"Get Language List","description":"This API endpoint will return a list of Key Value Pairs for Language","operationId":"LanguageList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.LanguageModel"}}}}}},"/api/HCCMasterData/SpecialityList":{"post":{"tags":["HCCMasterData"],"summary":"Get Speciality List","description":"This API endpoint will return a list of Key Value Pairs for Speciality","operationId":"SpecialityList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.SpecialityModel"}}}}}},"/api/HCCMasterData/ProfessionList":{"post":{"tags":["HCCMasterData"],"summary":"Get Profession List","description":"This API endpoint will return a list of Key Value Pairs for Profession","operationId":"ProfessionList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.ProfessionModel"}}}}}},"/api/HCCMasterData/MedicalAidList":{"post":{"tags":["HCCMasterData"],"summary":"Get Medical Aid List","description":"This API endpoint will return a list of Key Value Pairs for Medical Aid.","operationId":"MedicalAidList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.MedicalAidModel"}}}}}},"/api/HCCMasterData/EmployerList":{"post":{"tags":["HCCMasterData"],"summary":"Get Employer List","description":"his API endpoint will return a list of Key Value Pairs for Employer.","operationId":"EmployerList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.EmployerModel"}}}}}},"/api/HCCMasterData/GenderTypeList":{"post":{"tags":["HCCMasterData"],"summary":"Get Gender Type List","description":"This API endpoint will return a list of Key Value Pairs for Gender Type","operationId":"GenderTypeList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.ApiEnumModel"}}}}}},"/api/HCCMasterData/EthnicityTypeList":{"post":{"tags":["HCCMasterData"],"summary":"Get Ethnicity Type List","description":"This API endpoint will return a list of Key Value Pairs for Ethnicity Type","operationId":"EthnicityTypeList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.ApiEnumModel"}}}}}},"/api/HCCMedia/CategoryList":{"post":{"tags":["HCCMedia"],"summary":"Category List","description":"Returns a list of all the available media categories","operationId":"CategoryList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.MediaCategoryModel"}}}}}},"/api/HCCMedia/GetLatestMedia":{"post":{"tags":["HCCMedia"],"summary":"Media Search","description":"Returns a list of media records based of the search key provided","operationId":"GetLatestMedia","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.LatestMediaRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.MediaItemModel"}}}}}},"/api/HCCMedia/Search":{"post":{"tags":["HCCMedia"],"summary":"Media Search","description":"Returns a list of media records based of the search key provided","operationId":"Search","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.MediaSearchModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.MediaItemModel"}}}}}},"/api/HCCMedia/AdvancedSearch":{"post":{"tags":["HCCMedia"],"summary":"Media Search","description":"Returns a list of media records based of the search key provided","operationId":"AdvancedSearch","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.MediaAdvancedSearchModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.AdvancedSearchMediaModel"}}}}}},"/api/HCCMedia/AvatarGet":{"post":{"tags":["HCCMedia"],"summary":"Avatar Search","description":"Returns all avatars with media category maps","operationId":"AvatarGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.ApiRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.AvatarItemModel"}}}}},"/api/HCCMedia/AvatarMediaSearch":{"post":{"tags":["HCCMedia"],"summary":"Avatar Search","description":"Returns a list of media records based of the search key provided","operationId":"AvatarMediaSearch","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.AvatarMediaSearchModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.MediaItemModel"}}}}}},"/api/HCCMedia/GetMediaURL":{"post":{"tags":["HCCMedia"],"summary":"Get Media URL","description":"Returns the URL to the media content","operationId":"GetMediaURL","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.MediaRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.MediaRequestResultModel"}}}}},"/api/HCCMedia/GetMediaKeyWords":{"post":{"tags":["HCCMedia"],"summary":"Get Updated Media Key Words","description":"Returns The media id, summary and Key Words for media items that was updated/modified","operationId":"GetMediaKeyWords","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.MediaKeyWordsRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.MediaKeyWordsResultModel"}}}}}},"/api/HCCMedia/GetAvailableMediaLanguages":{"post":{"tags":["HCCMedia"],"summary":"Gets the available media languages for the current integrated system.","operationId":"GetAvailableMediaLanguages","consumes":["application/json"],"produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"type":"string"}}}}}},"/api/HCCMedia/Translate":{"post":{"tags":["HCCMedia"],"summary":"Translates words or phrases from a specified language to a list of other specified languages.","operationId":"Translate","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.TranslationModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Provider.MediaData.TranslatedItem"}}}}}},"/api/HCCPatient/ProfileGet":{"post":{"tags":["HCCPatient"],"summary":"Patient Profile Get","description":"Returns a profile for a patient via profile ID.","operationId":"PatientProfileGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.PatientProfileRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.PatientProfileModel"}}}}},"/api/HCCPatient/Register":{"post":{"tags":["HCCPatient"],"summary":"Patient Register","description":"The method will create a new Patient record in the HealthCloud database.","operationId":"PatientRegister","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.PatientRegisterModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.PatientRegistrationResultModel"}}}}},"/api/HCCPatient/ProfileUpdate":{"post":{"tags":["HCCPatient"],"summary":"Patient Profile Update","description":"This API endpoint will update a patient's profile","operationId":"PatientProfileUpdate","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.PatientUpdateModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.PatientProfileModel"}}}}},"/api/HCCPatient/CareProviderSearch":{"post":{"tags":["HCCPatient"],"summary":"Healthcare Provider Search","description":"This API will search for any available Healthcare providers","operationId":"CareProviderSearch","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.CareProviderSearchModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.GridResultModel`1[[HealthCloud.Models.Api.Patient.CareProviderSearchResult, HealthCloud, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"}}}}},"/api/HCCPatient/CompanySearch":{"post":{"tags":["HCCPatient"],"summary":"Company Search","description":"This API will return companies based on the search criteria","operationId":"CompanySearch","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.CompanySearchModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.GridResultModel`1[[HealthCloud.Models.Api.Patient.CompanySearchResult, HealthCloud, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"}}}}},"/api/HCCPatient/CreatePatientBooking":{"post":{"tags":["HCCPatient"],"summary":"Patient Booking Create","description":"This API endpoint will create a booking for the patient with the healthcare provider","operationId":"CreatePatientBooking","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.PatientBookingModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.PatientBookingResult"}}}}},"/api/HCCPatient/PatientBookingSearch":{"post":{"tags":["HCCPatient"],"summary":"Patient Booking Search","description":"This API endpoint will return the specified patient's booking's based on the filter criteria.","operationId":"PatientBookingSearch","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.PatientBookingSearchModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.GridResultModel`1[[HealthCloud.Models.Api.Patient.PatientBookingItemModel, HealthCloud, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"}}}}},"/api/HCCPatient/CancelBooking":{"post":{"tags":["HCCPatient"],"summary":"Patient Booking Cancel","description":"This API endpoint will cancel the patient's booking.","operationId":"CancelBooking","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.CancelBookingModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.OperationResultModel"}}}}},"/api/HCCSecurity/OTPVerification":{"post":{"tags":["HCCSecurity"],"summary":"Verifies a One Time Pin that was Generated for a user, the toen expires after 1 hour","operationId":"OTPVerification","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.OTPAuthRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.OperationResultModel"}}}}},"/api/HCCSecurity/OTPRequest":{"post":{"tags":["HCCSecurity"],"summary":"Requests a One Time Pin and sends the generated code to the user's Email Address","operationId":"OTPRequest","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.OTPRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.OperationResultModel"}}}}},"/api/HCCSecurity/LoginPatient":{"post":{"tags":["HCCSecurity"],"summary":"Login Patient","description":"This API endpoint will return a token for a patient login request.","operationId":"LoginPatient","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.LoginModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.LoginResultModel"}}}}},"/api/HCCSecurity/LoginCareProvider":{"post":{"tags":["HCCSecurity"],"summary":"Login Healthcare Provider","description":"This API endpoint will return a token for a Healthcare Provider login request.","operationId":"LoginCareProvider","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.LoginModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.LoginResultModel"}}}}},"/api/HCCSecurity/GetDeviceLinkURL":{"post":{"tags":["HCCSecurity"],"summary":"Get Device Link URL","description":"This API endpoint will return a URL which will allow a patient to be logged in once navigated to.","operationId":"HCCSecurityGetDeviceLinkURL","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.DeviceLinkURLRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"string"}}}}},"/api/HCCSecurity/RequestDeviceLinkURL":{"post":{"tags":["HCCSecurity"],"summary":"Request Device Link URL","description":"This API endpoint will return a URL (as an object) which will allow a patient to be logged in once navigated to.","operationId":"HCCSecurityRequestDeviceLinkURL","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.DeviceLinkURLRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.RequestDeviceLinkURLResultModel"}}}}},"/api/HCCSecurity/RetrieveProfileIdFromToken":{"post":{"tags":["HCCSecurity"],"summary":"Retrieve Profile Id From Token","description":"This method will be used to retrieve the ProfileId from a Single Sign-On (SSO) operation when HealthCloud has completed a \r\nlogin sequence.","operationId":"RetrieveProfileIdFromToken","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.ProfileFromTokenRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.ProfileFromTokenResult"}}}}},"/api/HCCSecurity/RecoverPatientPassword":{"post":{"tags":["HCCSecurity"],"summary":"Recover Patient Password","description":"This API endpoint will generate a recovery password email for the email provided.","operationId":"RecoverPatientPassword","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.RecoverPasswordModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.OperationResultModel"}}}}},"/api/HCCSecurity/RecoverCareProviderPassword":{"post":{"tags":["HCCSecurity"],"summary":"Recover Healthcare Provider Password","description":"This API endpoint will generate a recover password email for the email provided.","operationId":"RecoverCareProviderPassword","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.RecoverPasswordModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.OperationResultModel"}}}}},"/api/HCCSecurity/ChangePatientPassword":{"post":{"tags":["HCCSecurity"],"summary":"Change Patient Password","description":"This API endpoint will change the supplied accounts password.","operationId":"ChangePatientPassword","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.ChangePasswordModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.OperationResultModel"}}}}},"/api/HCCSecurity/ChangeCareProviderPassword":{"post":{"tags":["HCCSecurity"],"summary":"Change Healthcare Provider Password","description":"This API endpoint will change the supplied accounts password.","operationId":"ChangeCareProviderPassword","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.Security.ChangePasswordModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.OperationResultModel"}}}}},"/api/PersonalHealthRecord/PatientHealthRecordSave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Health Record Save","description":"This method adds the specified data to the patient’s health record","operationId":"PatientHealthRecordSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientHealthSummary.PatientRecordModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientHealthSummary.PatientHealthSummaryResult"}}}}},"/api/PersonalHealthRecord/PatientHealthSummaryGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Health Summary Get","description":"This method retrieves patient’s health record","operationId":"PatientHealthSummaryGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientHealthSummary.PatientSummaryRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientHealthSummary.PatientHealthSummaryResult"}}}}},"/api/PersonalHealthRecord/PatientDietSave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Diet Save","description":"Allows the patient to add or update a Diet record.","operationId":"PatientDietSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientDietModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientDietModel"}}}}},"/api/PersonalHealthRecord/PatientDietList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Diet List","description":"Returns the patient's entire Diet History.","operationId":"PatientDietList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientDietModel"}}}}}},"/api/PersonalHealthRecord/PatientDietGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Diet Get","description":"Returns the details of a specific Diet record.","operationId":"PatientDietGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientDietModel"}}}}},"/api/PersonalHealthRecord/PatientDietRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Diet Remove","description":"Allows the patient to remove a Diet record from their profile.","operationId":"PatientDietRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientActivitySave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Wellness Activity Save","description":"Allows the patient to add or update a Activity record.","operationId":"PatientActivitySave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientActivityModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientActivityModel"}}}}},"/api/PersonalHealthRecord/PatientActivityList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Wellness Activity List","description":"Returns the patient's entire Activity History.","operationId":"PatientActivityList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientActivityModel"}}}}}},"/api/PersonalHealthRecord/PatientActivityGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Wellness Activity Get","description":"Returns the details of a specific Activity record.","operationId":"PatientActivityGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientActivityModel"}}}}},"/api/PersonalHealthRecord/PatientActivityRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Wellness Activity Remove","description":"Allows the patient to remove an activity record from their profile.","operationId":"PatientActivityRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientMoodSave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Mood Save","description":"Allows the patient to add or update a Mood record.","operationId":"PatientMoodSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientMoodModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientMoodModel"}}}}},"/api/PersonalHealthRecord/PatientMoodList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Mood List","description":"Returns the patient's entire Mood History.","operationId":"PatientMoodList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientMoodModel"}}}}}},"/api/PersonalHealthRecord/PatientMoodGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Mood Get","description":"Returns the details of a specific Mood record.","operationId":"PatientMoodGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientMoodModel"}}}}},"/api/PersonalHealthRecord/PatientMoodRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Mood Remove","description":"Allows the patient to remove a Mood record from their profile.","operationId":"PatientMoodRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientAlcoholUsageSave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Alcohol Usage Save","description":"Allows the patient to add or update a Alcohol Usage record.","operationId":"PatientAlcoholUsageSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientAlcoholUsageModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientAlcoholUsageModel"}}}}},"/api/PersonalHealthRecord/PatientAlcoholUsageList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Alcohol Usage List","description":"Returns the patient's entire Alcohol Usage History.","operationId":"PatientAlcoholUsageList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientAlcoholUsageModel"}}}}}},"/api/PersonalHealthRecord/PatientAlcoholUsageGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Alcohol Usage Get","description":"Returns the details of a specific Alcohol Usage record.","operationId":"PatientAlcoholUsageGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientAlcoholUsageModel"}}}}},"/api/PersonalHealthRecord/PatientAlcoholUsageRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Alcohol Usage Remove","description":"Allows the patient to remove a Alcohol Usage record from their profile.","operationId":"PatientAlcoholUsageRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientTobaccoUsageSave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Tobacco Usage Save","description":"Allows the patient to add or update a Tobacco Usage record.","operationId":"PatientTobaccoUsageSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientTobaccoUsageModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientTobaccoUsageModel"}}}}},"/api/PersonalHealthRecord/PatientTobaccoUsageList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Tobacco Usage List","description":"Returns the patient's entire Tobacco Usage History.","operationId":"PatientTobaccoUsageList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientTobaccoUsageModel"}}}}}},"/api/PersonalHealthRecord/PatientTobaccoUsageGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Tobacco Usage Get","description":"Returns the details of a specific Tobacco Usage record.","operationId":"PatientTobaccoUsageGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientTobaccoUsageModel"}}}}},"/api/PersonalHealthRecord/PatientTobaccoUsageRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Tobacco Usage Remove","description":"Allows the patient to remove a Tobacco Usage record from their profile.","operationId":"PatientTobaccoUsageRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientResultSave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Result Save","description":"Allows the patient to add or update a Result record.","operationId":"PatientResultSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientResultModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientResultModel"}}}}},"/api/PersonalHealthRecord/PatientResultList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Result List","description":"Returns the patient's entire Result History.","operationId":"PatientResultList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientResultModel"}}}}}},"/api/PersonalHealthRecord/PatientResultGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Result Get","description":"Returns the details of a specific Result record.","operationId":"PatientResultGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientResultModel"}}}}},"/api/PersonalHealthRecord/PatientResultRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Result Remove","description":"Allows the patient to remove a Result record from their profile.","operationId":"PatientResultRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientImmunizationSave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Immunization Save","description":"Allows the patient to add or update an Immunization record.","operationId":"PatientImmunizationSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientImmunizationModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientImmunizationModel"}}}}},"/api/PersonalHealthRecord/PatientImmunizationList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Immunization List","description":"Returns the patient's entire Immunization collection.","operationId":"PatientImmunizationList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientImmunizationModel"}}}}}},"/api/PersonalHealthRecord/PatientImmunizationGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Immunization Get","description":"Returns the details of a specific Immunization record.","operationId":"PatientImmunizationGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientImmunizationModel"}}}}},"/api/PersonalHealthRecord/PatientImmunizationRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Immunization Remove","description":"Allows the patient to remove a Immunization record from their profile.","operationId":"PatientImmunizationRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientMedicationSave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Medication Save","description":"Allows the patient to add or update a Medication record.","operationId":"PatientMedicationSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientMedicationModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientMedicationModel"}}}}},"/api/PersonalHealthRecord/PatientMedicationList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Medication List","description":"Returns the patient's entire Medication History.","operationId":"PatientMedicationList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientMedicationModel"}}}}}},"/api/PersonalHealthRecord/PatientMedicationGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Medication Get","description":"Returns the details of a specific Medication record.","operationId":"PatientMedicationGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientMedicationModel"}}}}},"/api/PersonalHealthRecord/PatientMedicationRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Medication Remove","description":"Allows the patient to remove a Medication record from their profile.","operationId":"PatientMedicationRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientProcedureSave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Procedure Save","description":"Allows the patient to add or update a Procedure record.","operationId":"PatientProcedureSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientProcedureModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientProcedureModel"}}}}},"/api/PersonalHealthRecord/PatientProcedureList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Procedure List","description":"Returns the patient's entire Procedure History.","operationId":"PatientProcedureList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientProcedureModel"}}}}}},"/api/PersonalHealthRecord/PatientProcedureGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Procedure Get","description":"Returns the details of a specific Procedure record.","operationId":"PatientProcedureGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientProcedureModel"}}}}},"/api/PersonalHealthRecord/PatientProcedureRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Procedure Remove","description":"Allows the patient to remove a Procedure record from their profile.","operationId":"PatientProcedureRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientDiagnosisSave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Diagnosis Save","description":"Allows the patient to add or update a Diagnosis record.","operationId":"PatientDiagnosisSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientDiagnosisModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientDiagnosisModel"}}}}},"/api/PersonalHealthRecord/PatientDiagnosisList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Diagnosis List","description":"Returns the patient's entire Diagnosis History.","operationId":"PatientDiagnosisList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientDiagnosisModel"}}}}}},"/api/PersonalHealthRecord/PatientEncounterDiagnosisGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Diagnosis Get","description":"Returns the details of a specific Diagnosis record.","operationId":"PatientEncounterDiagnosisGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientDiagnosisModel"}}}}},"/api/PersonalHealthRecord/PatientDiagnosisRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Diagnosis Remove","description":"Allows the patient to remove a Diagnosis record from their profile.","operationId":"PatientDiagnosisRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientContactSave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Contact Save","description":"Allows the patient to add or update a Contact record.","operationId":"PatientContactSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientContactModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientContactModel"}}}}},"/api/PersonalHealthRecord/PatientContactList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Contact List","description":"Retrieve the patient's entire Contact collection.","operationId":"PatientContactList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientContactModel"}}}}}},"/api/PersonalHealthRecord/PatientContactGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Contact Get","description":"Returns the details of a specific Contact record.","operationId":"PatientContactGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientContactModel"}}}}},"/api/PersonalHealthRecord/PatientContactRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Contact Remove","description":"Allows the patient to remove a Contact record from their profile.","operationId":"PatientContactRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientAllergySave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Allergy Save","description":"Allows the patient to add or update a Allergy record.","operationId":"PatientAllergySave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientAllergyModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientAllergyModel"}}}}},"/api/PersonalHealthRecord/PatientAllergyList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Allergy List","description":"Retrieve the patient's entire Allergy collection.","operationId":"PatientAllergyList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientAllergyModel"}}}}}},"/api/PersonalHealthRecord/PatientAllergyGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Allergy Get","description":"Returns the details of a specific Allergy record.","operationId":"PatientAllergyGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientAllergyModel"}}}}},"/api/PersonalHealthRecord/PatientAllergyRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Allergy Remove","description":"Allows the patient to remove a Allergy record from their profile.","operationId":"PatientAllergyRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientProblemSave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Problem Save","description":"Allows the patient to add or update a Medical Problem record.","operationId":"PatientProblemSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.ProblemModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.ProblemModel"}}}}},"/api/PersonalHealthRecord/PatientProblemList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Problem List","description":"Retrieve the patient's entire Medical Problem History.","operationId":"PatientProblemList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.ProblemModel"}}}}}},"/api/PersonalHealthRecord/PatientProblemGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Problem Get","description":"Returns the details of a specific Medical Problem record.","operationId":"PatientProblemGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.ProblemModel"}}}}},"/api/PersonalHealthRecord/PatientProblemRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Problem Remove","description":"Allows the patient to remove a Medical Problem record from their profile.","operationId":"PatientProblemRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientFamilyHistorySave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Family History Save","description":"Allows the patient to add or update a Family History record.","operationId":"PatientFamilyHistorySave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientFamilyHistoryModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientFamilyHistoryModel"}}}}},"/api/PersonalHealthRecord/PatientFamilyHistoryList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Family History List","description":"Retrieve the patient's entire Family History Collection.","operationId":"PatientFamilyHistoryList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientFamilyHistoryModel"}}}}}},"/api/PersonalHealthRecord/PatientFamilyHistoryGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Family History Get","description":"Returns the details of a specific Family History record.","operationId":"PatientFamilyHistoryGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientFamilyHistoryModel"}}}}},"/api/PersonalHealthRecord/PatientFamilyHistoryRemove":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Family History Remove","description":"Allows the patient to remove a Family History record from their profile.","operationId":"PatientFamilyHistoryRemove","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"/api/PersonalHealthRecord/PatientFamilyHistoryProblemSave":{"post":{"tags":["PersonalHealthRecord"],"summary":"Family History Problem Save","description":"Allows the patient to add or update a Family History Problem record.","operationId":"PatientFamilyHistoryProblemSave","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.ProblemModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.ProblemModel"}}}}},"/api/PersonalHealthRecord/PatientFamilyHistoryProblemList":{"post":{"tags":["PersonalHealthRecord"],"summary":"Family History Problem List","description":"Retrieve the patient's entire Family History Problem Collection.","operationId":"PatientFamilyHistoryProblemList","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.ProblemModel"}}}}}},"/api/PersonalHealthRecord/PatientFamilyHistoryProblemGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Family History Problem Get","description":"Returns the details of a specific Family History Problem record.","operationId":"PatientFamilyHistoryProblemGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PHRIdModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.ProblemModel"}}}}},"/api/PersonalHealthRecord/PatientBiometricsGet":{"post":{"tags":["PersonalHealthRecord"],"summary":"Patient Biometrics Get","description":"Gets the Biometrics of the patient for a specified date range","operationId":"PatientBiometricsGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientBiometricsRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientBiometricsModel"}}}}}},"/api/PointOfCare/RegisterPatient":{"post":{"tags":["PointOfCare"],"summary":"Patient Registration without login capability","description":"The method will create a new Patient record in the HealthCloud database.","operationId":"RegisterPatient","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"model","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PointOfCare.PointOfCarePatientRegisterModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PointOfCare.PointOfCarePatientRegistrationResult"}}}}},"/api/PointOfCare/UploadPointOfCareTestResult":{"post":{"tags":["PointOfCare"],"summary":"Point of Care Test Result Submission","description":"A custom method to upload Point of Care Device Test Results","operationId":"UploadPointOfCareTestResult","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PointOfCare.ResultUploadRequestModel"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.PointOfCareResponseModel"}}}}}},"definitions":{"HealthCloud.Models.Api.ActivityProfile.ActivityProfileRegisterModel":{"required":["clientProfileCode"],"type":"object","properties":{"clientProfileCode":{"description":"a varchar(50) id unique to an integrated system.","maxLength":50,"type":"string"},"schemeMemberCodes":{"description":"a collection of unique reference codes assoicated with the client profile, atleast one code is required.","uniqueItems":false,"type":"array","items":{"type":"string"}},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.ActivityProfile.ActivityProfileResultModel":{"type":"object","properties":{"profileId":{"format":"uuid","description":"The HealthCloud Profile ID for a client profile code.","type":"string"}}},"HealthCloud.Models.Api.ActivityProfile.ActivityProfileUpdateModel":{"required":["clientProfileCode","newClientProfileCode"],"type":"object","properties":{"clientProfileCode":{"description":"The Existing Client Profile Code","type":"string"},"newClientProfileCode":{"description":"The new Client Profile Code","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.ActivityProfile.ActivityProfileUpdateResultModel":{"type":"object","properties":{"profileId":{"format":"uuid","type":"string"}}},"HealthCloud.Models.Api.ActivityProfile.DeregisterProfileFromSchemeRequestModel":{"required":["clientProfileCode"],"type":"object","properties":{"clientProfileCode":{"description":"varchar(50) id of a client unique to an integrated system","maxLength":50,"type":"string"},"schemeMemberCodes":{"description":"a collection of unique reference codes to remove from the client's profile","uniqueItems":false,"type":"array","items":{"type":"string"}},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.ActivityProfile.DeleteProfileResultModel":{"type":"object","properties":{"success":{"type":"boolean"}}},"HealthCloud.Models.Api.ActivityProfile.ActivityDeviceLinkURLRequestModel":{"required":["clientProfileCode","callerPageName","returnUrl"],"type":"object","properties":{"clientProfileCode":{"description":"varchar(50) id of a client unique to an integrated system","type":"string"},"callerPageName":{"description":"The name of the integrated system","type":"string"},"returnUrl":{"description":"The returning url, this is to allow user to navigate back to the calling system","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.ActivityProfile.ActivityDeviceLinkURLResultModel":{"type":"object","properties":{"redirectURL":{"type":"string"}}},"HealthCloud.Models.Api.ActivityProfile.ActivityProfileModel":{"required":["clientProfileCode"],"type":"object","properties":{"clientProfileCode":{"description":"a varchar(50) id unique to an integrated system","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.ActivityProfile.ProfileIdLookupResultModel":{"type":"object","properties":{"profileId":{"format":"uuid","type":"string"}}},"HealthCloud.Models.Api.ActivityProfile.ActivityProfileDailySummaryRequestModel":{"required":["clientProfileCode"],"type":"object","properties":{"clientProfileCode":{"description":"varchar(50) id of a client unique to an integrated system","type":"string"},"fromDate":{"format":"date-time","description":"The startDate of the activites to fetch","type":"string"},"toDate":{"format":"date-time","description":"The end of the activites to fetch","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.ActivityProfile.ActivityProfileDailySummaryResponseModel":{"type":"object","properties":{"profileId":{"format":"uuid","type":"string"},"clientProfileCode":{"type":"string"},"schemeMemberCodes":{"uniqueItems":false,"type":"array","items":{"type":"string"}},"activitySummary":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.ActivityProfile.DeviceActivitySummaryModel"}}}},"HealthCloud.Models.Api.ActivityProfile.DeviceActivitySummaryModel":{"type":"object","properties":{"deviceCode":{"type":"string"},"deviceName":{"type":"string"},"deviceProvider":{"type":"string"},"activityDate":{"format":"date-time","type":"string"},"created":{"format":"date-time","type":"string"},"updated":{"format":"date-time","type":"string"},"sleepInMinutes":{"format":"double","type":"number"},"heartRate":{"format":"double","type":"number"},"maxHeartRate":{"format":"double","type":"number"},"minHeartRate":{"format":"double","type":"number"},"restHeartRate":{"format":"double","type":"number"},"heartRateUnit":{"type":"string"},"calories":{"format":"double","type":"number"},"steps":{"format":"int32","type":"integer"},"distanceInMeters":{"format":"double","type":"number"},"vO2Max":{"format":"double","type":"number"},"fitnessAge":{"format":"int32","type":"integer"},"restStressDurationInSeconds":{"format":"int32","type":"integer"},"stressDurationInSeconds":{"format":"int32","type":"integer"},"lowStressDurationInSeconds":{"format":"int32","type":"integer"},"mediumStressDurationInSeconds":{"format":"int32","type":"integer"},"highStressDurationInSeconds":{"format":"int32","type":"integer"},"activityStressDurationInSeconds":{"format":"int32","type":"integer"},"averageStressLevel":{"format":"int32","type":"integer"},"maxStressLevel":{"format":"int32","type":"integer"},"stressQualifier":{"type":"string"}}},"HealthCloud.Models.Api.ActivityProfile.InactiveDevicesResultModel":{"type":"object","properties":{"providerType":{"description":"The Enum value of the fitness provider","enum":["FitBit","GoogleFit","Striiv","Garmin","TomTom","Polar","HealthKit"],"type":"string"},"status":{"description":"The Current Status of the device","enum":["Active","Disabled","Error"],"type":"string"},"errorMessage":{"description":"Message of the latest Error that has occured","type":"string"},"lastSynced":{"format":"date-time","description":"The last timestamp when the device has successfully synced","type":"string"},"providerName":{"description":"The name of fitness provider","type":"string","readOnly":true}}},"HealthCloud.Models.Api.PHR.Custom.WellnessEventModel":{"type":"object","properties":{"eventData":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientHealthSummary.EventInfoModel"},"patientWellnessRecords":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.PatientWellnessRecordModel"}},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.PHR.PatientHealthSummary.EventInfoModel":{"type":"object","properties":{"eventId":{"description":"Code that uniqly identifies the current event","type":"string"},"eventDate":{"format":"date-time","description":"Date and time of the event","type":"string"},"eventName":{"description":"Name of the event","type":"string"}}},"HealthCloud.Models.Api.PHR.Custom.PatientWellnessRecordModel":{"type":"object","properties":{"patientId":{"format":"uuid","description":"The UniqueIdentifier from HealthCloud of the patient","type":"string"},"companyName":{"description":"Company the patient works for","type":"string"},"branch":{"description":"The company branch","type":"string"},"division":{"description":"Division within the company","type":"string"},"employment":{"description":"Type of employment","enum":["Permanent","Contractor","Temporary"],"type":"string"},"firstname":{"description":"The patient's full name","type":"string"},"surname":{"description":"The patient's surname","type":"string"},"title":{"description":"The patient's title","type":"string"},"idNumber":{"description":"The patient's South African Id number","type":"string"},"passportNumber":{"description":"The patient's passport number","type":"string"},"gender":{"description":"The patient's Gender","enum":["Male","Female","Other","Unknown"],"type":"string"},"dateOfBirth":{"format":"date-time","description":"The patient's date of birth","type":"string"},"race":{"description":"The patient's Race","enum":["African","Coloured","Indian","White","Other"],"type":"string"},"cellNumber":{"description":"The patient's mobile number","type":"string"},"workNumber":{"description":"The patient's work number","type":"string"},"emergencyContactNumber":{"description":"The patient's emergancy contact","type":"string"},"medicalAid":{"description":"medical aid the patient belongs to","type":"string"},"medicalAidNumber":{"description":"The patient's medicalaid number","type":"string"},"isMainMember":{"description":"Is the patient the main member of the medical aid","type":"boolean"},"familyHistory":{"description":"Does the patient have any family medical problems","type":"string"},"medication":{"description":"Is the patient currently taking any medication","type":"string"},"tobaccoUsage":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientHealthSummary.FrequencyItem","description":"Patient's TobaccoUsage info"},"biometric":{"$ref":"#/definitions/HealthCloud.BL.Provider.PHR.PHRPatientData.BiometricModel","description":"Patient's Biometric info"},"excersices":{"description":"List of exercises","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientHealthSummary.TimestampItem"}},"testResults":{"description":"List of test results","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientHealthSummary.ResultItem"}}}},"HealthCloud.Models.Api.PHR.PatientHealthSummary.FrequencyItem":{"type":"object","properties":{"id":{"format":"uuid","description":"Id of the item to update","type":"string"},"startDate":{"format":"date-time","description":"Date the patient started using the substance","type":"string"},"endDate":{"format":"date-time","description":"Date the patient stoped using the substance","type":"string"},"frequency":{"format":"int32","description":"The quantity in a period","type":"integer"},"period":{"description":"The measuremnt ex: per day, per week etc","type":"string"},"notes":{"description":"Any additional info","type":"string"}}},"HealthCloud.BL.Provider.PHR.PHRPatientData.BiometricModel":{"type":"object","properties":{"biometricTimeStamp":{"format":"date-time","type":"string"},"heightInCentimeters":{"format":"double","type":"number"},"weightInKilograms":{"format":"double","type":"number"},"waistCircumferenceInCentimeters":{"format":"double","type":"number"},"hipCircumferenceInCentimeters":{"format":"double","type":"number"},"systolicBloodPressureInMmHg":{"format":"double","type":"number"},"diastolicBloodPressureInMmHg":{"format":"double","type":"number"},"glucoseInMmolL":{"format":"double","type":"number"},"totalCholesterolMmolL":{"format":"double","type":"number"},"temperatureInCelsius":{"format":"double","type":"number"},"hdlMmolL":{"format":"double","type":"number"},"ldlMmolL":{"format":"double","type":"number"},"triglycerideMmolL":{"format":"double","type":"number"}}},"HealthCloud.Models.Api.PHR.PatientHealthSummary.TimestampItem":{"required":["timestamp","description"],"type":"object","properties":{"id":{"format":"uuid","description":"Id of the item to update","type":"string"},"timestamp":{"format":"date-time","description":"Date the patient started the activity","type":"string"},"description":{"description":"the name of the activity","type":"string"}}},"HealthCloud.Models.Api.PHR.PatientHealthSummary.ResultItem":{"type":"object","properties":{"id":{"format":"uuid","description":"Id of the result to update","type":"string"},"timestamp":{"format":"date-time","description":"Date and time the result was received","type":"string"},"name":{"description":"The medical name of the result","type":"string"},"description":{"description":"a short description on the result","type":"string"},"batchNumber":{"description":"Unique batch number if available","type":"string"},"testNumber":{"description":"Unique test number if available","type":"string"},"result":{"description":"The Conclusion of the result","enum":["Positive","Negative","Inconclusive"],"type":"string"},"location":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientHealthSummary.LocationModel","description":"Location where the test was done"},"careproviderDetails":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.PatientHealthSummary.CareproviderDetailsModel","description":"Details of the care provider"}}},"HealthCloud.Models.Api.PHR.PatientHealthSummary.LocationModel":{"required":["address","facilityName"],"type":"object","properties":{"address":{"description":"The physical address","type":"string"},"facilityName":{"description":"The Name of the facility","type":"string"}}},"HealthCloud.Models.Api.PHR.PatientHealthSummary.CareproviderDetailsModel":{"required":["firstName","surname","credentials","practiceName"],"type":"object","properties":{"firstName":{"description":"The Healthcare Provider's full name","type":"string"},"surname":{"description":"The Healthcare Provider's surname","type":"string"},"credentials":{"description":"The Healthcare Provider's Credentials","type":"string"},"practiceName":{"description":"The Healthcare Provider's practice name","type":"string"}}},"HealthCloud.Models.Api.Patient.PatientWellnessRegisterModel":{"required":["firstName","surname","dateOfBirth"],"type":"object","properties":{"firstName":{"description":"The patient's full name","maxLength":200,"type":"string"},"surname":{"description":"The patient's surname","maxLength":200,"type":"string"},"title":{"description":"The patient's title","maxLength":20,"type":"string"},"mobileNumber":{"description":"The patient's mobile number","maxLength":15,"type":"string"},"alternateNumber":{"description":"Alternate Contact number","maxLength":15,"type":"string"},"dateOfBirth":{"format":"date-time","description":"The patient's date of birth","type":"string"},"rsaIdNumber":{"description":"The patient's South African Id number","maxLength":13,"type":"string"},"passportNumber":{"description":"The patient's passport number","maxLength":20,"type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.Patient.PatientRegistrationResultModel":{"type":"object","properties":{"registrationResult":{"description":"Result of the registration request","enum":["RegistrationOK","ProfileExists","EnterOTP"],"type":"string"},"profileId":{"format":"uuid","description":"the unique identifier of the newely registered patient","type":"string"},"legalReferenceNumber":{"type":"string"},"errorResponse":{"description":"The error message, only populated if an error has occured","type":"string"}}},"HealthCloud.Models.Api.ProviderData.StressRequestModel":{"description":"Request model for Stress data","required":["profileId"],"type":"object","properties":{"profileId":{"format":"uuid","description":"Unique identifier that links to the patient","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.ProviderData.GarminStressDataModel":{"type":"object","properties":{"activeGarminDeviceCount":{"format":"int32","description":"The number of active Garmin devices linked to this profile","type":"integer"},"garminDeviceCount":{"format":"int32","description":"The number of Garmin devices linked to this profile (active and inactive)","type":"integer"},"stressData":{"description":"The stress data for the previous three days","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.ProviderData.StressDataModel"}}}},"HealthCloud.Models.Api.ProviderData.StressDataModel":{"type":"object","properties":{"restStressDurationInSeconds":{"format":"int32","description":"The number of seconds in this monitoring period where stress level measurements were in the restful range (1 to 25).","type":"integer"},"stressDurationInSeconds":{"format":"int32","description":"The number of seconds in this monitoring period where stress level measurements were in the stressful range (26-100).","type":"integer"},"lowStressDurationInSeconds":{"format":"int32","description":"The portion of the user’s stress duration where the measured stress score was in the low range (26-50).","type":"integer"},"mediumStressDurationInSeconds":{"format":"int32","description":"The portion of the user’s stress duration where the measured stress score was in the medium range (51-75).","type":"integer"},"highStressDurationInSeconds":{"format":"int32","description":"The portion of the user’s stress duration where the measured stress score was in the high range (76-100).","type":"integer"},"activityStressDurationInSeconds":{"format":"int32","description":"The number of seconds in this monitoring period where the user was engaging in physical activity and so stress measurement was unreliable.","type":"integer"},"averageStressLevel":{"format":"int32","description":"User’s average stress level in this monitoring period, measured from 1 to 100","type":"integer"},"maxStressLevel":{"format":"int32","description":"The highest stress level measurement taken during this monitoring period","type":"integer"},"stressQualifier":{"description":"A qualitative label applied based on all stress measurements in this monitoring period. Possible values: unknown, calm, balanced, stressful, very_stressful, calm_awake, balanced_awake, stressful_awake, very_stressful_awake.","type":"string"},"deviceCode":{"description":"Unique code that identifies the device","type":"string"},"deviceName":{"description":"Name of the device used","type":"string"},"deviceProvider":{"description":"The Provider of the device(ex. FitBit)","type":"string"},"activityDateTime":{"format":"date-time","description":"Date and Time of when the activity took place","type":"string"},"dateUpdated":{"format":"date-time","description":"Date of when the activity was updated","type":"string"},"dateCreated":{"format":"date-time","description":"Created date","type":"string"}}},"HealthCloud.Models.Api.PHR.Custom.PointOfCareRequestModel":{"description":"Point of Care Request Model","required":["firstName","surname","dateOfBirth","gender"],"type":"object","properties":{"profileId":{"format":"uuid","description":"Unique Patient Profile Id","type":"string"},"firstName":{"description":"Patient First Name","type":"string"},"surname":{"description":"Patient Surname","type":"string"},"dateOfBirth":{"format":"date-time","description":"Patient Date of Birth","type":"string"},"gender":{"description":"Gender of Patient","enum":["Male","Female","Other","Unknown"],"type":"string"},"idNumber":{"description":"Patient Identity Number","type":"string"},"passportNumber":{"description":"Patient Passport Number","type":"string"},"emailAddress":{"description":"Patient Email Address","type":"string"},"mobileNumber":{"description":"Mobile Number for Patient","type":"string"},"alternateNumber":{"description":"Alternate Number for Patient","type":"string"},"medicalAid":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.MedicalAidModel","description":"The Patient's Medical Aid information"},"event":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.PointOfCareEvent","description":"Event Information"},"referenceRanges":{"description":"Reference Ranges","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.ReferenceRanges"}},"testResults":{"description":"Test Results","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.PointOfCareTestResult"}},"additionalData":{"description":"Patient Additional Data","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.AdditionalDataModel"}},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.PHR.Custom.MedicalAidModel":{"required":["medicalAid","medicalAidNumber"],"type":"object","properties":{"medicalAid":{"description":"Medical Aid the Patient belongs to (Use /api/HCCMasterData/MedicalAidList for list of Medical Aids)","type":"string"},"medicalAidNumber":{"description":"The Patient's Medical Aid Number","type":"string"},"isMainMember":{"description":"Is the Patient the Main Member on this Medical Aid","type":"boolean"},"beneficiaryNumber":{"description":"Patient's Beneficiary Number","type":"string"}}},"HealthCloud.Models.Api.PHR.Custom.PointOfCareEvent":{"description":"Point of Care Event","required":["name","description","locationDeviceName"],"type":"object","properties":{"name":{"description":"Event name / Id","type":"string"},"description":{"description":"Event description","type":"string"},"company":{"description":"Company name where event is taking place","type":"string"},"locationDeviceName":{"description":"Unique Name / Id of the device linking Point of Care device to HealthCloud e.g. onsite Rasberry Pi","type":"string"},"address":{"description":"Address where readings are taken","type":"string"},"contactName":{"description":"Contact name for this event","type":"string"},"contactNumber":{"description":"Contact number for this event","type":"string"},"contactEmail":{"description":"Contact email address for this event","type":"string"}}},"HealthCloud.Models.Api.PHR.Custom.ReferenceRanges":{"description":"Reference Ranges","type":"object","properties":{"analyteName":{"description":"Analyte Name","type":"string"},"groups":{"description":"Reference Range Groups","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.ReferenceRangeGroup"}}}},"HealthCloud.Models.Api.PHR.Custom.PointOfCareTestResult":{"description":"Point of Care Test Result","type":"object","properties":{"device":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.PointOfCareDevice","description":"Point of Care Device"},"operator":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.OperatorDetail","description":"Point of Care Device Operator"},"panelDetail":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.PointOfCareDevicePanelDetail","description":"Panel Detail"},"longName":{"description":"Biometric full name","type":"string"},"shortName":{"description":"Biometric short name","type":"string"},"rawResult":{"description":"Raw result from Point of Care Device","type":"string"},"interpretedResult":{"description":"Interpreted Result from Point of Care Device","type":"string"},"units":{"description":"Unit of Measure","type":"string"},"manualTest":{"description":"Was this an Automated test or a Manual test","type":"boolean"},"qualityChecks":{"description":"Quality Checks","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.PHR.Custom.QualityCheck"}},"testDate":{"format":"date-time","description":"Date the Test was performed","type":"string"},"receivedDate":{"format":"date-time","description":"Date the Test results was sent","type":"string"}}},"HealthCloud.Models.Api.PHR.Custom.AdditionalDataModel":{"type":"object","properties":{"key":{"description":"Key","type":"string"},"value":{"description":"Value","type":"string"}}},"HealthCloud.Models.Api.PHR.Custom.ReferenceRangeGroup":{"description":"Reference Range Group","type":"object","properties":{"lowValue":{"format":"double","description":"Low value of range","type":"number"},"highValue":{"format":"double","description":"High value of range","type":"number"},"description":{"description":"Description of range","type":"string"}}},"HealthCloud.Models.Api.PHR.Custom.PointOfCareDevice":{"description":"Point of Care Device","required":["manufacturer","model","serialNumber"],"type":"object","properties":{"pointOfCareDeviceId":{"format":"uuid","description":"Unique Id for this Point of Care Device","type":"string"},"manufacturer":{"description":"Device Manufacturer","type":"string"},"model":{"description":"Device Model","type":"string"},"description":{"description":"Device Description","type":"string"},"serialNumber":{"description":"Device Serial Number","type":"string"},"markId":{"description":"Mark Id","type":"string"}}},"HealthCloud.Models.Api.PHR.Custom.OperatorDetail":{"description":"Healthcare Provider details","required":["firstName","surname","dateOfBirth"],"type":"object","properties":{"profileId":{"format":"uuid","description":"Unique Operator Profile Id","type":"string"},"firstName":{"description":"Operator First Name","type":"string"},"surname":{"description":"Operator Surname","type":"string"},"dateOfBirth":{"format":"date-time","description":"Operator Date of Birth","type":"string"},"idNumber":{"description":"Operator Identity Number","type":"string"},"passportNumber":{"description":"Operator Passport Number","type":"string"},"emailAddress":{"description":"Operator Email Address","type":"string"},"mobileNumber":{"description":"Operator Mobile Number","type":"string"},"alternateNumber":{"description":"Operator Alternate Number","type":"string"}}},"HealthCloud.Models.Api.PHR.Custom.PointOfCareDevicePanelDetail":{"description":"Point of Care Device Panel Detail","type":"object","properties":{"lotNo":{"description":"Lot Number","type":"string"},"expiry":{"format":"date-time","description":"Expiry","type":"string"},"type":{"description":"Type","type":"string"}}},"HealthCloud.Models.Api.PHR.Custom.QualityCheck":{"description":"Quality Check","type":"object","properties":{"description":{"description":"Quality Check Description","type":"string"}}},"HealthCloud.Models.Api.PHR.Custom.PointOfCareResponseModel":{"description":"Point of Care Response Model","type":"object","properties":{"success":{"description":"Indicates if the call was successful","type":"boolean"},"errorDescription":{"description":"Error message with fault description","type":"string"},"transactionId":{"format":"uuid","description":"Transaction Id on Successful call","type":"string"},"profileId":{"format":"uuid","description":"Profile Id on Successful call","type":"string"}}},"HealthCloud.Models.Api.EHR.Lancet.LancetPatientQueryRequest":{"type":"object","properties":{"patientId":{"type":"string"},"patientFirstName":{"type":"string"},"patientSurname":{"type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.EHRPatientSummary":{"type":"object","properties":{"profile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile","description":"The Patient's most latest profile"},"encounters":{"description":"List of the Patient's encounters","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.Summary.EncounterResultModel"}}}},"HealthCloud.BL.Entities.PatientData.PatientProfile":{"type":"object","properties":{"userIdentityId":{"format":"uuid","type":"string"},"userIdentity":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.UserIdentity"},"medicalRecordNumber":{"type":"string"},"lastUpdated":{"format":"date-time","type":"string"},"genderType":{"enum":["Male","Female","Other","Unknown"],"type":"string"},"ethnicityType":{"enum":["Unspecified","Caucasian","Black","Coloured","Asian","Indian"],"type":"string"},"raceCategory":{"enum":["African","Coloured","Indian","White","Other"],"type":"string"},"patientType":{"enum":["Adult","Child"],"type":"string"},"languages":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientLanguage"}},"isDeviceProfile":{"type":"boolean"},"mobileNumber":{"maxLength":15,"type":"string"},"alternateNumber":{"maxLength":15,"type":"string"},"rsaIdNumber":{"maxLength":13,"type":"string"},"passportNumber":{"maxLength":20,"type":"string"},"dateOfBirth":{"format":"date-time","type":"string"},"maritalStatus":{"enum":["Married","Divorced","Widowed","Involoved","NoSexualPartners"],"type":"string"},"qualification":{"type":"string"},"province":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Province"},"provinceId":{"format":"uuid","type":"string"},"physicalAddress":{"maxLength":200,"type":"string"},"postalAddress":{"maxLength":200,"type":"string"},"city":{"maxLength":200,"type":"string"},"suburb":{"maxLength":200,"type":"string"},"postalCode":{"maxLength":200,"type":"string"},"latitude":{"format":"double","type":"number"},"longitude":{"format":"double","type":"number"},"timeZoneOffset":{"format":"int32","type":"integer"},"medicalAid":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalAid"},"medicalAidId":{"format":"uuid","type":"string"},"medicalAidProduct":{"maxLength":200,"type":"string"},"medicalAidPolicyNumber":{"maxLength":15,"type":"string"},"isMainMember":{"type":"boolean"},"beneficiaryNumber":{"maxLength":15,"type":"string"},"emergencyContactName":{"type":"string"},"emergencyNumber":{"maxLength":15,"type":"string"},"emergencyContactNextOfKin":{"type":"string"},"bloodType":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.BloodType"},"bloodTypeId":{"format":"uuid","type":"string"},"employer":{"$ref":"#/definitions/HealthCloud.BL.Entities.EmployerData.Employer"},"employerId":{"format":"uuid","type":"string"},"employmentType":{"enum":["Permanent","Contractor","Temporary"],"type":"string"},"companyName":{"type":"string"},"employerName":{"type":"string"},"branch":{"type":"string"},"division":{"type":"string"},"occupation":{"type":"string"},"workNumber":{"type":"string"},"termsAccepted":{"type":"boolean"},"signatureImage":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.ImageData"},"signatureImageId":{"format":"uuid","type":"string"},"biometrics":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientVitalSign"}},"allergies":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientAllergy"}},"patientProcedures":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProcedure"}},"patientMedicationList":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientMedication"}},"patientImmunizations":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientImmunization"}},"patientDiagnosisList":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientDiagnosis"}},"patientEncounters":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.PatientEncounter"}},"carePlans":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.CarePlanData.CarePlan"}},"integratedSystemPatients":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.IntegratedSystemPatient"}},"activityProfiles":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.ActivityProfileData.ActivityProfile"}},"getTimeZoneOffset":{"format":"int32","type":"integer","readOnly":true}}},"HealthCloud.Models.Api.EHR.Summary.EncounterResultModel":{"type":"object","properties":{"encounterEHRId":{"format":"uuid","description":"The Unique Encounter Id","type":"string"},"requisitionNumber":{"description":"The Unique Encounter Id from the source system","type":"string"},"dataSource":{"description":"The Source system the data was populated from","type":"string"},"dateTime":{"format":"date-time","description":"The Date and time of the visit / encounter","type":"string"},"endDateTime":{"format":"date-time","description":"The end Date and time of the visit / encounter","type":"string"},"isHospitalization":{"description":"Was the Patient Hospitalized","type":"boolean"},"encounterLabTestList":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.Summary.EncounterLabTestModel"}}}},"HealthCloud.BL.Entities.SecurityData.UserIdentity":{"required":["emailAddress"],"type":"object","properties":{"token":{"format":"uuid","type":"string"},"tokenExpiry":{"format":"date-time","type":"string"},"emailAddress":{"maxLength":200,"type":"string"},"hasEmailAddress":{"type":"boolean"},"canLogin":{"type":"boolean"},"otpVerificationRequired":{"type":"boolean"},"accountVerified":{"type":"boolean"},"dateVerified":{"format":"date-time","type":"string"},"title":{"maxLength":20,"type":"string"},"firstName":{"maxLength":200,"type":"string"},"surname":{"maxLength":200,"type":"string"},"maidenName":{"maxLength":200,"type":"string"},"profileImageDataId":{"format":"uuid","type":"string"},"profileImageData":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.ImageData"},"profileRoleType":{"enum":["Admin","Patient","HealthCareProfessional","Company","Secretary","Employer","PointOfCareDeviceOperator"],"type":"string"},"registered":{"format":"date-time","type":"string"},"passwordControl":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.PasswordControl"},"active":{"type":"boolean"},"isSystemAdmin":{"type":"boolean"},"integratedSystemId":{"format":"uuid","type":"string"},"integratedSystem":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystem"},"roles":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.UserIdentityRole"}},"integratedSystemCalls":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystemCall"}},"allowedPrivileges":{"uniqueItems":false,"type":"array","items":{"enum":["UserMaintenance","RoleMaintenance","SettingsMaintenance","IntegratedSystemMaintenance","ProvinceMaintenance","SpecialityMaintenance","ProfessionMaintenance","LanguageMaintenance","MedicalAidMaintenance","BookingSlotSizeMaintenance","BookingMaintenance","APISummaryMaintenance","APIDetailMaintenance","DataExtractMaintenance","MediaSearchHistoryMaintenance","ProtocolRequestMaintenance","ProtocolConsumptionMaintenance","AccessProfile","ViewCalendar","MaintainBookings","CreateReferrals","AccessCompanyMembership","ViewTimeSlots","MaintainTimeSlots","TemplateFormMaintenance","EmployerMaintenance","MediaCategoryMaintenance","IgnoredWordMaintenance","MediaMaintenance","CodeSystemMaintenance","AllergyMaintenance","BloodTypeMaintenance","RelationshipMaintenance","DiagnosisMaintenance","ProcedureMaintenance","BiometricMaintenance","ReasonForVisit","Result","DeviceSummaryReport","PointOfCareSummary","APIRequest","ActivitySummary","MediaStatistics","HealthCloudStatistics","AvatarMaintenance","MediaLanguageMaintenance"],"type":"string"}},"fullName":{"type":"string","readOnly":true},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientLanguage":{"type":"object","properties":{"userIdentityId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"languageId":{"format":"uuid","type":"string"},"language":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Language"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Province":{"required":["name"],"type":"object","properties":{"name":{"maxLength":200,"type":"string"},"active":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.MedicalAid":{"required":["name"],"type":"object","properties":{"name":{"maxLength":200,"type":"string"},"active":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.BloodType":{"type":"object","properties":{"type":{"type":"string"},"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.EmployerData.Employer":{"required":["tradingName","registeredName","registrationNumber","contactNumber","postalAddress","physicalAddress","emailAddress","firstName","surname"],"type":"object","properties":{"tradingName":{"type":"string"},"registeredName":{"type":"string"},"registrationNumber":{"type":"string"},"vatNumber":{"maxLength":50,"type":"string"},"contactNumber":{"maxLength":20,"type":"string"},"postalAddress":{"type":"string"},"physicalAddress":{"type":"string"},"emailAddress":{"maxLength":200,"type":"string"},"firstName":{"maxLength":200,"type":"string"},"surname":{"maxLength":200,"type":"string"},"isActive":{"type":"boolean"},"employerUsers":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.EmployerData.EmployerUser"}},"patients":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.ImageData":{"required":["fileName","fileData"],"type":"object","properties":{"fileName":{"maxLength":500,"type":"string"},"fileData":{"format":"byte","type":"string"},"profiles":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.UserIdentity"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientVitalSign":{"type":"object","properties":{"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"patientTransactionId":{"format":"uuid","type":"string"},"patientTransaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.PointOfCareData.PatientTransaction"},"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"encounterId":{"format":"uuid","type":"string"},"encounter":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.PatientEncounter"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"timeOfMeasurement":{"format":"date-time","type":"string"},"value":{"format":"double","type":"number"},"biometricId":{"format":"uuid","type":"string"},"biometric":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Biometric"},"panelDetailId":{"format":"uuid","type":"string"},"panelDetail":{"$ref":"#/definitions/HealthCloud.BL.Entities.PointOfCareData.PanelDetail"},"isTrusted":{"type":"boolean"},"adHocData":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.AdHocData"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientAllergy":{"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientAllergy"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"allergyId":{"format":"uuid","type":"string"},"allergy":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Allergy"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"severityId":{"format":"uuid","type":"string"},"severity":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Severity"},"substanceId":{"format":"uuid","type":"string"},"substance":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Substance"},"statusId":{"format":"uuid","type":"string"},"status":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Status"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"description":{"maxLength":50,"type":"string"},"isTrusted":{"type":"boolean"},"isRemoved":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientProcedure":{"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProcedure"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"dateOfProcedure":{"format":"date-time","type":"string"},"description":{"maxLength":200,"type":"string"},"source":{"maxLength":200,"type":"string"},"isTrusted":{"type":"boolean"},"isRemoved":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientMedication":{"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientMedication"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"name":{"maxLength":200,"type":"string"},"reason":{"maxLength":500,"type":"string"},"isPrescription":{"type":"boolean"},"dosageQuantity":{"format":"double","type":"number"},"dosageUnitId":{"format":"uuid","type":"string"},"dosageUnit":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MeasurementUnit"},"frequencyQuantity":{"format":"double","type":"number"},"frequencyUnitId":{"format":"uuid","type":"string"},"frequencyUnit":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MeasurementUnit"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"isChronic":{"type":"boolean"},"isTrusted":{"type":"boolean"},"isRemoved":{"type":"boolean"},"prescribedByFirstName":{"maxLength":200,"type":"string"},"prescribedBySurname":{"maxLength":200,"type":"string"},"prescribedByCredentials":{"maxLength":200,"type":"string"},"prescribedByPracticeName":{"maxLength":200,"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientImmunization":{"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientImmunization"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"dateOfImmunization":{"format":"date-time","type":"string"},"description":{"maxLength":200,"type":"string"},"isTrusted":{"type":"boolean"},"isRemoved":{"type":"boolean"},"locationAddress":{"maxLength":200,"type":"string"},"facilityName":{"maxLength":200,"type":"string"},"careProviderCredentials":{"maxLength":200,"type":"string"},"careProviderFirstName":{"maxLength":200,"type":"string"},"careProviderSurname":{"maxLength":200,"type":"string"},"careProviderPracticeName":{"maxLength":200,"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientDiagnosis":{"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientDiagnosis"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"dateOfDiagnosis":{"format":"date-time","type":"string"},"description":{"maxLength":200,"type":"string"},"source":{"maxLength":200,"type":"string"},"isTrusted":{"type":"boolean"},"isRemoved":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.EncounterData.PatientEncounter":{"type":"object","properties":{"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"dataSource":{"type":"string"},"accountNumber":{"type":"string"},"requisitionNumber":{"type":"string"},"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"reasonForVisitId":{"format":"uuid","type":"string"},"reasonForVisit":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.ReasonForVisit"},"description":{"maxLength":200,"type":"string"},"dateTime":{"format":"date-time","type":"string"},"endDateTime":{"format":"date-time","type":"string"},"isHospitalization":{"type":"boolean"},"encounterDiagnosisList":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.EncounterDiagnosis"}},"encounterImmunizations":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.EncounterImmunization"}},"patientEncounterProviders":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.PatientEncounterProvider"}},"encounterNotes":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.EncounterNote"}},"observations":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Observation"}},"encounterLabTests":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.EncounterLabTest"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.CarePlanData.CarePlan":{"type":"object","properties":{"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"modifiedDate":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.IntegratedSystemPatient":{"type":"object","properties":{"ehrPatientProfileId":{"format":"uuid","type":"string"},"ehrPatientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"integratedSystemId":{"format":"uuid","type":"string"},"integratedSystem":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystem"},"medicalRecordNumber":{"type":"string"},"timestamp":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.ActivityProfileData.ActivityProfile":{"required":["clientProfile"],"type":"object","properties":{"clientProfile":{"maxLength":100,"type":"string"},"integratedSystemId":{"format":"uuid","type":"string"},"integratedSystem":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystem"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"created":{"format":"date-time","type":"string"},"lastDataPushed":{"format":"date-time","type":"string"},"activityProfileMemberSchemeCodes":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.ActivityProfileData.ActivityProfileMemberScheme"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.Models.Api.EHR.Summary.EncounterLabTestModel":{"type":"object","properties":{"codeId":{"format":"uuid","description":"HealthCloud Code Id","type":"string"},"loinc":{"description":"Loinc Code","type":"string"},"name":{"description":"The name of the test","type":"string"},"description":{"description":"Short description about the test","type":"string"},"testResults":{"description":"Collection of results","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.EHR.Summary.EncounterLabResultModel"}}}},"HealthCloud.BL.Entities.SecurityData.PasswordControl":{"required":["currentPasswordHash"],"type":"object","properties":{"userIdentityId":{"format":"uuid","type":"string"},"userIdentity":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.UserIdentity"},"currentPasswordHash":{"type":"string"},"failedLoginAttempts":{"format":"int32","type":"integer"},"lockedOut":{"format":"date-time","type":"string"},"deactivated":{"format":"date-time","type":"string"},"lastLogin":{"format":"date-time","type":"string"},"previousLogin":{"format":"date-time","type":"string"},"passwordRecords":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.PasswordRecord"}}}},"HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystem":{"required":["name"],"type":"object","properties":{"apiKey":{"format":"uuid","type":"string"},"secret":{"type":"string"},"timeToLive":{"format":"int32","type":"integer"},"isSecretRequired":{"type":"boolean"},"isDomainFilterRequired":{"type":"boolean"},"isOAUTH2":{"type":"boolean"},"otpVerificationRequired":{"type":"boolean"},"enableRefreshToken":{"type":"boolean"},"tokenType":{"type":"string"},"expiresIn":{"format":"int32","type":"integer"},"accessToken":{"type":"string"},"oautH2TokenURL":{"type":"string"},"bodyParameters":{"type":"string"},"tokenExpiry":{"format":"date-time","type":"string"},"tokenLastUpdated":{"format":"date-time","type":"string"},"domainName":{"maxLength":200,"type":"string"},"hasLocalDomainAlias":{"type":"boolean"},"homeLink":{"maxLength":200,"type":"string"},"localDomainAlias":{"maxLength":200,"type":"string"},"integratedSystemRequestId":{"format":"uuid","type":"string"},"integratedSystemRequest":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystemRequest"},"name":{"maxLength":200,"type":"string"},"callbackUrl":{"maxLength":500,"type":"string"},"imageAlignment":{"enum":["Left","Center","Right"],"type":"string"},"imageDataId":{"format":"uuid","type":"string"},"imageData":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.ImageData"},"activityPushURL":{"type":"string"},"activityPushEnabled":{"type":"boolean"},"activityPushResponseType":{"enum":["JSON","FHIR"],"type":"string"},"nextActivityPush":{"format":"date-time","type":"string"},"activityPushURLHeaders":{"type":"string"},"singleClickView":{"type":"boolean"},"active":{"type":"boolean"},"disableHomePage":{"type":"boolean"},"hasPatientPortal":{"type":"boolean"},"hasEmployerPortal":{"type":"boolean"},"hasCaregiverPortal":{"type":"boolean"},"hasCompanyPortal":{"type":"boolean"},"apiCalls":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystemCall"}},"usersCreated":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.UserIdentity"}},"mediaCategories":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystemMediaCategory"}},"mediaLanguages":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystemMediaLanguage"}},"integratedSystemAllowedIPList":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystemAllowedIP"}},"activityProfiles":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.ActivityProfileData.ActivityProfile"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.SecurityData.UserIdentityRole":{"type":"object","properties":{"userIdentityId":{"format":"uuid","type":"string"},"userIdentity":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.UserIdentity"},"roleId":{"format":"uuid","type":"string"},"role":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.Role"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystemCall":{"type":"object","properties":{"integratedSystemId":{"format":"uuid","type":"string"},"integratedSystem":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystem"},"userIdentityId":{"format":"uuid","type":"string"},"userIdentity":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.UserIdentity"},"dateCalled":{"format":"date-time","type":"string"},"methodName":{"type":"string"},"controllerName":{"type":"string"},"ipAddress":{"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Language":{"required":["name"],"type":"object","properties":{"name":{"maxLength":200,"type":"string"},"active":{"type":"boolean"},"patientLanguages":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientLanguage"}},"careProviderLanguages":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.CareProviderLanguage"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.MedicalCode":{"type":"object","properties":{"codeSystemId":{"format":"uuid","type":"string"},"codeSystem":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.CodeSystem"},"code":{"type":"string"},"description":{"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.EmployerData.EmployerUser":{"type":"object","properties":{"userIdentityId":{"format":"uuid","type":"string"},"userIdentity":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.UserIdentity"},"employerId":{"format":"uuid","type":"string"},"employer":{"$ref":"#/definitions/HealthCloud.BL.Entities.EmployerData.Employer"},"isAccountActivated":{"type":"boolean"}}},"HealthCloud.BL.Entities.Transaction.RecordTransaction":{"type":"object","properties":{"timestamp":{"format":"date-time","type":"string"},"patientTransactions":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PointOfCareData.PatientTransaction"}},"allergies":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientAllergy"}},"contacts":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientContact"}},"familyHistories":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.FamilyHistory"}},"diets":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientDiet"}},"alcoholUsages":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientAlcoholUsage"}},"tobaccoUsages":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientTobaccoUsage"}},"vitalSigns":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientVitalSign"}},"moods":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientMood"}},"activities":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientActivity"}},"problems":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.Problem"}},"results":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientResult"}},"immunizations":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientImmunization"}},"diagnoses":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientDiagnosis"}},"procedures":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProcedure"}},"medications":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientMedication"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PointOfCareData.PatientTransaction":{"type":"object","properties":{"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"userIdentityId":{"format":"uuid","type":"string"},"userIdentity":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.UserIdentity"},"eventInfoId":{"format":"uuid","type":"string"},"eventInfo":{"$ref":"#/definitions/HealthCloud.BL.Entities.EventData.EventData"},"pointOfCareOperatorId":{"format":"uuid","type":"string"},"pointOfCareOperator":{"$ref":"#/definitions/HealthCloud.BL.Entities.Operator.PointOfCareOperator"},"pointOfCareDeviceId":{"format":"uuid","type":"string"},"pointOfCareDevice":{"$ref":"#/definitions/HealthCloud.BL.Entities.PointOfCareData.PointOfCareDevice"},"patientBiometricTests":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientVitalSign"}},"patientResults":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientResult"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Biometric":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"description":{"maxLength":200,"type":"string"},"shortName":{"maxLength":200,"type":"string"},"measurementUnitId":{"format":"uuid","type":"string"},"measurementUnit":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MeasurementUnit"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PointOfCareData.PanelDetail":{"type":"object","properties":{"lotNo":{"type":"string"},"expiry":{"format":"date-time","type":"string"},"type":{"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.AdHocData":{"type":"object","properties":{"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"transactionId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"patientProfileId":{"format":"uuid","type":"string"},"patientVitalSign":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientVitalSign"},"patientVitalSignId":{"format":"uuid","type":"string"},"adHocDataType":{"enum":["NotSet","FamilyHistory","Medication"],"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Allergy":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"allergyName":{"maxLength":50,"type":"string"},"isActive":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Severity":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"description":{"maxLength":50,"type":"string"},"isActive":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Substance":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"description":{"maxLength":50,"type":"string"},"isActive":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Status":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"description":{"maxLength":50,"type":"string"},"isActive":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.MeasurementUnit":{"type":"object","properties":{"description":{"maxLength":200,"type":"string"},"symbol":{"maxLength":20,"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.ReasonForVisit":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.EncounterData.EncounterDiagnosis":{"type":"object","properties":{"encounterId":{"format":"uuid","type":"string"},"patientEncounter":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.PatientEncounter"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"diagnosisId":{"format":"uuid","type":"string"},"diagnosis":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Diagnosis"},"description":{"maxLength":200,"type":"string"},"timestamp":{"format":"date-time","type":"string"},"isTrusted":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.EncounterData.EncounterImmunization":{"type":"object","properties":{"patientEncounterId":{"format":"uuid","type":"string"},"patientEncounter":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.PatientEncounter"},"productId":{"format":"uuid","type":"string"},"product":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Product"},"routeId":{"format":"uuid","type":"string"},"route":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Route"},"unitId":{"format":"uuid","type":"string"},"unit":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MeasurementUnit"},"quantity":{"format":"double","type":"number"},"immunizationDate":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.EncounterData.PatientEncounterProvider":{"type":"object","properties":{"encounterId":{"format":"uuid","type":"string"},"patientEncounter":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.PatientEncounter"},"providerId":{"format":"uuid","type":"string"},"providerProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.CareGiverData.CareProviderProfile"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"providerProcedures":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.ProviderProcedure"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.EncounterData.EncounterNote":{"type":"object","properties":{"fileDataId":{"format":"uuid","type":"string"},"fileData":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.FileData"},"encounterId":{"format":"uuid","type":"string"},"encounter":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.PatientEncounter"},"content":{"type":"string"},"noteDate":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Observation":{"type":"object","properties":{"encounterId":{"format":"uuid","type":"string"},"encounter":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.PatientEncounter"},"providerProcedureId":{"format":"uuid","type":"string"},"providerProcedure":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.ProviderProcedure"},"providerProcedureResultId":{"format":"uuid","type":"string"},"providerProcedureResult":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.ProviderProcedureResult"},"vitalSignId":{"format":"uuid","type":"string"},"vitalSign":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientVitalSign"},"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"encounterDiagnosisId":{"format":"uuid","type":"string"},"encounterDiagnosis":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.EncounterDiagnosis"},"unitId":{"format":"uuid","type":"string"},"measurementUnit":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MeasurementUnit"},"targetSiteId":{"format":"uuid","type":"string"},"targetSite":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.TargetSite"},"statusId":{"format":"uuid","type":"string"},"status":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Status"},"observeStartDate":{"format":"date-time","type":"string"},"observeEndDate":{"format":"date-time","type":"string"},"interpretation":{"maxLength":200,"type":"string"},"value":{"format":"double","type":"number"},"comment":{"maxLength":200,"type":"string"},"referenceRangeLow":{"format":"double","type":"number"},"referenceRangeHigh":{"format":"double","type":"number"},"referenceRangeDescription":{"maxLength":200,"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.EncounterData.EncounterLabTest":{"type":"object","properties":{"patientEncounterId":{"format":"uuid","type":"string"},"patientEncounter":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.PatientEncounter"},"codeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"loinc":{"type":"string"},"name":{"maxLength":200,"type":"string"},"description":{"maxLength":200,"type":"string"},"results":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.EncounterLabResult"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.ActivityProfileData.ActivityProfileMemberScheme":{"required":["schemeCode"],"type":"object","properties":{"activityProfileId":{"format":"uuid","type":"string"},"activityProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.ActivityProfileData.ActivityProfile"},"schemeCode":{"maxLength":100,"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.Models.Api.EHR.Summary.EncounterLabResultModel":{"type":"object","properties":{"measurementUnitId":{"format":"uuid","description":"HealthCloud Measurement Id","type":"string"},"value":{"description":"Absolute result value","type":"string"},"rangeInterpretation":{"description":"Range Definition","type":"string"},"range":{"description":"Pathologist’s minimum and maximum result value on the particular test.","type":"string"}}},"HealthCloud.BL.Entities.SecurityData.PasswordRecord":{"required":["passwordHash"],"type":"object","properties":{"userIdentityLoginControlId":{"format":"uuid","type":"string"},"passwordControl":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.PasswordControl"},"passwordType":{"enum":["Invalid","OneTimeUse","Temporary","Old"],"type":"string"},"passwordHash":{"type":"string"},"validUntil":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystemRequest":{"required":["emailAddress","firstName","surname","companyName","reason"],"type":"object","properties":{"timestamp":{"format":"date-time","type":"string"},"emailAddress":{"maxLength":200,"type":"string"},"firstName":{"maxLength":200,"type":"string"},"surname":{"maxLength":200,"type":"string"},"companyName":{"maxLength":200,"type":"string"},"reason":{"maxLength":500,"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystemMediaCategory":{"type":"object","properties":{"integratedSystemId":{"format":"uuid","type":"string"},"integratedSystem":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystem"},"mediaCategoryId":{"format":"uuid","type":"string"},"mediaCategory":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaCategory"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystemMediaLanguage":{"type":"object","properties":{"integratedSystemId":{"format":"uuid","type":"string"},"integratedSystem":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystem"},"mediaLanguageId":{"format":"uuid","type":"string"},"mediaLanguage":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaLanguage"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystemAllowedIP":{"type":"object","properties":{"integratedSystemId":{"format":"uuid","type":"string"},"integratedSystem":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystem"},"ipAddress":{"type":"string"},"description":{"type":"string"},"isActive":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.SecurityData.Role":{"required":["roleName"],"type":"object","properties":{"roleName":{"maxLength":100,"type":"string"},"description":{"type":"string"},"status":{"enum":["Active","Inactive","Archive"],"type":"string"},"privileges":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.RolePrivilege"}},"users":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.UserIdentityRole"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.CareProviderLanguage":{"type":"object","properties":{"userIdentityId":{"format":"uuid","type":"string"},"careProviderProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.CareGiverData.CareProviderProfile"},"languageId":{"format":"uuid","type":"string"},"language":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Language"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.CodeSystem":{"required":["code"],"type":"object","properties":{"code":{"maxLength":45,"type":"string"},"description":{"maxLength":200,"type":"string"},"isActive":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientContact":{"required":["firstName","surname","mobileNumber"],"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientContact"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"relationshipId":{"format":"uuid","type":"string"},"relationship":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Relationship"},"title":{"maxLength":20,"type":"string"},"firstName":{"maxLength":200,"type":"string"},"surname":{"maxLength":200,"type":"string"},"mobileNumber":{"maxLength":15,"type":"string"},"genderType":{"enum":["Male","Female","Other","Unknown"],"type":"string"},"orginisation":{"maxLength":200,"type":"string"},"physicalAddress":{"maxLength":200,"type":"string"},"postalAddress":{"maxLength":200,"type":"string"},"city":{"maxLength":200,"type":"string"},"suburb":{"maxLength":200,"type":"string"},"postalCode":{"maxLength":200,"type":"string"},"isRemoved":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.FamilyHistory":{"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.FamilyHistory"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"relationshipId":{"format":"uuid","type":"string"},"relationship":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Relationship"},"firstName":{"type":"string"},"surname":{"type":"string"},"isDeceased":{"type":"boolean"},"genderType":{"enum":["Male","Female","Other","Unknown"],"type":"string"},"dateOfBirth":{"format":"date-time","type":"string"},"isTrusted":{"type":"boolean"},"isRemoved":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientDiet":{"required":["dietName"],"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientDiet"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"dietName":{"maxLength":200,"type":"string"},"description":{"maxLength":500,"type":"string"},"prescribedByFirstName":{"maxLength":200,"type":"string"},"prescribedBySurname":{"maxLength":200,"type":"string"},"prescribedByCredentials":{"maxLength":200,"type":"string"},"prescribedByPracticeName":{"maxLength":200,"type":"string"},"isRemoved":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientAlcoholUsage":{"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientAlcoholUsage"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"frequency":{"format":"int32","type":"integer"},"measurementUnitId":{"format":"uuid","type":"string"},"measurementUnit":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MeasurementUnit"},"description":{"maxLength":200,"type":"string"},"isTrusted":{"type":"boolean"},"isRemoved":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientTobaccoUsage":{"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientTobaccoUsage"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"frequency":{"format":"int32","type":"integer"},"measurementUnitId":{"format":"uuid","type":"string"},"measurementUnit":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MeasurementUnit"},"description":{"maxLength":200,"type":"string"},"isTrusted":{"type":"boolean"},"isRemoved":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientMood":{"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientMood"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"mood":{"enum":["ExtremelyUnhappy","VeryUnhappy","Unhappy","Neutral","Happy","VeryHappy","Elated"],"type":"string"},"timeStamp":{"format":"date-time","type":"string"},"reason":{"type":"string"},"isRemoved":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientActivity":{"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientActivity"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"activity":{"type":"string"},"isRemoved":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.Problem":{"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.Problem"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"familyHistoryId":{"format":"uuid","type":"string"},"familyHistory":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.FamilyHistory"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"dateStarted":{"format":"date-time","type":"string"},"ageAtOnset":{"format":"int32","type":"integer"},"isCauseOfDeath":{"type":"boolean"},"description":{"maxLength":200,"type":"string"},"isRemoved":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.PatientResult":{"type":"object","properties":{"parentRecordId":{"format":"uuid","type":"string"},"parentRecord":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientResult"},"transactionId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"patientTransactionId":{"format":"uuid","type":"string"},"patientTransaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.PointOfCareData.PatientTransaction"},"dateOfResult":{"format":"date-time","type":"string"},"dateOfTest":{"format":"date-time","type":"string"},"value":{"format":"double","type":"number"},"measurement":{"type":"string"},"resultName":{"maxLength":200,"type":"string"},"shortName":{"maxLength":200,"type":"string"},"description":{"maxLength":500,"type":"string"},"testResult":{"enum":["Positive","Negative","Inconclusive"],"type":"string"},"batchNumber":{"type":"string"},"testNumber":{"type":"string"},"isTrusted":{"type":"boolean"},"manualTest":{"type":"boolean"},"locationAddress":{"maxLength":200,"type":"string"},"facilityName":{"maxLength":200,"type":"string"},"careProviderCredentials":{"maxLength":200,"type":"string"},"careProviderFirstName":{"maxLength":200,"type":"string"},"careProviderSurname":{"maxLength":200,"type":"string"},"careProviderPracticeName":{"maxLength":200,"type":"string"},"isRemoved":{"type":"boolean"},"adHocData":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.AdHocData"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.EventData.EventData":{"type":"object","properties":{"eventId":{"type":"string"},"integratedSystem":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystem"},"integratedSystemId":{"format":"uuid","type":"string"},"transaction":{"$ref":"#/definitions/HealthCloud.BL.Entities.Transaction.RecordTransaction"},"transactionId":{"format":"uuid","type":"string"},"eventname":{"type":"string"},"description":{"type":"string"},"company":{"type":"string"},"contactName":{"type":"string"},"contactNumber":{"type":"string"},"contactEmail":{"type":"string"},"address":{"type":"string"},"patientTransactionList":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.PointOfCareData.PatientTransaction"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.Operator.PointOfCareOperator":{"type":"object","properties":{"userIdentityId":{"format":"uuid","type":"string"},"userIdentity":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.UserIdentity"},"dateOfBirth":{"format":"date-time","type":"string"},"idNumber":{"type":"string"},"passportNumber":{"type":"string"},"mobileNumber":{"type":"string"},"alternateNumber":{"type":"string"},"isLogginEnabled":{"type":"boolean"}}},"HealthCloud.BL.Entities.PointOfCareData.PointOfCareDevice":{"type":"object","properties":{"manufacturer":{"type":"string"},"model":{"type":"string"},"description":{"type":"string"},"serialNumber":{"type":"string"},"markId":{"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Diagnosis":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"description":{"maxLength":200,"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Product":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"description":{"maxLength":200,"type":"string"},"productStatusId":{"format":"uuid","type":"string"},"productStatus":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.ProductStatus"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Route":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"description":{"maxLength":50,"type":"string"},"isActive":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.CareGiverData.CareProviderProfile":{"type":"object","properties":{"userIdentityId":{"format":"uuid","type":"string"},"userIdentity":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.UserIdentity"},"signatureImageId":{"format":"uuid","type":"string"},"signatureImage":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.ImageData"},"genderType":{"enum":["Male","Female","Other","Unknown"],"type":"string"},"ethnicityType":{"enum":["Unspecified","Caucasian","Black","Coloured","Asian","Indian"],"type":"string"},"rsaIdentificationNumber":{"maxLength":13,"type":"string"},"dateOfBirth":{"format":"date-time","type":"string"},"specialityId":{"format":"uuid","type":"string"},"speciality":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Speciality"},"professionId":{"format":"uuid","type":"string"},"profession":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Profession"},"qualifications":{"type":"string"},"practiceName":{"maxLength":200,"type":"string"},"phoneNumber":{"maxLength":15,"type":"string"},"practiceEmailAddress":{"maxLength":200,"type":"string"},"council":{"maxLength":15,"type":"string"},"privatePracticeNumber":{"maxLength":15,"type":"string"},"additional1":{"maxLength":15,"type":"string"},"additional2":{"maxLength":15,"type":"string"},"physicalAddress":{"maxLength":200,"type":"string"},"postalAddress":{"maxLength":200,"type":"string"},"practiceAddress":{"maxLength":200,"type":"string"},"suburb":{"maxLength":50,"type":"string"},"city":{"maxLength":50,"type":"string"},"provinceId":{"format":"uuid","type":"string"},"province":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Province"},"mobileNumber":{"maxLength":15,"type":"string"},"alternateNumber":{"maxLength":15,"type":"string"},"termsAccepted":{"type":"boolean"},"location":{"type":"string"},"latitude":{"format":"double","type":"number"},"longitude":{"format":"double","type":"number"},"timeZoneOffset":{"format":"int32","type":"integer"},"getTimeZoneOffset":{"format":"int32","type":"integer","readOnly":true},"languages":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.CareProviderLanguage"}},"companies":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.CareProviderCompany"}},"calendarSettings":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.BookingData.CalendarConfig"}},"bookings":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.BookingData.Booking"}}}},"HealthCloud.BL.Entities.EncounterData.ProviderProcedure":{"type":"object","properties":{"encounterProviderId":{"format":"uuid","type":"string"},"encounterProvider":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.PatientEncounterProvider"},"procedureId":{"format":"uuid","type":"string"},"procedure":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Procedure"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"statusId":{"format":"uuid","type":"string"},"status":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Status"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"procedureName":{"type":"string"},"isTrusted":{"type":"boolean"},"providerProcedureResults":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.ProviderProcedureResult"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.FileData":{"required":["fileName","fileExtension"],"type":"object","properties":{"data":{"format":"byte","type":"string"},"fileName":{"maxLength":50,"type":"string"},"fileExtension":{"maxLength":10,"type":"string"},"dateOfFile":{"format":"date-time","type":"string"},"encounterNotes":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.EncounterNote"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.EncounterData.ProviderProcedureResult":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"providerProcedureId":{"format":"uuid","type":"string"},"providerProcedure":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.ProviderProcedure"},"resultDate":{"format":"date-time","type":"string"},"description":{"maxLength":200,"type":"string"},"observations":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Observation"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.TargetSite":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"description":{"maxLength":200,"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.EncounterData.EncounterLabResult":{"type":"object","properties":{"encounterLabTestId":{"format":"uuid","type":"string"},"encounterLabTest":{"$ref":"#/definitions/HealthCloud.BL.Entities.EncounterData.EncounterLabTest"},"measurementUnitId":{"format":"uuid","type":"string"},"measurementUnit":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MeasurementUnit"},"value":{"type":"string"},"rangeInterpretation":{"type":"string"},"range":{"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MediaData.MediaCategory":{"type":"object","properties":{"name":{"type":"string"},"searchKeywords":{"type":"string"},"exclusionTags":{"type":"string"},"isActive":{"type":"boolean"},"mediaLanguageId":{"format":"uuid","type":"string"},"mediaLanguage":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaLanguage"},"mediaItems":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaItem"}},"catagoryAvatarMaps":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.AvatarData.CatagoryAvatarMap"}},"translatedMediaCategories":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.TranslatedMediaCategory"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MediaData.MediaLanguage":{"type":"object","properties":{"name":{"type":"string"},"code":{"type":"string"},"isActive":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.SecurityData.RolePrivilege":{"type":"object","properties":{"roleId":{"format":"uuid","type":"string"},"role":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.Role"},"privilegeId":{"format":"uuid","type":"string"},"privilege":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.Privilege"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Relationship":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"description":{"maxLength":50,"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.ProductStatus":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"description":{"maxLength":200,"type":"string"},"isActive":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Speciality":{"required":["name"],"type":"object","properties":{"name":{"maxLength":200,"type":"string"},"active":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Profession":{"required":["name"],"type":"object","properties":{"name":{"maxLength":200,"type":"string"},"active":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.CareProviderCompany":{"type":"object","properties":{"careProviderProfileId":{"format":"uuid","type":"string"},"careProviderProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.CareGiverData.CareProviderProfile"},"companyId":{"format":"uuid","type":"string"},"company":{"$ref":"#/definitions/HealthCloud.BL.Entities.CompanyData.Company"},"isActive":{"type":"boolean"},"useCalendar":{"type":"boolean"},"membershipStatus":{"enum":["Pending","Approved","Declined"],"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.BookingData.CalendarConfig":{"type":"object","properties":{"careProviderPofileId":{"format":"uuid","type":"string"},"careProviderProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.CareGiverData.CareProviderProfile"},"dayOfWeek":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"directBooking":{"type":"boolean"},"bookingSlotSizeId":{"format":"uuid","type":"string"},"bookingSlotSize":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.BookingSlotSize"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.BookingData.Booking":{"type":"object","properties":{"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"description":{"type":"string"},"referedByCareProviderId":{"format":"uuid","type":"string"},"referedByCareProvider":{"$ref":"#/definitions/HealthCloud.BL.Entities.CareGiverData.CareProviderProfile"},"companyId":{"format":"uuid","type":"string"},"company":{"$ref":"#/definitions/HealthCloud.BL.Entities.CompanyData.Company"},"careProviderPofileId":{"format":"uuid","type":"string"},"careProviderProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.CareGiverData.CareProviderProfile"},"patientProfileId":{"format":"uuid","type":"string"},"patientProfile":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.PatientProfile"},"unregisteredPatientId":{"format":"uuid","type":"string"},"unregisteredPatient":{"$ref":"#/definitions/HealthCloud.BL.Entities.PatientData.UnregisteredPatient"},"bookingStatus":{"enum":["Preliminary","Confirmed","Declined","Canceled","TimeSlotAlreadyBooked","NoTimeSlotsAvailable"],"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MasterData.Procedure":{"type":"object","properties":{"medicalCodeId":{"format":"uuid","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.MedicalCode"},"description":{"maxLength":200,"type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MediaData.MediaItem":{"type":"object","properties":{"dateCreated":{"format":"date-time","type":"string"},"dateModified":{"format":"date-time","type":"string"},"integratedSystemId":{"format":"uuid","type":"string"},"integratedSystem":{"$ref":"#/definitions/HealthCloud.BL.Entities.IntegratedSystemData.IntegratedSystem"},"name":{"type":"string"},"indexKey":{"type":"string"},"shortCode":{"maxLength":10,"type":"string"},"mediaCategoryId":{"format":"uuid","type":"string"},"mediaCategory":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaCategory"},"summary":{"type":"string"},"keyWords":{"type":"string"},"inclusionTags":{"type":"string"},"exclusionTags":{"type":"string"},"htmlContent":{"type":"string"},"mediaContentId":{"format":"uuid","type":"string"},"mediaContent":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaContent"},"isInfoGraphic":{"type":"boolean"},"thumbnailImageId":{"format":"uuid","type":"string"},"thumbnailImage":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.ImageData"},"isActive":{"type":"boolean"},"isInReview":{"type":"boolean"},"isTextToSpeech":{"type":"boolean"},"mediaLanguageId":{"format":"uuid","type":"string"},"mediaLanguage":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaLanguage"},"translationComplete":{"type":"boolean"},"articleDate":{"format":"date-time","type":"string"},"modifiedReviewStatus":{"format":"date-time","type":"string"},"mediaItemKeyWords":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaItemKeyWord"}},"originalMediaItems":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.TranslatedMediaItem"}},"translatedMediaItems":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.TranslatedMediaItem"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.AvatarData.CatagoryAvatarMap":{"required":["fileName"],"type":"object","properties":{"avatarId":{"format":"uuid","type":"string"},"avatar":{"$ref":"#/definitions/HealthCloud.BL.Entities.AvatarData.Avatar"},"mediaCategoryId":{"format":"uuid","type":"string"},"mediaCategory":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaCategory"},"fileData":{"format":"byte","type":"string"},"fileName":{"maxLength":50,"type":"string"},"avatarMaps":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.AvatarData.AvatarMap"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MediaData.TranslatedMediaCategory":{"type":"object","properties":{"originalMediaCategoryId":{"format":"uuid","type":"string"},"originalMediaCategory":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaCategory"},"translatedName":{"type":"string"},"mediaLanguageId":{"format":"uuid","type":"string"},"mediaLanguage":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaLanguage"},"created":{"format":"date-time","type":"string"},"modified":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.SecurityData.Privilege":{"required":["description"],"type":"object","properties":{"security":{"enum":["UserMaintenance","RoleMaintenance","SettingsMaintenance","IntegratedSystemMaintenance","ProvinceMaintenance","SpecialityMaintenance","ProfessionMaintenance","LanguageMaintenance","MedicalAidMaintenance","BookingSlotSizeMaintenance","BookingMaintenance","APISummaryMaintenance","APIDetailMaintenance","DataExtractMaintenance","MediaSearchHistoryMaintenance","ProtocolRequestMaintenance","ProtocolConsumptionMaintenance","AccessProfile","ViewCalendar","MaintainBookings","CreateReferrals","AccessCompanyMembership","ViewTimeSlots","MaintainTimeSlots","TemplateFormMaintenance","EmployerMaintenance","MediaCategoryMaintenance","IgnoredWordMaintenance","MediaMaintenance","CodeSystemMaintenance","AllergyMaintenance","BloodTypeMaintenance","RelationshipMaintenance","DiagnosisMaintenance","ProcedureMaintenance","BiometricMaintenance","ReasonForVisit","Result","DeviceSummaryReport","PointOfCareSummary","APIRequest","ActivitySummary","MediaStatistics","HealthCloudStatistics","AvatarMaintenance","MediaLanguageMaintenance"],"type":"string"},"description":{"maxLength":200,"type":"string"},"roles":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.RolePrivilege"}},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.CompanyData.Company":{"required":["registeredName","websiteUrl","description","phoneNumber"],"type":"object","properties":{"userIdentityId":{"format":"uuid","type":"string"},"userIdentity":{"$ref":"#/definitions/HealthCloud.BL.Entities.SecurityData.UserIdentity"},"registeredName":{"type":"string"},"vatNumber":{"maxLength":50,"type":"string"},"websiteUrl":{"type":"string"},"companyType":{"enum":["Agency","Practice","Wellness"],"type":"string"},"imageId":{"format":"uuid","type":"string"},"imageData":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.ImageData"},"signatureImageId":{"format":"uuid","type":"string"},"signatureImage":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.ImageData"},"description":{"maxLength":200,"type":"string"},"healthCareProviderContactEmail":{"maxLength":50,"type":"string"},"patientContactEmail":{"maxLength":50,"type":"string"},"phoneNumber":{"maxLength":20,"type":"string"},"contactNumber":{"maxLength":20,"type":"string"},"publicEmail":{"type":"string"},"suburb":{"maxLength":50,"type":"string"},"city":{"maxLength":50,"type":"string"},"provinceId":{"format":"uuid","type":"string"},"province":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.Province"},"location":{"type":"string"},"latitude":{"format":"double","type":"number"},"longitude":{"format":"double","type":"number"},"timeZoneOffset":{"format":"int32","type":"integer"},"registered":{"format":"date-time","type":"string"},"active":{"type":"boolean"},"termsAccepted":{"type":"boolean"},"careProviders":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Entities.MasterData.CareProviderCompany"}},"getTimeZoneOffset":{"format":"int32","type":"integer","readOnly":true}}},"HealthCloud.BL.Entities.MasterData.BookingSlotSize":{"required":["name"],"type":"object","properties":{"name":{"maxLength":200,"type":"string"},"active":{"type":"boolean"},"minutes":{"format":"int32","type":"integer"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.PatientData.UnregisteredPatient":{"type":"object","properties":{"title":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"gender":{"enum":["Male","Female","Other","Unknown"],"type":"string"},"emailAddress":{"type":"string"},"mobileNumeber":{"type":"string"},"fullName":{"type":"string","readOnly":true},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MediaData.MediaContent":{"type":"object","properties":{"fileName":{"type":"string"},"fileType":{"enum":["MP3"],"type":"string"},"mediaData":{"format":"byte","type":"string"},"dateUploaded":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MediaData.MediaItemKeyWord":{"required":["keyWord"],"type":"object","properties":{"mediaItemId":{"format":"uuid","type":"string"},"mediaItem":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaItem"},"keyWord":{"maxLength":200,"type":"string"},"keyWordCount":{"format":"int32","type":"integer"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.MediaData.TranslatedMediaItem":{"type":"object","properties":{"originalMediaItemId":{"format":"uuid","type":"string"},"originalMediaItem":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaItem"},"translatedMediaId":{"format":"uuid","type":"string"},"translatedMedia":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaItem"},"mediaLanguageId":{"format":"uuid","type":"string"},"mediaLanguage":{"$ref":"#/definitions/HealthCloud.BL.Entities.MediaData.MediaLanguage"},"created":{"format":"date-time","type":"string"},"modified":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.AvatarData.Avatar":{"required":["name","fileName"],"type":"object","properties":{"name":{"type":"string"},"genderType":{"enum":["Male","Female"],"type":"string"},"positionType":{"enum":["Front","Back"],"type":"string"},"fileData":{"format":"byte","type":"string"},"fileName":{"maxLength":50,"type":"string"},"isActive":{"type":"boolean"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.BL.Entities.AvatarData.AvatarMap":{"required":["coordinates","title","shape","priority"],"type":"object","properties":{"coordinates":{"type":"string"},"title":{"maxLength":200,"type":"string"},"shape":{"maxLength":200,"type":"string"},"hint":{"maxLength":200,"type":"string"},"priority":{"format":"int32","type":"integer"},"id":{"format":"uuid","type":"string"}}},"HealthCloud.Models.ApiRequest":{"type":"object","properties":{"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.CodeSystemModel":{"type":"object","properties":{"ehrId":{"format":"uuid","description":"Unique identifier of the item","type":"string"},"code":{"description":"This code represents the system being used (ex. ICD-10, SNOMED, etc)","type":"string"},"description":{"description":"This describes the code( ex. Code: ICD-10 Description: International Statistical Classification of Diseases and Related Health Problems 10th Revision)","type":"string"}}},"HealthCloud.Models.Api.MasterData.BloodTypeModel":{"type":"object","properties":{"bloodTypeEHRId":{"format":"uuid","description":"Unique identifier that links to a blood type","type":"string"},"description":{"description":"Additional description of the blood type","type":"string"},"codeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel","description":"The medical code linked to this item, if there is one"}}},"HealthCloud.Models.Api.MasterData.CodeModel":{"type":"object","properties":{"ehrId":{"format":"uuid","description":"Unique identifier of the item","type":"string"},"codeSystem":{"description":"This code represents the system being used (ex. ICD-10, SNOMED, etc)","type":"string"},"code":{"description":"The unique code based on the medical code system used","type":"string"},"description":{"description":"This describes the code( ex. Code: ICD-10 Description: International Statistical Classification of Diseases and Related Health Problems 10th Revision)","type":"string"}}},"HealthCloud.Models.Api.MasterData.AllergyModel":{"type":"object","properties":{"allergyEHRId":{"format":"uuid","description":"Unique identifier that links to an allergy","type":"string"},"allergyName":{"description":"Additional description of the allergy","type":"string"},"codeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel","description":"The medical code linked to this item, if there is one"},"isActive":{"description":"A boolean value that determines if the allergy is active or not","type":"boolean"}}},"HealthCloud.Models.Api.MasterData.BiometricModel":{"type":"object","properties":{"biometricEHRId":{"format":"uuid","description":"Unique identifier that links to a biometric","type":"string"},"description":{"description":"Additional description of the biometric type","type":"string"},"codeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel","description":"The medical code linked to this item, if there is one"}}},"HealthCloud.Models.Api.MasterData.RelationshipModel":{"type":"object","properties":{"relationshipEHRId":{"format":"uuid","description":"Unique identifier that links to a relationship","type":"string"},"description":{"description":"Additional description of the relationship","type":"string"},"codeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel","description":"The medical code linked to this item, if there is one"}}},"HealthCloud.Models.Api.MasterData.ProcedureModel":{"type":"object","properties":{"procedureEHRId":{"format":"uuid","description":"Unique identifier that links to a procedure","type":"string"},"description":{"description":"Additional description of the procedure","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel","description":"The medical code linked to this item, if there is one"}}},"HealthCloud.Models.Api.MasterData.ResultModel":{"type":"object","properties":{"resultEHRId":{"format":"uuid","description":"Unique identifier that links to a result type","type":"string"},"medicalCode":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel","description":"The medical code linked to this item, if there is one"},"resultDate":{"format":"date-time","description":"Date of which the result was added","type":"string"},"resultDescription":{"description":"Description of the result","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.EHRPatientSaveModel":{"required":["emailAddress","firstName","surname","mobileNumber"],"type":"object","properties":{"patientEHRId":{"format":"uuid","description":"Unique identifier that links to a patient's profile","type":"string"},"medicalRecordNumber":{"description":"Unique record number on the client system","type":"string"},"emailAddress":{"description":"Email address of the patient","maxLength":200,"type":"string"},"firstName":{"description":"First name of the patient","maxLength":200,"type":"string"},"surname":{"description":"Surname of the patient","maxLength":200,"type":"string"},"title":{"description":"Title of the patient","maxLength":20,"type":"string"},"mobileNumber":{"description":"Mobile contact number of the patient","maxLength":15,"type":"string"},"alternateNumber":{"description":"Alternative contact number of the patient","maxLength":15,"type":"string"},"gender":{"description":"The patient's Gender","enum":["Male","Female","Other","Unknown"],"type":"string"},"ethnicity":{"description":"The patient's Ethnicity","enum":["Unspecified","Caucasian","Black","Coloured","Asian","Indian"],"type":"string"},"provinceId":{"format":"uuid","description":"Unique identifier that links to a province","type":"string"},"physicalAddress":{"description":"Physical address of the","type":"string"},"postalAddress":{"description":"Postal address of the patient","type":"string"},"city":{"description":"City where the patient lives in","type":"string"},"suburb":{"description":"Suburb where the patient lives in","type":"string"},"postalCode":{"description":"Postal code of the patient's address","type":"string"},"rsaIdNumber":{"description":"South African Identity Document number or Passport number","maxLength":13,"type":"string"},"dateOfBirth":{"format":"date-time","description":"Date of birth of the patient","type":"string"},"medicalAidId":{"format":"uuid","description":"Unique identifier that links to a medical aid","type":"string"},"medicalAidProduct":{"description":"The Medical Aid the patient is a member of","maxLength":200,"type":"string"},"beneficiaryNumber":{"description":"The Beneficiary Number of the medical aid","maxLength":15,"type":"string"},"medicalAidPolicyNumber":{"description":"Membership number of the scheme the member is active on","maxLength":15,"type":"string"},"emergencyContactName":{"description":"Name of the emergency contact person of the patient","type":"string"},"emergencyNumber":{"description":"Contact number of patient's emergency person","maxLength":15,"type":"string"},"emergencyContactNextOfKin":{"description":"Emergency contact person's Next of kin","type":"string"},"employerId":{"format":"uuid","description":"Unique identifier that links to an employer registered on HealthCloud","type":"string"},"employerName":{"description":"Name of patient's employer","type":"string"},"occupation":{"description":"Patient's Occupation","type":"string"},"qualification":{"description":"Patient's Qualification","type":"string"},"bloodType":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.BloodTypeModel","description":"The blood type of the patient, this is a EHRMasterData BloodType item"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.PatientAddResultModel":{"type":"object","properties":{"registrationResult":{"description":"Result of the registration request","enum":["RegistrationOK","ProfileExists","EnterOTP"],"type":"string"},"profileId":{"format":"uuid","description":"the unique identifier of the newely registered patient","type":"string"},"errorResponse":{"description":"The error message, only populated if an error has occured","type":"string"}}},"HealthCloud.Models.Api.EHR.EHRIdModel":{"type":"object","properties":{"ehrId":{"format":"uuid","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.TobaccoUsageModel":{"type":"object","properties":{"tobaccoUsageEHRId":{"format":"uuid","type":"string"},"patientEHRId":{"format":"uuid","type":"string"},"tobaccoUsageCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"frequency":{"format":"int32","type":"integer"},"measurementUnitId":{"format":"uuid","type":"string"},"description":{"maxLength":200,"type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.AlcoholUsageModel":{"type":"object","properties":{"alcoholUsageEHRId":{"format":"uuid","type":"string"},"patientEHRId":{"format":"uuid","type":"string"},"alcoholUsageCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"frequency":{"format":"int32","type":"integer"},"measurementUnitId":{"format":"uuid","type":"string"},"description":{"maxLength":200,"type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.PatientContactModel":{"required":["firstName","surname","mobileNumber"],"type":"object","properties":{"patientContactEHRId":{"format":"uuid","type":"string"},"patientProfileId":{"format":"uuid","type":"string"},"relationshipId":{"format":"uuid","type":"string"},"title":{"maxLength":20,"type":"string"},"firstName":{"maxLength":200,"type":"string"},"surname":{"maxLength":200,"type":"string"},"mobileNumber":{"maxLength":15,"type":"string"},"genderType":{"enum":["Male","Female","Other","Unknown"],"type":"string"},"orginisation":{"maxLength":200,"type":"string"},"physicalAddress":{"maxLength":200,"type":"string"},"postalAddress":{"maxLength":200,"type":"string"},"city":{"maxLength":200,"type":"string"},"suburb":{"maxLength":200,"type":"string"},"postalCode":{"maxLength":200,"type":"string"},"relationshipCode":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.PatientEncounterModel":{"type":"object","properties":{"encounterEHRId":{"format":"uuid","type":"string"},"codeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"patientProfileId":{"format":"uuid","type":"string"},"description":{"maxLength":200,"type":"string"},"dateTime":{"format":"date-time","type":"string"},"endDateTime":{"format":"date-time","type":"string"},"isHospitalization":{"type":"boolean"},"rfvMedicalCode":{"type":"string"},"rfvCodeSystem":{"type":"string"},"rfvMedicalDescription":{"type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.PatientEncounterGetModel":{"type":"object","properties":{"ehrId":{"format":"uuid","type":"string"},"numberOfRecords":{"format":"int32","type":"integer"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.EncounterProviderModel":{"type":"object","properties":{"encounterProviderEHRId":{"format":"uuid","type":"string"},"encounterEHRId":{"format":"uuid","type":"string"},"providerEHRId":{"format":"uuid","type":"string"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.EncounterNoteModel":{"type":"object","properties":{"encounterNoteEHRId":{"format":"uuid","type":"string"},"encounterEHRId":{"format":"uuid","type":"string"},"fileData":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.FileData"},"content":{"type":"string"},"noteDate":{"format":"date-time","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.MasterData.FileData":{"type":"object","properties":{"fileDataEHRId":{"format":"uuid","type":"string"},"data":{"format":"byte","type":"string"},"fileName":{"maxLength":50,"type":"string"},"fileExtension":{"maxLength":10,"type":"string"},"dateOfFile":{"format":"date-time","type":"string"}}},"HealthCloud.Models.Api.EHR.FamilyHistoryModel":{"required":["firstName","surname"],"type":"object","properties":{"familyHistoryEHRId":{"format":"uuid","type":"string"},"patientProfileId":{"format":"uuid","type":"string"},"relationshipCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"firstName":{"maxLength":200,"type":"string"},"surname":{"maxLength":200,"type":"string"},"isDeceased":{"type":"boolean"},"genderType":{"enum":["Male","Female","Other","Unknown"],"type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.PatientAllergyModel":{"type":"object","properties":{"patientAllergyId":{"format":"uuid","type":"string"},"allergyId":{"format":"uuid","type":"string"},"allergyCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"patientProfileId":{"format":"uuid","type":"string"},"severityId":{"format":"uuid","type":"string"},"severityCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"substanceId":{"format":"uuid","type":"string"},"substanceCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"statusId":{"format":"uuid","type":"string"},"statusCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"description":{"maxLength":50,"type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.PatientVitalSignModel":{"type":"object","properties":{"vitalSignEHRId":{"format":"uuid","type":"string"},"codeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"encounterEHRId":{"format":"uuid","type":"string"},"timeOfMeasurement":{"format":"date-time","type":"string"},"value":{"format":"double","type":"number"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.ObservationModel":{"type":"object","properties":{"observationEHRId":{"format":"uuid","type":"string"},"encounterEHRId":{"format":"uuid","type":"string"},"providerProcedureEHRId":{"format":"uuid","type":"string"},"resultEHRId":{"format":"uuid","type":"string"},"patientVitalSignEHRId":{"format":"uuid","type":"string"},"encounterDiagnosisId":{"format":"uuid","type":"string"},"unitId":{"format":"uuid","type":"string"},"targetSiteCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"statusCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"medicalCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"observeStartDate":{"format":"date-time","type":"string"},"observeEndDate":{"format":"date-time","type":"string"},"interpretation":{"maxLength":200,"type":"string"},"value":{"format":"double","type":"number"},"comment":{"maxLength":200,"type":"string"},"referenceRangeLow":{"format":"double","type":"number"},"referenceRangeHigh":{"format":"double","type":"number"},"referenceRangeDescription":{"maxLength":200,"type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.ProviderProcedureModel":{"type":"object","properties":{"providerProcedureEHRId":{"format":"uuid","type":"string"},"encounterProviderEHRId":{"format":"uuid","type":"string"},"procedureCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.EncounterDiagnosisModel":{"type":"object","properties":{"encounterDiagnosisEHRId":{"format":"uuid","type":"string"},"encounterEHRId":{"format":"uuid","type":"string"},"diagnosisCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"description":{"maxLength":200,"type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.DiagnosisMedicationModel":{"type":"object","properties":{"diagnosisMedicationEHRId":{"format":"uuid","type":"string"},"diagnosisId":{"format":"uuid","type":"string"},"productCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"routeCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"dosageQuantity":{"format":"double","type":"number"},"dosageUnitId":{"format":"uuid","type":"string"},"frequencyQuantity":{"format":"double","type":"number"},"frequencyUnitId":{"format":"uuid","type":"string"},"isPrescription":{"type":"boolean"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"instructions":{"type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.EncounterImmunizationModel":{"type":"object","properties":{"immunizationEHRId":{"format":"uuid","type":"string"},"patientEncounterId":{"format":"uuid","type":"string"},"productCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"routeCodeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"quantity":{"format":"double","type":"number"},"measurementUnitId":{"format":"uuid","type":"string"},"immunizationDate":{"format":"date-time","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.ProcedureResultModel":{"type":"object","properties":{"resultEHRId":{"format":"uuid","type":"string"},"providerProcedureId":{"format":"uuid","type":"string"},"codeSystem":{"$ref":"#/definitions/HealthCloud.Models.Api.MasterData.CodeModel"},"resultDate":{"format":"date-time","type":"string"},"description":{"type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.EHR.CarePlanModel":{"type":"object","properties":{"carePlanId":{"format":"uuid","type":"string"},"patientProfileId":{"format":"uuid","type":"string"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"modifiedDate":{"format":"date-time","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.ProviderData.RequestModel":{"required":["profileId","fromDate","toDate"],"type":"object","properties":{"profileId":{"format":"uuid","description":"Unique identifier that links to the patient","type":"string"},"fromDate":{"format":"date-time","description":"Start Date of the date range","type":"string"},"toDate":{"format":"date-time","description":"End Date of the date range","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.ProviderData.SleepDataForPatientModel":{"type":"object","properties":{"minutes":{"format":"double","description":"Total sleep time in minutes","type":"number"},"deviceCode":{"description":"Unique code that identifies the device","type":"string"},"deviceName":{"description":"Name of the device used","type":"string"},"deviceProvider":{"description":"The Provider of the device(ex. FitBit)","type":"string"},"activityDateTime":{"format":"date-time","description":"Date and Time of when the activity took place","type":"string"},"dateUpdated":{"format":"date-time","description":"Date of when the activity was updated","type":"string"},"dateCreated":{"format":"date-time","description":"Created date","type":"string"}}},"HealthCloud.Models.Api.ProviderData.HearthRateDataForPatientModel":{"type":"object","properties":{"restHeartRate":{"format":"double","description":"Resting Heart Rate Value","type":"number"},"minHeartRateBpm":{"format":"double","description":"Min Heart Rate Value","type":"number"},"maxHeartRate":{"format":"double","description":"MAx Heart Rate Value","type":"number"},"averageHeartRate":{"format":"double","description":"Average Heart Rate Value","type":"number"},"unit":{"description":"The unit of which the value is measured in. ex. bpm (beats per minute)","type":"string"},"deviceCode":{"description":"Unique code that identifies the device","type":"string"},"deviceName":{"description":"Name of the device used","type":"string"},"deviceProvider":{"description":"The Provider of the device(ex. FitBit)","type":"string"},"activityDateTime":{"format":"date-time","description":"Date and Time of when the activity took place","type":"string"},"dateUpdated":{"format":"date-time","description":"Date of when the activity was updated","type":"string"},"dateCreated":{"format":"date-time","description":"Created date","type":"string"}}},"HealthCloud.Models.Api.ProviderData.CaloriesDataForPatientModel":{"type":"object","properties":{"calories":{"format":"double","description":"Total Mathematical calculated calories burned during the time range","type":"number"},"deviceCode":{"description":"Unique code that identifies the device","type":"string"},"deviceName":{"description":"Name of the device used","type":"string"},"deviceProvider":{"description":"The Provider of the device(ex. FitBit)","type":"string"},"activityDateTime":{"format":"date-time","description":"Date and Time of when the activity took place","type":"string"},"dateUpdated":{"format":"date-time","description":"Date of when the activity was updated","type":"string"},"dateCreated":{"format":"date-time","description":"Created date","type":"string"}}},"HealthCloud.Models.Api.ProviderData.StepDataForPatientModel":{"type":"object","properties":{"steps":{"format":"int32","description":"Total amount of steps taken during the time range","type":"integer"},"deviceCode":{"description":"Unique code that identifies the device","type":"string"},"deviceName":{"description":"Name of the device used","type":"string"},"deviceProvider":{"description":"The Provider of the device(ex. FitBit)","type":"string"},"activityDateTime":{"format":"date-time","description":"Date and Time of when the activity took place","type":"string"},"dateUpdated":{"format":"date-time","description":"Date of when the activity was updated","type":"string"},"dateCreated":{"format":"date-time","description":"Created date","type":"string"}}},"HealthCloud.Models.Api.ProviderData.DistanceDataForPatientModel":{"type":"object","properties":{"distance":{"format":"double","description":"Total Distance traveled during the time range in Km","type":"number"},"deviceCode":{"description":"Unique code that identifies the device","type":"string"},"deviceName":{"description":"Name of the device used","type":"string"},"deviceProvider":{"description":"The Provider of the device(ex. FitBit)","type":"string"},"activityDateTime":{"format":"date-time","description":"Date and Time of when the activity took place","type":"string"},"dateUpdated":{"format":"date-time","description":"Date of when the activity was updated","type":"string"},"dateCreated":{"format":"date-time","description":"Created date","type":"string"}}},"HealthCloud.Models.Api.Patient.ProfileIdModel":{"type":"object","properties":{"profileId":{"format":"uuid","description":"Unique identifier that links to the patient","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.Patient.PatientInactiveDevicesResultModel":{"type":"object","properties":{"providerType":{"description":"The Fitness Provider of the device ex FitBit","enum":["FitBit","GoogleFit","Striiv","Garmin","TomTom","Polar","HealthKit"],"type":"string"},"status":{"description":"The Current Status of the device","enum":["Active","Disabled","Error"],"type":"string"},"errorMessage":{"description":"Set only if an error has occurred and the device is in an error status","type":"string"},"lastSynced":{"format":"date-time","description":"The Last time the device has synced data","type":"string"},"providerName":{"description":"The name of the fitness provider","type":"string","readOnly":true}}},"HealthCloud.Models.Api.ApiRequestIdModel":{"required":["id"],"type":"object","properties":{"id":{"format":"uuid","description":"The Unique Fitness Provider Id","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.ActivityProfile.DeviceStatusResultModel":{"type":"object","properties":{"status":{"description":"The Current Status of the device","enum":["Active","Disabled","Error"],"type":"string"}}},"HealthCloud.Models.Api.CareProvider.CareProviderProfileRequest":{"type":"object","properties":{"profileId":{"format":"uuid","description":"The Unique Identifier of the Healthcare Provider","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.CareProvider.CareProviderProfileModel":{"type":"object","properties":{"profileId":{"format":"uuid","description":"Unique identifier that links to a Healthcare Provider","type":"string"},"emailAddress":{"description":"Email address of the Healthcare Provider","type":"string"},"title":{"description":"Title of the Healthcare Provider","type":"string"},"firstName":{"description":"First name of the Healthcare Provider","type":"string"},"surname":{"description":"Surname of the Healthcare Provider","type":"string"},"gender":{"description":"Gender of the Healthcare Provider","enum":["Male","Female","Other","Unknown"],"type":"string"},"ethnicity":{"description":"Ethnicity of the Healthcare Provider","enum":["Unspecified","Caucasian","Black","Coloured","Asian","Indian"],"type":"string"},"languages":{"description":"A collection of languages that the Healthcare Provider can speak","uniqueItems":false,"type":"array","items":{"format":"uuid","type":"string"}},"rsaIdentificationNumber":{"description":"South African identification document number of the Healthcare Provider","type":"string"},"dateOfBirth":{"format":"date-time","description":"Date of birth of the Healthcare Provider","type":"string"},"specialityId":{"format":"uuid","description":"Unique identifier that links to a specialty","type":"string"},"specialityName":{"description":"Specialty name associated with the specialityId","type":"string"},"professionId":{"format":"uuid","description":"Unique identifier that links to a profession","type":"string"},"professionName":{"description":"Profession name associated with the professionId","type":"string"},"qualifications":{"description":"The qualifications that the Healthcare Provider possesses","type":"string"},"practiceName":{"description":"Name of the practice where the Healthcare Provider is stationed","type":"string"},"phoneNumber":{"description":"Contact number of the practitioner","type":"string"},"practiceEmailAddress":{"description":"General email address of the practice","type":"string"},"council":{"type":"string"},"privatePracticeNumber":{"description":"Private contact number of the practice","type":"string"},"additional1":{"description":"First additional number in case private number is unavailable","type":"string"},"additional2":{"description":"Second additional number in case private and first additional number is unavailable","type":"string"},"physicalAddress":{"description":"Physical address of the Healthcare Provider","type":"string"},"postalAddress":{"description":"Postal address of the Healthcare Provider","type":"string"},"practiceAddress":{"description":"Physical address of the practice","type":"string"},"suburb":{"description":"Suburb in which the Healthcare Provider stays in","type":"string"},"city":{"description":"City in which the Healthcare Provider stays in","type":"string"},"provinceId":{"format":"uuid","description":"Unique identifier of the province in which the Healthcare Provider stays in","type":"string"},"provinceName":{"description":"Provincial name associated with the provinceId","type":"string"},"mobileNumber":{"description":"Mobile number of the Healthcare Provider","type":"string"},"alternateNumber":{"description":"Alternative contact number of the Healthcare Provider","type":"string"},"location":{"description":"Location of the practice","type":"string"},"longitude":{"format":"double","description":"Global positioning longitude of the practice","type":"number"},"latitude":{"format":"double","description":"Global positioning latitude of the practice","type":"number"}}},"HealthCloud.Models.Api.CareProvider.CareProviderRegisterModel":{"required":["emailAddress","password","firstName","surname"],"type":"object","properties":{"emailAddress":{"description":"Email address of the Healthcare Provider","maxLength":200,"type":"string"},"password":{"format":"password","description":"Rule: Password must have a minimum of 8 characters. Password must consist of at least 1 Capital letter and one special character.","minLength":8,"pattern":"^.*(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%^&*\\(\\)_\\-+=])(?=.{8,}).*$","type":"string"},"title":{"description":"Title of the Healthcare Provider","maxLength":20,"type":"string"},"firstName":{"description":"First name of the Healthcare Provider","maxLength":50,"type":"string"},"surname":{"description":"Surname of the Healthcare Provider","maxLength":50,"type":"string"},"gender":{"description":"Gender of the Healthcare Provider","enum":["Male","Female","Other","Unknown"],"type":"string"},"ethnicity":{"description":"Ethnicity of the Healthcare Provider","enum":["Unspecified","Caucasian","Black","Coloured","Asian","Indian"],"type":"string"},"languages":{"description":"A collection of languages that the Healthcare Provider can speak","uniqueItems":false,"type":"array","items":{"format":"uuid","type":"string"}},"rsaIdentificationNumber":{"description":"South African identification document number of the Healthcare Provider","maxLength":13,"type":"string"},"dateOfBirth":{"format":"date-time","description":"Date of birth of the Healthcare Provider","type":"string"},"specialityId":{"format":"uuid","description":"Unique identifier that links to a specialty","type":"string"},"professionId":{"format":"uuid","description":"Unique identifier that links to a profession","type":"string"},"qualifications":{"description":"The qualifications that the Healthcare Provider possesses","type":"string"},"practiceName":{"description":"Name of the practice where the Healthcare Provider is stationed","maxLength":200,"type":"string"},"phoneNumber":{"description":"Contact number of the practitioner","maxLength":15,"type":"string"},"practiceEmailAddress":{"description":"General email address of the practice","maxLength":200,"type":"string"},"council":{"maxLength":15,"type":"string"},"privatePracticeNumber":{"description":"Private contact number of the practice","maxLength":15,"type":"string"},"additional1":{"description":"First additional number in case private number is unavailable","maxLength":15,"type":"string"},"additional2":{"description":"Second additional number in case private and first additional number is unavailable","maxLength":15,"type":"string"},"physicalAddress":{"description":"Physical address of the Healthcare Provider","maxLength":200,"type":"string"},"postalAddress":{"description":"Postal address of the Healthcare Provider","maxLength":200,"type":"string"},"practiceAddress":{"description":"Physical address of the practice","maxLength":200,"type":"string"},"suburb":{"description":"Suburb in which the Healthcare Provider stays in","maxLength":50,"type":"string"},"city":{"description":"City in which the Healthcare Provider stays in","maxLength":50,"type":"string"},"provinceId":{"format":"uuid","description":"Unique identifier of the province in which the Healthcare Provider stays in","type":"string"},"location":{"description":"Location of the practice","type":"string"},"longitude":{"format":"double","description":"Global positioning longitude of the practice","type":"number"},"latitude":{"format":"double","description":"Global positioning latitude of the practice","type":"number"},"mobileNumber":{"description":"Mobile number of the Healthcare Provider","maxLength":15,"type":"string"},"alternateNumber":{"description":"Alternative contact number of the Healthcare Provider","maxLength":15,"type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.CareProvider.CareProviderRegisterResultModel":{"type":"object","properties":{"registrationResult":{"description":"Result of the registration request","enum":["RegistrationOK","ProfileExists","EnterOTP"],"type":"string"},"profileId":{"format":"uuid","description":"the unique identifier of the newely registered patient","type":"string"},"errorResponse":{"type":"string"}}},"HealthCloud.Models.Api.CareProvider.CareProviderProfileUpdateModel":{"required":["profileId","emailAddress","firstName","surname"],"type":"object","properties":{"profileId":{"format":"uuid","description":"Unique identifier that links to a Healthcare Provider","type":"string"},"emailAddress":{"description":"Email address of the Healthcare Provider","maxLength":200,"type":"string"},"title":{"description":"Title of the Healthcare Provider","maxLength":20,"type":"string"},"firstName":{"description":"First name of the Healthcare Provider","maxLength":50,"type":"string"},"surname":{"description":"Surname of the Healthcare Provider","maxLength":50,"type":"string"},"gender":{"description":"Gender of the Healthcare Provider","enum":["Male","Female","Other","Unknown"],"type":"string"},"ethnicity":{"description":"Ethnicity of the Healthcare Provider","enum":["Unspecified","Caucasian","Black","Coloured","Asian","Indian"],"type":"string"},"languages":{"description":"A collection of languages that the Healthcare Provider can speak","uniqueItems":false,"type":"array","items":{"format":"uuid","type":"string"}},"rsaIdentificationNumber":{"description":"South African identification document number of the Healthcare Provider","maxLength":13,"type":"string"},"dateOfBirth":{"format":"date-time","description":"Date of birth of the Healthcare Provider","type":"string"},"specialityId":{"format":"uuid","description":"Unique identifier that links to a specialty","type":"string"},"professionId":{"format":"uuid","description":"Unique identifier that links to a profession","type":"string"},"qualifications":{"description":"The qualifications that the Healthcare Provider possesses","type":"string"},"practiceName":{"description":"Name of the practice where the Healthcare Provider is stationed","maxLength":200,"type":"string"},"phoneNumber":{"description":"Contact number of the Healthcare Provider","maxLength":10,"type":"string"},"practiceEmailAddress":{"description":"General email address of the Healthcare Provider's practice","maxLength":200,"type":"string"},"council":{"maxLength":10,"type":"string"},"privatePracticeNumber":{"description":"Private contact number of the practice","maxLength":10,"type":"string"},"additional1":{"description":"First additional number in case private number is unavailable","maxLength":10,"type":"string"},"additional2":{"description":"Second additional number in case private and first additional number is unavailable","maxLength":10,"type":"string"},"physicalAddress":{"description":"Physical address of the Healthcare Provider","maxLength":200,"type":"string"},"postalAddress":{"description":"Postal address of the Healthcare Provider","maxLength":200,"type":"string"},"practiceAddress":{"description":"Physical address of the practice","maxLength":200,"type":"string"},"suburb":{"description":"Suburb in which the Healthcare Provider stays in","maxLength":50,"type":"string"},"city":{"description":"City in which the Healthcare Provider stays in","maxLength":50,"type":"string"},"provinceId":{"format":"uuid","description":"Unique identifier of the province in which the Healthcare Provider stays in","type":"string"},"mobileNumber":{"description":"Mobile number of the Healthcare Provider","maxLength":10,"type":"string"},"alternateNumber":{"description":"Alternative contact number of the Healthcare Provider","maxLength":10,"type":"string"},"location":{"description":"Location of the practice","type":"string"},"longitude":{"format":"double","description":"Global positioning longitude of the practice","type":"number"},"latitude":{"format":"double","description":"Global positioning latitude of the practice","type":"number"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.CareProvider.CareProviderPatientSearchModel":{"type":"object","properties":{"rsaIdNumber":{"description":"South African identification document number of the Patient","type":"string"},"firstName":{"description":"First name of the Patient","type":"string"},"lastName":{"description":"Surname of the Patient","type":"string"},"cellNumber":{"description":"Mobile number of the Patient","type":"string"},"pageNumber":{"format":"int32","description":"The page number","type":"integer"},"sizeOfPage":{"format":"int32","description":"The amount of records to retrieve per page","type":"integer"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.GridResultModel`1[[HealthCloud.Models.Api.CareProvider.PatientSearchResult, HealthCloud, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]":{"type":"object","properties":{"results":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.CareProvider.PatientSearchResult"}},"recordCount":{"format":"int32","type":"integer"}}},"HealthCloud.Models.Api.CareProvider.PatientSearchResult":{"type":"object","properties":{"id":{"format":"uuid","description":"Unique identifier that links to the patient","type":"string"},"title":{"description":"Title of the patient","type":"string"},"firstName":{"description":"First name of the patient","type":"string"},"lastName":{"description":"Surname of the patient","type":"string"},"cellNumber":{"description":"Mobile Number of the patient","type":"string"},"rsaIdNumber":{"description":"South African identification document number of the patient","type":"string"},"emailAddress":{"description":"Email address of the patient","type":"string"},"gender":{"description":"Gender of the patient","enum":["Male","Female","Other","Unknown"],"type":"string"},"fullName":{"description":"The patient's concatenated first name and surname","type":"string","readOnly":true},"fullNameWithEmail":{"description":"The patient's concatenated first name, surname and email address","type":"string","readOnly":true}}},"HealthCloud.Models.Api.CareProvider.CareProviderBookingSearchModel":{"required":["profileId"],"type":"object","properties":{"profileId":{"format":"uuid","description":"Unique identifier that links to a Healthcare Provider","type":"string"},"startDate":{"format":"date-time","description":"Bookings Start Date","type":"string"},"endDate":{"format":"date-time","description":"Bookings End Date","type":"string"},"description":{"description":"Booking Description","type":"string"},"pageNumber":{"format":"int32","description":"The page number","type":"integer"},"sizeOfPage":{"format":"int32","description":"The amount of records to retrieve per page","type":"integer"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.GridResultModel`1[[HealthCloud.Models.Api.CareProvider.CareProviderBookingResultModel, HealthCloud, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]":{"type":"object","properties":{"results":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.CareProvider.CareProviderBookingResultModel"}},"recordCount":{"format":"int32","type":"integer"}}},"HealthCloud.Models.Api.CareProvider.CareProviderBookingResultModel":{"type":"object","properties":{"patientId":{"format":"uuid","description":"Unique identifier that links to a patient's profile","type":"string"},"unregisteredPatientId":{"format":"uuid","description":"Unique identifier that links to a unregistered patient's profile","type":"string"},"bookingId":{"format":"uuid","description":"Unique identifier that links the booking","type":"string"},"startDate":{"format":"date-time","description":"Date of which the visit starts","type":"string"},"endDate":{"format":"date-time","description":"Date of which the visit ends","type":"string"},"description":{"description":"Description of the booking","type":"string"},"patientName":{"description":"Patient's First Name","type":"string"},"patientSurname":{"description":"Patient's Surname","type":"string"},"timeSlotSize":{"format":"int32","description":"How Long the Visit is in minutes","type":"integer"},"bookingState":{"description":"Status of the booking","enum":["Preliminary","Confirmed","Declined","Canceled","TimeSlotAlreadyBooked","NoTimeSlotsAvailable"],"type":"string"},"bookingTime":{"description":"Formatted time string","type":"string","readOnly":true},"bookingDate":{"description":"Formatted Date string","type":"string","readOnly":true}}},"HealthCloud.Models.Api.CareProvider.AvailableTimeSlotRequestModel":{"type":"object","properties":{"profileId":{"format":"uuid","description":"Unique identifier that links to a Healthcare Provider","type":"string"},"dateTime":{"format":"date-time","description":"Booking Date and Time","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.CareProvider.CareProviderAvailableTimeSlotModel":{"type":"object","properties":{"profileId":{"format":"uuid","description":"Unique identifier that links to a Healthcare Provider","type":"string"},"availableTimeSlots":{"description":"List of available time slots for a specified date","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.CareProvider.AvailableTimeSlotModel"}}}},"HealthCloud.Models.Api.CareProvider.AvailableTimeSlotModel":{"type":"object","properties":{"startDate":{"format":"date-time","description":"Time slot start Time","type":"string"},"endDate":{"format":"date-time","description":"Time slot end Time","type":"string"}}},"HealthCloud.Models.Api.MasterData.ProvinceModel":{"type":"object","properties":{"id":{"format":"uuid","description":"Unique identifier that links to a province","type":"string"},"name":{"description":"The name of the province","type":"string"}}},"HealthCloud.Models.Api.MasterData.TimeSlotModel":{"type":"object","properties":{"id":{"format":"uuid","description":"Unique identifier that links to a Timeslot","type":"string"},"description":{"description":"This is a description of the timeslot","type":"string"},"minutes":{"format":"int32","description":"This indicates the length of the timeslot in minutes","type":"integer"}}},"HealthCloud.Models.Api.MasterData.LanguageModel":{"type":"object","properties":{"id":{"format":"uuid","description":"Unique identifier that links to a language","type":"string"},"name":{"description":"This is the language's name","type":"string"}}},"HealthCloud.Models.Api.MasterData.SpecialityModel":{"type":"object","properties":{"id":{"format":"uuid","description":"Unique identifier that links to a speciality","type":"string"},"name":{"description":"This is the speciality's name","type":"string"}}},"HealthCloud.Models.Api.MasterData.ProfessionModel":{"type":"object","properties":{"id":{"format":"uuid","description":"Unique identifier that links to a profession","type":"string"},"name":{"description":"This is the profession's name","type":"string"}}},"HealthCloud.Models.Api.MasterData.MedicalAidModel":{"type":"object","properties":{"id":{"format":"uuid","description":"Unique identifier that links to a medical aid","type":"string"},"name":{"description":"This is the medical aid's name","type":"string"}}},"HealthCloud.Models.Api.MasterData.EmployerModel":{"type":"object","properties":{"employerId":{"format":"uuid","description":"Unique identifier that links to an employer","type":"string"},"friendlyName":{"description":"This is the friendly name given to the employer","type":"string"},"registeredName":{"description":"This is the employer's registered name","type":"string"},"registrationNumber":{"description":"Employer's Registration Number","type":"string"}}},"HealthCloud.Models.Api.MasterData.ApiEnumModel":{"type":"object","properties":{"value":{"description":"This is the Value associated with the Enum item","type":"string"},"description":{"description":"This is the description given form the Enum item","type":"string"}}},"HealthCloud.Models.Api.Media.MediaCategoryModel":{"type":"object","properties":{"categoryId":{"format":"uuid","description":"Unique identifier that links to a category","type":"string"},"name":{"description":"A name that is given to a specific category","type":"string"}}},"HealthCloud.Models.Api.Media.LatestMediaRequestModel":{"type":"object","properties":{"numberOfItems":{"format":"int32","type":"integer"},"language":{"type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.Media.MediaItemModel":{"type":"object","properties":{"createdDate":{"format":"date-time","description":"Created Date of the Media","type":"string"},"mediaId":{"format":"uuid","description":"Unique identifier that links to Media","type":"string"},"categoryId":{"format":"uuid","description":"Unique identifier that links to a category","type":"string"},"thumbnailImageURL":{"description":"link to ThumbnailImage","type":"string"},"isInfographic":{"description":"Is the article a infographic","type":"boolean"},"categoryName":{"description":"A name given for a specific media category","type":"string"},"summary":{"description":"This is a summarized version of what the media item contains","type":"string"},"rank":{"format":"int32","description":"The Search result rank number","type":"integer"},"protocolName":{"description":"Name of the group / sub-category","type":"string","readOnly":true},"content":{"description":"The Html Content","type":"string","readOnly":true},"singleClickView":{"description":"The Media can be viewed without a request if true","type":"boolean","readOnly":true}}},"HealthCloud.Models.Api.Media.MediaSearchModel":{"type":"object","properties":{"categoryId":{"format":"uuid","description":"Unique identifier that links to a category","type":"string"},"searchKey":{"description":"A keyword that helps to find a specific media item","type":"string"},"language":{"description":"Language the search key is in","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.Media.MediaAdvancedSearchModel":{"type":"object","properties":{"categoryId":{"format":"uuid","description":"Unique identifier that links to a category","type":"string"},"searchKeys":{"description":"A keyword that helps to find a specific media item. Multiple search keywords can be simicolon seperated (eg. first;second;third ...)","type":"string"},"relationalTags":{"description":"A relational keyword that helps to find a specific media item. Multiple relational keywords can be simicolon seperated (eg. first;second;third ...)","type":"string"},"relationalKeys":{"description":"Relational keyword pairs that helps to find a specific media item","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Models.SmartSearchModels.RelationalTagModel"}},"resquestAsFlatStructure":{"description":"Specifies if the relational tags within the result to be returned should be as a value key pairs(false) or comma seperated list(true).","type":"boolean"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.BL.Models.SmartSearchModels.RelationalTagModel":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"HealthCloud.Models.Api.Media.AdvancedSearchMediaModel":{"type":"object","properties":{"createdDate":{"format":"date-time","description":"Created Date of the Media","type":"string"},"mediaId":{"format":"uuid","description":"Unique identifier that links to Media","type":"string"},"categoryId":{"format":"uuid","description":"Unique identifier that links to a category","type":"string"},"thumbnailImageURL":{"description":"link to ThumbnailImage","type":"string"},"isInfographic":{"description":"Is the article a infographic","type":"boolean"},"categoryName":{"description":"A name given for a specific media category","type":"string"},"summary":{"description":"This is a summarized version of what the media item contains","type":"string"},"rank":{"format":"int32","description":"The Search result rank number","type":"integer"},"protocolName":{"description":"Name of the group / sub-category","type":"string","readOnly":true},"content":{"description":"The Html Content","type":"string","readOnly":true},"singleClickView":{"description":"The Media can be viewed without a request if true","type":"boolean","readOnly":true},"flattenedRelationalTags":{"description":"Relational tags connecting the media item to people, places and things as a comma seperated list","type":"string"},"relationalTags":{"description":"Relational tags connecting the media item to people, places and things","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Models.SmartSearchModels.RelationalTagModel"}}}},"HealthCloud.Models.Api.Media.AvatarItemModel":{"type":"object","properties":{"mediaCategoryId":{"format":"uuid","description":"link to Media Category","type":"string"},"maleFrontImageURL":{"description":"link to Male Front Image","type":"string"},"maleBackImageURL":{"description":"link to Male Back Image","type":"string"},"femaleFrontImageURL":{"description":"link to Female Front Image","type":"string"},"femaleBackImageURL":{"description":"link to Female Back Image","type":"string"},"avatarMaps":{"description":"link to Avatar Maps","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.Media.AvatarMapItemModel"}}}},"HealthCloud.Models.Api.Media.AvatarMapItemModel":{"type":"object","properties":{"mediaCategoryId":{"format":"uuid","description":"link to Media Category","type":"string"},"coordinates":{"description":"link to Coordinates","type":"string"},"title":{"description":"link to Title","type":"string"},"shape":{"description":"link to Shape","type":"string"},"hint":{"description":"link to Hint","type":"string"},"priority":{"format":"int32","description":"link to Priority","type":"integer"},"genderType":{"description":"link to GenderType","enum":["Male","Female"],"type":"string"},"positionType":{"description":"link to PositionType","enum":["Front","Back"],"type":"string"}}},"HealthCloud.Models.Api.Media.AvatarMediaSearchModel":{"type":"object","properties":{"categoryId":{"format":"uuid","description":"Unique identifier that links to a category","type":"string"},"genderType":{"description":"Unique identifier that links to a gender type","enum":["Male","Female"],"type":"string"},"positionType":{"description":"Unique identifier that links to a position type","enum":["Front","Back"],"type":"string"},"coordinates":{"description":"Unique identifier that links to a coordinates","type":"string"},"title":{"description":"Unique identifier that links to a coordinates title","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.Media.MediaRequestModel":{"required":["mediaId"],"type":"object","properties":{"mediaId":{"format":"uuid","description":"Unique identifier that links to Media","type":"string"},"reference":{"description":"A referencing name for the media item","type":"string"},"language":{"description":"A language the media item should be returned in","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.Media.MediaRequestResultModel":{"type":"object","properties":{"url":{"description":"A URL for the media item","type":"string"},"expires":{"format":"date-time","description":"A Specific Date and Time until the URL expires","type":"string"},"singleClickView":{"type":"boolean"}}},"HealthCloud.Models.Api.Media.MediaKeyWordsRequestModel":{"type":"object","properties":{"lastUpdatedDate":{"format":"date-time","description":"Date of the last extraction","type":"string"},"startFrom":{"format":"int32","type":"integer"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.Media.MediaKeyWordsResultModel":{"type":"object","properties":{"mediaItemId":{"format":"uuid","type":"string"},"summaryText":{"type":"string"},"keyWords":{"uniqueItems":false,"type":"array","items":{"type":"string"}},"lastUpdateDate":{"format":"date-time","type":"string"}}},"HealthCloud.Models.Api.Media.TranslationModel":{"type":"object","properties":{"words":{"description":"Words or phrases to be translated.","uniqueItems":false,"type":"array","items":{"type":"string"}},"fromLanguage":{"description":"Language the words or phrases is written in.","type":"string"},"toLanguages":{"description":"Languages the words or phrases must be translated to.","uniqueItems":false,"type":"array","items":{"type":"string"}}}},"HealthCloud.BL.Provider.MediaData.TranslatedItem":{"type":"object","properties":{"translations":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.BL.Provider.MediaData.Translation"}}}},"HealthCloud.BL.Provider.MediaData.Translation":{"type":"object","properties":{"text":{"type":"string"},"to":{"type":"string"}}},"HealthCloud.Models.Api.Patient.PatientProfileRequest":{"type":"object","properties":{"patientProfileId":{"format":"uuid","description":"Unique identifier that links to the patient","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.Patient.PatientProfileModel":{"type":"object","properties":{"profileId":{"format":"uuid","description":"Unique identifier that links to the patient","type":"string"},"medicalAidId":{"format":"uuid","description":"Unique identifier that links to a medical aid","type":"string"},"employerId":{"format":"uuid","description":"Unique identifier that links to an employer","type":"string"},"provinceName":{"description":"Name of the province in which the patient stays in","type":"string"},"medicalAidName":{"description":"Name of the medical aid of the patient","type":"string"},"email":{"description":"Email address of the patient","type":"string"},"firstName":{"description":"First name of The Patient","type":"string"},"surname":{"description":"Surname of the patient","type":"string"},"title":{"description":"Title of the patient","type":"string"},"mobileNumber":{"description":"Primary contact number of the patient","type":"string"},"alternateNumber":{"description":"Secondary contact number of the patient","type":"string"},"gender":{"description":"The Patient's Gender","enum":["Male","Female","Other","Unknown"],"type":"string"},"ethnicity":{"description":"The Patient's Ethnicity","enum":["Unspecified","Caucasian","Black","Coloured","Asian","Indian"],"type":"string"},"patientType":{"description":"Is the patient an adult or a child","enum":["Adult","Child"],"type":"string"},"languages":{"description":"Collection of languages that the patient can speak","uniqueItems":false,"type":"array","items":{"format":"uuid","type":"string"}},"physicalAddress":{"description":"Physical address of the patient","type":"string"},"postalAddress":{"description":"Postal address of the patient","type":"string"},"city":{"description":"City where the patient lives in","type":"string"},"provinceId":{"format":"uuid","description":"Unique identifier that links to a province","type":"string"},"suburb":{"description":"Suburb where the beneficiary lives","type":"string"},"postalCode":{"description":"Postal code of patient's address","type":"string"},"rsaIdNumber":{"description":"South African Identity Document number or Passport number","type":"string"},"dateOfBirth":{"format":"date-time","description":"Date of birth of the Patient","type":"string"},"medicalAidProduct":{"description":"The medical aid scheme the patient is a member of","type":"string"},"medicalAidPolicyNumber":{"description":"Membership number of the scheme the member is active on","type":"string"},"emergencyContactName":{"description":"Name of patient's emergency contact person","type":"string"},"emergencyNumber":{"description":"contact number of patient's emergency person","type":"string"},"emergencyContactNextOfKin":{"description":"Contact number of The Patient's closest relative","type":"string"},"employerName":{"description":"Name of patient's employer","type":"string"},"occupation":{"description":"patient's occupation","type":"string"},"qualification":{"description":"patient's qualification","type":"string"}}},"HealthCloud.Models.Api.Patient.PatientRegisterModel":{"required":["emailAddress","firstName","surname","mobileNumber","password"],"type":"object","properties":{"emailAddress":{"description":"Email Address of the patient","maxLength":200,"type":"string"},"firstName":{"description":"First name of patient","maxLength":200,"type":"string"},"surname":{"description":"Surname of patient","maxLength":200,"type":"string"},"title":{"description":"Title of the patient","maxLength":20,"type":"string"},"mobileNumber":{"description":"Mobile Number of the patient","maxLength":15,"type":"string"},"alternateNumber":{"description":"Alternative Mobile Number of the patient","maxLength":15,"type":"string"},"password":{"format":"password","description":"Rule: Password must have a minimum of 8 characters. Password must consist of at least 1 Capital letter and one special character.","type":"string"},"otpVerificationRequired":{"description":"Should one time pin verification should be enforced","type":"boolean"},"otpLength":{"format":"int32","type":"integer"},"gender":{"description":"Gender of the patient","enum":["Male","Female","Other","Unknown"],"type":"string"},"ethnicity":{"description":"Ethnicity of the patient","enum":["Unspecified","Caucasian","Black","Coloured","Asian","Indian"],"type":"string"},"patientType":{"description":"Is the Patient an adult or a child","enum":["Adult","Child"],"type":"string"},"languages":{"description":"Collection of languages that the patient can speak","uniqueItems":false,"type":"array","items":{"format":"uuid","type":"string"}},"provinceId":{"format":"uuid","description":"Unique identifier that links to a province","type":"string"},"physicalAddress":{"description":"Physical address of the patient","type":"string"},"postalAddress":{"description":"Postal address of the patient","type":"string"},"city":{"description":"City the patient lives in","type":"string"},"suburb":{"description":"Suburb the patient lives in","type":"string"},"postalCode":{"description":"Postal code of patient's address","type":"string"},"rsaIdNumber":{"description":"South African Identity Document number or Passport number","maxLength":13,"type":"string"},"dateOfBirth":{"format":"date-time","description":"Date of birth of the patient","type":"string"},"medicalAidId":{"format":"uuid","description":"Unique identifier that links to a medical aid","type":"string"},"medicalAidProduct":{"description":"The medical aid scheme the patient is a member of","maxLength":200,"type":"string"},"medicalAidPolicyNumber":{"description":"Membership number of the scheme the member is active on","maxLength":15,"type":"string"},"beneficiaryNumber":{"description":"The Beneficiary Number of the medical aid","maxLength":15,"type":"string"},"emergencyContactName":{"description":"Name of patient's emergency contact person","type":"string"},"emergencyNumber":{"description":"contact number of patient's emergency person","maxLength":15,"type":"string"},"emergencyContactNextOfKin":{"description":"Contact number of The Patient's closest relative","type":"string"},"employerId":{"format":"uuid","description":"Unique identifier that links to a employer","type":"string"},"employerName":{"description":"Name of patient's employer","type":"string"},"occupation":{"description":"patient's occupation","type":"string"},"businessUnit":{"description":"patient's BusinessUnit/Division","type":"string"},"qualification":{"description":"patient's qualification","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.Patient.PatientUpdateModel":{"required":["profileId","email","firstName","surname","mobileNumber"],"type":"object","properties":{"profileId":{"format":"uuid","description":"Unique identifier that links to the patient","type":"string"},"medicalAidId":{"format":"uuid","description":"Unique identifier that links to a medical aid","type":"string"},"email":{"description":"Email address of the patient","maxLength":200,"type":"string"},"firstName":{"description":"First name of The Patient","maxLength":200,"type":"string"},"surname":{"description":"Surname of the patient","maxLength":200,"type":"string"},"title":{"description":"Title of the patient","maxLength":20,"type":"string"},"mobileNumber":{"description":"Primary contact number of the patient","maxLength":15,"type":"string"},"alternateNumber":{"description":"Secondary contact number of the patient","maxLength":15,"type":"string"},"gender":{"description":"The Patient's Gender","enum":["Male","Female","Other","Unknown"],"type":"string"},"ethnicity":{"description":"The Patient's Ethnicity","enum":["Unspecified","Caucasian","Black","Coloured","Asian","Indian"],"type":"string"},"patientType":{"description":"Is the patient an adult or a child","enum":["Adult","Child"],"type":"string"},"languages":{"description":"Collection of languages that the patient can speak","uniqueItems":false,"type":"array","items":{"format":"uuid","type":"string"}},"physicalAddress":{"description":"Physical address of the patient","type":"string"},"postalAddress":{"description":"Postal address of the patient","type":"string"},"city":{"description":"City where the patient lives in","type":"string"},"provinceId":{"format":"uuid","description":"Unique identifier that links to a province","type":"string"},"suburb":{"description":"Suburb where the beneficiary lives","maxLength":200,"type":"string"},"postalCode":{"description":"Postal code of patient's address","type":"string"},"rsaIdNumber":{"description":"South African Identity Document number or Passport number","type":"string"},"dateOfBirth":{"format":"date-time","description":"Date of birth of the Patient","type":"string"},"medicalAidProduct":{"description":"The medical aid scheme the patient is a member of","maxLength":200,"type":"string"},"medicalAidPolicyNumber":{"description":"Membership number of the scheme the member is active on","maxLength":15,"type":"string"},"beneficiaryNumber":{"description":"The Beneficiary Number of the medical aid","maxLength":15,"type":"string"},"emergencyContactName":{"description":"Name of patient's emergency contact person","type":"string"},"emergencyNumber":{"description":"contact number of patient's emergency person","maxLength":15,"type":"string"},"emergencyContactNextOfKin":{"description":"Contact number of The Patient's closest relative","type":"string"},"employerId":{"format":"uuid","description":"Unique identifier that links to a employer","type":"string"},"employerName":{"description":"Name of patient's employer","type":"string"},"occupation":{"description":"patient's occupation","type":"string"},"businessUnit":{"description":"patient's BusinessUnit/Division","type":"string"},"qualification":{"description":"patient's qualification","type":"string"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.Patient.CareProviderSearchModel":{"type":"object","properties":{"provinceId":{"format":"uuid","description":"Filter by province Id","type":"string"},"city":{"description":"Filter by City","type":"string"},"name":{"description":"Filter by Name","type":"string"},"pageNumber":{"format":"int32","description":"The page number","type":"integer"},"sizeOfPage":{"format":"int32","description":"The amount of records to retrieve","type":"integer"},"latitude":{"format":"double","description":"Filter by Latitude","type":"number"},"longitude":{"format":"double","description":"Filter by Longitude","type":"number"},"distance":{"format":"double","description":"Filter by distance","type":"number"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.GridResultModel`1[[HealthCloud.Models.Api.Patient.CareProviderSearchResult, HealthCloud, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]":{"type":"object","properties":{"results":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.CareProviderSearchResult"}},"recordCount":{"format":"int32","type":"integer"}}},"HealthCloud.Models.Api.Patient.CareProviderSearchResult":{"type":"object","properties":{"id":{"format":"uuid","type":"string"},"provinceId":{"format":"uuid","type":"string"},"province":{"type":"string"},"city":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"title":{"type":"string"},"mobileNumber":{"type":"string"},"emailAddress":{"type":"string"},"gender":{"enum":["Male","Female","Other","Unknown"],"type":"string"},"careProfessionalProfessionId":{"format":"uuid","type":"string"},"careProfessionalSpecialityId":{"format":"uuid","type":"string"},"careProfessionalProfession":{"type":"string"},"careProfessionalSpeciality":{"type":"string"},"careProfessionalAddress":{"type":"string"},"careProfessionalPracticeName":{"type":"string"},"fromLatitude":{"format":"double","type":"number"},"fromLogitude":{"format":"double","type":"number"},"toLatitude":{"format":"double","type":"number"},"toLongitude":{"format":"double","type":"number"},"careProfessionalDistance":{"format":"double","type":"number","readOnly":true}}},"HealthCloud.Models.Api.Patient.CompanySearchModel":{"required":["provinceId"],"type":"object","properties":{"provinceId":{"format":"uuid","description":"Unique identifier of the province in which the Healthcare Provider stays in","type":"string"},"city":{"description":"City in which the company is located","type":"string"},"name":{"description":"Name of the company","type":"string"},"pageNumber":{"format":"int32","description":"The page number","type":"integer"},"sizeOfPage":{"format":"int32","description":"The amount of records to retrieve per page","type":"integer"},"apiKey":{"format":"uuid","description":"The Integrating System's unique identifier.","type":"string"},"language":{"description":"The language the content is requested in","type":"string"},"correlationId":{"description":"Concatenated string of the current UTC Date Time and 32 Random Generated Alphanumeric characters (0-9, A-Z, a-z)","type":"string"},"passphrase":{"description":"base64 string of the HMACSHA256 hashing.","type":"string"},"loggedInUserId":{"format":"uuid","description":"Unique identifier of the logged in user","type":"string"}}},"HealthCloud.Models.Api.GridResultModel`1[[HealthCloud.Models.Api.Patient.CompanySearchResult, HealthCloud, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]":{"type":"object","properties":{"results":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthCloud.Models.Api.Patient.CompanySearchResult"}},"recordCount":{"format":"int32","type":"integer"}}},"HealthCloud.Models.Api.Patient.CompanySearchResult":{"type":"object","properties":{"id":{"format":"uuid","description":"Unique identifier of the company","type":"string"},"provinceId":{"format":"uuid","description":"Unique identifier of the province in which the Healthcare Provider stays in","type":"string"},"province":{"description":"The name of the province","type":"string"},"city":{"description":" ///
Exposes fitness provider data and daily summaries
"},{"name":"HCCMasterData","description":"Contains a collection of API Endpoints that allows users to retrieve static lists of objects.
"},{"name":"HCCMedia","description":"The Media API's allows an integrated system to retrieve valuable health related media content with a variety of different categories to search from
"},{"name":"HCCSecurity","description":"Security Related API Endpoints.
"},{"name":"ActivityProfile","description":"The ActivityProfile API contains a collection of methods for registering and interacting with patient / member wellness data.When an organisation integrates with HealthCloud, the patient / member can be linked to one or more Categories.
Example 1: A Medical Scheme Administrator can have multiple Categories for their Medical Schemes and patients / members can be linked to, and moved between,the Categories without the need to re-register when moving between the Categories.
Example 2: A Company may wish to link the patient / member to a specific business unit or division within the organisation.
The patient / member is registered anonymously to one or more Categories and will be identified by the provided Category ID or the newly generated HealthCloud ID.
"},{"name":"EHRMasterData","description":"Contains a collection of API Endpoints to allow a user to retrieve a list of specific data.
"},{"name":"ElectronicHealthRecord","description":"Electronic Health Record (EHR) provides a digital record of a patient's health information, it also contains input from all the practitioners that are involved in the patient’s care and provides a comprehensive view of the patient’s health and treatment history.
"},{"name":"HCCCareProvider","description":"Contains a collection of API Endpoints to allow Healthcare Providers to Register and Maintain their profiles.
"},{"name":"HCCPatient","description":"Contains a collection of API Endpoints to allow Patients to Register and Maintain their profiles, as well as to create new bookings.
"},{"name":"Custom","description":"Customized Api Calls
"},{"name":"PersonalHealthRecord","description":"A Personal Health Record (PHR), is a health record where health data and other information related to the care of a patient is maintained by the patient. Where as the EHR is maintained by medical professionals.
"},{"name":"PointOfCare","description":"Point Of Care Api Calls
"}]}