Introduction

Welcome to the HealthCloud API! You can use our API to access HC API endpoints.

HealthCloud exposes a Swagger UI which can be accessed at /swagger/ui.

The Swagger can be used with http://editor.swagger.io/ to generate client proxy code in many different development languages including but not limited to the following:

Languages
akka-scale	android	apex	async-scala
bash	clojure	cpprest	C#
C# DotNet 2	cwiki	dart	dynamic-html
eiffel	elixir	flash	go
groovy	html	html 2	java
javascript	javascript-closure-angular	jaxrs-cxf-client	jmeter
kotlin	objc	perl	php
powershell	python	qt5cpp	ruby
scala	swagger	swagger-yaml	swift
swift 3	swift 4	tizen	typescript-angular
typescript-angular 2	typescript-fetch	typescript-jquery	typescript-node

Apply for access

To be able to integrate with the HealthCloud SSO platform the developer needs to follow a few steps.

Step 1 – Follow the Apply for access link to register for your API credentials.

Step 2 – You will receive an email once your application is approved with your api credentials.

Step 3 – You can configure your callback url and maintain your credentials by following Maintain Credentials.

Step 4 - Implementation.

Implementation

The HC System requires the API Key, a CorrelationId and passphrase, to be sent with every request, this will be used to identify the calling system and to prevent Replay attacks.

string apiKey = “{YOUR API KEY}”;
string secret = “{YOUR SECRET}”;
string correlationId = DateTime.UtcNow.ToString("yyyyMMddHHmm") + RandomString(32);

var hash = new HMACSHA256(Encoding.ASCII.GetBytes(correlationId + secret));//setup
var passHash = hash.ComputeHash(Encoding.ASCII.GetBytes(apiKey));//calculate hash

string passphrase = Convert.ToBase64String(passHash);

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.
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.
Lastly convert this HASH value to a base64 string and pass it to the server as your passphrase.

Patient

Contains a collection of API Endpoints to allow Patients to Register and Maintain their profiles, as well as to create new bookings.

Patient Register

The method will create a new Patient record in the HC database.

API Endpoint

POST /api/HCCPatient/Register

POST /api/HCCPatient/Register HTTP/1.1
Content-Type: application/json

{
    "emailAddress": "string",
    "firstName": "string",
    "surname": "string",
    "title": "string",
    "mobileNumber": "string",
    "alternateNumber": "string",
    "password": "string",
    "gender": "string",
    "ethnicity": "string",
    "patientType": "string",
    "languages": [
        "string"
    ],
    "provinceId": "string",
    "physicalAddress": "string",
    "postalAddress": "string",
    "city": "string",
    "suburb": "string",
    "postalCode": "string",
    "rsaIdNumber": "string",
    "dateOfBirth": "string",
    "medicalAidId": "string",
    "medicalAidProduct": "string",
    "medicalAidPolicyNumber": "string",
    "emergencyContactName": "string",
    "emergencyNumber": "string",
    "emergencyContactNextOfKin": "string",
    "employerId": "string",
    "employerName": "string",
    "occupation": "string",
    "qualification": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Acceptable values	Description
emailAddress *	string		Email Address of the beneficiary
firstName *	string		First name of beneficiary
surname *	string		Surname of beneficiary
title	string		Title of beneficiary
mobileNumber *	string		Mobile Number of the beneficiary
alternateNumber	string		Alternative Mobile Number of the beneficiary
password *	string		Rule: Password must have a minimum of 8 characters. Password must consist of at least 1 Capital letter and one special character.
gender	string	[Male, Female]
ethnicity	string	[Unspecified, Caucasian, Black, Coloured, Asian, Indian]
patientType	string	[Adult, Child]
languages	array[string]		Collection of languages that the patient can speak
provinceId	string	uuid	Unique identifier that links to a province
physicalAddress	string		Physical address of the beneficiary
postalAddress	string		Postal address of the beneficiary
city	string		City the beneficiary lives in
suburb	string		Suburb the beneficiary lives in
postalCode	string		Postal code of patient's address
rsaIdNumber	string		South African Identity Document number or Passport number
dateOfBirth	string	date-time	Date of birth of the beneficiary
medicalAidId	string	uuid	Unique identifier that links to a medical aid
medicalAidProduct	string
medicalAidPolicyNumber	string		Membership number of the scheme the member is active on
emergencyContactName	string		Name of patient's emergency contact person
emergencyNumber	string		Contact number of patient's emergency person
emergencyContactNextOfKin	string
employerId	string	uuid	Unique identifier that links to a employer
employerName	string		Name of beneficiary's employer
occupation	string		Beneficiary's occupation
qualification	string		Beneficiary's qualification

HTTP/1.1 200 OK
Content-Type: application/json

{
    "registrationResult": "string",
    "profileId": "string",
    "errorResponse": "string"
}

Fields

Name	Type	Format	Description
registrationResult	string	[RegistrationOK, ProfileExists, EnterOTP]
profileId	string	uuid	Unique identifier that links to the patient
errorResponse	string

Patient Profile Get

Returns a profile for a patient via profile ID.

API Endpoint

POST /api/HCCPatient/ProfileGet

POST /api/HCCPatient/ProfileGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to the patient

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profileId": "string",
    "medicalAidId": "string",
    "employerId": "string",
    "provinceName": "string",
    "medicalAidName": "string",
    "email": "string",
    "firstName": "string",
    "surname": "string",
    "title": "string",
    "mobileNumber": "string",
    "alternateNumber": "string",
    "gender": "string",
    "ethnicity": "string",
    "patientType": "string",
    "languages": [
        "string"
    ],
    "physicalAddress": "string",
    "postalAddress": "string",
    "city": "string",
    "provinceId": "string",
    "suburb": "string",
    "postalCode": "string",
    "rsaIdNumber": "string",
    "dateOfBirth": "string",
    "medicalAidProduct": "string",
    "medicalAidPolicyNumber": "string",
    "emergencyContactName": "string",
    "emergencyNumber": "string",
    "emergencyContactNextOfKin": "string",
    "employerName": "string",
    "occupation": "string",
    "qualification": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to the patient
medicalAidId	string	uuid	Unique identifier that links to a medical aid
employerId	string	uuid	Unique identifier that links to an employer
provinceName	string		Name of the province in which the patient stays in
medicalAidName	string		Name of the medical aid of the patient
email	string		Email address of the patient
firstName	string		First name of beneficiary
surname	string		Surname of beneficiary
title	string		Title of beneficiary
mobileNumber	string		Primary contact number of the patient
alternateNumber	string		Secondary contact number of the patient
gender	string	[Male,Female]
ethnicity	string	[Unspecified, Caucasian, Black, Coloured, Asian, Indian]	Ethnicity of the beneficiary
patientType	string	[Adult,Child]
languages	array[string]		Collection of languages that the patient can speak
physicalAddress	string		Physical address of the beneficiary
postalAddress	string		Postal address of the beneficiary
city	string		City where the beneficiary lives in
provinceId	string	uuid	Unique identifier that links to a province
suburb	string		Suburb where the beneficiary lives
postalCode	string		Postal code of patient's address
rsaIdNumber	string		South African Identity Document number or Passport number
dateOfBirth	string	date-time	Date of birth of the beneficiary
medicalAidProduct	string
medicalAidPolicyNumber	string		Membership number of the scheme the member is active on
emergencyContactName	string		Name of patient's emergency contact person
emergencyNumber	string		contact number of patient's emergency person
emergencyContactNextOfKin	string
employerName	string		Name of beneficiary's employer
occupation	string		Beneficiary's occupation
qualification	string		Beneficiary's qualification

Patient Profile Update

This API endpoint will update a patient's profile

API Endpoint

POST /api/HCCPatient/ProfileUpdate

POST /api/HCCPatient/ProfileUpdate HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "medicalAidId": "string",
    "email": "string",
    "firstName": "string",
    "surname": "string",
    "title": "string",
    "mobileNumber": "string",
    "alternateNumber": "string",
    "gender": "string",
    "ethnicity": "string",
    "patientType": "string",
    "languages": [
        "string"
    ],
    "physicalAddress": "string",
    "postalAddress": "string",
    "city": "string",
    "provinceId": "string",
    "suburb": "string",
    "postalCode": "string",
    "rsaIdNumber": "string",
    "dateOfBirth": "string",
    "medicalAidProduct": "string",
    "medicalAidPolicyNumber": "string",
    "emergencyContactName": "string",
    "emergencyNumber": "string",
    "emergencyContactNextOfKin": "string",
    "employerId": "string",
    "employerName": "string",
    "occupation": "string",
    "qualification": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
medicalAidId	string	uuid	Unique identifier that links to a medical aid
email *	string		Email address of the beneficiary
firstName *	string		First name of beneficiary
surname *	string		Surname of beneficiary
title	string		Title of beneficiary
mobileNumber *	string		Mobile contact number of the beneficiary
alternateNumber	string		Secondary contact number of the beneficiary
gender	string	[Male, Female]
ethnicity	string	[Unspecified, Caucasian, Black, Coloured, Asian, Indian]	Ethnicity of beneficiary
patientType	string	[Adult, Child]
languages	array[string]		Collection of languages that the beneficiary can speak
physicalAddress	string		Physical address of the beneficiary
postalAddress	string		Postal address of the beneficiary
city	string		City where the beneficiary lives in
provinceId	string	uuid	Unique identifier that links to a province
suburb	string		Suburb where the beneficiary lives
postalCode	string		Postal code of beneficiary's address
rsaIdNumber	string		South African Identity Document number or Passport number
dateOfBirth	string	date-time	Date of birth of the beneficiary
medicalAidProduct	string
medicalAidPolicyNumber	string		Membership number of the scheme the member is active on
emergencyContactName	string		Name of patient's emergency contact person
emergencyNumber	string		Contact number of patient's emergency person
emergencyContactNextOfKin	string
employerId	string	uuid	Unique identifier that links to an employer
employerName	string		Name of beneficiary's employer
occupation	string		Beneficiary's occupation
qualification	string		Beneficiary's qualification

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profileId": "string",
    "medicalAidId": "string",
    "employerId": "string",
    "provinceName": "string",
    "medicalAidName": "string",
    "email": "string",
    "firstName": "string",
    "surname": "string",
    "title": "string",
    "mobileNumber": "string",
    "alternateNumber": "string",
    "gender": "string",
    "ethnicity": "string",
    "patientType": "string",
    "languages": [
        "string"
    ],
    "physicalAddress": "string",
    "postalAddress": "string",
    "city": "string",
    "provinceId": "string",
    "suburb": "string",
    "postalCode": "string",
    "rsaIdNumber": "string",
    "dateOfBirth": "string",
    "medicalAidProduct": "string",
    "medicalAidPolicyNumber": "string",
    "emergencyContactName": "string",
    "emergencyNumber": "string",
    "emergencyContactNextOfKin": "string",
    "employerName": "string",
    "occupation": "string",
    "qualification": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to the patient
medicalAidId	string	uuid	Unique identifier that links to a medical aid
employerId	string	uuid	Unique identifier that links to a employer
provinceName	string		Name of the province in which the patient stays in
medicalAidName	string		Name of the medical aid of the patient
email	string		Email address of the beneficiary
firstName	string		First name of beneficiary
surname	string		Surname of beneficiary
title	string		Title of beneficiary
mobileNumber	string		Mobile contact number of the beneficiary
alternateNumber	string		Secondary contact number of the beneficiary
gender	string	[Male, Female]
ethnicity	string	[Unspecified, Caucasian, Black, Coloured, Asian, Indian]	Ethnicity of beneficiary
patientType	string	[Adult, Child]
languages	array[string]		Collection of languages that the beneficiary can speak
physicalAddress	string		Physical address of the beneficiary
postalAddress	string		Postal address of the beneficiary
city	string		City where the beneficiary lives in
provinceId	string	uuid	Unique identifier that links to a province
suburb	string		Suburb where the beneficiary lives
postalCode	string		Postal code of beneficiary's address
rsaIdNumber	string		South African Identity Document number or Passport number
dateOfBirth	string	date-time	Date of birth of the beneficiary
medicalAidProduct	string
medicalAidPolicyNumber	string		Membership number of the scheme the member is active on
emergencyContactName	string		Name of patient's emergency contact person
emergencyNumber	string		Contact number of patient's emergency person
emergencyContactNextOfKin	string
employerName	string		Name of beneficiary's employer
occupation	string		Beneficiary's occupation
qualification	string		Beneficiary's qualification

Patient Booking Search

This API endpoint will return the specified patient's booking's based on the filter criteria.

API Endpoint

POST /api/HCCPatient/PatientBookingSearch

POST /api/HCCPatient/PatientBookingSearch HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "startDate": "string",
    "endDate": "string",
    "description": "string",
    "pageNumber": "integer",
    "sizeOfPage": "integer",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to the patient
startDate	string	date-time	Date of which the visit starts
endDate	string	date-time	Date of which the visit ends
description	string		Description of the booking
pageNumber	integer	int32	The page number
sizeOfPage	integer	int32	The amount of records to retrieve

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "results": [
        {
            "bookingId": "string",
            "practitionerId": "string",
            "startDate": "string",
            "endDate": "string",
            "practitioner": "string",
            "careProfessionalPracticeName": "string",
            "careProfessionalEmail": "string",
            "careProfessionalAddress": "string",
            "careProfessionalLocation": "string",
            "description": "string",
            "bookingState": "string",
            "bookingTime": "string",
            "bookingDate": "string"
        }
    ],
    "recordCount": "integer"
}

Fields

Name	Type	Format	Description
bookingId	string	uuid	Unique identifier that links the booking
practitionerId	string	uuid	Unique identifier that links to a practitioner
startDate	string	date-time	Date of which the visit starts
endDate	string	date-time	Date of which the visit ends
practitioner	string		Name of the person being visited
careProfessionalPracticeName	string
careProfessionalEmail	string
careProfessionalAddress	string
careProfessionalLocation	string
description	string		Description of the booking
bookingState	string	[Preliminary, Confirmed, Declined, Canceled, TimeSlotAlreadyBooked, NoTimeSlotsAvailable]
bookingTime	string		Time of which the booking will take place
bookingDate	string		Date of when the booking will take place

Patient Booking Create

This API endpoint will create a next booking a patient with a healthcare provider.

API Endpoint

POST /api/HCCPatient/CreatePatientBooking

POST /api/HCCPatient/CreatePatientBooking HTTP/1.1
Content-Type: application/json

{
    "bookingId": "string",
    "patientId": "string",
    "companyId": "string",
    "careProfessionalId": "string",
    "dateTime": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "bookingId": "string",
    "resultType": "string",
    "nextAvailableTimeSlot": "string"
}

Fields

Name	Type	Format	Description
patientId	string	uuid	Unique identifier that links the booking
companyId	string	uuid	The company's unique id
careProfessionalId	string	uuid	The careprovider's unique id
dateTime	string	date-time	Date of which the visit starts
description	string		Description of the booking

Patient Booking Cancel

This API endpoint will cancel the patient's booking.

API Endpoint

POST /api/HCCPatient/CancelBooking

POST /api/HCCPatient/CancelBooking HTTP/1.1
Content-Type: application/json

{
    "bookingId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "success": "boolean",
    "message": "string"
}

Fields

Name	Type	Description
bookingId	string	Unique identifier of the patient's booking

Healthcare Provider

Contains a collection of API Endpoints to allow Healthcare Providers to Register and Maintain their profiles.

Healthcare Provider Registration

The method will create a new Healthcare Provider record in the HC database.

API Endpoint

POST /api/HCCCareProvider/Register

POST /api/HCCCareProvider/Register HTTP/1.1
Content-Type: application/json

{
    "emailAddress": "string",
    "password": "string",
    "title": "string",
    "firstName": "string",
    "surname": "string",
    "gender": "string",
    "ethnicity": "string",
    "languages": [
        "string"
    ],
    "rsaIdentificationNumber": "string",
    "dateOfBirth": "string",
    "specialityId": "string",
    "professionId": "string",
    "qualifications": "string",
    "practiceName": "string",
    "phoneNumber": "string",
    "practiceEmailAddress": "string",
    "council": "string",
    "privatePracticeNumber": "string",
    "additional1": "string",
    "additional2": "string",
    "physicalAddress": "string",
    "postalAddress": "string",
    "practiceAddress": "string",
    "suburb": "string",
    "city": "string",
    "provinceId": "string",
    "location": "string",
    "longitude": "number",
    "latitude": "number",
    "mobileNumber": "string",
    "alternateNumber": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
emailAddress *	string		Email address of the Healthcare Provider
password *	string		Rule: Password must have a minimum of 8 characters. Password must consist of at least 1 Capital letter and one special character.
title	string		Title of the Healthcare Provider
firstName *	string		First name of the Healthcare Provider
surname *	string		Surname of the Healthcare Provider
gender	string	[Male, Female]
ethnicity	string	[Unspecified, Caucasian, Black, Coloured, Asian, Indian]	Ethnicity of the Healthcare Provider
languages	array[string]		A collection of languages that the Healthcare Provider can speak
rsaIdentificationNumber	string		South African identification document number of the Healthcare Provider
dateOfBirth	string	date-time	Date of birth of the Healthcare Provider
specialityId	string	uuid	Unique identifier that links to a speciality
professionId	string	uuid	Unique identifier that links to a profession
qualifications	string		The qualifications that the Healthcare Provider possesses
practiceName	string		Name of the practice where the Healthcare Provider is stationed
phoneNumber	string		Contact number of the practision
practiceEmailAddress	string		General email address of the practice
council	string
privatePracticeNumber	string		Private contact number of the practice
additional1	string		First additional number incase private number is unavailable
additional2	string		Second additional number incase private and first additional number is unavailable
physicalAddress	string		Physical address of the Healthcare Provider
postalAddress	string		Postal address of the Healthcare Provider
practiceAddress	string		Physical address of the practice
suburb	string		Suburb in which the Healthcare Provider stays in
city	string		City in which the Healthcare Provider stays in
provinceId	string	uuid	Unique identifier of the province in which the Healthcare Provider stays in
location	string		Location of the practice
longitude	number	double	Global positioning longitude of the practice
latitude	number	double	Global positioning latitude of the practice
mobileNumber	string		Mobile number of the Healthcare Provider
alternateNumber	string		Alternative contact number of the Healthcare Provider

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "registrationResult": "string",
    "profileId": "string",
    "errorResponse": "string"
}

Fields

Name	Type	Format	Description
registrationResult	string	[RegistrationOK, ProfileExists, EnterOTP]	Returns a status of the Healthcare Provider's registration
profileId	string	uuid	Unique identifier that links to the newly created Healthcare Provider
errorResponse	string		Incase something went wrong with the registration, an error message will be given

Healthcare Provider Profile Update

This API endpoint will update an existing Healthcare Providers profile.

API Endpoint

POST /api/HCCCareProvider/ProfileUpdate

POST /api/HCCCareProvider/ProfileUpdate HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "emailAddress": "string",
    "title": "string",
    "firstName": "string",
    "surname": "string",
    "gender": "string",
    "ethnicity": "string",
    "languages": [
        "string"
    ],
    "rsaIdentificationNumber": "string",
    "dateOfBirth": "string",
    "specialityId": "string",
    "professionId": "string",
    "qualifications": "string",
    "practiceName": "string",
    "phoneNumber": "string",
    "practiceEmailAddress": "string",
    "council": "string",
    "privatePracticeNumber": "string",
    "additional1": "string",
    "additional2": "string",
    "physicalAddress": "string",
    "postalAddress": "string",
    "practiceAddress": "string",
    "suburb": "string",
    "city": "string",
    "provinceId": "string",
    "mobileNumber": "string",
    "alternateNumber": "string",
    "location": "string",
    "longitude": "number",
    "latitude": "number",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId *	string	uuid	Unique identifier that links to a Healthcare Provider
emailAddress *	string		Email address of the Healthcare Provider
title	string		Title of the Healthcare Provider
firstName *	string		First name of the Healthcare Provider
surname *	string		Surname of the Healthcare Provider
gender	string	[Male, Female]
ethnicity	string	[Unspecified, Caucasian, Black, Coloured, Asian, Indian]	Ethnicity of the Healthcare Provider
languages	array[string]		A collection of languages that the Healthcare Provider can speak
rsaIdentificationNumber	string		South African identification document number of the Healthcare Provider
dateOfBirth	string	date-time	Date of birth of the Healthcare Provider
specialityId	string	uuid	Unique identifier that links to a speciality
professionId	string	uuid	Unique identifier that links to a profession
qualifications	string		The qualifications that the Healthcare Provider possesses
practiceName	string		Name of the practice where the Healthcare Provider is stationed
phoneNumber	string		Contact number of the practision
practiceEmailAddress	string		General email address of the practice
council	string
privatePracticeNumber	string		Private contact number of the practice
additional1	string		First additional number incase private number is unavailable
additional2	string		Second additional number incase private and first additional number is unavailable
physicalAddress	string		Physical address of the Healthcare Provider
postalAddress	string		Postal address of the Healthcare Provider
practiceAddress	string		Physical address of the practice
suburb	string		Suburb in which the Healthcare Provider stays in
city	string		City in which the Healthcare Provider stays in
provinceId	string	uuid	Unique identifier of the province in which the Healthcare Provider stays in
location	string		Location of the practice
longitude	number	double	Global positioning longitude of the practice
latitude	number	double	Global positioning latitude of the practice
mobileNumber	string		Mobile number of the Healthcare Provider
alternateNumber	string		Alternative contact number of the Healthcare Provider

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profileId": "string",
    "emailAddress": "string",
    "title": "string",
    "firstName": "string",
    "surname": "string",
    "gender": "string",
    "ethnicity": "string",
    "languages": [
        "string"
    ],
    "rsaIdentificationNumber": "string",
    "dateOfBirth": "string",
    "specialityId": "string",
    "specialityName": "string",
    "professionId": "string",
    "professionName": "string",
    "qualifications": "string",
    "practiceName": "string",
    "phoneNumber": "string",
    "practiceEmailAddress": "string",
    "council": "string",
    "privatePracticeNumber": "string",
    "additional1": "string",
    "additional2": "string",
    "physicalAddress": "string",
    "postalAddress": "string",
    "practiceAddress": "string",
    "suburb": "string",
    "city": "string",
    "provinceId": "string",
    "provinceName": "string",
    "mobileNumber": "string",
    "alternateNumber": "string",
    "location": "string",
    "longitude": "number",
    "latitude": "number"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to a Healthcare Provider
emailAddress	string		Email address of the Healthcare Provider
title	string		Title of the Healthcare Provider
firstName	string		First name of the Healthcare Provider
surname	string		Surname of the Healthcare Provider
gender	string	[Male, Female]
ethnicity	string	[Unspecified, Caucasian, Black, Coloured, Asian, Indian]	Ethnicity of the Healthcare Provider
languages	array[string]		A collection of languages that the Healthcare Provider can speak
rsaIdentificationNumber	string		South African identification document number of the Healthcare Provider
dateOfBirth	string	date-time	Date of birth of the Healthcare Provider
specialityId	string	uuid	Unique identifier that links to a speciality
professionId	string	uuid	Unique identifier that links to a profession
qualifications	string		The qualifications that the Healthcare Provider possesses
practiceName	string		Name of the practice where the Healthcare Provider is stationed
phoneNumber	string		Contact number of the practision
practiceEmailAddress	string		General email address of the practice
council	string
privatePracticeNumber	string		Private contact number of the practice
additional1	string		First additional number incase private number is unavailable
additional2	string		Second additional number incase private and first additional number is unavailable
physicalAddress	string		Physical address of the Healthcare Provider
postalAddress	string		Postal address of the Healthcare Provider
practiceAddress	string		Physical address of the practice
suburb	string		Suburb in which the Healthcare Provider stays in
city	string		City in which the Healthcare Provider stays in
provinceId	string	uuid	Unique identifier of the province in which the Healthcare Provider stays in
mobileNumber	string		Mobile number of the Healthcare Provider
alternateNumber	string		Alternative contact number of the Healthcare Provider
location	string		Location of the practice
longitude	number	double	Global positioning longitude of the practice
latitude	number	double	Global positioning latitude of the practice

Healthcare Provider Profile Get

This API endpoint will return a Healthcare Providers profile information.

API Endpoint

POST /api/HCCCareProvider/ProfileGet

POST //api/HCCCareProvider/ProfileGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to a Healthcare Provider

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profileId": "string",
    "emailAddress": "string",
    "title": "string",
    "firstName": "string",
    "surname": "string",
    "gender": "string",
    "ethnicity": "string",
    "languages": [
        "string"
    ],
    "rsaIdentificationNumber": "string",
    "dateOfBirth": "string",
    "specialityId": "string",
    "specialityName": "string",
    "professionId": "string",
    "professionName": "string",
    "qualifications": "string",
    "practiceName": "string",
    "phoneNumber": "string",
    "practiceEmailAddress": "string",
    "council": "string",
    "privatePracticeNumber": "string",
    "additional1": "string",
    "additional2": "string",
    "physicalAddress": "string",
    "postalAddress": "string",
    "practiceAddress": "string",
    "suburb": "string",
    "city": "string",
    "provinceId": "string",
    "provinceName": "string",
    "mobileNumber": "string",
    "alternateNumber": "string",
    "location": "string",
    "longitude": "number",
    "latitude": "number"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to a Healthcare Provider
emailAddress	string		Email address of the Healthcare Provider
title	string		Title of the Healthcare Provider
firstName	string		First name of the Healthcare Provider
surname	string		Surname of the Healthcare Provider
gender	string	[Male, Female]
ethnicity	string	[Unspecified, Caucasian, Black, Coloured, Asian, Indian]	Ethnicity of the Healthcare Provider
languages	array[string]		A collection of languages that the Healthcare Provider can speak
rsaIdentificationNumber	string		South African identification document number of the Healthcare Provider
dateOfBirth	string	date-time	Date of birth of the Healthcare Provider
specialityId	string	uuid	Unique identifier that links to a speciality
specialityName	string		Speciality name associated with the specialityId
professionId	string	uuid	Unique identifier that links to a profession
professionName	string		Profession name associated with the professionId
qualifications	string		The qualifications that the Healthcare Provider possesses
practiceName	string		Name of the practice where the Healthcare Provider is stationed
phoneNumber	string		Contact number of the practision
practiceEmailAddress	string		General email address of the practice
council	string
privatePracticeNumber	string		Private contact number of the practice
additional1	string		First additional number incase private number is unavailable
additional2	string		Second additional number incase private and first additional number is unavailable
physicalAddress	string		Physical address of the Healthcare Provider
postalAddress	string		Postal address of the Healthcare Provider
practiceAddress	string		Physical address of the practice
suburb	string		Suburb in which the Healthcare Provider stays in
city	string		City in which the Healthcare Provider stays in
provinceId	string	uuid	Unique identifier of the province in which the Healthcare Provider stays in
provinceName	string		Provincial name associated with the provinceId
mobileNumber	string		Mobile number of the Healthcare Provider
alternateNumber	string		Alternative contact number of the Healthcare Provider
location	string		Location of the practice
longitude	number	double	Global positioning longitude of the practice
latitude	number	double	Global positioning latitude of the practice

Healthcare Provider Available Timeslots

This API endpoint will return a Healthcare Providers available timeslots for a specified date.

API Endpoint

POST /api/HCCCareProvider/GetCareProviderAvailableTimeSlots

POST //api/HCCCareProvider/GetCareProviderAvailableTimeSlots HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "dateTime": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to a Healthcare Provider
dateTime	string	date-time	The date to get the available timeslots for, will return the entire day's available slots

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profileId": "string",
    "availableTimeSlots": [
        {
            "startDate": "string",
            "endDate": "string"
        }
    ]
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to a Healthcare Provider
availableTimeSlots	array[]		Array of availableTimeSlot objects

Security

Request API Key

This API endpoint will request an API key which will then need to be activated under the admin portal.

API Endpoint

POST /api/HCCSecurity/RequestAPIKey

POST /api/HCCSecurity/RequestAPIKey HTTP/1.1
Content-Type: application/json

{
    "systemName": "string",
    "callbackUrl": "string"
}

Fields

Name	Type	Format	Description
systemName *	string
callbackUrl *	string

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "apiKey": "string",
    "keyIsActive": "boolean"
}

Fields

Name	Type	Format	Description
apiKey	string	uuid
keyIsActive	boolean		Boolean indicates whether the API Key is active or not

This API endpoint will return a token for a patient login request.

API Endpoint

POST /api/HCCSecurity/LoginPatient

POST /api/HCCSecurity/LoginPatient HTTP/1.1
Content-Type: application/json

{
    "email": "string",
    "password": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
email *	string		Email address of the patient which he/she registered with
password *	string		Password set by the patient upon registration Rule: Password must have a minimum of 8 characters. Password must consist of at least 1 Capital letter and one special character.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profileId": "string",
    "profileType": "string",
    "loginStatus": "string",
    "token": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to the logged in patient
profileType	string	[Admin, Patient, HealthCareProfessional, Company, Secretary, Employer]
loginStatus	string	[LoginOK, OTPRequired]	Gives a status on the patient login
token	string	uuid

This API endpoint will return a token for a Health Healthcare Provider login request.

API Endpoint

POST /api/HCCSecurity/LoginCareProvider

POST /api/HCCSecurity/LoginCareProvider HTTP/1.1
Content-Type: application/json

{
    "email": "string",
    "password": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
email *	string		Email address of the Healthcare Provider
password *	string		Password that was set upon registration. Rule: Password must have a minimum of 8 characters. Password must consist of at least 1 Capital letter and one special character.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profileId": "string",
    "profileType": "string",
    "loginStatus": "string",
    "token": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to the logged in Healthcare Provider
profileType	string	[Admin, Patient, HealthCareProfessional, Company, Secretary, Employer]
loginStatus	string	[LoginOK, OTPRequired]	Gives a status on the patient login
token	string	uuid

Retrieve Profile Id From Token

This method will be used to retrieve the ProfileId from a SSO operation. The HC has completed a login sequence and redirected the client via the call back URL specified in Request API Key method. A parameter string ?hccToken=xxxxx should be retrieved and passed to this call.

API Endpoint

POST /api/HCCSecurity/RetrieveProfileIdFromToken

POST /api/HCCSecurity/RetrieveProfileIdFromToken HTTP/1.1
Content-Type: application/json

{
    "hccToken": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
hccToken *	string	uuid

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profileId": "string",
    "profileType": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Returns the requested profileId
profileType	string	[Admin, Patient, HealthCareProfessional, Company, Secretary, Employer]

Request Patient One Time Pin

This API endpoint will return a URL which will allow a patient to be logged in once navigated to.

How the flow works

Step 1 - Calculate your return URL where HC must direct the user back to when the link is complete. We deduct /patient/activityDashboard because we only want the root of the application.

Step 2 - Call POST /api/HCCSecurity/RequestPatientOneTimePin. The call will return a string response as the URL to direct the browser to.

Step 3 - Store the current user in the browser session storage for access when the user returns.

Step 4 - Direct the current user to the URL returned from RequestPatientOneTimePin.

The user will now link his device within the HC portal, with the URL we encoded details that will also authenticate the user automatically and log him in. Once completed the user will be directed back to the “ReturnURL” passed in step 2.

API Endpoint

POST /api/HCCSecurity/RequestPatientOneTimePin

POST /api/HCCSecurity/RequestPatientOneTimePin HTTP/1.1
Content-Type: application/json

{
    "token": "string",
    "profileId": "string",
    "callerPageName": "string",
    "returnUrl": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
token	string	uuid
profileId	string	uuid	Unique identifier that links to a specific profile
callerPageName	string		This is the name of the page to display on the return button within HealthCloud
returnUrl	string		This contains the URL to direct the user back to when the operation was completed

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

"string"

Responses

Http code	Type	Description
200	string	Success

Recover Patient Password

This API endpoint will generate a recovery password email for the email provided.

API Endpoint

POST /api/HCCSecurity/RecoverPatientPassword

POST /api/HCCSecurity/RecoverPatientPassword HTTP/1.1
Content-Type: application/json

{
    "email": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
email	string		Email address of the requested profile

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "success": "boolean",
    "message": "string"
}

Fields

Name	Type	Format	Description
success	boolean
message	string

Recover HealthHealthcare Provider Password

This API endpoint will generate a recover password email for the email provided.

API Endpoint

POST /api/HCCSecurity/RecoverCareProviderPassword

POST /api/HCCSecurity/RecoverCareProviderPassword HTTP/1.1
Content-Type: application/json

{
    "email": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
email	string		Email address of the requested profile

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "success": "boolean",
    "message": "string"
}

Fields

Name	Type	Format	Description
success	boolean
message	string

Change Patient Password

This API endpoint will change the supplied accounts password.

API Endpoint

POST /api/HCCSecurity/ChangePatientPassword

POST /api/HCCSecurity/ChangePatientPassword HTTP/1.1
Content-Type: application/json

{
    "email": "string",
    "currentPassword": "string",
    "newPassword": "string",
    "confirmPassword": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Description
email *	string	Email address of the patient
currentPassword *	string	Current password set by the patient. Rule: Password must have a minimum of 8 characters. Password must consist of at least 1 Capital letter and one special character.
newPassword *	string	New password that will overwrite the current password. Rule: Password must have a minimum of 8 characters. Password must consist of at least 1 Capital letter and one special character.
confirmPassword *	string	Confirmation check on the new password to see if it is the same as the one entered here. Rule: Password must have a minimum of 8 characters. Password must consist of at least 1 Capital letter and one special character.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "success": "boolean",
    "message": "string"
}

Fields

Name	Type	Format	Description
success	boolean
message	string

Change Healthcare Provider Password

This API endpoint will change the supplied accounts password.

API Endpoint

POST /api/HCCSecurity/ChangeCareProviderPassword

POST /api/HCCSecurity/ChangeCareProviderPassword HTTP/1.1
Content-Type: application/json

{
    "email": "string",
    "currentPassword": "string",
    "newPassword": "string",
    "confirmPassword": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Description
email *	string	Email address of the Healthcare Provider
currentPassword *	string	Current password set by the patient. Rule: Password must have a minimum of 8 characters. Password must consist of at least 1 Capital letter and one special character.
newPassword *	string	New password that will overwrite the current password. Rule: Password must have a minimum of 8 characters. Password must consist of at least 1 Capital letter and one special character.
confirmPassword *	string	Confirmation check on the new password to see if it is the same as the one entered here. Rule: Password must have a minimum of 8 characters. Password must consist of at least 1 Capital letter and one special character.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "success": "boolean",
    "message": "string"
}

Fields

Name	Type	Format	Description
success	boolean
message	string

Wellness

Sleep Get

Returns Sleep Data Obtained from Devices Connected to Profile.

API Endpoint

POST //api/HCCActivity/SleepGet

POST //api/HCCActivity/SleepGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "fromDate": "string",
    "toDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId *	string	uuid	Unique identifier that links to a profile
fromDate *	string	date-time	Start date of the search range
toDate *	string	date-time	End date of the search range

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "minutes": "number",
        "deviceCode": "string",
        "deviceName": "string",
        "deviceProvider": "string",
        "activityDateTime": "string",
        "dateUpdated": "string",
        "dateCreated": "string"
    }
]

Fields

Name	Type	Format	Description
minutes	number	double	Total sleep time in minutes
deviceCode	string		Unique code that identifies the device
deviceName	string		Name of the device used
deviceProvider	string		The Provider of the device(ex. Striiv)
activityDateTime	string	date-time	Date and Time of when the activity took place
dateUpdated	string	date-time	Date of when the activity was updated
dateCreated	string	date-time	Created date

Heart Rate Get

Returns Heart Rate Data Obtained from Devices Connected to Profile.

API Endpoint

POST //api/HCCActivity/HeartRateGet

POST //api/HCCActivity/HeartRateGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "fromDate": "string",
    "toDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId *	string	uuid	Unique identifier that links to a profile
fromDate *	string	date-time	Start date of the search range
toDate *	string	date-time	End date of the search range

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "value": "number",
        "unit": "string",
        "deviceCode": "string",
        "deviceName": "string",
        "deviceProvider": "string",
        "activityDateTime": "string",
        "dateUpdated": "string",
        "dateCreated": "string"
    }
]

Fields

Name	Type	Format	Description
value	number	double	The value that was measured
unit	string		The unit of which the value is measured in. ex. bpm (beats per minute)
deviceCode	string		Unique code that identifies the device
deviceName	string		Name of the device used
deviceProvider	string		The Provider of the device(ex. Striiv)
activityDateTime	string	date-time	Date and Time of when the activity took place
dateUpdated	string	date-time	Date of when the activity was updated
dateCreated	string	date-time	Created date

Calories

Returns Calorie Data Obtained from Devices Connected to Profile.

API Endpoint

POST //api/HCCActivity/CaloriesGet

POST //api/HCCActivity/CaloriesGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "fromDate": "string",
    "toDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId *	string	uuid	Unique identifier that links to a profile
fromDate *	string	date-time	Start date of the search range
toDate *	string	date-time	End date of the search range

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "calories": "number",
        "deviceCode": "string",
        "deviceName": "string",
        "deviceProvider": "string",
        "activityDateTime": "string",
        "dateUpdated": "string",
        "dateCreated": "string"
    }
]

Fields

Name	Type	Format	Description
calories	number	double	Total Mathematical calculated calories burned during the time range
deviceCode	string		Unique code that identifies the device
deviceName	string		Name of the device used
deviceProvider	string		The Provider of the device(ex. Striiv)
activityDateTime	string	date-time	Date and Time of when the activity took place
dateUpdated	string	date-time	Date of when the activity was updated
dateCreated	string	date-time	Created date

Steps Get

Returns Step Data Obtained from Devices Connected to Profile.

API Endpoint

POST //api/HCCActivity/StepsGet

POST //api/HCCActivity/StepsGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "fromDate": "string",
    "toDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId *	string	uuid	Unique identifier that links to a profile
fromDate *	string	date-time	Start date of the search range
toDate *	string	date-time	End date of the search range

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "steps": "integer",
        "deviceCode": "string",
        "deviceName": "string",
        "deviceProvider": "string",
        "activityDateTime": "string",
        "dateUpdated": "string",
        "dateCreated": "string"
    }
]

Fields

Name	Type	Format	Description
steps	integer	int32	Total amount of steps taken during the time range
deviceCode	string		Unique code that identifies the device
deviceName	string		Name of the device used
deviceProvider	string		The Provider of the device(ex. Striiv)
activityDateTime	string	date-time	Date and Time of when the activity took place
dateUpdated	string	date-time	Date of when the activity was updated
dateCreated	string	date-time	Created date

Distance Get

Returns Distance Data Obtained from Devices Connected to Profile.

API Endpoint

POST //api/HCCActivity/DistanceGet

POST //api/HCCActivity/DistanceGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "fromDate": "string",
    "toDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId *	string	uuid	Unique identifier that links to a profile
fromDate *	string	date-time	Start date of the search range
toDate *	string	date-time	End date of the search range

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "distance": "number",
        "deviceCode": "string",
        "deviceName": "string",
        "deviceProvider": "string",
        "activityDateTime": "string",
        "dateUpdated": "string",
        "dateCreated": "string"
    }
]

Fields

Name	Type	Format	Description
distance	number	double	Total Distance traveled during the time range
deviceCode	string		Unique code that identifies the device
deviceName	string		Name of the device used
deviceProvider	string		The Provider of the device(ex. Striiv)
activityDateTime	string	date-time	Date and Time of when the activity took place
dateUpdated	string	date-time	Date of when the activity was updated
dateCreated	string	date-time	Created date

Sleep Summary Get

Returns a Summary of Sleep Data Obtained from Devices Connected to Profile.

API Endpoint

POST //api/HCCActivity/SleepSummaryGet

POST //api/HCCActivity/SleepSummaryGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "numberOfDays": "integer",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to a profile
numberOfDays	integer	int32	This is an integer(number) value that represents the number of days

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "providers": [
        {
            "id": "integer",
            "provider": "string",
            "description": "string",
            "color": "string",
            "data": [
                [
                    "object"
                ]
            ]
        }
    ],
    "sumValue": "number",
    "duration": "integer",
    "getLineChartSettings": "object",
    "getBarChartSettings": "object"
}

Fields

Name	Type	Format	Description
providers	array[HealthCloud.Models.Api.Patient.ActivityDataForProviderModel]		Based on a list of Providers
sumValue	number	double	This is the total amount of hours on the activity
duration	integer	int32	Provides the length of the person's activity time
getLineChartSettings	object
getBarChartSettings	object

Providers Fields

Name	Type	Format	Description
id	integer	int32	Unique identifier
provider	string		Manufacturer of the device
description	string		Describes the Provider
color	string		The color that represents a provider
data	array[array[object]]		Consist of a list of objects

Heart Rate Summary Get

Returns a Summary of Heart Rate Data Obtained from Devices Connected to Profile.

API Endpoint

POST //api/HCCActivity/HeartrateSummaryGet

POST //api/HCCActivity/HeartrateSummaryGet HTTP/1.1
`POST /api/HCCPatient/HeartrateSummaryGet`

```http
POST /api/HCCActivity/HeartrateSummaryGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "numberOfDays": "integer",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to a profile
numberOfDays	integer	int32	This is an integer(number) value that represents the number of days

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "providers": [
        {
            "id": "integer",
            "provider": "string",
            "description": "string",
            "color": "string",
            "data": [
                [
                    "object"
                ]
            ]
        }
    ],
    "sumValue": "number",
    "duration": "integer",
    "getLineChartSettings": "object",
    "getBarChartSettings": "object"
}

Fields

Name	Type	Format	Description
providers	array[HealthCloud.Models.Api.Patient.ActivityDataForProviderModel]
sumValue	number	double	This is the total amount of hours on the activity
duration	integer	int32	Provides the length of the person's activity time
getLineChartSettings	object
getBarChartSettings	object

Providers Fields

Name	Type	Format	Description
id	integer	int32	Unique identifier
provider	string		Manufacturer of the device
description	string		Describes the Provider
color	string		The color that represents a provider
data	array[array[object]		Consist of a list of objects

Calories Summary Get

Returns a Summary of Calories Data Obtained from Devices Connected to Profile.

API Endpoint

POST //api/HCCActivity/CaloriesSummaryGet

POST //api/HCCActivity/CaloriesSummaryGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "numberOfDays": "integer",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to a profile
numberOfDays	integer	int32	This is an integer(number) value that represents the number of days

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "providers": [
        {
            "id": "integer",
            "provider": "string",
            "description": "string",
            "color": "string",
            "data": [
                [
                    "object"
                ]
            ]
        }
    ],
    "sumValue": "number",
    "duration": "integer",
    "getLineChartSettings": "object",
    "getBarChartSettings": "object"
}

Fields

Name	Type	Format	Description
providers	array[HealthCloud.Models.Api.Patient.ActivityDataForProviderModel]
sumValue	number	double	This is the total amount of hours on the activity
duration	integer	int32	Provides the length of the person's activity time
getLineChartSettings	object
getBarChartSettings	object

Providers Fields

Name	Type	Format	Description
id	integer	int32	Unique identifier
provider	string		Manufacturer of the device
description	string		Describes the Provider
color	string		The color that represents the provider
data	array[array[object]		Consist of a list of objects

Steps Summary Get

Returns a Summary of Step Data Obtained from Devices Connected to Profile.

API Endpoint

POST //api/HCCActivity/StepsSummaryGet

POST //api/HCCActivity/StepsSummaryGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "numberOfDays": "integer",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to a profile
numberOfDays	integer	int32	This is an integer(number) value that represents the number of days

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "providers": [
        {
            "id": "integer",
            "provider": "string",
            "description": "string",
            "color": "string",
            "data": [
                [
                    "object"
                ]
            ]
        }
    ],
    "sumValue": "number",
    "duration": "integer",
    "getLineChartSettings": "object",
    "getBarChartSettings": "object"
}

Fields

Name	Type	Format	Description
providers	array[HealthCloud.Models.Api.Patient.ActivityDataForProviderModel]
sumValue	number	double	This is the total amount of hours on the activity
duration	integer	int32	Provides the length of the person's activity time
getLineChartSettings	object
getBarChartSettings	object

Providers Fields

Name	Type	Format	Description
id	integer	int32	Unique identifier
provider	string		Manufacturer of the device
description	string		Describes the Provider
color	string		The color that represents a provider
data	array[array[object]		Consist of a list of objects

Distances Summary Get

Returns a Summary of Distance Data Obtained from Devices Connected to Profile.

API Endpoint

POST //api/HCCActivity/DistancesSummaryGet

POST //api/HCCActivity/DistancesSummaryGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "numberOfDays": "integer",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to a profile
numberOfDays	integer	int32	This is an integer(number) value that represents the number of days

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "providers": [
        {
            "id": "integer",
            "provider": "string",
            "description": "string",
            "color": "string",
            "data": [
                [
                    "object"
                ]
            ]
        }
    ],
    "sumValue": "number",
    "duration": "integer",
    "getLineChartSettings": "object",
    "getBarChartSettings": "object"
}

Fields

Name	Type	Format	Description
providers	array[HealthCloud.Models.Api.Patient.ActivityDataForProviderModel]
sumValue	number	double	This is the total amount of hours on the activity
duration	integer	int32	Provides the length of the person's activity time
getLineChartSettings	object
getBarChartSettings	object

Providers Fields

Name	Type	Format	Description
id	integer	int32	Unique identifier
provider	string		Manufacturer of the device
description	string		Describes the Provider
color	string		The color that represents a provider
data	array[array[object]		Consist of a list of objects

Get Patient Device Count

Returns a count of the total devices that the specific account has

API Endpoint

POST //api/HCCActivity/GetPatientDeviceCount

POST //api/HCCActivity/GetPatientDeviceCount HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	Unique identifier that links to a profile

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

"integer"

Fields

Http code	Type	Description
200	integer	Success

Master Data

Get Province List

This API endpoint will return a list of Key Value Pairs for Provinces

API Endpoint

POST //api/HCCMasterData/ProvinceList

POST //api/HCCMasterData/ProvinceList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": "string",
        "name": "string"
    }
]

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a province
name	string		This is the name of the province

Get TimeSlot List

This API endpoint will return a list of Key Value Pairs for TimeSlot

API Endpoint

POST //api/HCCMasterData/TimeSlotList

POST //api/HCCMasterData/TimeSlotList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": "string",
        "description": "string",
        "minutes": "integer"
    }
]

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a Timeslot
description	string		This is a description of the timeslot
minutes	integer	int32	This indicates the length of the timeslot in minutes

This API endpoint will return a list of Key Value Pairs for Language

API Endpoint

POST //api/HCCMasterData/LanguageList

POST //api/HCCMasterData/LanguageList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": "string",
        "name": "string"
    }
]

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a language
name	string		This is the language's name

Get Speciality List

This API endpoint will return a list of Key Value Pairs for Speciality

API Endpoint

POST //api/HCCMasterData/SpecialityList

POST //api/HCCMasterData/SpecialityList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": "string",
        "name": "string"
    }
]

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a speciality
name	string		This is the speciality's name

Get Profession List

This API endpoint will return a list of Key Value Pairs for Profession

API Endpoint

POST //api/HCCMasterData/ProfessionList

POST //api/HCCMasterData/ProfessionList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": "string",
        "name": "string"
    }
]

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a profession
name	string		This is the profession's name

Get Medical Aid List

This API endpoint will return a list of Key Value Pairs for Medical Aid

API Endpoint

POST //api/HCCMasterData/MedicalAidList

POST //api/HCCMasterData/MedicalAidList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": "string",
        "name": "string"
    }
]

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a medical aid
name	string		This is the medical aid's name

Get Employer List

This API endpoint will return a list of Key Value Pairs for Employer

API Endpoint

POST //api/HCCMasterData/EmployerList

POST //api/HCCMasterData/EmployerList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "employerId": "string",
        "friendlyName": "string",
        "registeredName": "string",
        "registrationNumber": "string"
    }
]

Fields

Name	Type	Format	Description
employerId	string	uuid	Unique identifier that links to an employer
friendlyName	string		This is the friendly name given to the employer
registeredName	string		This is the employer's registered name
registrationNumber	string

Get Gender Type List

This API endpoint will return a list of Key Value Pairs for Gender Type

API Endpoint

POST //api/HCCMasterData/GenderTypeList

POST //api/HCCMasterData/GenderTypeList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "value": "string",
        "description": "string"
    }
]

Fields

Name	Type	Format	Description
value	string		This is the Value associated with the Enum item
description	string		This is the description given form the Enum item

Get Ethnicity Type List

This API endpoint will return a list of Key Value Pairs for Ethnicity Type

API Endpoint

POST //api/HCCMasterData/EthnicityTypeList

POST //api/HCCMasterData/EthnicityTypeList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "value": "string",
        "description": "string"
    }
]

Fields

Name	Type	Format	Description
value	string		This is the Value associated with the Enum item
description	string		This is the description given form the Enum item

Get Language Type List

This API endpoint will return a list of Key Value Pairs for Language Type

API Endpoint

POST //api/HCCMasterData/LanguageTypeList

POST //api/HCCMasterData/LanguageTypeList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "value": "string",
        "description": "string"
    }
]

Fields

Name	Type	Format	Description
value	string		This is the Value associated with the Enum item
description	string		This is the description given form the Enum item

Get Media Type List

This API endpoint will return a list of Key Value Pairs for Media Type

API Endpoint

POST //api/HCCMasterData/MediaTypeList

POST //api/HCCMasterData/MediaTypeList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "value": "string",
        "description": "string"
    }
]

Fields

Name	Type	Format	Description
value	string		This is the Value associated with the Enum item
description	string		This is the description given form the Enum item

Get Profile Role Type List

This API endpoint will return a list of Key Value Pairs for Profile Role Type

API Endpoint

POST //api/HCCMasterData/ProfileRoleTypeList

POST //api/HCCMasterData/ProfileRoleTypeList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "value": "string",
        "description": "string"
    }
]

Fields

Name	Type	Format	Description
value	string		This is the Value associated with the Enum item
description	string		This is the description given form the Enum item

Get Patient Type List

This API endpoint will return a list of Key Value Pairs for Patient Type

API Endpoint

POST //api/HCCMasterData/PatientTypeList

POST //api/HCCMasterData/PatientTypeList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "value": "string",
        "description": "string"
    }
]

Fields

Name	Type	Format	Description
value	string		This is the Value associated with the Enum item
description	string		This is the description given form the Enum item

Media

Returns a list of all the categories in the database

API Endpoint

POST //api/HCCMedia/CategoryList

POST //api/HCCMedia/CategoryList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this hash must be the concatenation of your CorrelationId and your secret. Convert this hash value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "categoryId": "string",
        "name": "string"
    }
]

Fields

Name	Type	Format	Description
categoryId	string	uuid	Unique identifier that links to a category
name	string		A name that is given to a specific category

Search

Returns a list of media records based of the search key provided

API Endpoint

POST //api/HCCMedia/Search

POST //api/HCCMedia/Search HTTP/1.1
Content-Type: application/json

{
    "categoryId": "string",
    "searchKey": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
categoryId	string	uuid	Unique identifier that links to a category
searchKey	string		A keyword that helps to find a specific media item

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "mediaId": "string",
        "categoryId": "string",
        "categoryName": "string",
        "summary": "string",
        "rank": "integer",
        "protocolName": "string",
        "content": "string"
    }
]

Fields

Name	Type	Format	Description
mediaId	string	uuid	Unique identifier that links to Media
categoryId	string	uuid	Unique identifier that links to a category
categoryName	string		A name given for a specific media item
summary	string		This is a summarized version of what the media item contains
rank	integer	int32
protocolName	string
content	string

Get Media URL

Returns the URL associated with the media id supplied

API Endpoint

POST //api/HCCMedia/GetMediaURL

POST //api/HCCMedia/GetMediaURL HTTP/1.1
Content-Type: application/json

{
    "mediaId": "string",
    "reference": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
mediaId	string	uuid	Unique identifier that links to Media
reference	string		A referencing name for the media item

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "url": "string",
    "expires": "string"
}

Fields

Name	Type	Format	Description
url	string		A URL for the media item
expires	string	date-time	A Specific Date and Time until the URL expires

EHR Master Data

Contains a collection of API Endpoints to allow a user to retrieve a list of specific data.

Code System List

The method will return a list of all available Code Systems that has been added to the system.

API Endpoint

POST //api/EHRMasterData/CodeSystemList

POST //api/EHRMasterData/CodeSystemList HTTP/1.1
Content-Type: application/json

{

    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "ehrId": "string",
        "code": "string",
        "description": "string"
    }
]

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier generated for
code	string		This code represents the system being used (ex. ICD-10, SNOMED, etc)
description	string		This describes the code( ex. Code: ICD-10 Description: International Statistical Classification of Diseases and Related Health Problems 10th Revision)

Blood Type List

The method will return a list of all available blood types that has been added to the system.

API Endpoint

POST //api/EHRMasterData/BloodTypeList

POST //api/EHRMasterData/BloodTypeList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "bloodTypeEHRId": "string",
        "description": "string",
        "codeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        }
    }
]

Fields

Name	Type	Format	Description
bloodTypeEHRId	string	uuid	Unique identifier that links to a blood type
description	string		Additional description of the blood type
codeSystem	[HealthCloud.Models.Api.MasterData.CodeModel]

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the blood type based on the code system used
description	string		This is a description of the code being used

Allergy List

The method will return a list of all available allergies that has been added to the system.

API Endpoint

POST //api/EHRMasterData/AllergyList

POST //api/EHRMasterData/AllergyList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "allergyEHRId": "string",
        "allergyName": "string",
        "codeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "isActive": "boolean"
    }
]

Fields

Name	Type	Format	Description
allergyEHRId	string	uuid	Unique identifier that links to an allergy
description	string		Additional description of the allergy
codeSystem	[HealthCloud.Models.Api.MasterData.CodeModel]
isActive	boolean		A boolean value that determines if the allergy is active or not

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the allergy based on the code system used
description	string		This is a description of the code being used

Biometric List

The method will return a list of all available biometrics that has been added to the system.

API Endpoint

POST //api/EHRMasterData/BiometricList

POST //api/EHRMasterData/BiometricList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "biometricEHRId": "string",
        "description": "string",
        "codeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        }
    }
]

Fields

Name	Type	Format	Description
biometricEHRId	string	uuid	Unique identifier that links to a biometric
description	string		Additional description of the biometric type
codeSystem	[HealthCloud.Models.Api.MasterData.CodeModel]

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the biometric based on the code system used
description	string		This is a description of the code being used

Relationship List

The method will return a list of all available relationships that has been added to the system.

API Endpoint

POST //api/EHRMasterData/RelationshipList

POST //api/EHRMasterData/RelationshipList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "relationshipEHRId": "string",
        "description": "string",
        "codeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        }
    }
]

Fields

Name	Type	Format	Description
procedureEHRId	string	uuid	Unique identifier that links to a relationship
description	string		Additional description of the relationship
medicalCode	[HealthCloud.Models.Api.MasterData.CodeModel]

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the relationship based on the code system used
description	string		This is a description of the code being used

Procedure List

The method will return a list of all available procedures that has been added to the system.

API Endpoint

POST //api/EHRMasterData/ProcedureList

POST //api/EHRMasterData/ProcedureList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "procedureEHRId": "string",
        "description": "string",
        "medicalCode": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        }
    }
]

Fields

Name	Type	Format	Description
procedureEHRId	string	uuid	Unique identifier that links to a procedure
description	string		Additional description of the procedure
medicalCode	[HealthCloud.Models.Api.MasterData.CodeModel]

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

ResultList

The method will return a list of all available result types that has been added to the system.

API Endpoint

POST //api/EHRMasterData/ResultList

POST //api/EHRMasterData/ResultList HTTP/1.1
Content-Type: application/json

{
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "resultEHRId": "string",
        "medicalCode": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "resultDate": "string",
        "resultDescription": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
resultEHRId	string	uuid	Unique identifier that links to a result type
medicalCode	[HealthCloud.Models.Api.MasterData.CodeModel]
resultDate	string	date-time	Date of which the result was added
resultDescription	string		Description of the result

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

Electronic Health Record

EHR Patient Profile Get

The method will return a patient's profile that's linked to the ehrId being passed in.

API Endpoint

POST //api/EHRClinicalSummary/PatientProfileGet

POST //api/EHRClinicalSummary/PatientProfileGet HTTP/1.1
Content-Type: application/json

 {
        "ehrId": "string",
        "medicalRecordNumber": "string",
        "patientRsaId": "string",
        "searchString": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
 }

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier used to retrieve patient's profile
medicalRecordNumber	string		Record number for identifying
patientRsaId	string		Patient's South African Identification number
searchString	string		Custom string value used for searching a patient

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "patientEHRId": "string",
    "medicalRecordNumber": "string",
    "emailAddress": "string",
    "firstName": "string",
    "surname": "string",
    "title": "string",
    "mobileNumber": "string",
    "alternateNumber": "string",
    "gender": "string",
    "ethnicity": "string",
    "provinceId": "string",
    "physicalAddress": "string",
    "postalAddress": "string",
    "city": "string",
    "suburb": "string",
    "postalCode": "string",
    "rsaIdNumber": "string",
    "dateOfBirth": "string",
    "medicalAidId": "string",
    "medicalAidProduct": "string",
    "beneficiaryNumber": "string",
    "medicalAidPolicyNumber": "string",
    "emergencyContactName": "string",
    "emergencyNumber": "string",
    "emergencyContactNextOfKin": "string",
    "employerId": "string",
    "employerName": "string",
    "occupation": "string",
    "qualification": "string",
    "bloodType": {
        "ehrId": "string",
        "type": "string",
        "medicalCodeId": "string",
        "codeSystemId": "string",
        "codeSystem": "string",
        "medicalCode": "string",
        "medicalDescription": "string"
    }
}

Fields

Name	Type	Format	Description
patientEHRId	string	uuid	Unique identifier that links to a patient's profile
medicalRecordNumber	string		Unique record number on the client system
emailAddress	string		Email address of the patient
firstName	string		First name of the patient
surname	string		Surname of the patient
title	string		Title of the patient
mobileNumber	string		Mobile contact number of the patient
alternateNumber	string		Alternative contact number of the patient
gender	string	[Male, Female]
ethnicity	string	[Unspecified, Caucasian, Black, Coloured, Asian, Indian]
provinceId	string	uuid	Unique identifier that links to a province
physicalAddress	string		Physical address of the
postalAddress	string		Postal address of the patient
city	string		City where the patient lives in
suburb	string		Suburb where the patient lives in
postalCode	string		Postal code of the patient's address
rsaIdNumber	string		South African Identity Document number or Passport number
dateOfBirth	string	date-time	Date of birth of the patient
medicalAidId	string	uuid	Unique identifier that links to a medical aid
medicalAidProduct	string
beneficiaryNumber	string
medicalAidPolicyNumber	string		Membership number of the scheme the member is active on
emergencyContactName	string		Name of the emergency contact person of the patient
emergencyNumber	string		Contact number of patient's emergency person
emergencyContactNextOfKin	string		Emergency contact person's Next of kin
employerId	string	uuid	Unique identifier that links to an employer
employerName	string		Name of patient's employer
occupation	string		Patient's Occupation
qualification	string		Patient's Qualification
bloodType	[Blood Type Model]

Blood Type Model

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a blood type
type	string		This is the summarized version of the blood type (ex. AB+)
medicalCodeId	string	uuid	Unique identifier that links to a code model
codeSystemId	string	uuid	Unique identifier that links to a code system
codeSystem	string		This is a representation of the code system being used like "ICD-10"
medicalCode	string		This is the specific code used for the blood type based on the code system used
medicalDescription	string		This is a description of the code being used

EHR Patient Profile Save

The method allows the user to save the patient's profile information.

API Endpoint

POST //api/EHRClinicalSummary/PatientProfileSave

POST //api/EHRClinicalSummary/PatientProfileSave HTTP/1.1
Content-Type: application/json

{
        "patientEHRId": "string",
        "medicalRecordNumber": "string",
        "emailAddress": "string",
        "firstName": "string",
        "surname": "string",
        "title": "string",
        "mobileNumber": "string",
        "alternateNumber": "string",
        "gender": "string",
        "ethnicity": "string",
        "provinceId": "string",
        "physicalAddress": "string",
        "postalAddress": "string",
        "city": "string",
        "suburb": "string",
        "postalCode": "string",
        "rsaIdNumber": "string",
        "dateOfBirth": "string",
        "medicalAidId": "string",
        "medicalAidProduct": "string",
        "beneficiaryNumber": "string",
        "medicalAidPolicyNumber": "string",
        "emergencyContactName": "string",
        "emergencyNumber": "string",
        "emergencyContactNextOfKin": "string",
        "employerId": "string",
        "employerName": "string",
        "occupation": "string",
        "qualification": "string",
        "bloodType": {
            "bloodTypeEHRId": "string",
            "description": "string",
            "codeSystem": {
                "ehrId": "string",
                "codeSystem": "string",
                "code": "string",
                "description": "string"
            }
        },
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
}

Fields

Name	Type	Format	Description
patientEHRId	string	uuid	Unique identifier that links to a patient's profile
medicalRecordNumber	string		Unique record number on the client system
emailAddress *	string		Email address of the patient
firstName *	string		First name of the patient
surname *	string		Surname of the patient
title	string		Title of the patient
mobileNumber *	string		Mobile contact number of the patient
alternateNumber	string		Alternative contact number of the patient
gender	string	[Male, Female]
ethnicity	string	[Unspecified, Caucasian, Black, Coloured, Asian, Indian]
provinceId	string	uuid	Unique identifier that links to a province
physicalAddress	string		Physical address of the
postalAddress	string		Postal address of the patient
city	string		City where the patient lives in
suburb	string		Suburb where the patient lives in
postalCode	string		Postal code of the patient's address
rsaIdNumber	string		South African Identity Document number or Passport number
dateOfBirth	string	date-time	Date of birth of the patient
medicalAidId	string	uuid	Unique identifier that links to a medical aid
medicalAidProduct	string
beneficiaryNumber	string
medicalAidPolicyNumber	string		Membership number of the scheme the member is active on
emergencyContactName	string		Name of the emergency contact person of the patient
emergencyNumber	string		Contact number of patient's emergency person
emergencyContactNextOfKin	string		Emergency contact person's Next of kin
employerId	string	uuid	Unique identifier that links to an employer
employerName	string		Name of patient's employer
occupation	string		Patient's Occupation
qualification	string		Patient's Qualification
bloodType	[Blood Type Model]

Blood Type Model

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a blood type
type	string		This is the summarized version of the blood type (ex. AB+)
medicalCodeId	string	uuid	Unique identifier that links to a code model
codeSystemId	string	uuid	Unique identifier that links to a code system
codeSystem	string		This is a representation of the code system being used like "ICD-10"
medicalCode	string		This is the specific code used for the blood type based on the code system used
medicalDescription	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "registrationResult": "string",
    "profileId": "string",
    "errorResponse": "string"
}

Fields

Name	Type	Format	Description
registrationResult	string	[RegistrationOK, ProfileExists, EnterOTP]
profileId	string	uuid	Unique identifier that links to a profile
errorResponse	string		Incase something went wrong with the registration, an error message will be given

EHR Tobacco Usage Save

This allows the user to save the details of the patient tobacco usage.

API Endpoint

POST //api/EHRClinicalSummary/TabaccoUsageSave

POST //api/EHRClinicalSummary/TabaccoUsageSave HTTP/1.1
Content-Type: application/json

{
    "tabacoUsageEHRId": "string",
    "patientEHRId": "string",
    "tabacoUsageCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "startDate": "string",
    "endDate": "string",
    "frequency": "integer",
    "measurementUnitId": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
tabacoUsageEHRId	string	uuid	Unique identifier that links to tobacco usage
patientEHRId	string	uuid	Unique identifier that links to a patient
tabacoUsageCodeSystem	[Code Model Fields]
startDate	string	date-time	Date of which tobacco usage started
endDate	string	date-time	Date of which tobacco usage ended
frequency	integer	int32	The frequency of which the patient uses tobacco
measurementUnitId	string	uuid	Unit of measurement (ex. daily / hourly)
description	string		Additional information about the patient's tobacco usage

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "tabacoUsageEHRId": "string",
    "patientEHRId": "string",
    "tabacoUsageCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "startDate": "string",
    "endDate": "string",
    "frequency": "integer",
    "measurementUnitId": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
tabacoUsageEHRId	string	uuid	Unique identifier that links to tobacco usage
patientEHRId	string	uuid	Unique identifier that links to a patient
tabacoUsageCodeSystem	[Code Model Fields]
startDate	string	date-time	Date of which tobacco usage started
endDate	string	date-time	Date of which tobacco usage ended
frequency	integer	int32	The frequency of which the patient uses tobacco
measurementUnitId	string	uuid	Unit of measurement (ex. daily / hourly)
description	string		Additional information about the patient's tobacco usage

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Tobacco Usage Get

This method returns the details of the patient's tobacco usage.

API Endpoint

POST //api/EHRClinicalSummary/TabaccoUsageGet

POST //api/EHRClinicalSummary/TabaccoUsageGet HTTP/1.1
Content-Type: application/json

{

    "ehrId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier used to retrieve a specific tobacco usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "tabacoUsageEHRId": "string",
        "patientEHRId": "string",
        "tabacoUsageCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "startDate": "string",
        "endDate": "string",
        "frequency": "integer",
        "measurementUnitId": "string",
        "description": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
tabacoUsageEHRId	string	uuid	Unique identifier that links to tobacco usage
patientEHRId	string	uuid	Unique identifier that links to a patient
tabacoUsageCodeSystem	[Code Model]
startDate	string	date-time	Date of which tobacco usage started
endDate	string	date-time	Date of which tobacco usage ended
frequency	integer	int32	The frequency of which the patient uses tobacco
measurementUnitId	string	uuid	Unit of measurement (ex. daily / hourly)
description	string		Additional information about the patient's tobacco usage

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Alcohol Usage Save

This allows the user to save the details of the patient alcohol usage.

API Endpoint

POST //api/EHRClinicalSummary/AlcoholUsageSave

POST //api/EHRClinicalSummary/AlcoholUsageSave HTTP/1.1
Content-Type: application/json

{

    "alcoholUsageEHRId": "string",
    "patientEHRId": "string",
    "alcoholUsageCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "startDate": "string",
    "endDate": "string",
    "frequency": "integer",
    "measurementUnitId": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
alcoholUsageEHRId	string	uuid	Unique identifier that links to alcohol usage
patientEHRId	string	uuid	Unique identifier that links to a patient
alcoholUsageCodeSystem	[Code Model]
startDate	string	date-time	Date of which alcohol usage started
endDate	string	date-time	Date of which alcohol usage ended
frequency	integer	int32	The frequency of which the patient uses alcohol
measurementUnitId	string	uuid	Unit of measurement (ex. daily / hourly)
description	string		Additional information about the patient's alcohol usage

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "alcoholUsageEHRId": "string",
    "patientEHRId": "string",
    "alcoholUsageCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "startDate": "string",
    "endDate": "string",
    "frequency": "integer",
    "measurementUnitId": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
alcoholUsageEHRId	string	uuid	Unique identifier that links to alcohol usage
patientEHRId	string	uuid	Unique identifier that links to a patient
alcoholUsageCodeSystem	[Code Model]
startDate	string	date-time	Date of which alcohol usage started
endDate	string	date-time	Date of which alcohol usage ended
frequency	integer	int32	The frequency of which the patient uses alcohol
measurementUnitId	string	uuid	Unit of measurement (ex. daily / hourly)
description	string		Additional information about the patient's alcohol usage

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Alcohol Usage Get

This method returns the details of the patient's alcohol usage.

API Endpoint

POST //api/EHRClinicalSummary/AlcoholUsageGet

POST //api/EHRClinicalSummary/AlcoholUsageGet HTTP/1.1
Content-Type: application/json

{

     "ehrId": "string",
     "apiKey": "string",
     "correlationId": "string",
     "passphrase": "string"

}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to alcohol usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "alcoholUsageEHRId": "string",
        "patientEHRId": "string",
        "alcoholUsageCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "startDate": "string",
        "endDate": "string",
        "frequency": "integer",
        "measurementUnitId": "string",
        "description": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
alcoholUsageEHRId	string	uuid	Unique identifier that links to alcohol usage
patientEHRId	string	uuid	Unique identifier that links to a patient
alcoholUsageCodeSystem	[Code Model]
startDate	string	date-time	Date of which alcohol usage started
endDate	string	date-time	Date of which alcohol usage ended
frequency	integer	int32	The frequency of which the patient uses alcohol
measurementUnitId	string	uuid	Unit of measurement (ex. daily / hourly)
description	string		Additional information about the patient's alcohol usage

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Patient Contact Save

The method that allows the user to save details of additional contacts to be used when needed.

API Endpoint

POST //api/EHRClinicalSummary/PatientContactSave

POST //api/EHRClinicalSummary/PatientContactSave HTTP/1.1
Content-Type: application/json

{

    "patientContactEHRId": "string",
    "patientProfileId": "string",
    "relationshipId": "string",
    "title": "string",
    "firstName": "string",
    "surname": "string",
    "mobileNumber": "string",
    "genderType": "string",
    "orginisation": "string",
    "physicalAddress": "string",
    "postalAddress": "string",
    "city": "string",
    "suburb": "string",
    "postalCode": "string",
    "relationshipCode": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
patientContactEHRId	string	uuid	Unique identifier that link to a patient contact
patientProfileId	string	uuid	Unique identifier that links to a patient profile
relationshipId	string	uuid	Unique identifier that links to a relationship
title	string		Title of the patient's contact
firstName *	string		First name of the patient's contact
surname *	string		Surname of the patient's contact
mobileNumber *	string		Mobile contact number of the patient's contact
genderType	string	[Male, Female]
orginisation	string		Organization of which the patient's contact works for
physicalAddress	string		Physical address of the patient's contact
postalAddress	string		Postal address of the patient's contact
city	string		City in which the patient's contact lives in
suburb	string		Suburb in which the patient's contact lives in
postalCode	string		Postal code of the patient's contact's address
relationshipCode	[ ]

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "patientContactEHRId": "string",
    "patientProfileId": "string",
    "relationshipId": "string",
    "title": "string",
    "firstName": "string",
    "surname": "string",
    "mobileNumber": "string",
    "genderType": "string",
    "orginisation": "string",
    "physicalAddress": "string",
    "postalAddress": "string",
    "city": "string",
    "suburb": "string",
    "postalCode": "string",
    "relationshipCode": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
patientContactEHRId	string	uuid	Unique identifier that link to a patient contact
patientProfileId	string	uuid	Unique identifier that links to a patient profile
relationshipId	string	uuid	Unique identifier that links to a relationship
title	string		Title of the patient's contact
firstName *	string		First name of the patient's contact
surname *	string		Surname of the patient's contact
mobileNumber *	string		Mobile contact number of the patient's contact
genderType	string	[Male, Female]
orginisation	string		Organization of which the patient's contact works for
physicalAddress	string		Physical address of the patient's contact
postalAddress	string		Postal address of the patient's contact
city	string		City in which the patient's contact lives in
suburb	string		Suburb in which the patient's contact lives in
postalCode	string		Postal code of the patient's contact's address
relationshipCode	[ ]

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Encounter Provider Save

This method lets the user store a patient's encounter, and provider details.

API Endpoint

POST //api/EHRClinicalSummary/EncounterProviderSave

POST //api/EHRClinicalSummary/EncounterProviderSave HTTP/1.1
Content-Type: application/json

{

    "encounterProviderEHRId": "string",
    "encounterEHRId": "string",
    "providerEHRId": "string",
    "startDate": "string",
    "endDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
encounterProviderEHRId	string	uuid	Unique identifier that links to an EncounterProvider
encounterEHRId	string	uuid	Unique identifier that links to an encounter
providerEHRId	string	uuid	Unique identifier that links to a provider
startDate	string	date-time	Start date of the encounter provider
endDate	string	date-time	End date of the encounter provider

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "encounterProviderEHRId": "string",
    "encounterEHRId": "string",
    "providerEHRId": "string",
    "startDate": "string",
    "endDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
encounterProviderEHRId	string	uuid	Unique identifier that links to an encounter provider
encounterEHRId	string	uuid	Unique identifier that links to an encounter
providerEHRId	string	uuid	Unique identifier that links to a provider
startDate	string	date-time	Start date of the encounter provider
endDate	string	date-time	End date of the encounter provider

EHR Family History Save

This method lets the user save Family history details of a patient.

API Endpoint

POST //api/EHRClinicalSummary/FamilyHistorySave

POST //api/EHRClinicalSummary/FamilyHistorySave HTTP/1.1
Content-Type: application/json

{

    "familyHistoryEHRId": "string",
    "patientProfileId": "string",
    "relationshipCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "firstName": "string",
    "surname": "string",
    "isDeceased": "boolean",
    "genderType": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
familyHistoryEHRId	string	uuid	Unique Identifier that links to FamilyHistory
patientProfileId	string	uuid	Unique identifier that links to a patient's profile
relationshipCodeSystem	[Code Model]
firstName *	string		First name of the patient's family member
surname *	string		Surname of the patient's family member
isDeceased	boolean		Boolean value that indicates if the family member is deceased or not
genderType	string	[Male, Female]

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "familyHistoryEHRId": "string",
    "patientProfileId": "string",
    "relationshipCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "firstName": "string",
    "surname": "string",
    "isDeceased": "boolean",
    "genderType": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
familyHistoryEHRId	string	uuid	Unique Identifier that links to FamilyHistory
patientProfileId	string	uuid	Unique identifier that links to a patient's profile
relationshipCodeSystem	[Code Model]
firstName *	string		First name of the patient's family member
surname *	string		Surname of the patient's family member
isDeceased	boolean		Boolean value that idicates if the family member is deceased or not
genderType	string	[Male, Female]

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Family History Get

This method lets the user get details of a specific family history record

API Endpoint

POST //api/EHRClinicalSummary/FamilyHistoryGet

POST //api/EHRClinicalSummary/FamilyHistoryGet HTTP/1.1
Content-Type: application/json

{

    "ehrId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to alcohol usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "familyHistoryEHRId": "string",
        "patientProfileId": "string",
        "relationshipCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "firstName": "string",
        "surname": "string",
        "isDeceased": "boolean",
        "genderType": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
familyHistoryEHRId	string	uuid	Unique Identifier that links to FamilyHistory
patientProfileId	string	uuid	Unique identifier that links to a patient's profile
relationshipCodeSystem	[Code Model]
firstName *	string		First name of the patient's family member
surname *	string		Surname of the patient's family member
isDeceased	boolean		Boolean value that idicates if the family member is deceased or not
genderType	string	[Male, Female]

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR EHR Patient Allergy Save

This method lets the user save a patient's allergy details.

API Endpoint

POST //api/EHRClinicalSummary/PatientAllergySave

POST //api/EHRClinicalSummary/PatientAllergySave HTTP/1.1
Content-Type: application/json

{

    "patientAllergyId": "string",
    "allergyId": "string",
    "allergyCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "patientProfileId": "string",
    "severityId": "string",
    "severityCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "substanceId": "string",
    "substanceCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "statusId": "string",
    "statusCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "startDate": "string",
    "endDate": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
patientAllergyId	string	uuid	Unique identifier that links to a patient's allergy
allergyId	string	uuid	Unique identifier that links to an allergy
allergyCodeSystem	[Code Model]
patientProfileId	string	uuid	Unique identifier that links to a patient's profile
severityId	string	uuid	Unique identifier that links to a severity type
severityCodeSystem	[Code Model]
substanceId	string	uuid	Unique identifier that links to a substance type
substanceCodeSystem	[Code Model]
statusId	string	uuid	Unique identifier that links to a status
statusCodeSystem	[Code Model]
startDate	string	date-time	Starting date of which the allergy was noticed
endDate	string	date-time	Ending date of which the allergy was
description	string		Additional information that describes the allergy

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "patientAllergyId": "string",
    "allergyId": "string",
    "allergyCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "patientProfileId": "string",
    "severityId": "string",
    "severityCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "substanceId": "string",
    "substanceCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "statusId": "string",
    "statusCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "startDate": "string",
    "endDate": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
patientAllergyId	string	uuid	Unique identifier that links to a patient's allergy
allergyId	string	uuid	Unique identifier that links to an allergy
allergyCodeSystem	[Code Model]
patientProfileId	string	uuid	Unique identifier that links to a patient's profile
severityId	string	uuid	Unique identifier that links to a severity type
severityCodeSystem	[Code Model]
substanceId	string	uuid	Unique identifier that links to a substance type
substanceCodeSystem	[Code Model]
statusId	string	uuid	Unique identifier that links to a status
statusCodeSystem	[Code Model]
startDate	string	date-time	Starting date of which the allergy was noticed
endDate	string	date-time	Ending date of which the allergy was
description	string		Additional information that describes the allergy

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Patient Allergy Get

This allows the user the retrieve the details of a patient's allergy

API Endpoint

POST //api/EHRClinicalSummary/PatientAllergyGet

POST //api/EHRClinicalSummary/PatientAllergyGet HTTP/1.1
Content-Type: application/json

{

    "ehrId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to alcohol usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "patientAllergyId": "string",
        "allergyId": "string",
        "allergyCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "patientProfileId": "string",
        "severityId": "string",
        "severityCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "substanceId": "string",
        "substanceCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "statusId": "string",
        "statusCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "startDate": "string",
        "endDate": "string",
        "description": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
patientAllergyId	string	uuid	Unique identifier that links to a patient's allergy
allergyId	string	uuid	Unique identifier that links to an allergy
allergyCodeSystem	[Code Model]
patientProfileId	string	uuid	Unique identifier that links to a patient's profile
severityId	string	uuid	Unique identifier that links to a severity type
severityCodeSystem	[Code Model]
substanceId	string	uuid	Unique identifier that links to a substance type
substanceCodeSystem	[Code Model]
statusId	string	uuid	Unique identifier that links to a status
statusCodeSystem	[Code Model]
startDate	string	date-time	Starting date of which the allergy was noticed
endDate	string	date-time	Ending date of which the allergy was
description	string		Additional information that describes the allergy

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Patient Encounter Save

This lets the user save a patient's encounter.

API Endpoint

POST //api/EHRClinicalSummary/PatientEncounterSave

POST //api/EHRClinicalSummary/PatientEncounterSave HTTP/1.1
Content-Type: application/json

{

    "encounterEHRId": "string",
    "codeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "patientProfileId": "string",
    "description": "string",
    "dateTime": "string",
    "endDateTime": "string",
    "isHospitalization": "boolean",
    "rfvMedicalCode": "string",
    "rfvCodeSystem": "string",
    "rfvMedicalDescription": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
encounterEHRId	string	uuid	Unique identifier that links to an encounter
codeSystem	[Code Model]
patientProfileId	string	uuid	Unique identifier that links to a patient's profile
description	string		Additional information that describes the encounter
dateTime	string	date-time	Date and time of which the encounter occurred
endDateTime	string	date-time	Date and time of which the encounter ended
isHospitalization	boolean		Boolean value that indicates if the encounter caused hospitalization or not
rfvMedicalCode	string
rfvCodeSystem	string
rfvMedicalDescription	string

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "encounterEHRId": "string",
    "codeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "patientProfileId": "string",
    "description": "string",
    "dateTime": "string",
    "endDateTime": "string",
    "isHospitalization": "boolean",
    "rfvMedicalCode": "string",
    "rfvCodeSystem": "string",
    "rfvMedicalDescription": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
encounterEHRId	string	uuid	Unique identifier that links to an encounter
codeSystem	[Code Model]
patientProfileId	string	uuid	Unique identifier that links to a patient's profile
description	string		Additional information that describes the encounter
dateTime	string	date-time	Date and time of which the encounter occurred
endDateTime	string	date-time	Date and time of which the encounter ended
isHospitalization	boolean		Boolean value that indicates if the encounter caused hospitalization or not
rfvMedicalCode	string
rfvCodeSystem	string
rfvMedicalDescription	string

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Patient Encounter Get

The method that allows the user to retrieve a patient's encounter.

API Endpoint

POST //api/EHRClinicalSummary/PatientEncounterGet

POST //api/EHRClinicalSummary/PatientEncounterGet HTTP/1.1
Content-Type: application/json

{

    "ehrId": "string",
    "numberOfRecords": "integer",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to alcohol usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "encounterEHRId": "string",
        "codeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "patientProfileId": "string",
        "description": "string",
        "dateTime": "string",
        "endDateTime": "string",
        "isHospitalization": "boolean",
        "rfvMedicalCode": "string",
        "rfvCodeSystem": "string",
        "rfvMedicalDescription": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
encounterEHRId	string	uuid	Unique identifier that links to an encounter
codeSystem	[Code Model]
patientProfileId	string	uuid	Unique identifier that links to a patient's profile
description	string		Additional information that describes the encounter
dateTime	string	date-time	Date and time of which the encounter occurred
endDateTime	string	date-time	Date and time of which the encounter ended
isHospitalization	boolean		Boolean value that indicates if the encounter caused hospitalization or not
rfvMedicalCode	string
rfvCodeSystem	string
rfvMedicalDescription	string

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Patient Vital Sign Save

The method that allows the user to save a patient's vital sign.

API Endpoint

POST //api/EHRClinicalSummary/PatientVitalSignSave

POST //api/EHRClinicalSummary/PatientVitalSignSave HTTP/1.1
Content-Type: application/json

{

    "vitalSignEHRId": "string",
    "codeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "encounterEHRId": "string",
    "timeOfMeasurement": "string",
    "value": "number",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
vitalSignEHRId	string	uuid	Unique identifier that links to a vital sign
codeSystem	[Code Model]
encounterEHRId	string	uuid	Unique identifier that links to an encounter
timeOfMeasurement	string	date-time	Date and time of which the vital were taken
value	number	double	Result of the taken vital sign

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "vitalSignEHRId": "string",
    "codeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "encounterEHRId": "string",
    "timeOfMeasurement": "string",
    "value": "number",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
vitalSignEHRId	string	uuid	Unique identifier that links to a vital sign
codeSystem	[Code Model]
encounterEHRId	string	uuid	Unique identifier that links to an encounter
timeOfMeasurement	string	date-time	Date and time of which the vital were taken
value	number	double	Result of the taken vital sign

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Vital Sign Get

The method that allows the user to retrieve the details of a patient's vital sign.

API Endpoint

POST //api/EHRClinicalSummary/VitalSignGet

POST //api/EHRClinicalSummary/VitalSignGet HTTP/1.1
Content-Type: application/json

{

    "ehrId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to alcohol usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "vitalSignEHRId": "string",
        "codeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "encounterEHRId": "string",
        "timeOfMeasurement": "string",
        "value": "number",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
vitalSignEHRId	string	uuid	Unique identifier that links to a vital sign
codeSystem	[Code Model]
encounterEHRId	string	uuid	Unique identifier that links to an encounter
timeOfMeasurement	string	date-time	Date and time of which the vital were taken
value	number	double	Result of the taken vital sign

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Encounter Note Save

The method that allows the user to save notes of an encounter.

API Endpoint

POST //api/EHRClinicalSummary/EncounterNoteSave

POST //api/EHRClinicalSummary/EncounterNoteSave HTTP/1.1
Content-Type: application/json

{

    "encounterNoteEHRId": "string",
    "encounterEHRId": "string",
    "fileData": {
        "fileDataEHRId": "string",
        "data": "string",
        "fileName": "string",
        "fileExtension": "string",
        "dateOfFile": "string"
    },
    "content": "string",
    "noteDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
encounterNoteEHRId	string	uuid	Unique identifier that links to an encounter note
encounterEHRId	string	uuid	unique identifier that links to an encounter
fileData	[File Data]
content	string		Contains the content of the file
noteDate	string	date-time	Date and time of which the note was taken

File Data Fields

Name	Type	Format	Description
fileDataEHRId	string	uuid	Unique identifier that links to a file
data	string	byte	Contains the data within the file
fileName	string		Name given to the file
fileExtension	string		The file extension (ex. txt)
dateOfFile	string	date-time	Date and time of when the file was created

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "encounterNoteEHRId": "string",
    "encounterEHRId": "string",
    "fileData": {
        "fileDataEHRId": "string",
        "data": "string",
        "fileName": "string",
        "fileExtension": "string",
        "dateOfFile": "string"
    },
    "content": "string",
    "noteDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
encounterNoteEHRId	string	uuid	Unique identifier that links to an encounter note
encounterEHRId	string	uuid	unique identifier that links to an encounter
fileData	[File Data]
content	string		Contains the content of the file
noteDate	string	date-time	Date and time of which the note was taken

File Data Fields

Name	Type	Format	Description
fileDataEHRId	string	uuid	Unique identifier that links to a file
data	string	byte	Contains the data within the file
fileName	string		Name given to the file
fileExtension	string		The file extension (ex. txt)
dateOfFile	string	date-time	Date and time of when the file was created

EHR Encounter Note Get

The method that allows the user to retrieve a note's detail of an encounter.

API Endpoint

POST //api/EHRClinicalSummary/EncounterNoteGet

POST //api/EHRClinicalSummary/EncounterNoteGet HTTP/1.1
Content-Type: application/json

{

    "ehrId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to alcohol usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "encounterNoteEHRId": "string",
        "encounterEHRId": "string",
        "fileData": {
            "fileDataEHRId": "string",
            "data": "string",
            "fileName": "string",
            "fileExtension": "string",
            "dateOfFile": "string"
        },
        "content": "string",
        "noteDate": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
encounterNoteEHRId	string	uuid	Unique identifier that links to an encounter note
encounterEHRId	string	uuid	unique identifier that links to an encounter
fileData	[File Data]
content	string		Contains the content of the file
noteDate	string	date-time	Date and time of which the note was taken

File Data Fields

Name	Type	Format	Description
fileDataEHRId	string	uuid	Unique identifier that links to a file
data	string	byte	Contains the data within the file
fileName	string		Name given to the file
fileExtension	string		The file extension (ex. txt)
dateOfFile	string	date-time	Date and time of when the file was created

EHR Observation Save

The method that allows the user to save observation details of an encounter.

API Endpoint

POST //api/EHRClinicalSummary/ObservationSave

POST //api/EHRClinicalSummary/ObservationSave HTTP/1.1
Content-Type: application/json

{

    "observationEHRId": "string",
    "encounterEHRId": "string",
    "providerProcedureEHRId": "string",
    "resultEHRId": "string",
    "patientVitalSignEHRId": "string",
    "encounterDiagnosisId": "string",
    "unitId": "string",
    "targetSiteCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "statusCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "medicalCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "observeStartDate": "string",
    "observeEndDate": "string",
    "interpretation": "string",
    "value": "number",
    "comment": "string",
    "referenceRangeLow": "number",
    "referenceRangeHigh": "number",
    "referenceRangeDescription": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
observationEHRId	string	uuid	Unique identifier that links to an observation
encounterEHRId	string	uuid	Unique identifier that links to an encounter
providerProcedureEHRId	string	uuid	Unique identifier that links to a provider's procedure
resultEHRId	string	uuid	Unique identifier that links to a result
patientVitalSignEHRId	string	uuid	Unique identifier that links to a patient's vital sign
encounterDiagnosisId	string	uuid	Unique identifier that links to an encounter diagnosis
unitId	string	uuid	Unique identifier that links to a unit
targetSiteCodeSystem	[Code Model]
statusCodeSystem	[Code Model]
medicalCodeSystem	[Code Model]
observeStartDate	string	date-time	Start Date of the observation
observeEndDate	string	date-time	End date of the observation
interpretation	string		Interpretation of what is observed
value	number	double	Value retrieved from the observation( ex. Heart rate = 120bpm)
comment	string		Additional comments made from the observation
referenceRangeLow	number	double	A low value retrieve(ex. Blood pressure 90/120)
referenceRangeHigh	number	double	A high value retrieve(ex. Blood pressure 90/120)
referenceRangeDescription	string		Additional information on the Low and High reference range

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "observationEHRId": "string",
    "encounterEHRId": "string",
    "providerProcedureEHRId": "string",
    "resultEHRId": "string",
    "patientVitalSignEHRId": "string",
    "encounterDiagnosisId": "string",
    "unitId": "string",
    "targetSiteCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "statusCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "medicalCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "observeStartDate": "string",
    "observeEndDate": "string",
    "interpretation": "string",
    "value": "number",
    "comment": "string",
    "referenceRangeLow": "number",
    "referenceRangeHigh": "number",
    "referenceRangeDescription": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
observationEHRId	string	uuid	Unique identifier that links to an observation
encounterEHRId	string	uuid	Unique identifier that links to an encounter
providerProcedureEHRId	string	uuid	Unique identifier that links to a provider's procedure
resultEHRId	string	uuid	Unique identifier that links to a result
patientVitalSignEHRId	string	uuid	Unique identifier that links to a patient's vital sign
encounterDiagnosisId	string	uuid	Unique identifier that links to an encounter diagnosis
unitId	string	uuid	Unique identifier that links to a unit
targetSiteCodeSystem	[Code Model]
statusCodeSystem	[Code Model]
medicalCodeSystem	[Code Model]
observeStartDate	string	date-time	Start Date of the observation
observeEndDate	string	date-time	End date of the observation
interpretation	string		Interpretation of what is observed
value	number	double	Value retrieved from the observation( ex. Heart rate = 120bpm)
comment	string		Additional comments made from the observation
referenceRangeLow	number	double	A low value retrieve(ex. Blood pressure 90/120)
referenceRangeHigh	number	double	A high value retrieve(ex. Blood pressure 90/120)
referenceRangeDescription	string		Additional information on the Low and High reference range

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Observation Get

The method that allows the user to retrieve observation details of an encounter.

API Endpoint

POST //api/EHRClinicalSummary/ObservationGet

POST //api/EHRClinicalSummary/ObservationGet HTTP/1.1
Content-Type: application/json

{

    "ehrId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to alcohol usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "observationEHRId": "string",
        "encounterEHRId": "string",
        "providerProcedureEHRId": "string",
        "resultEHRId": "string",
        "patientVitalSignEHRId": "string",
        "encounterDiagnosisId": "string",
        "unitId": "string",
        "targetSiteCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "statusCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "medicalCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "observeStartDate": "string",
        "observeEndDate": "string",
        "interpretation": "string",
        "value": "number",
        "comment": "string",
        "referenceRangeLow": "number",
        "referenceRangeHigh": "number",
        "referenceRangeDescription": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
observationEHRId	string	uuid	Unique identifier that links to an observation
encounterEHRId	string	uuid	Unique identifier that links to an encounter
providerProcedureEHRId	string	uuid	Unique identifier that links to a provider's procedure
resultEHRId	string	uuid	Unique identifier that links to a result
patientVitalSignEHRId	string	uuid	Unique identifier that links to a patient's vital sign
encounterDiagnosisId	string	uuid	Unique identifier that links to an encounter diagnosis
unitId	string	uuid	Unique identifier that links to a unit
targetSiteCodeSystem	[Code Model]
statusCodeSystem	[Code Model]
medicalCodeSystem	[Code Model]
observeStartDate	string	date-time	Start Date of the observation
observeEndDate	string	date-time	End date of the observation
interpretation	string		Interpretation of what is observed
value	number	double	Value retrieved from the observation( ex. Heart rate = 120bpm)
comment	string		Additional comments made from the observation
referenceRangeLow	number	double	A low value retrieve(ex. Blood pressure 90/120)
referenceRangeHigh	number	double	A high value retrieve(ex. Blood pressure 90/120)
referenceRangeDescription	string		Additional information on the Low and High reference range

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Provider Procedure Save

The method that allows the user to save provider procedure details of an encounter.

API Endpoint

POST //api/EHRClinicalSummary/ProviderProcedureSave

POST //api/EHRClinicalSummary/ProviderProcedureSave HTTP/1.1
Content-Type: application/json

{

    "providerProcedureEHRId": "string",
    "encounterProviderEHRId": "string",
    "procedureCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "startDate": "string",
    "endDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
providerProcedureEHRId	string	uuid	Unique identifier that links to a provider procedure
encounterProviderEHRId	string	uuid	Unique identifier that links to an encounter procedure
procedureCodeSystem	[Code Model]
startDate	string	date-time	Start date of the provider procedure
endDate	string	date-time	End date of the provider procedure

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "providerProcedureEHRId": "string",
    "encounterProviderEHRId": "string",
    "procedureCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "startDate": "string",
    "endDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
providerProcedureEHRId	string	uuid	Unique identifier that links to a provider procedure
encounterProviderEHRId	string	uuid	Unique identifier that links to an encounter procedure
procedureCodeSystem	[Code Model]
startDate	string	date-time	Start date of the provider procedure
endDate	string	date-time	End date of the provider procedure

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Encounter Procedures Get

The method that allows the user to retrieve provider procedure details of an encounter.

API Endpoint

POST //api/EHRClinicalSummary/EncounterProceduresGet

POST //api/EHRClinicalSummary/EncounterProceduresGet HTTP/1.1
Content-Type: application/json

{

    "ehrId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to alcohol usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "providerProcedureEHRId": "string",
        "encounterProviderEHRId": "string",
        "procedureCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "startDate": "string",
        "endDate": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
providerProcedureEHRId	string	uuid	Unique identifier that links to a provider procedure
encounterProviderEHRId	string	uuid	Unique identifier that links to an encounter procedure
procedureCodeSystem	[Code Model]
startDate	string	date-time	Start date of the provider procedure
endDate	string	date-time	End date of the provider procedure

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Encounter Diagnosis

The method that allows the user to save the diagnosis details of an encounter.

API Endpoint

POST //api/EHRClinicalSummary/EncounterDiagnosis

POST //api/EHRClinicalSummary/EncounterDiagnosis HTTP/1.1
Content-Type: application/json

{

    "encounterDiagnosisEHRId": "string",
    "encounterEHRId": "string",
    "diagnosisCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
encounterDiagnosisEHRId	string	uuid	Unique identifier that links to an encounter diagnosis
encounterEHRId	string	uuid	Unique identifier that links to an encounter
diagnosisCodeSystem	[Code Model]
description	string		Additional information that describes the diagnosis

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "encounterDiagnosisEHRId": "string",
    "encounterEHRId": "string",
    "diagnosisCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
encounterDiagnosisEHRId	string	uuid	Unique identifier that links to an encounter diagnosis
encounterEHRId	string	uuid	Unique identifier that links to an encounter
diagnosisCodeSystem	[Code Model]
description	string		Additional information that describes the diagnosis

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Encounter Diagnosis Get

The method that allows the user to retrieve the diagnosis details of an encounter.

API Endpoint

POST //api/EHRClinicalSummary/EncounterDiagnosisGet

POST //api/EHRClinicalSummary/EncounterDiagnosisGet HTTP/1.1
Content-Type: application/json

{

    "ehrId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to alcohol usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "encounterDiagnosisEHRId": "string",
        "encounterEHRId": "string",
        "diagnosisCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "description": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
encounterDiagnosisEHRId	string	uuid	Unique identifier that links to an encounter diagnosis
encounterEHRId	string	uuid	Unique identifier that links to an encounter
diagnosisCodeSystem	[Code Model]
description	string		Additional information that describes the diagnosis

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Encounter Immunizations

The method that allows the user to save the immunization details of an encounter.

API Endpoint

POST //api/EHRClinicalSummary/EncounterImmunizations

POST //api/EHRClinicalSummary/EncounterImmunizations HTTP/1.1
Content-Type: application/json

{

    "immunizationEHRId": "string",
    "patientEncounterId": "string",
    "productCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "routeCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "quantity": "number",
    "measurementUnitId": "string",
    "immunizationDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
immunizationEHRId	string	uuid	Unique identifier that links to an immunization
patientEncounterId	string	uuid	Unique identifier that links to a patient's encounter
productCodeSystem	[Code Model]
routeCodeSystem	[Code Model]
quantity	number	double	Amount of the product used for the immunization
measurementUnitId	string	uuid	Unique identifier that links to a measurement unit
immunizationDate	string	date-time	Date of which the immunization was done

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "immunizationEHRId": "string",
    "patientEncounterId": "string",
    "productCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "routeCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "quantity": "number",
    "measurementUnitId": "string",
    "immunizationDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
immunizationEHRId	string	uuid	Unique identifier that links to an immunization
patientEncounterId	string	uuid	Unique identifier that links to a patient's encounter
productCodeSystem	[Code Model]
routeCodeSystem	[Code Model]
quantity	number	double	Amount of the product used for the immunization
measurementUnitId	string	uuid	Unique identifier that links to a measurement unit
immunizationDate	string	date-time	Date of which the immunization was done

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Immunizations Get

The method that allows the user to retrieve the immunization details of an encounter.

API Endpoint

POST //api/EHRClinicalSummary/ImmunizationsGet

POST //api/EHRClinicalSummary/ImmunizationsGet HTTP/1.1
Content-Type: application/json

{

    "ehrId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to alcohol usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "immunizationEHRId": "string",
        "patientEncounterId": "string",
        "productCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "routeCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "quantity": "number",
        "measurementUnitId": "string",
        "immunizationDate": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
immunizationEHRId	string	uuid	Unique identifier that links to an immunization
patientEncounterId	string	uuid	Unique identifier that links to a patient's encounter
productCodeSystem	[Code Model]
routeCodeSystem	[Code Model]
quantity	number	double	Amount of the product used for the immunization
measurementUnitId	string	uuid	Unique identifier that links to a measurement unit
immunizationDate	string	date-time	Date of which the immunization was done

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Diagnosis Medication Save

The method that allows the user to save the medication details of a diagnosis.

API Endpoint

POST //api/EHRClinicalSummary/DiagnosisMedicationSave

POST //api/EHRClinicalSummary/DiagnosisMedicationSave HTTP/1.1
Content-Type: application/json

{

    "diagnosisMedicationEHRId": "string",
    "diagnosisId": "string",
    "productCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "routeCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "dosageQuantity": "number",
    "dosageUnitId": "string",
    "frequencyQuantity": "number",
    "frequencyUnitId": "string",
    "isPrescription": "boolean",
    "startDate": "string",
    "endDate": "string",
    "instructions": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
diagnosisMedicationEHRId	string	uuid	Unique identifier that links to diagnosed medication
diagnosisId	string	uuid	Unique identifier that links to a diagnosis
productCodeSystem	[Code Model ]
routeCodeSystem	[Code Model]
dosageQuantity	number	double	Dosage amount
dosageUnitId	string	uuid	Unique identifier that links to a dosage unit
frequencyQuantity	number	double	Frequency amount
frequencyUnitId	string	uuid	Unique identifier that links to a frequency unit
isPrescription	boolean		Boolean value that indicates if the medication is prescribed or not
startDate	string	date-time	Start date of the medication
endDate	string	date-time	End date of the medication
instructions	string		Additional information on the usage of the medication

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "diagnosisMedicationEHRId": "string",
    "diagnosisId": "string",
    "productCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "routeCodeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "dosageQuantity": "number",
    "dosageUnitId": "string",
    "frequencyQuantity": "number",
    "frequencyUnitId": "string",
    "isPrescription": "boolean",
    "startDate": "string",
    "endDate": "string",
    "instructions": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
diagnosisMedicationEHRId	string	uuid	Unique identifier that links to diagnosed medication
diagnosisId	string	uuid	Unique identifier that links to a diagnosis
productCodeSystem	[Code Model ]
routeCodeSystem	[Code Model]
dosageQuantity	number	double	Dosage amount
dosageUnitId	string	uuid	Unique identifier that links to a dosage unit
frequencyQuantity	number	double	Frequency amount
frequencyUnitId	string	uuid	Unique identifier that links to a frequency unit
isPrescription	boolean		Boolean value that indicates if the medication is prescribed or not
startDate	string	date-time	Start date of the medication
endDate	string	date-time	End date of the medication
instructions	string		Additional information on the usage of the medication

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Diagnosis Medication Get

The method that allows the user to retrieve the medication details of a diagnosis.

API Endpoint

POST //api/EHRClinicalSummary/DiagnosisMedicationGet

POST //api/EHRClinicalSummary/DiagnosisMedicationGet HTTP/1.1
Content-Type: application/json

{
    "ehrId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"   
}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to alcohol usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "diagnosisMedicationEHRId": "string",
        "diagnosisId": "string",
        "productCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "routeCodeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "dosageQuantity": "number",
        "dosageUnitId": "string",
        "frequencyQuantity": "number",
        "frequencyUnitId": "string",
        "isPrescription": "boolean",
        "startDate": "string",
        "endDate": "string",
        "instructions": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
diagnosisMedicationEHRId	string	uuid	Unique identifier that links to diagnosed medication
diagnosisId	string	uuid	Unique identifier that links to a diagnosis
productCodeSystem	[Code Model ]
routeCodeSystem	[Code Model]
dosageQuantity	number	double	Dosage amount
dosageUnitId	string	uuid	Unique identifier that links to a dosage unit
frequencyQuantity	number	double	Frequency amount
frequencyUnitId	string	uuid	Unique identifier that links to a frequency unit
isPrescription	boolean		Boolean value that indicates if the medication is prescribed or not
startDate	string	date-time	Start date of the medication
endDate	string	date-time	End date of the medication
instructions	string		Additional information on the usage of the medication

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Procedure Result Save

The method that allows the user to save the result details of a procedure.

API Endpoint

POST //api/EHRClinicalSummary/ProcedureResultSave

POST //api/EHRClinicalSummary/ProcedureResultSave HTTP/1.1
Content-Type: application/json

{

    "resultEHRId": "string",
    "providerProcedureId": "string",
    "codeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "resultDate": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
resultEHRId	string	uuid	Unique identifier that links to a result
providerProcedureId	string	uuid	Unique identifier that links to a provider procedure
codeSystem	[Code Model]
resultDate	string	date-time	Date of when the result came
description	string		Additional information on the procedure result

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "resultEHRId": "string",
    "providerProcedureId": "string",
    "codeSystem": {
        "ehrId": "string",
        "codeSystem": "string",
        "code": "string",
        "description": "string"
    },
    "resultDate": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
resultEHRId	string	uuid	Unique identifier that links to a result
providerProcedureId	string	uuid	Unique identifier that links to a provider procedure
codeSystem	[Code Model]
resultDate	string	date-time	Date of when the result came
description	string		Additional information on the procedure result

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Procedure Result Get

The method that allows the user to retrieve the result details of a procedure.

API Endpoint

POST //api/EHRClinicalSummary/ProcedureResultGet

POST //api/EHRClinicalSummary/ProcedureResultGet HTTP/1.1
Content-Type: application/json

{

    "ehrId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string" 
}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to alcohol usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "resultEHRId": "string",
        "providerProcedureId": "string",
        "codeSystem": {
            "ehrId": "string",
            "codeSystem": "string",
            "code": "string",
            "description": "string"
        },
        "resultDate": "string",
        "description": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
resultEHRId	string	uuid	Unique identifier that links to a result
providerProcedureId	string	uuid	Unique identifier that links to a provider procedure
codeSystem	[Code Model]
resultDate	string	date-time	Date of when the result came
description	string		Additional information on the procedure result

Code Model Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to a code model
codeSystem	string		This is a representation of the code system being used like "ICD-10"
code	string		This is the specific code used for the procedure based on the code system used
description	string		This is a description of the code being used

EHR Care Plan Save

The method that allows the user to save the details of a care plan for a patient.

API Endpoint

POST //api/EHRClinicalSummary/CarePlanSave

POST //api/EHRClinicalSummary/CarePlanSave HTTP/1.1
Content-Type: application/json

{

    "carePlanId": "string",
    "patientProfileId": "string",
    "startDate": "string",
    "endDate": "string",
    "modifiedDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
carePlanId	string	uuid	Unique identifier that links to a care plan
patientProfileId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the care plan
endDate	string	date-time	End date of the care plan
modifiedDate	string	date-time	Date of when the care plan was modified

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "carePlanId": "string",
    "patientProfileId": "string",
    "startDate": "string",
    "endDate": "string",
    "modifiedDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
carePlanId	string	uuid	Unique identifier that links to a care plan
patientProfileId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the care plan
endDate	string	date-time	End date of the care plan
modifiedDate	string	date-time	Date of when the care plan was modified

EHR Care Plan Get

The method that allows the user to retrieve the details of a care plan for a patient.

API Endpoint

POST //api/EHRClinicalSummary/CarePlanGet

POST //api/EHRClinicalSummary/CarePlanGet HTTP/1.1
Content-Type: application/json

{

    "ehrId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format	Description
ehrId	string	uuid	Unique identifier that links to alcohol usage

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "carePlanId": "string",
        "patientProfileId": "string",
        "startDate": "string",
        "endDate": "string",
        "modifiedDate": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
carePlanId	string	uuid	Unique identifier that links to a care plan
patientProfileId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the care plan
endDate	string	date-time	End date of the care plan
modifiedDate	string	date-time	Date of when the care plan was modified

Patient Health Record

Patient Health Record Save

This method add the specified data to the patient’s health record

API Endpoint

POST //api/PersonalHealthRecord/PatientHealthRecordSave

POST //api/PersonalHealthRecord/PatientHealthRecordSave HTTP/1.1
Content-Type: application/json

{
        "profileId": "string",
        "contacts": [
            {
                "relationship": "string",
                "title": "string",
                "firstName": "string",
                "surname": "string",
                "mobileNumber": "string",
                "genderType": "string",
                "gender": "string",
                "orginisation": "string",
                "physicalAddress": "string",
                "postalAddress": "string",
                "city": "string",
                "suburb": "string",
                "postalCode": "string"
            }
        ],
        "familyHistory": [
            {
                "relationship": "string",
                "firstName": "string",
                "surname": "string",
                "isDeceased": "boolean",
                "dateOfBirth": "string",
                "genderType": "string",
                "problems": [
                    {
                        "dateStarted": "string",
                        "ageAtOnset": "integer",
                        "isCauseOfDeath": "boolean",
                        "problemDescription": "string"
                    }
                ]
            }
        ],
        "diet": [
            {
                "prescribedBy": {
                    "firstName": "string",
                    "surname": "string",
                    "credentials": "string",
                    "practiceName": "string"
                },
                "startDate": "string",
                "endDate": "string",
                "name": "string",
                "decription": "string"
            }
        ],
        "allergies": [
            {
                "startDate": "string",
                "endDate": "string",
                "name": "string",
                "decription": "string"
            }
        ],
        "alcoholUsage": {
            "startDate": "string",
            "endDate": "string",
            "frequency": "integer",
            "period": "string",
            "notes": "string"
        },
        "tabacoUsage": {
            "startDate": "string",
            "endDate": "string",
            "frequency": "integer",
            "period": "string",
            "notes": "string"
        },
        "biometric": {
            "biometricTimeStamp": "string",
            "heightInCentimeters": "number",
            "weightInKilograms": "number",
            "waistCircumferenceInCentimeters": "number",
            "hipCircumferenceInCentimeters": "number",
            "systolicBloodPressureInMmHg": "number",
            "diastolicBloodPressureInMmHg": "number",
            "glucoseInMmolL": "number",
            "totalCholesterolMmolL": "number",
            "temperatureInCelsius": "number"
        },
        "mood": {
            "patientMood": "string",
            "timeStamp": "string"
        },
        "activities": [
            {
                "timestamp": "string",
                "description": "string"
            }
        ],
        "problems": [
            {
                "dateStarted": "string",
                "ageAtOnset": "integer",
                "isCauseOfDeath": "boolean",
                "problemDescription": "string"
            }
        ],
        "labTestResults": [
            {
                "timestamp": "string",
                "name": "string",
                "description": "string",
                "location": {
                    "address": "string",
                    "facilityName": "string"
                },
                "careproviderDetails": {
                    "firstName": "string",
                    "surname": "string",
                    "credentials": "string",
                    "practiceName": "string"
                }
            }
        ],
        "immunizations": [
            {
                "timestamp": "string",
                "name": "string",
                "description": "string",
                "location": {
                    "address": "string",
                    "facilityName": "string"
                },
                "careproviderDetails": {
                    "firstName": "string",
                    "surname": "string",
                    "credentials": "string",
                    "practiceName": "string"
                }
            }
        ],
        "diagnosis": [
            {
                "timestamp": "string",
                "name": "string",
                "description": "string",
                "location": {
                    "address": "string",
                    "facilityName": "string"
                },
                "careproviderDetails": {
                    "firstName": "string",
                    "surname": "string",
                    "credentials": "string",
                    "practiceName": "string"
                }
            }
        ],
        "procedures": [
            {
                "timestamp": "string",
                "name": "string",
                "description": "string",
                "location": {
                    "address": "string",
                    "facilityName": "string"
                },
                "careproviderDetails": {
                    "firstName": "string",
                    "surname": "string",
                    "credentials": "string",
                    "practiceName": "string"
                }
            }
        ],
        "medication": [
            {
                "startDate": "string",
                "endDate": "string",
                "name": "string",
                "isPrescription": "boolean",
                "dosageQuantity": "number",
                "dosageUnit": "string",
                "frequencyQuantity": "number",
                "frequencyUnit": "string",
                "isChronic": "boolean",
                "reason": "string",
                "prescribedBy": {
                    "firstName": "string",
                    "surname": "string",
                    "credentials": "string",
                    "practiceName": "string"
                }
            }
        ]

}

Fields

Contacts[]

A list of the patient's contacts

Name	Type	Format	Description
relationship	string		The relationship the patient has with the contact
title	string		Title of the Contact
firstName	string		Name of the Contact
surname	string		Surname of the contact
mobileNumber	string		Internation mobile number of the contac
genderType	string	[Male, Female]	The patient's gender only the values in the format column are supported
orginisation	string		Name of the orginistion the contact works for
physicalAddress	string		Physcial address of the contact
postalAddress	string		Postal address of the contact
city	string		The city where the contact lives
suburb	string		The Suburb where the contact lives
postalCode	string		The Suburb's Postal Code

Family History[]

A list of the patient's family members and relevant problems

Name	Type	Format	Description
relationship	string		The relationship the patient has with the family member
firstName	string		Name of the family Member
surname	string		Surname of the family Member
isDeceased	boolean		Is the family Member deceased
dateOfBirth	string	date-time	Date of birth of the family Member
genderType	string	[Male, Female]	The patient's gender only the values in the format column are supported
problems	array[Problems]		List of all the family member's problems

Diet[]

A list of the patient's current and past diet's

Name	Type	Format	Description
prescribedBy	medicalProfessional		The medical professional which prescribed the diet to the patient
startDate	string	date-time	When the patient started following the diet program
endDate	string	date-time	When the patient stoped following the diet program
name	string		Name of the Diet program
decription	string		Short description of the diet program

Allergies[]

A list of the patient's current and past allergies

Name	Type	Format	Description
startDate	string	date-time	Date when the Allergy first started occuring
endDate	string	date-time	Date when the Allergy stopped
name	string		Name of the Allergy
decription	string		Free text description about the allergy

AlcoholUsage

Details on the patient's alcohol intake

Name	Type	Format	Description
startDate	string	date-time	Date the patient started consuming alcohol
endDate	string	date-time	Date the patient stoped consuming alcohol
frequency	integer	int32	the rate per period (frequancy is used in conjunction with the period)
period	string		How often the occurnece takes place, ex per day, per week etc.
notes	string		Free text

TobaccoUsage

Details on the patient's Tobacco usage

Name	Type	Format	Description
startDate	string	date-time	Date the patient started smoking
endDate	string	date-time	Date the patient stoped smoking
frequency	integer	int32	the rate per period (frequancy is used in conjunction with the period)
period	string		How often the occurnece takes place, ex per hour, per day etc.
notes	string		Free text

Biometrics

The Patient's current Vital signs

Name	Type	Format	Description
biometricTimeStamp	string	date-time	Date of the measurement
heightInCentimeters	number	double	The patient's measured height in cm
weightInKilograms	number	double	The patient's measured weight in kg
waistCircumferenceInCentimeters	number	double	The patient's measured waist in cm
hipCircumferenceInCentimeters	number	double	The patient's measured hipCircumference in cm
systolicBloodPressureInMmHg	number	double	Systolic Blood Pressure of the patient in MmHg
diastolicBloodPressureInMmHg	number	double	diastolic Blood Pressure of the patient in MmHg
glucoseInMmolL	number	double	Glucose level of the patient in MMolL
totalCholesterolMmolL	number	double	Cholesterol level of the patient in MmolL
temperatureInCelsius	number	double	Temperature of the patient in degrees Celsius

Mood

The Patient's current Mood

Name	Type	Format	Description
patientMood	string	[ExtremelyUnhappy, VeryUnhappy, Unhappy, Neutral, Happy, VeryHappy, Elated]
timeStamp	string	date-time	the time the mood was captured

Activities

List of Patient's activities

Name	Type	Format	Description
timestamp	string	date-time
description	string

Problems

List of Patient's Problems

Name	Type	Format
dateStarted	string	date-time
ageAtOnset	integer	int32
isCauseOfDeath	boolean
problemDescription	string

LabResults

List of Patient's Lab Results

Name	Type	Format
timestamp	string	date-time
name	string
description	string
location	LocationModel
careproviderDetails	CareproviderDetailsModel

Immunizations

List of Patient's Immunizations

Name	Type	Format
timestamp	string	date-time
name	string
description	string
location	LocationModel
careproviderDetails	CareproviderDetailsModel

Diagnosis

List of Patient's Diagnosis

Name	Type	Format
timestamp	string	date-time
name	string
description	string
location	LocationModel
careproviderDetails	CareproviderDetailsModel

Procedures

List of Patient's Procedures

Name	Type	Format
timestamp	string	date-time
name	string
description	string
location	LocationModel
careproviderDetails	CareproviderDetailsModel

Medication

List of Patient's Medication

Name	Type	Format
startDate	string	date-time
endDate	string	date-time
name	string
isPrescription	boolean
dosageQuantity	number	double
dosageUnit	string
frequencyQuantity	number	double
frequencyUnit	string
isChronic	boolean
reason	string
prescribedBy	CareproviderDetailsModel

Patient Health Summary Get

Retreives a summary of all the latest records for the patient

API Endpoint

POST //api/PersonalHealthRecord/PatientHealthSummaryGet

POST //api/PersonalHealthRecord/PatientHealthSummaryGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profile": {
        "profileId": "string",
        "emailAddress": "string",
        "firstName": "string",
        "surname": "string",
        "title": "string",
        "mobileNumber": "string",
        "alternateNumber": "string",
        "genderEnumValue": "string",
        "gender": "string",
        "ethnicityEnumValue": "string",
        "ethnicity": "string",
        "province": "string",
        "physicalAddress": "string",
        "postalAddress": "string",
        "city": "string",
        "suburb": "string",
        "postalCode": "string",
        "rsaIdNumber": "string",
        "dateOfBirth": "string",
        "medicalAidProduct": "string",
        "beneficiaryNumber": "string",
        "medicalAidPolicyNumber": "string",
        "emergencyContactName": "string",
        "emergencyNumber": "string",
        "emergencyContactNextOfKin": "string",
        "employerName": "string",
        "occupation": "string",
        "qualification": "string"
    },
    "familyHistory": [
        {
            "id": "string",
            "relationship": "string",
            "firstName": "string",
            "surname": "string",
            "isDeceased": "boolean",
            "dateOfBirth": "string",
            "genderType": "string",
            "problems": [
                {
                    "dateStarted": "string",
                    "ageAtOnset": "integer",
                    "isCauseOfDeath": "boolean",
                    "problemDescription": "string"
                }
            ]
        }
    ],
    "contacts": [
        {
            "id": "string",
            "relationship": "string",
            "title": "string",
            "firstName": "string",
            "surname": "string",
            "mobileNumber": "string",
            "genderType": "string",
            "gender": "string",
            "orginisation": "string",
            "physicalAddress": "string",
            "postalAddress": "string",
            "city": "string",
            "suburb": "string",
            "postalCode": "string"
        }
    ],
    "problems": [
        {
            "dateStarted": "string",
            "ageAtOnset": "integer",
            "isCauseOfDeath": "boolean",
            "problemDescription": "string"
        }
    ],
    "dietItems": [
        {
            "id": "string",
            "startDate": "string",
            "endDate": "string",
            "name": "string",
            "decription": "string"
        }
    ],
    "allergies": [
        {
            "id": "string",
            "startDate": "string",
            "endDate": "string",
            "name": "string",
            "decription": "string"
        }
    ],
    "biometrics": {
        "biometricTimeStamp": "string",
        "heightInCentimeters": "number",
        "weightInKilograms": "number",
        "waistCircumferenceInCentimeters": "number",
        "hipCircumferenceInCentimeters": "number",
        "systolicBloodPressureInMmHg": "number",
        "diastolicBloodPressureInMmHg": "number",
        "glucoseInMmolL": "number",
        "totalCholesterolMmolL": "number",
        "temperatureInCelsius": "number"
    },
    "activities": [
        {
            "id": "string",
            "timestamp": "string",
            "description": "string"
        }
    ],
    "moods": [
        {
            "id": "string",
            "timestamp": "string",
            "description": "string"
        }
    ],
    "results": [
        {
            "id": "string",
            "timestamp": "string",
            "name": "string",
            "description": "string",
            "location": {
                "address": "string",
                "facilityName": "string"
            },
            "careproviderDetails": {
                "firstName": "string",
                "surname": "string",
                "credentials": "string",
                "practiceName": "string"
            }
        }
    ],
    "immunizations": [
        {
            "id": "string",
            "timestamp": "string",
            "name": "string",
            "description": "string",
            "location": {
                "address": "string",
                "facilityName": "string"
            },
            "careproviderDetails": {
                "firstName": "string",
                "surname": "string",
                "credentials": "string",
                "practiceName": "string"
            }
        }
    ],
    "procedures": [
        {
            "id": "string",
            "timestamp": "string",
            "name": "string",
            "description": "string",
            "location": {
                "address": "string",
                "facilityName": "string"
            },
            "careproviderDetails": {
                "firstName": "string",
                "surname": "string",
                "credentials": "string",
                "practiceName": "string"
            }
        }
    ],
    "diagnosis": [
        {
            "id": "string",
            "timestamp": "string",
            "name": "string",
            "description": "string",
            "location": {
                "address": "string",
                "facilityName": "string"
            },
            "careproviderDetails": {
                "firstName": "string",
                "surname": "string",
                "credentials": "string",
                "practiceName": "string"
            }
        }
    ],
    "alcoholUsage": {
        "id": "string",
        "startDate": "string",
        "endDate": "string",
        "frequency": "integer",
        "period": "string",
        "notes": "string"
    },
    "tobaccoUsage": {
        "id": "string",
        "startDate": "string",
        "endDate": "string",
        "frequency": "integer",
        "period": "string",
        "notes": "string"
    },
    "medication": [
        {
            "id": "string",
            "startDate": "string",
            "endDate": "string",
            "name": "string",
            "isPrescription": "boolean",
            "dosageQuantity": "number",
            "dosageUnit": "string",
            "frequencyQuantity": "number",
            "frequencyUnit": "string",
            "isChronic": "boolean",
            "reason": "string",
            "prescribedBy": {
                "firstName": "string",
                "surname": "string",
                "credentials": "string",
                "practiceName": "string"
            }
        }
    ]
}

Fields

Contacts[]

A list of the patient's contacts

Name	Type	Format	Description
relationship	string		The relationship the patient has with the contact
title	string		Title of the Contact
firstName	string		Name of the Contact
surname	string		Surname of the contact
mobileNumber	string		Internation mobile number of the contac
genderType	string	[Male, Female]	The patient's gender only the values in the format column are supported
orginisation	string		Name of the orginistion the contact works for
physicalAddress	string		Physcial address of the contact
postalAddress	string		Postal address of the contact
city	string		The city where the contact lives
suburb	string		The Suburb where the contact lives
postalCode	string		The Suburb's Postal Code

Family History[]

A list of the patient's family members and relevant problems

Name	Type	Format	Description
relationship	string		The relationship the patient has with the family member
firstName	string		Name of the family Member
surname	string		Surname of the family Member
isDeceased	boolean		Is the family Member deceased
dateOfBirth	string	date-time	Date of birth of the family Member
genderType	string	[Male, Female]	The patient's gender only the values in the format column are supported
problems	array[Problems]		List of all the family member's problems

Diet[]

A list of the patient's current and past diet's

Name	Type	Format	Description
prescribedBy	medicalProfessional		The medical professional which prescribed the diet to the patient
startDate	string	date-time	When the patient started following the diet program
endDate	string	date-time	When the patient stoped following the diet program
name	string		Name of the Diet program
decription	string		Short description of the diet program

Allergies[]

A list of the patient's current and past allergies

Name	Type	Format	Description
startDate	string	date-time	Date when the Allergy first started occuring
endDate	string	date-time	Date when the Allergy stopped
name	string		Name of the Allergy
decription	string		Free text description about the allergy

AlcoholUsage

Details on the patient's alcohol intake

Name	Type	Format	Description
startDate	string	date-time	Date the patient started consuming alcohol
endDate	string	date-time	Date the patient stoped consuming alcohol
frequency	integer	int32	the rate per period (frequancy is used in conjunction with the period)
period	string		How often the occurnece takes place, ex per day, per week etc.
notes	string		Free text

TobaccoUsage

Details on the patient's Tobacco usage

Name	Type	Format	Description
startDate	string	date-time	Date the patient started smoking
endDate	string	date-time	Date the patient stoped smoking
frequency	integer	int32	the rate per period (frequancy is used in conjunction with the period)
period	string		How often the occurnece takes place, ex per hour, per day etc.
notes	string		Free text

Biometrics

The Patient's current Vital signs

Name	Type	Format	Description
biometricTimeStamp	string	date-time	Date of the measurement
heightInCentimeters	number	double	The patient's measured height in cm
weightInKilograms	number	double	The patient's measured weight in kg
waistCircumferenceInCentimeters	number	double	The patient's measured waist in cm
hipCircumferenceInCentimeters	number	double	The patient's measured hipCircumference in cm
systolicBloodPressureInMmHg	number	double	Systolic Blood Pressure of the patient in MmHg
diastolicBloodPressureInMmHg	number	double	diastolic Blood Pressure of the patient in MmHg
glucoseInMmolL	number	double	Glucose level of the patient in MMolL
totalCholesterolMmolL	number	double	Cholesterol level of the patient in MmolL
temperatureInCelsius	number	double	Temperature of the patient in degrees Celsius

Mood

The Patient's current Mood

Name	Type	Format	Description
patientMood	string	[ExtremelyUnhappy, VeryUnhappy, Unhappy, Neutral, Happy, VeryHappy, Elated]
timeStamp	string	date-time	the time the mood was captured

Activities

List of Patient's activities

Name	Type	Format	Description
timestamp	string	date-time
description	string

Problems

List of Patient's Problems

Name	Type	Format
dateStarted	string	date-time
ageAtOnset	integer	int32
isCauseOfDeath	boolean
problemDescription	string

LabResults

List of Patient's Lab Results

Name	Type	Format
timestamp	string	date-time
name	string
description	string
location	LocationModel
careproviderDetails	CareproviderDetailsModel

Immunizations

List of Patient's Immunizations

Name	Type	Format
timestamp	string	date-time
name	string
description	string
location	LocationModel
careproviderDetails	CareproviderDetailsModel

Diagnosis

List of Patient's Diagnosis

Name	Type	Format
timestamp	string	date-time
name	string
description	string
location	LocationModel
careproviderDetails	CareproviderDetailsModel

Procedures

List of Patient's Procedures

Name	Type	Format
timestamp	string	date-time
name	string
description	string
location	LocationModel
careproviderDetails	CareproviderDetailsModel

Medication

List of Patient's Medication

Name	Type	Format
startDate	string	date-time
endDate	string	date-time
name	string
isPrescription	boolean
dosageQuantity	number	double
dosageUnit	string
frequencyQuantity	number	double
frequencyUnit	string
isChronic	boolean
reason	string
prescribedBy	CareproviderDetailsModel

Patient Diet Save

The method that allows the patient to save details regarding the patient's diet.

API Endpoint

POST //api/PersonalHealthRecord/PatientDietSave

POST //api/PersonalHealthRecord/PatientDietSave HTTP/1.1
Content-Type: application/json

{
    "dietId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
dietId	string	uuid	Unique identifier that links to a patient's diet
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the diet
endDate	string	date-time	End date of the diet
description	string		Additional information given about the diet

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "dietId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
dietId	string	uuid	Unique identifier that links to a patient's diet
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the diet
endDate	string	date-time	End date of the diet
description	string		Additional information given about the diet

Patient Diet List

The method that allows the patient to retrieve their entire diet collection

API Endpoint

POST //api/PersonalHealthRecord/PatientDietList

POST //api/PersonalHealthRecord/PatientDietList HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's diet

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "dietId": "string",
        "patientId": "string",
        "startDate": "string",
        "endDate": "string",
        "dietName": "string",
        "description": "string",
        "prescribedBy": {
            "firstName": "string",
            "surname": "string",
            "credentials": "string",
            "practiceName": "string"
        },
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
dietId	string	uuid	Unique identifier that links to a patient's diet
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the diet
endDate	string	date-time	End date of the diet
description	string		Additional information given about the diet
prescribedBy	CareproviderDetailsModel

Patient Diet Get

The method that allows the patient to retrieve details regarding the patient's diet.

API Endpoint

POST //api/PersonalHealthRecord/PatientDietGet

POST //api/PersonalHealthRecord/PatientDietGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's diet

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "dietId": "string",
        "patientProfileId": "string",
        "startDate": "string",
        "endDate": "string",
        "description": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
dietId	string	uuid	Unique identifier that links to a patient's diet
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the diet
endDate	string	date-time	End date of the diet
description	string		Additional information given about the diet

Patient Diet Remove

The method that allows the patient to remove a diet record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientDietRemove

POST //api/PersonalHealthRecord/PatientDietRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's diet

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Patient Wellness Activity Save

The method that allows the patient to save details regarding the patient's activity.

API Endpoint

POST //api/PersonalHealthRecord/PatientActivitySave

POST //api/PersonalHealthRecord/PatientActivitySave HTTP/1.1
Content-Type: application/json

{
    "activityId": "string",
    "patientId": "string",
    "startDate": "string",
    "activity": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
activityId	string	uuid	Unique identifier that links to a patient's activity
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the activity
activity	string		Description of the activity

HTTP/1.1 200 OK
Content-Type: application/json

{
    "activityId": "string",
    "patientId": "string",
    "startDate": "string",
    "activity": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
activityId	string	uuid	Unique identifier that links to a patient's activity
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the activity
activity	string		Description of the activity

Patient Wellness Activity List

The method that allows the patient to retrieve their entire activity collection

API Endpoint

POST //api/PersonalHealthRecord/PatientActivityList

POST //api/PersonalHealthRecord/PatientDietList HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's diet

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "activityId": "string",
        "patientId": "string",
        "startDate": "string",
        "activity": "string"
    }
]

Fields

Name	Type	Format	Description
activityId	string	uuid	Unique identifier that links to a patient's activity
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the activity
activity	string		Description of the activity

Patient Wellness Activity Get

The method that allows the patient to retrieve details regarding the patient's activity.

API Endpoint

POST //api/PersonalHealthRecord/PatientActivityGet

POST //api/PersonalHealthRecord/PatientActivityGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's activity

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "activityId": "string",
        "patientId": "string",
        "startDate": "string",
        "activity": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
    }
]

Fields

Name	Type	Format	Description
activityId	string	uuid	Unique identifier that links to a patient's activity
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the activity
activity	string		Description of the activity

Patient Wellness Activity Remove

The method that allows the patient to remove a activity record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientActivityRemove

POST //api/PersonalHealthRecord/PatientActivityRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's diet

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Patient Mood Save

The method that allows the patient to save details regarding the patient's mood.

API Endpoint

POST //api/PersonalHealthRecord/PatientMoodSave

POST //api/PersonalHealthRecord/PatientMoodSave HTTP/1.1
Content-Type: application/json

{
    "moodId": "string",
    "patientId": "string",
    "patientMood": "string",
    "timeStamp": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
moodId	string	uuid	Unique identifier that links to a mood
patientId	string	uuid	Unique identifier that links to a patient's profile
patientMood	string	[ExtremelyUnhappy, VeryUnhappy, Unhappy, Neutral, Happy, VeryHappy, Elated]
timeStamp	string	date-time	Time of which the patient changed their mood

HTTP/1.1 200 OK
Content-Type: application/json

{
    "moodId": "string",
    "patientId": "string",
    "patientMood": "string",
    "timeStamp": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
moodId	string	uuid	Unique identifier that links to a mood
patientId	string	uuid	Unique identifier that links to a patient's profile
patientMood	string	[ExtremelyUnhappy, VeryUnhappy, Unhappy, Neutral, Happy, VeryHappy, Elated]
timeStamp	string	date-time	Time of which the patient changed their mood

Patient Mood List

The method that allows the patient to retrieve their entire mood collection

API Endpoint

POST //api/PersonalHealthRecord/PatientMoodList

POST //api/PersonalHealthRecord/PatientMoodList HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's mood

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

[
     {
        "moodId": "string",
        "patientId": "string",
        "patientMood": "string",
        "timeStamp": "string",
    }
]

Fields

Name	Type	Format	Description
moodId	string	uuid	Unique identifier that links to a mood
patientId	string	uuid	Unique identifier that links to a patient's profile
patientMood	string	[ExtremelyUnhappy, VeryUnhappy, Unhappy, Neutral, Happy, VeryHappy, Elated]
timeStamp	string	date-time	Time of which the patient changed their mood

Patient Mood Get

The method that allows the patient to retrieve details regarding the patient's mood.

API Endpoint

POST //api/PersonalHealthRecord/PatientMoodGet

POST //api/PersonalHealthRecord/PatientMoodGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's mood

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "moodId": "string",
    "patientId": "string",
    "patientMood": "string",
    "timeStamp": "string",
}

Fields

Name	Type	Format	Description
moodId	string	uuid	Unique identifier that links to a mood
patientId	string	uuid	Unique identifier that links to a patient's profile
patientMood	string	[ExtremelyUnhappy, VeryUnhappy, Unhappy, Neutral, Happy, VeryHappy, Elated]
timeStamp	string	date-time	Time of which the patient changed their mood

Patient Mood Remove

The method that allows the patient to remove a mood record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientMoodRemove

POST //api/PersonalHealthRecord/PatientMoodRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's mood

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Patient Alcohol Usage Save

The method that allows the patient to save details regarding the patient's alcohol usage.

API Endpoint

POST //api/PersonalHealthRecord/PatientAlcoholUsageSave

POST //api/PersonalHealthRecord/PatientAlcoholUsageSave HTTP/1.1
Content-Type: application/json

{
    "alcoholUsageId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "frequency": "integer",
    "measurementUnitId": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
alcoholUsageId	string	uuid	Unique identifier that links to a specific alcohol usage
patientId	string	uuid	Unique identifier that links to a patient
startDate	string	date-time	Starting date of usage
endDate	string	date-time	End date of usage
frequency	integer	int32	The frequency of which the patient uses alcohol
measurementUnitId	string	uuid	Unique identifier that links to a unit of measurement
description	string		Additional information on the patient's usage

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "alcoholUsageId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "frequency": "integer",
    "measurementUnitId": "string",
    "description": "string"
}

Fields

Name	Type	Format	Description
alcoholUsageId	string	uuid	Unique identifier that links to a specific alcohol usage
patientId	string	uuid	Unique identifier that links to a patient
startDate	string	date-time	Starting date of usage
endDate	string	date-time	End date of usage
frequency	integer	int32	The frequency of which the patient uses alcohol
measurementUnitId	string	uuid	Unique identifier that links to a unit of measurement
description	string		Additional information on the patient's usage

Patient Alcohol Usage List

The method that returns a list regarding the patient's alcohol usage

API Endpoint

POST //api/PersonalHealthRecord/PatientAlcoholUsageList

POST //api/PersonalHealthRecord/PatientAlcoholUsageList HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Patient's profile Id

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "alcoholUsageId": "string",
        "patientId": "string",
        "startDate": "string",
        "endDate": "string",
        "frequency": "integer",
        "measurementUnitId": "string",
        "description": "string"
    }
]

Fields

Name	Type	Format	Description
alcoholUsageId	string	uuid	Unique identifier that links to a specific alcohol usage
patientId	string	uuid	Unique identifier that links to a patient
startDate	string	date-time	Starting date of usage
endDate	string	date-time	End date of usage
frequency	integer	int32	The frequency of which the patient uses alcohol
measurementUnitId	string	uuid	Unique identifier that links to a unit of measurement
description	string		Additional information on the patient's usage

Patient Alcohol Usage Get

The method that returns the details regarding the patient's alcohol usage

API Endpoint

POST //api/PersonalHealthRecord/PatientAlcoholUsageGet

POST //api/PersonalHealthRecord/PatientAlcoholUsageGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "alcoholUsageId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "frequency": "integer",
    "measurementUnitId": "string",
    "description": "string",
}

Fields

Name	Type	Format	Description
alcoholUsageId	string	uuid	Unique identifier that links to a specific alcohol usage
patientId	string	uuid	Unique identifier that links to a patient
startDate	string	date-time	Starting date of usage
endDate	string	date-time	End date of usage
frequency	integer	int32	The frequency of which the patient uses alcohol
measurementUnitId	string	uuid	Unique identifier that links to a unit of measurement
description	string		Additional information on the patient's usage

Patient Alcohol Usage Remove

The method that allows the patient to remove a Alcohol Usage record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientAlcoholUsageRemove

POST //api/PersonalHealthRecord/PatientAlcoholUsageRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	The Unique AlcoholUsageId

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Patient Tobacco Usage Save

This method creates a new tobacco usage record or updates an existing one if a tabacoUsageId is specified

API Endpoint

POST //api/PersonalHealthRecord/PatientTobaccoUsageSave

POST //api/PersonalHealthRecord/PatientTobaccoUsageSave HTTP/1.1
Content-Type: application/json

{
    "tabacoUsageId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "frequency": "integer",
    "measurementUnitId": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
tabacoUsageId	string	uuid	Unique identifier that links to tobacco usage
patientId	string	uuid	Unique identifier that links to a patient
startDate	string	date-time	Date of which tobacco usage started
endDate	string	date-time	Date of which tobacco usage ended
frequency	integer	int32	The frequency of which the patient uses tobacco
measurementUnitId	string	uuid	Unit of measurement (ex. daily / hourly)
description	string		Additional information about the patient's tobacco usage

HTTP/1.1 200 OK
Content-Type: application/json

{
    "tabacoUsageId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "frequency": "integer",
    "measurementUnitId": "string",
    "description": "string"
}

Fields

Name	Type	Format	Description
tabacoUsageId	string	uuid	Unique identifier that links to tobacco usage
patientId	string	uuid	Unique identifier that links to a patient
startDate	string	date-time	Date of which tobacco usage started
endDate	string	date-time	Date of which tobacco usage ended
frequency	integer	int32	The frequency of which the patient uses tobacco
measurementUnitId	string	uuid	Unit of measurement (ex. daily / hourly)
description	string		Additional information about the patient's tobacco usage

Patient Tobacco Usage List

Allows the patient to retrieve all their associated tobacco usage records

API Endpoint

POST //api/PersonalHealthRecord/PatientTobaccoUsageList

POST //api/PersonalHealthRecord/PatientTobaccoUsageList HTTP/1.1
Content-Type: application/json

{
        "id": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the patient

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "tobaccoUsageId": "string",
        "patientId": "string",
        "startDate": "string",
        "endDate": "string",
        "frequency": "integer",
        "measurementUnitId": "string",
        "description": "string"
    }
]

Fields

Name	Type	Format	Description
tobaccoUsageId	string	uuid	Unique identifier that links to tobacco usage
patientId	string	uuid	Unique identifier that links to a patient
startDate	string	date-time	Date of which tobacco usage started
endDate	string	date-time	Date of which tobacco usage ended
frequency	integer	int32	The frequency of which the patient uses tobacco
measurementUnitId	string	uuid	Unit of measurement (ex. daily / hourly)
description	string		Additional information about the patient's tobacco usage

Patient Tobacco Usage Get

Retrieves the details of a the specified tobacco usage record

API Endpoint

POST //api/PersonalHealthRecord/PatientTobaccoUsageGet

POST //api/PersonalHealthRecord/PatientTobaccoUsageGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the tobacco usage record

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "tobaccoUsageId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "frequency": "integer",
    "measurementUnitId": "string",
    "description": "string"
}

Fields

Name	Type	Format	Description
tobaccoUsageId	string	uuid	Unique identifier that links to tobacco usage
patientId	string	uuid	Unique identifier that links to a patient
startDate	string	date-time	Date of which tobacco usage started
endDate	string	date-time	Date of which tobacco usage ended
frequency	integer	int32	The frequency of which the patient uses tobacco
measurementUnitId	string	uuid	Unit of measurement (ex. daily / hourly)
description	string		Additional information about the patient's tobacco usage

Patient Tobacco Usage Remove

The method that allows the patient to remove a tobacco usage record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientTobaccoUsageRemove

POST //api/PersonalHealthRecord/PatientTobaccoUsageRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the tobacco usage record

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Patient Result Save

The method that saves the details regarding the patient's result

API Endpoint

POST //api/PersonalHealthRecord/PatientResultSave

POST //api/PersonalHealthRecord/PatientResultSave HTTP/1.1
Content-Type: application/json

{
    "resultId": "string",
    "patientId": "string",
    "dateOfResult": "string",
    "description": "string",
    "location": {
        "address": "string",
        "facilityName": "string"
    },
    "careproviderDetails": {
        "firstName": "string",
        "surname": "string",
        "credentials": "string",
        "practiceName": "string"
    },
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
resultId	string	uuid	Unique identifier that links to a patient's result
patientId	string	uuid	Unique identifier that links to a patient's profile
dateOfResult	string	date-time	Date of the result
description	string		Details on the result
location	LocationModel		Location the results was processed
careproviderDetails	CareproviderDetailsModel		Care provider's details

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "patientResultId": "string",
    "patientProfileId": "string",
    "dateOfResult": "string",
    "description": "string",
    "location": {
        "address": "string",
        "facilityName": "string"
    },
    "careproviderDetails": {
        "firstName": "string",
        "surname": "string",
        "credentials": "string",
        "practiceName": "string"
    }
}

Fields

Name	Type	Format	Description
resultId	string	uuid	Unique identifier that links to a patient's result
patientId	string	uuid	Unique identifier that links to a patient's profile
dateOfResult	string	date-time	Date of the result
description	string		Details on the result
location	LocationModel		Location the results was processed
careproviderDetails	CareproviderDetailsModel		Care provider's details

Patient Result List

The method that returns a list regarding the patient's results

API Endpoint

POST //api/PersonalHealthRecord/PatientResultList

POST //api/PersonalHealthRecord/PatientResultList HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "resultId": "string",
        "patientId": "string",
        "dateOfResult": "string",
        "description": "string",
        "location": {
        "address": "string",
        "facilityName": "string"
        },
        "careproviderDetails": {
        "firstName": "string",
        "surname": "string",
        "credentials": "string",
        "practiceName": "string"
        }
    }
]

Fields

Name	Type	Format	Description
resultId	string	uuid	Unique identifier that links to a patient's result
patientId	string	uuid	Unique identifier that links to a patient's profile
dateOfResult	string	date-time	Date of the result
description	string		Details on the result
location	LocationModel		Location the results was processed
careproviderDetails	CareproviderDetailsModel		Care provider's details

Patient Result Get

The method that returns the details regarding the patient's result

API Endpoint

POST //api/PersonalHealthRecord/PatientResultGet

POST //api/PersonalHealthRecord/PatientResultGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	The Result's Unique identifier

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "patientResultId": "string",
    "patientProfileId": "string",
    "dateOfResult": "string",
    "description": "string",
    "location": {
        "address": "string",
        "facilityName": "string"
    },
    "careproviderDetails": {
        "firstName": "string",
        "surname": "string",
        "credentials": "string",
        "practiceName": "string"
    }
}

Fields

Name	Type	Format	Description
resultId	string	uuid	Unique identifier that links to a patient's result
patientId	string	uuid	Unique identifier that links to a patient's profile
dateOfResult	string	date-time	Date of the result
description	string		Details on the result
location	LocationModel		Location the results was processed
careproviderDetails	CareproviderDetailsModel		Care provider's details

Patient Result Remove

The method that allows the patient to remove a result record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientResultRemove

POST //api/PersonalHealthRecord/PatientResultRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's result

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Patient Immunization Save

The method that returns the details regarding the patient's immunization

API Endpoint

POST //api/PersonalHealthRecord/PatientImmunizationSave

POST //api/PersonalHealthRecord/PatientImmunizationSave HTTP/1.1
Content-Type: application/json

{
    "ImmunizationId": "string",
    "patientId": "string",
    "dateOfImmunization": "string",
    "description": "string",
    "location": {
        "address": "string",
        "facilityName": "string"
    },
    "careproviderDetails": {
        "firstName": "string",
        "surname": "string",
        "credentials": "string",
        "practiceName": "string"
    }
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
ImmunizationId	string	uuid	Unique identifier of the immunization record
patientId	string	uuid	Unique identifier that links to a patient
dateOfImmunization	string	date-time	Date of the Immunization
description	string		Additional information on the patient's usage
location	LocationModel		Location the results was processed
careproviderDetails	CareproviderDetailsModel		Care provider's details

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "ImmunizationId": "string",
    "patientId": "string",
    "dateOfImmunization": "string",
    "description": "string",
    "location": {
        "address": "string",
        "facilityName": "string"
    },
    "careproviderDetails": {
        "firstName": "string",
        "surname": "string",
        "credentials": "string",
        "practiceName": "string"
    }
}

Fields

Name	Type	Format	Description
ImmunizationId	string	uuid	Unique identifier of the immunization record
patientId	string	uuid	Unique identifier that links to a patient
dateOfImmunization	string	date-time	Date of the Immunization
description	string		Additional information on the patient's usage
location	LocationModel		Location the results was processed
careproviderDetails	CareproviderDetailsModel		Care provider's details

Patient Immunization List

The method that returns a list regarding the patient's immunization

API Endpoint

POST //api/PersonalHealthRecord/PatientImmunizationList

POST //api/PersonalHealthRecord/PatientImmunizationList HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "ImmunizationId": "string",
        "patientId": "string",
        "dateOfImmunization": "string",
        "description": "string",
        "location": {
            "address": "string",
            "facilityName": "string"
        },
        "careproviderDetails": {
            "firstName": "string",
            "surname": "string",
            "credentials": "string",
            "practiceName": "string"
        }
    }
]

Fields

Name	Type	Format	Description
ImmunizationId	string	uuid	Unique identifier of the immunization record
patientId	string	uuid	Unique identifier that links to a patient
dateOfImmunization	string	date-time	Date of the Immunization
description	string		Additional information on the patient's usage
location	LocationModel		Location the results was processed
careproviderDetails	CareproviderDetailsModel		Care provider's details

Patient Immunization Get

The method that returns the details regarding the patient's immunization

API Endpoint

POST //api/PersonalHealthRecord/PatientImmunizationGet

POST //api/PersonalHealthRecord/PatientImmunizationGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the patient's immunization record

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "ImmunizationId": "string",
    "patientId": "string",
    "dateOfImmunization": "string",
    "description": "string",
    "location": {
        "address": "string",
        "facilityName": "string"
    },
    "careproviderDetails": {
        "firstName": "string",
        "surname": "string",
        "credentials": "string",
        "practiceName": "string"
    }
}

Fields

Name	Type	Format	Description
ImmunizationId	string	uuid	Unique identifier of the immunization record
patientId	string	uuid	Unique identifier that links to a patient
dateOfImmunization	string	date-time	Date of the Immunization
description	string		Additional information on the patient's usage
location	LocationModel		Location the results was processed
careproviderDetails	CareproviderDetailsModel		Care provider's details

Patient Immunization Remove

This method allows the patient to remove a immunization record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientImmunizationRemove

POST //api/PersonalHealthRecord/PatientImmunizationRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's immunization

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Patient Medication Save

The method that saves the details regarding the patient's medication

API Endpoint

POST //api/PersonalHealthRecord/PatientMedicationSave

POST //api/PersonalHealthRecord/PatientMedicationSave HTTP/1.1
Content-Type: application/json

{
    "medicationId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "name": "string",
    "isPrescription": "boolean",
    "dosageQuantity": "number",
    "dosageUnit": "string",
    "frequencyQuantity": "number",
    "frequencyUnit": "string",
    "isChronic": "boolean",
    "reason": "string",
    "prescribedBy": {
        "firstName": "string",
        "surname": "string",
        "credentials": "string",
        "practiceName": "string"
    },
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
medicationId	string	uuid	Unique identifier that links to a patient's medication
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the medication
endDate	string	date-time	End date of the medication
name	string		The name of the medication
isPrescription	boolean		Boolean that states if the medication is a prescription
dosageQuantity	number	double
dosageUnitId	string	uuid	Unique identifier that links to a specific dosage unit
frequencyQuantity	number	double
frequencyUnitId	string	uuid	Unique identifier that links to a specific frequency unit
isChronic	boolean		Boolean that states if the medication is chronic
reason	string		why the patient is taking the medication
prescribedBy	CareproviderDetailsModel

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "medicationId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "name": "string",
    "isPrescription": "boolean",
    "dosageQuantity": "number",
    "dosageUnit": "string",
    "frequencyQuantity": "number",
    "frequencyUnit": "string",
    "isChronic": "boolean",
    "reason": "string",
    "prescribedBy": {
        "firstName": "string",
        "surname": "string",
        "credentials": "string",
        "practiceName": "string"
    }
}

Fields

Name	Type	Format	Description
medicationId	string	uuid	Unique identifier that links to a patient's medication
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the medication
endDate	string	date-time	End date of the medication
name	string		The name of the medication
isPrescription	boolean		Boolean that states if the medication is a prescription
dosageQuantity	number	double
dosageUnitId	string	uuid	Unique identifier that links to a specific dosage unit
frequencyQuantity	number	double
frequencyUnitId	string	uuid	Unique identifier that links to a specific frequency unit
isChronic	boolean		Boolean that states if the medication is chronic
reason	string		why the patient is taking the medication
prescribedBy	CareproviderDetailsModel

Patient Medication List

The method that retrieve a list regarding the patient's medication

API Endpoint

POST //api/PersonalHealthRecord/PatientMedicationList

POST //api/PersonalHealthRecord/PatientMedicationList HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the Patient's profile

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

[
   {
    "medicationId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "name": "string",
    "isPrescription": "boolean",
    "dosageQuantity": "number",
    "dosageUnit": "string",
    "frequencyQuantity": "number",
    "frequencyUnit": "string",
    "isChronic": "boolean",
    "reason": "string",
    "prescribedBy": {
        "firstName": "string",
        "surname": "string",
        "credentials": "string",
        "practiceName": "string"
     }
    }
]

Fields

Name	Type	Format	Description
medicationId	string	uuid	Unique identifier that links to a patient's medication
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the medication
endDate	string	date-time	End date of the medication
name	string		The name of the medication
isPrescription	boolean		Boolean that states if the medication is a prescription
dosageQuantity	number	double
dosageUnitId	string	uuid	Unique identifier that links to a specific dosage unit
frequencyQuantity	number	double
frequencyUnitId	string	uuid	Unique identifier that links to a specific frequency unit
isChronic	boolean		Boolean that states if the medication is chronic
reason	string		why the patient is taking the medication
prescribedBy	CareproviderDetailsModel

Patient Medication Get

The method that retrieve the details regarding the patient's medication

API Endpoint

POST //api/PersonalHealthRecord/PatientMedicationGet

POST //api/PersonalHealthRecord/PatientMedicationGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "medicationId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "name": "string",
    "isPrescription": "boolean",
    "dosageQuantity": "number",
    "dosageUnit": "string",
    "frequencyQuantity": "number",
    "frequencyUnit": "string",
    "isChronic": "boolean",
    "reason": "string",
    "prescribedBy": {
        "firstName": "string",
        "surname": "string",
        "credentials": "string",
        "practiceName": "string"
    }
}

Fields

Name	Type	Format	Description
medicationId	string	uuid	Unique identifier that links to a patient's medication
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the medication
endDate	string	date-time	End date of the medication
name	string		The name of the medication
isPrescription	boolean		Boolean that states if the medication is a prescription
dosageQuantity	number	double
dosageUnitId	string	uuid	Unique identifier that links to a specific dosage unit
frequencyQuantity	number	double
frequencyUnitId	string	uuid	Unique identifier that links to a specific frequency unit
isChronic	boolean		Boolean that states if the medication is chronic
reason	string		why the patient is taking the medication
prescribedBy	CareproviderDetailsModel

Patient Medication Remove

The method that allows the patient to remove a medication record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientMedicationRemove

POST //api/PersonalHealthRecord/PatientMedicationRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's Medication

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Patient Procedure Save

This method creates a new procedure or updates an existing one if a procedureId is specified

API Endpoint

POST //api/PersonalHealthRecord/PatientProviderProcedureSave

POST //api/PersonalHealthRecord/PatientProviderProcedureSave HTTP/1.1
Content-Type: application/json

{
    "procedureId": "string",
    "patientId": "string",
    "procedureName": "string",
    "startDate": "string",
    "endDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
procedureId	string	uuid	Unique identifier that links to a provider procedure
patientId	string	uuid	Unique identifier that links to a patient's profile
procedureName	string		Name of the procedure that has been done
startDate	string	date-time	Starting date and time of the procedure
endDate	string	date-time	End date and time of the procedure

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "procedureId": "string",
    "patientId": "string",
    "procedureName": "string",
    "startDate": "string",
    "endDate": "string"
}

Fields

Name	Type	Format	Description
procedureId	string	uuid	Unique identifier that links to a provider procedure
patientId	string	uuid	Unique identifier that links to a patient's profile
procedureName	string		that has been
startDate	string	date-time	Starting date and time of the procedure
endDate	string	date-time	End date and time of the procedure

Patient Procedure List

The method that retrieve a list regarding the patient's procedure

API Endpoint

POST //api/PersonalHealthRecord/PatientProcedureList

POST //api/PersonalHealthRecord/PatientProceduresList HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the patient

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "procedureId": "string",
        "patientId": "string",
        "procedureName": "string",
        "startDate": "string",
        "endDate": "string",
    }
]

Fields

Name	Type	Format	Description
procedureId	string	uuid	Unique identifier that links to a provider procedure
patientId	string	uuid	Unique identifier that links to a patient's profile
procedureName	string		that has been
startDate	string	date-time	Starting date and time of the procedure
endDate	string	date-time	End date and time of the procedure

Patient Procedure Get

The method that retrieve the details regarding the patient's procedure

API Endpoint

POST //api/PersonalHealthRecord/PatientProcedureGet

POST //api/PersonalHealthRecord/PatientProceduresGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
phrId	string	uuid	Unique identifier of the procedure

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "procedureId": "string",
    "patientId": "string",
    "procedureName": "string",
    "startDate": "string",
    "endDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
procedureId	string	uuid	Unique identifier that links to a provider procedure
patientId	string	uuid	Unique identifier that links to a patient's profile
procedureName	string		that has been
startDate	string	date-time	Starting date and time of the procedure
endDate	string	date-time	End date and time of the procedure

Patient Procedure Remove

The method that allows the patient to remove a procedure record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientProcedureRemove

POST //api/PersonalHealthRecord/PatientProcedureRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the procedure

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Patient Diagnosis Save

This method creates a new diagnosis record or updates an existing one if a diagnosisId is specified

API Endpoint

POST //api/PersonalHealthRecord/PatientDiagnosisSave

POST //api/PersonalHealthRecord/PatientDiagnosisSave HTTP/1.1
Content-Type: application/json

{
    "diagnosisId": "string",
    "patientId": "string",
    "description": "string",
    "dateOfDiagnosis": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
diagnosisId	string	uuid	Unique identifier that links to a diagnosis
patientId	string	uuid	Unique identifier that links to a patient's profile
description	string		Additional information of the diagnosis
dateOfDiagnosis	string	date-time	Date and time of the diagnosis

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "diagnosisId": "string",
    "patientId": "string",
    "description": "string",
    "dateOfDiagnosis": "string",
}

Fields

Name	Type	Format	Description
diagnosisId	string	uuid	Unique identifier that links to a diagnosis
patientId	string	uuid	Unique identifier that links to a patient's profile
description	string		Additional information of the diagnosis
dateOfDiagnosis	string	date-time	Date and time of the diagnosis

Patient Diagnosis List

This method retrieves a list of the patient's diagnosis

API Endpoint

POST //api/PersonalHealthRecord/PatientDiagnosisList

POST //api/PersonalHealthRecord/PatientDiagnosisList HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the patient

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "diagnosisId": "string",
        "patientId": "string",
        "description": "string",
        "dateOfDiagnosis": "string",
    }
]

Fields

Name	Type	Format	Description
diagnosisId	string	uuid	Unique identifier that links to a diagnosis
patientId	string	uuid	Unique identifier that links to a patient's profile
description	string		Additional information of the diagnosis
dateOfDiagnosis	string	date-time	Date and time of the diagnosis

Patient Diagnosis Get

This method retrieves the details of the patient's diagnosis

API Endpoint

POST //api/PersonalHealthRecord/PatientDiagnosisGet

POST //api/PersonalHealthRecord/PatientDiagnosisGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "diagnosisId": "string",
    "patientId": "string",
    "description": "string",
    "dateOfDiagnosis": "string",
}

Fields

Name	Type	Format	Description
diagnosisId	string	uuid	Unique identifier that links to a diagnosis
patientId	string	uuid	Unique identifier that links to a patient's profile
description	string		Additional information of the diagnosis
dateOfDiagnosis	string	date-time	Date and time of the diagnosis

Patient Diagnosis Remove

The method that allows the patient to remove a diagnosis record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientDiagnosisRemove

POST //api/PersonalHealthRecord/PatientDiagnosisRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's diagnosis

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Patient Contact Save

This method creates a new contact record or updates an existing one if a contactId is specified

API Endpoint

POST //api/PersonalHealthRecord/PatientContactSave

POST //api/PersonalHealthRecord/PatientContactSave HTTP/1.1
Content-Type: application/json

{
    "contactId": "string",
    "patientId": "string",
    "relationship": "string",
    "title": "string",
    "firstName": "string",
    "surname": "string",
    "mobileNumber": "string",
    "genderType": "string",
    "orginisation": "string",
    "physicalAddress": "string",
    "postalAddress": "string",
    "city": "string",
    "suburb": "string",
    "postalCode": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
contactId	string	uuid	Unique identifier that link to a patient contact
patientId	string	uuid	Unique identifier that links to a patient profile
relationship	string	uuid	Unique identifier that links to a relationship
title	string		Title of the patient's contact
firstName *	string		First name of the patient's contact
surname *	string		Surname of the patient's contact
mobileNumber *	string		Mobile contact number of the patient's contact
genderType	string	[Male, Female]
orginisation	string		Organization of which the patient's contact works for
physicalAddress	string		Physical address of the patient's contact
postalAddress	string		Postal address of the patient's contact
city	string		City in which the patient's contact lives in
suburb	string		Suburb in which the patient's contact lives in
postalCode	string		Postal code of the patient's contact's address

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "contactId": "string",
    "patientId": "string",
    "relationship": "string",
    "title": "string",
    "firstName": "string",
    "surname": "string",
    "mobileNumber": "string",
    "genderType": "string",
    "orginisation": "string",
    "physicalAddress": "string",
    "postalAddress": "string",
    "city": "string",
    "suburb": "string",
    "postalCode": "string"
}

Fields

Name	Type	Format	Description
contactId	string	uuid	Unique identifier that link to a patient contact
patientId	string	uuid	Unique identifier that links to a patient profile
relationship	string	uuid	Unique identifier that links to a relationship
title	string		Title of the patient's contact
firstName *	string		First name of the patient's contact
surname *	string		Surname of the patient's contact
mobileNumber *	string		Mobile contact number of the patient's contact
genderType	string	[Male, Female]
orginisation	string		Organization of which the patient's contact works for
physicalAddress	string		Physical address of the patient's contact
postalAddress	string		Postal address of the patient's contact
city	string		City in which the patient's contact lives in
suburb	string		Suburb in which the patient's contact lives in
postalCode	string		Postal code of the patient's contact's address

Patient Contact List

This method allows the patient to retrieve their entire contact collection

API Endpoint

POST //api/PersonalHealthRecord/PatientContactList

POST //api/PersonalHealthRecord/PatientContactList HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "contactId": "string",
        "patientId": "string",
        "relationship": "string",
        "title": "string",
        "firstName": "string",
        "surname": "string",
        "mobileNumber": "string",
        "genderType": "string",
        "orginisation": "string",
        "physicalAddress": "string",
        "postalAddress": "string",
        "city": "string",
        "suburb": "string",
        "postalCode": "string"
    }
]

Fields

Name	Type	Format	Description
contactId	string	uuid	Unique identifier that link to a patient contact
patientId	string	uuid	Unique identifier that links to a patient profile
relationship	string	uuid	Unique identifier that links to a relationship
title	string		Title of the patient's contact
firstName *	string		First name of the patient's contact
surname *	string		Surname of the patient's contact
mobileNumber *	string		Mobile contact number of the patient's contact
genderType	string	[Male, Female]
orginisation	string		Organization of which the patient's contact works for
physicalAddress	string		Physical address of the patient's contact
postalAddress	string		Postal address of the patient's contact
city	string		City in which the patient's contact lives in
suburb	string		Suburb in which the patient's contact lives in
postalCode	string		Postal code of the patient's contact's address

Patient Contact Get

This method retrieves the Contact details

API Endpoint

POST //api/PersonalHealthRecord/PatientContactGet

POST //api/PersonalHealthRecord/PatientContactGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "contactId": "string",
    "patientId": "string",
    "relationship": "string",
    "title": "string",
    "firstName": "string",
    "surname": "string",
    "mobileNumber": "string",
    "genderType": "string",
    "orginisation": "string",
    "physicalAddress": "string",
    "postalAddress": "string",
    "city": "string",
    "suburb": "string",
    "postalCode": "string"
}

Fields

Name	Type	Format	Description
contactId	string	uuid	Unique identifier that link to a patient contact
patientId	string	uuid	Unique identifier that links to a patient profile
relationship	string	uuid	Unique identifier that links to a relationship
title	string		Title of the patient's contact
firstName *	string		First name of the patient's contact
surname *	string		Surname of the patient's contact
mobileNumber *	string		Mobile contact number of the patient's contact
genderType	string	[Male, Female]
orginisation	string		Organization of which the patient's contact works for
physicalAddress	string		Physical address of the patient's contact
postalAddress	string		Postal address of the patient's contact
city	string		City in which the patient's contact lives in
suburb	string		Suburb in which the patient's contact lives in
postalCode	string		Postal code of the patient's contact's address

Patient Contact Remove

The method that allows the patient to remove a contact record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientContactRemove

POST //api/PersonalHealthRecord/PatientContactRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's contact

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Patient Allergy Save

The method that save the details regarding the patient's allergy

API Endpoint

POST //api/PersonalHealthRecord/PatientAllergySave

POST //api/PersonalHealthRecord/PatientAllergySave HTTP/1.1
Content-Type: application/json

{
    "allergyId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "description": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
allergyId	string	uuid	Unique identifier that links to a patient's allergy
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the allergy
endDate	string	date-time	End date of the allergy
description	string		Additional information of the allergy

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "allergyId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "description": "string"
}

Fields

Name	Type	Format	Description
allergyId	string	uuid	Unique identifier that links to a patient's allergy
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the allergy
endDate	string	date-time	End date of the allergy
description	string		Additional information of the allergy

Patient Allergy List

This method allows the patient to retrieve their entire allergy collection

API Endpoint

POST //api/PersonalHealthRecord/PatientAllergyList

POST //api/PersonalHealthRecord/PatientAllergyList HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
phrId	string	uuid	Unique identifier of the patient

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "allergyId": "string",
        "patientId": "string",
        "startDate": "string",
        "endDate": "string",
        "description": "string"
    }
]

Fields

Name	Type	Format	Description
allergyId	string	uuid	Unique identifier that links to a patient's allergy
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the allergy
endDate	string	date-time	End date of the allergy
description	string		Additional information of the allergy

Patient Allergy Get

The method that retrieve the details regarding the patient's allergy

API Endpoint

POST //api/PersonalHealthRecord/PatientAllergyGet

POST //api/PersonalHealthRecord/PatientAllergyGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the patient's allergy

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "allergyId": "string",
    "patientId": "string",
    "startDate": "string",
    "endDate": "string",
    "description": "string"
}

Fields

Name	Type	Format	Description
allergyId	string	uuid	Unique identifier that links to a patient's allergy
patientId	string	uuid	Unique identifier that links to a patient's profile
startDate	string	date-time	Starting date of the allergy
endDate	string	date-time	End date of the allergy
description	string		Additional information of the allergy

Patient Allergy Remove

The method that allows the patient to remove a allergy record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientAllergyRemove

POST //api/PersonalHealthRecord/PatientAllergyRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's allergy

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Patient Problem Save

This method creates a new patient problem record or updates an existing one if a problemId is specified

API Endpoint

POST //api/PersonalHealthRecord/PatientProblemSave

POST //api/PersonalHealthRecord/PatientProblemSave HTTP/1.1
Content-Type: application/json

{
    "problemId": "string",
    "patientId": "string",
    "dateStarted": "string",
    "description": "string",
    "ageAtOnset": "integer",
    "isCauseOfDeath": "boolean",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
problemId	string	uuid	Unique identifier that links to a problem
patientId	string	uuid	Unique identifier that links to a patient's profile
dateStarted	string	date-time	Date when the problem started
ageAtOnset	integer	int32	Person's age at the time when the problem started
isCauseOfDeath	boolean		Boolean value that states if the problem is the cause of death
description	string		Additional information that describes the problem

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "problemId": "string",
    "patientId": "string",
    "dateStarted": "string",
    "ageAtOnset": "integer",
    "isCauseOfDeath": "boolean",
    "description": "string",
}

Fields

Name	Type	Format	Description
problemId	string	uuid	Unique identifier that links to a problem
patientId	string	uuid	Unique identifier that links to a patient's profile
dateStarted	string	date-time	Date when the problem started
ageAtOnset	integer	int32	Person's age at the time when the problem started
isCauseOfDeath	boolean		Boolean value that states if the problem is the cause of death
description	string		Additional information that describes the problem

Patient Problem List

This method allows the patient to retrieve all their associated problems

API Endpoint

POST //api/PersonalHealthRecord/PatientProblemList

POST //api/PersonalHealthRecord/PatientProblemList HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the patient

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "problemId": "string",
        "patientId": "string",
        "dateStarted": "string",
        "ageAtOnset": "integer",
        "isCauseOfDeath": "boolean",
        "description": "string"
    }
]

Fields

Name	Type	Format	Description
problemId	string	uuid	Unique identifier that links to a problem
patientId	string	uuid	Unique identifier that links to a patient's profile
dateStarted	string	date-time	Date when the problem started
ageAtOnset	integer	int32	Person's age at the time when the problem started
isCauseOfDeath	boolean		Boolean value that states if the problem is the cause of death
description	string		Additional information that describes the problem

Patient Problem Get

Retrieves the info of a specific problem

API Endpoint

POST //api/PersonalHealthRecord/PatientProblemGet

POST //api/PersonalHealthRecord/PatientProblemGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the patient's problem record

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "problemId": "string",
    "patientId": "string",
    "dateStarted": "string",
    "ageAtOnset": "integer",
    "isCauseOfDeath": "boolean",
    "description": "string"
}

Patient Problem Remove

The method that allows the patient to remove a problem record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientProblemRemove

POST //api/PersonalHealthRecord/PatientProblemRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier that links to a patient's problem

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Patient Family History Save

This method creates a new family history record or updates an existing one if a familyHistoryId is specified

API Endpoint

POST //api/PersonalHealthRecord/PatientFamilyHistorySave

POST //api/PersonalHealthRecord/PatientFamilyHistorySave HTTP/1.1
Content-Type: application/json

{
    "familyHistoryId": "string",
    "patientId": "string",
    "relationshipId": "string",
    "firstName": "string",
    "surname": "string",
    "isDeceased": "boolean",
    "dateOfBirth": "string",
    "genderType": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
familyHistoryId	string	uuid	Unique Identifier that links to FamilyHistory
patientId	string	uuid	Unique identifier that links to a patient's profile
relationshipId	string	uuid	Unique identifier that links to a relationship
firstName *	string		First name of the patient's family member
surname *	string		Surname of the patient's family member
isDeceased	boolean		Boolean value that indicates if the family member is deceased or not
dateOfBirth	string	date-time	Date of birth of the family member
genderType	string	[Male, Female]

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "familyHistoryId": "string",
    "patientId": "string",
    "relationshipId": "string",
    "firstName": "string",
    "surname": "string",
    "isDeceased": "boolean",
    "dateOfBirth": "string",
    "genderType": "string"
}

Fields

Name	Type	Format	Description
familyHistoryId	string	uuid	Unique Identifier that links to FamilyHistory
patientId	string	uuid	Unique identifier that links to a patient's profile
relationshipId	string	uuid	Unique identifier that links to a relationship
firstName *	string		First name of the patient's family member
surname *	string		Surname of the patient's family member
isDeceased	boolean		Boolean value that indicates if the family member is deceased or not
dateOfBirth	string	date-time	Date of birth of the family member
genderType	string	[Male, Female]

Patient Family History List

This method allows the patient to retrieve all their associated family history records

API Endpoint

POST //api/PersonalHealthRecord/PatientFamilyHistoryList

POST //api/PersonalHealthRecord/PatientFamilyHistoryList HTTP/1.1
Content-Type: application/json

{
        "id": "string",
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the patient

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "familyHistoryId": "string",
        "patientId": "string",
        "relationshipId": "string",
        "firstName": "string",
        "surname": "string",
        "isDeceased": "boolean",
        "dateOfBirth": "string",
        "genderType": "string"
    }
]

Fields

Name	Type	Format	Description
familyHistoryId	string	uuid	Unique Identifier that links to FamilyHistory
patientId	string	uuid	Unique identifier that links to a patient's profile
relationshipId	string	uuid	Unique identifier that links to a relationship
firstName *	string		First name of the patient's family member
surname *	string		Surname of the patient's family member
isDeceased	boolean		Boolean value that indicates if the family member is deceased or not
dateOfBirth	string	date-time	Date of birth of the family member
genderType	string	[Male, Female]

Patient Family History Get

Retrieves the details of the specified family history record

API Endpoint

POST //api/PersonalHealthRecord/PatientFamilyHistoryGet

POST //api/PersonalHealthRecord/PatientFamilyHistoryGet HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the family history record

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "familyHistoryId": "string",
    "patientId": "string",
    "relationshipId": "string",
    "firstName": "string",
    "surname": "string",
    "isDeceased": "boolean",
    "dateOfBirth": "string",
    "genderType": "string"
}

Fields

Name	Type	Format	Description
familyHistoryId	string	uuid	Unique Identifier that links to FamilyHistory
patientId	string	uuid	Unique identifier that links to a patient's profile
relationshipId	string	uuid	Unique identifier that links to a relationship
firstName *	string		First name of the patient's family member
surname *	string		Surname of the patient's family member
isDeceased	boolean		Boolean value that indicates if the family member is deceased or not
dateOfBirth	string	date-time	Date of birth of the family member
genderType	string	[Male, Female]

Patient Family History Remove

The method that allows the patient to remove a family history record from their profiles.

API Endpoint

POST //api/PersonalHealthRecord/PatientFamilyHistoryRemove

POST //api/PersonalHealthRecord/PatientFamilyHistoryRemove HTTP/1.1
Content-Type: application/json

{
    "id": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Unique identifier of the family history record

API Response field definitions:

HTTP/1.1 200 OK
Content-Type: application/json

"boolean"

Responses

Http code	Type	Description
200	boolean	true when successful

Activity Profile

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.

Register Activity Profile

Will create a new profile and link the scheme code(s) (Category codes) to the profile.

API Endpoint

POST //api/ActivityProfile/RegisterNewProfile

POST //api/ActivityProfile/RegisterNewProfile HTTP/1.1
Content-Type: application/json

{
        "clientProfileCode": "string",
        "schemeMemberCodes": [
            "string"
        ],
        "apiKey": "string",
        "correlationId": "string",
        "passphrase": "string"
}

Fields

Name	Type	Format	Description
clientProfileCode *	string		The unique Id of the user from the client system
schemeMemberCodes	array[string]
apiKey	string	uuid
correlationId	string
passphrase	string

Fields

Name	Type	Format	Description
apiKey *	string	uuid	This will be the returned value from the Request API Key that was received.
correlationId	string		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
passphrase	string		A HASH using HMACSHA256 of your API Key. The Secret used in this HASH must be the concatenation of your CorrelationId and your secret. Convert this HASH value to a base64 string and pass it to the server as your passphrase.
clientProfileCode	string		The unique Id of the user from the client system

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profileId": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	The Unique Id generated by HealthCloud

Update Schemes

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.

API Endpoint

POST //api/ActivityProfile/UpdateSchemes HTTP/1.1

POST //api/ActivityProfile/UpdateSchemes HTTP/1.1
Content-Type: application/json

{
    "clientProfileCode": "string",
    "schemeMemberCodes": [
        "string"
    ],
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
clientProfileCode *	string		The unique Id of the user from the client system
schemeMemberCodes	array[string]
apiKey	string	uuid
correlationId	string
passphrase	string

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profileId": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	The Unique Id generated by HealthCloud

Update Client Profile

Will update the client profile code and merge the old and new profile data if the new profile code is already on the system.

API Endpoint

POST //api/ActivityProfile/UpdateClientProfile HTTP/1.1

POST //api/ActivityProfile/UpdateClientProfile HTTP/1.1
Content-Type: application/json

{
    "clientProfileCode": "string",
    "newClientProfileCode": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format	Description
clientProfileCode *	string		The current unique Id of the profile from the client system.
newClientProfileCode *	string		The new unique Id of the profile.
apiKey	string	uuid
correlationId	string
passphrase	string

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profileId": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid	The Unique Id generated by HealthCloud

Deregistrer Scheme

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.

API Endpoint

POST //api/ActivityProfile/DeregisterScheme HTTP/1.1

POST //api/ActivityProfile/DeregisterScheme HTTP/1.1
Content-Type: application/json

{
    "clientProfileCode": "string",
    "schemeMemberCodes": [
        "string"
    ],
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

Name	Type	Format
clientProfileCode *	string
newClientProfileCode *	string
apiKey	string	uuid
correlationId	string
passphrase	string

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "success": "boolean"
}

Fields

Name	Type	Format	Description
success	boolean

Profile Id Lookup

Returns the HealthCloud Profile ID for a client profile code.

API Endpoint

POST //api/ActivityProfile/ProfileIdLookup HTTP/1.1

POST //api/ActivityProfile/ProfileIdLookup HTTP/1.1
Content-Type: application/json

{

    "clientProfileCode": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format
clientProfileCode *	string
apiKey	string	uuid
correlationId	string
passphrase	string

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profileId": "string"
}

Fields

Name	Type	Format	Description
profileId	string	uuid

Daily Summary

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.

API Endpoint

POST //api/ActivityProfile/DailySummaryGet HTTP/1.1

POST //api/ActivityProfile/DailySummaryGet HTTP/1.1
Content-Type: application/json

{

    "clientProfileCode": "string",
    "fromDate": "string",
    "toDate": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format
clientProfileCode *	string
fromDate	string	date-time
toDate	string	date-time
apiKey	string	uuid
correlationId	string
passphrase	string

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "profileId": "string",
    "clientProfileCode": "string",
    "schemeMemberCodes": [
        "string"
    ],
    "activitySummary": [
        {
            "deviceCode": "string",
            "deviceName": "string",
            "deviceProvider": "string",
            "activityDate": "string",
            "created": "string",
            "updated": "string",
            "sleepInMinutes": "number",
            "heartRate": "number",
            "heartRateUnit": "string",
            "calories": "number",
            "steps": "integer",
            "distanceInMeters": "number"
        }
    ]
}

Fields

Name	Type	Format
profileId	string	uuid
clientProfileCode	string
schemeMemberCodes	array[string]
activitySummary	array[DeviceActivitySummaryModel]

Request Device Link URL

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.

API Endpoint

POST //api/ActivityProfile/RequestDeviceLinkURL HTTP/1.1

POST //api/ActivityProfile/RequestDeviceLinkURL HTTP/1.1
Content-Type: application/json

{

    "clientProfileCode": "string",
    "callerPageName": "string",
    "returnUrl": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"

}

Fields

Name	Type	Format
clientProfileCode *	string
callerPageName *	string
returnUrl *	string
apiKey	string	uuid
correlationId	string
passphrase	string

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "redirectURL": "string"
}

Fields

Name	Type	Format	Description
redirectURL	string

Inactive Devices

Returns the list of devices that are not active anymore e.g. Disabled or in an Error state.

API Endpoint

POST //api/HCCActivity/InactiveDevicesGet HTTP/1.1

POST //api/HCCActivity/InactiveDevicesGet HTTP/1.1
Content-Type: application/json

{
    "profileId": "string",
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "providerType": "string",
        "status": "string",
        "errorMessage": "string",
        "lastSynced": "string",
        "providerName": "string"
    }
]

Fields

Name	Type	Format	Description
profileId	string	uuid	The Unique Id generated by HealthCloud

Push Notifications

A push notification can be configured by HealthCloud to send new data to a preconfigured callback URL. HealthCloud will do a POST to the URL with a provided AuthHeader and Key.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data":
    [
        {
            "profileId": "string",
            "clientProfileCode": "string",
            "schemeMemberCodes": [
            "string"
            ],
            "activitySummary": [
                {
                    "deviceCode": "string",
                    "deviceName": "string",
                    "deviceProvider": "string",
                    "activityDate": "2018-04-25T02:06:42.691Z",
                    "created": "2018-04-25T02:06:42.691Z",
                    "updated": "2018-04-25T02:06:42.691Z",
                    "sleepInMinutes": 0,
                    "heartRate": 0,
                    "heartRateUnit": "string",
                    "calories": 0,
                    "steps": 0,
                    "distanceInMeters": 0
                }
            ]
        }
    ]
}

PHR Custom API

Patient Wellness Record Save

This method is intended for Wellness events.

API Endpoint

POST //api/Custom/PatientWellnessRecordSave

POST //api/Custom/PatientWellnessRecordSave HTTP/1.1
Content-Type: application/json

{
    "eventData": {
        "eventId": "string",
        "eventDate": "string",
        "eventName": "string"
    },
    "patientWellnessRecords": [
        {
            "patientId": "string",
            "companyName": "string",
            "branch": "string",
            "division": "string",
            "employment": "string",
            "firstname": "string",
            "surname": "string",
            "title": "string",
            "idNumber": "string",
            "passportNumber": "string",
            "gender": "string",
            "dateOfBirth": "string",
            "race": "string",
            "cellNumber": "string",
            "workNumber": "string",
            "emergencyContactNumber": "string",
            "medicalAid": "string",
            "medicalAidNumber": "string",
            "isMainMember": "boolean",
            "familyHistory": "string",
            "medication": "string",
            "tabacoUsage": {
                "id": "string",
                "startDate": "string",
                "endDate": "string",
                "frequency": "integer",
                "period": "string",
                "notes": "string"
            },
            "biometric": {
                "biometricTimeStamp": "string",
                "heightInCentimeters": "number",
                "weightInKilograms": "number",
                "waistCircumferenceInCentimeters": "number",
                "hipCircumferenceInCentimeters": "number",
                "systolicBloodPressureInMmHg": "number",
                "diastolicBloodPressureInMmHg": "number",
                "glucoseInMmolL": "number",
                "totalCholesterolMmolL": "number",
                "temperatureInCelsius": "number",
                "hdlMmolL": "number",
                "ldlMmolL": "number",
                "triglycerideMmolL": "number"
            },
            "excersices": [
                {
                    "id": "string",
                    "timestamp": "string",
                    "description": "string"
                }
            ],
            "testResults": [
                {
                    "id": "string",
                    "timestamp": "string",
                    "name": "string",
                    "description": "string",
                    "batchNumber": "string",
                    "testNumber": "string",
                    "result": "string",
                    "location": {
                        "address": "string",
                        "facilityName": "string"
                    },
                    "careproviderDetails": {
                        "firstName": "string",
                        "surname": "string",
                        "credentials": "string",
                        "practiceName": "string"
                    }
                }
            ]
        }
    ],
    "apiKey": "string",
    "correlationId": "string",
    "passphrase": "string"
}

Fields

eventData

Contains the relevent info for the current wellness event

Name	Type	Format	Description
eventId	string		The unique event code
eventDate	string	date-time	Date of the current event
eventName	string		name of the current event

patientWellnessRecords

Name	Type	Format	Description
patientId	string	uuid	The UniqueIdentifier from HealthCloud of the patient
companyName	string		Company the patient works for
branch	string		The company branch
division	string		Division within the company
employment	string		Allowed values: Permanent, Contractor, Temporary
firstname	string		The patient's full name
surname	string		The patient's surname
title	string		The patient's title
idNumber	string		The patient's South African Id number
passportNumber	string		The patient's passport number
gender	string		Allowed values: Male, Female
dateOfBirth	string	date-time	The patient's date of birth
race	string		Allowed values: African, Coloured, Indian, White, Other
cellNumber	string		The patient's mobile number
workNumber	string		The patient's work number
emergencyContactNumber	string		The patient's emergancy contact
medicalAid	string		medical aid the patient belongs to
medicalAidNumber	string		The patient's medicalaid number
isMainMember	boolean		Is the patient the main member of the medical aid
familyHistory	string		Does the patient have any family medical problems
medication	string		Is the patient currently taking any medication
tabacoUsage	FrequancyItem
biometric	BiometricModel
excersices	array[TimestampItem]
testResults	array[ResultItem]

Models

FrequancyItem

{
    "id": "string",
    "startDate": "string",
    "endDate": "string",
    "frequency": "integer",
    "period": "string",
    "notes": "string"
}

Fields

Name	Type	Format	Description
id (optional)	string	uuid	Id of the item to update
startDate	string	date-time	Date the patient started using the substance
endDate	string	date-time	Date the patient stoped using the substance
frequency	integer	int32	The quantity in a period
period	string		The measuremnt ex: per day, per week etc
notes	string		Any additional info

BiometricModel

{
    "biometricTimeStamp": "string",
    "heightInCentimeters": "number",
    "weightInKilograms": "number",
    "waistCircumferenceInCentimeters": "number",
    "hipCircumferenceInCentimeters": "number",
    "systolicBloodPressureInMmHg": "number",
    "diastolicBloodPressureInMmHg": "number",
    "glucoseInMmolL": "number",
    "totalCholesterolMmolL": "number",
    "temperatureInCelsius": "number",
    "hdlMmolL": "number",
    "ldlMmolL": "number",
    "triglycerideMmolL": "number"
}

Fields

Name	Type	Format	Description
biometricTimeStamp	string	date-time	Date and time the measurement took place
heightInCentimeters	number	double	The Patient's height in cm
weightInKilograms	number	double	The Patient's weight in kg
waistCircumferenceInCentimeters	number	double	The Patient's waist circumference height in cm
hipCircumferenceInCentimeters	number	double	The Patient's hip Circumference in cm
systolicBloodPressureInMmHg	number	double	The Patient's systolic Blood Pressure in MmHg
diastolicBloodPressureInMmHg	number	double	The Patient's diastolic Blood Pressure inMmHg
glucoseInMmolL	number	double	The Patient's glucose glucose in MmolL
totalCholesterolMmolL	number	double	The Patient's total Cholesterol in MmolL
temperatureInCelsius	number	double	The Patient's temperature in Celsius
hdlMmolL	number	double	The Patient's hdl levels in MmolL
ldlMmolL	number	double	The Patient's ldl levels in MmolL
triglycerideMmolL	number	double	The Patient's triglyceride levels in MmolL

TimestampItem

{
    "id": "string",
    "timestamp": "string",
    "description": "string"
}

Fields

Name	Type	Format	Description
id	string	uuid	Id of the item to update
timestamp	string	date-time	Date the patient started the activity
description	string		the name of the activity

ResultItem

{
    "id": "string",
    "timestamp": "string",
    "name": "string",
    "description": "string",
    "batchNumber": "string",
    "testNumber": "string",
    "result": "string",
    "location": {
        "address": "string",
        "facilityName": "string"
    },
    "careproviderDetails": {
        "firstName": "string",
        "surname": "string",
        "credentials": "string",
        "practiceName": "string"
    }
}

Fields

Name	Type	Format	Description
id	string	uuid	Id of the result to update
timestamp	string	date-time	Date and time the result was received
name	string		The medical name of the result
description	string		a short description on the result
batchNumber	string		unique batch number if there is one
testNumber	string		unique batch number if there is one
result	string	Acceptable values: Positive, Negative, Inconclusive	The conclusion of the result
location	LocationModel
careproviderDetails	CareproviderDetailsModel

LocationModel

{
    "address": "string",
    "facilityName": "string"
}

Fields

Name	Type	Description
address	string	The physical address
facilityName	string	The Name of the facility

CareproviderDetailsModel

{
    "firstName": "string",
    "surname": "string",
    "credentials": "string",
    "practiceName": "string"
}

Fields

Name	Type	Description
firstName	string	The Careporvider's full name
surname	string	The Careporvider's surname
credentials	string	The Careporvider's Credentials
practiceName	string	The Careporvider's practice name

Introduction

Apply for access

Implementation

Patient

Patient Register

API Endpoint

Fields

Fields

Patient Profile Get

API Endpoint

Fields

Fields

Patient Profile Update

API Endpoint

Fields

Fields

Patient Booking Search

API Endpoint

Fields

Fields

Patient Booking Create

API Endpoint

Fields

Patient Booking Cancel

API Endpoint

Fields

Healthcare Provider

Healthcare Provider Registration

API Endpoint

Fields

Fields

Healthcare Provider Profile Update

API Endpoint

Fields

Fields

Healthcare Provider Profile Get

API Endpoint

Fields

Fields

Healthcare Provider Available Timeslots

API Endpoint

Fields

Fields

Security

Request API Key

API Endpoint

Fields

Fields

Login Patient

API Endpoint

Fields

Fields

Login Health Healthcare Provider

API Endpoint

Fields

Fields

Retrieve Profile Id From Token

API Endpoint

Fields

Fields

Request Patient One Time Pin

How the flow works

API Endpoint

Fields

Responses

Recover Patient Password

API Endpoint

Fields

Fields

Recover HealthHealthcare Provider Password

API Endpoint

Fields

Fields

Change Patient Password

API Endpoint

Fields

Fields

Change Healthcare Provider Password

API Endpoint

Fields