Login API

{BaseURL}/sandbox/AccessToken/
Method Description
Post
 Required for Login and Patient registration.

Request body

Response

Patient Registration

{BaseURL}/sandbox/Patient/
Method Description
Post
 Required to create a new Patient
Get
 Required to get Demographics and other administrative information about an individual receiving care or other health-related service

Mandatory parameters

Field FieldDescription Example Comments
root,resourceType resourceType Patient This value is constant
root.name.given First name Middle name also can add in addition with First name
root.telecom.system.phone Mobile Number Patient mobile Number
root.gender Patient gender male Refer the master table values
root.birthDate Date of Birth 01-12-1975 Patient DOB
root.address.use.home Permanent address Address of the patient
root.managingOrganization Managing organization ABC Hospital Partner Hospital Name

Conditional parameters

Field FieldDescription Example Comments
root.identifier.system.Karkinos Karkinos Patient ID KHID00001234678 Karkinos patient ID
root.maritalstatus Marital Status M Patient marital status - refer the marital status table for codes and respective display value
root.identifier.system hospital_name Hospital ID MRN00001 Hospital patient ID
root.identifier.system.https://uidai.gov.in Aadhaar ID This array is only required if Aadhaar number present
root.identifier.system.Employee number Employee ID This array is only required if Employee number present
root.identifier.system.Ration card Ration Card ID This array is only required if Ration Card number present
root.identifier.system.Driver license Driver License ID This array is only required if Driver license number present

Request Body:

Response

Masters

Service Request

{BaseURL}/sandbox/ServiceRequest/
Method Description
Post
 Required to create a service request
Get
 Required to get details of a service request
Put
 Required to update a service request

Mandatory parameters

Field FieldDescription Example Comments
root.resourceType resourceType Bundle This is a constant value
root.id Service Request bundle order unique id Transaction id This is the common transaction id for a bundle request
root.type Service request type collection This is a constant value
root.entry.resource.resourceType resourceType ServiceRequest This is a constant value
root.entry.resource.id Service request order item transaction uniqueid Item transaction id
root.entry.resource.code.coding Service Request Item identifier Refer the service codes table for code values
root.entry.resourceType.subject Patient MR No MRN00001 Patient MRN from Hospital

Conditional Parameters

Field FieldDescription Example Comments
root.entry.resource.identifier Service request order item transaction uniqueid Item transaction id Item transaction id from the requesting application.

Request Body:

Response

Code Display
hosp_order_id Unique id generated in Hospital against the Bundle request

Masters

Masters Mapping format – Hospital services mapping with Karkinos services

Service Code (Example)

Service Item ID Karkinos Service Item Name in Karkinos Service Item ID in Hospital Service Item name in Hospital
KH_SER_001 Complete Blood Count HOSP_SER_001 COMPLETE BLOOD COUNT
KH_SER_002 X-Ray HOSP_SER_002 X-RAY
KH_SER_003 Chemotherapy HOSP_SER_003 CHEMOTHERAPY

Reason Code (Example)

Code Display
SCREENING SCREENING

Diagnostic Report

{BaseURL}/sandbox/DiagnosticReport/
MethodDescription
Post
Required to create a Diagnostic Report

Diagnostic Report key attributes

Mandatory parameters

Field Field Description Example Comments
root.resourceType resourceType Bundle This is a constant value
root.resourceType.id Hospital Order No Hospital order Number generated against the service request
root.resourceType.type collection This is a constant value
Mandatory fields under the resourceType of DiagnosticsReport
root.entry.resource.resourceType Report type  identification DiagnosticReport This is a constant value
root.entry.resource..id Report  identification Report id generated in Hospital HIS
root.entry.resource.status Report status final/amended
root.entry.resource.category.code. coding Test Identification Refer the Services codes master
root.entry.resource.text Service/Test Name Service/Test name from hospital masters
root.entry.resource.subject Patient Hospital MRN MRN00001
root.entry.resource.result Result parameters/observations Observations name
Mandatory fields under the resourceType of Observation
root.entry.resource.resourceType resourceType Observation
root.entry.resource.id Observation id Observations id from result list
root.entry.resource.code.coding Observation identification
root.entry.resource.text Parameter name Parameter name
root.entry.resource.valueQuantity Parameter values
root.entry.resource.valueString Text based report

Conditional parameters

Field Field Name Example Comments
root.entry.resource.identifier Service request order item transaction uniqueid Item transaction id Item transaction id from the requesting application.
root.entry.resource. presentedForm PDF Report This is a Base64data field required when individual PDF reports are available against tests
root.entry.resource.resourceType Binary This is a Base64data field required when consolidated  PDF reports are available against tests in the bundle.

Request Body:

Value in quantity based Result :

Value in string based Result

Response

Attributes Description
Status Response status with code and description

Clinical Summary

{BaseURL}/sandbox/ClinicalSummary/
Method Description
Post
 Required to create Clinical summary documents

Request Body:

Response

Attributes Description
Status Response status with code and description

Discharge Summary

{BaseURL}/sandbox/DischargeSummary/
MethodDescription
Post
Required to create Discharge summary documents

Request Body:

Response

Attributes Description
Status Response status with code and description

Financial Report Format

{BaseURL}/sandbox/financialreport/
Method Description
Get
 Required to create Financial Report documents
Fields Description
Created Timestamp Bill created timestamp
Modified Timestamp Bill modified timestamp
Sl.No Billed Items SL No. in the report
Uhid Hospital UHID
Khid Karkinos UHID
Patient Name Patient Full Name
Bill No Hospital Bill No
Bill Date Hospital Bill Date
Visit ID OP/IP Encounter ID
Visit Date Encounter date
Visit Status OutPatient / InPatient Encounter
Discharge Date Discharge date of IP Encounter
Doctor Name Prescribed / Performed Doctor Name
Dept Name Services department
Service Category Services category
Service Name (Test/service/Item Name)
Gross Amount Item Gross Amount
Refund Refund amount
Net Amount Net Amount after refunds

Risk Assessment

{BaseURL}/v1/QuestionnaireResponse/

 

 

MethodDescription
Post
Required to generate the risk assessment score for a patient

Below is an example of the Request and Response for the Questionnaire response. Please reach out to us to get the entire set questions for Questionnaire Response.

 

Request Body:

Response

Powered by  GDPR Cookie Compliance
Privacy Overview

This website uses cookies so that we can provide you with the best user experience possible. Cookie information is stored in your browser and performs functions such as recognising you when you return to our website and helping our team to understand which sections of the website you find most interesting and useful.