eClaims and Preauth APIs

ePrescriptions

Endpointhttps://ilm-dev.dha.go.ke/uat-middleware

Endpoints for managing prescriptions.

Preview prescription

GET

https://ilm-dev.dha.go.ke/uat-middleware

/api/v1/prescriptions

Fetches a preview of a prescription using a consent token

Preview prescription › query Parameters

consent_token

string · required

Consent token

Preview prescription › Responses

Prescription preview fetched successfully

object

code

string

doctorReviewStatus

string

object[]

guid

string

id

integer

object

replicated

string

status

string

GET/api/v1/prescriptions

curl --request GET \
  --url 'https://ilm-dev.dha.go.ke/uat-middleware/api/v1/prescriptions?consent_token=%3Cstring%3E'

shell

Example Responses

{
  "authorization": {
    "authCode": "authCode",
    "beneficiaryCode": "beneficiaryCode",
    "beneficiaryName": "beneficiaryName",
    "beneficiaryNumber": "beneficiaryNumber",
    "expiry": "expiry",
    "guid": "guid",
    "id": 0,
    "payerName": "payerName",
    "providerName": "providerName",
    "replicated": "replicated",
    "status": "status",
    "token": "token"
  },
  "beneficiary": {
    "age": 0,
    "beneficiaryCode": "beneficiaryCode",
    "contacts": [
      {
        "active": true,
        "contactType": "contactType",
        "contactValue": "contactValue",
        "id": 0,
        "isMainContact": true,
        "ownerType": "ownerType"
      }
    ],
    "dob": "dob",
    "gender": "gender",
    "guid": "guid",
    "id": 0,
    "identifiers": [
      {
        "id": 0,
        "identifier": "identifier",
        "identifierType": "identifierType",
        "isMainIdentifier": true
      }
    ],
    "isPrincipal": true,
    "mainIdentifier": "mainIdentifier",
    "names": "names"
  },
  "code": "code",
  "doctorReviewStatus": "doctorReviewStatus",
  "dosage": [
    {
      "doseQuantity": "doseQuantity",
      "doseUnit": "doseUnit",
      "duration": "duration",
      "durationUnit": "durationUnit",
      "endDate": "endDate",
      "frequency": 0,
      "guid": "guid",
      "id": 0,
      "medication": "medication",
      "medicationIdentifier": "medicationIdentifier",
      "medicationPrice": 0,
      "patientInstruction": "patientInstruction",
      "periodUnit": "periodUnit",
      "practitionerId": "practitionerId",
      "prescription": 0,
      "replicated": "replicated",
      "route": "route",
      "routeCode": "routeCode",
      "startDate": "startDate"
    }
  ],
  "guid": "guid",
  "id": 0,
  "intervention": {
    "accessPoint": "accessPoint",
    "active": true,
    "activeForUhc": true,
    "applicableFacilityOwnership": "applicableFacilityOwnership",
    "applicableGender": "applicableGender",
    "applicableSchemes": [
      "string"
    ],
    "benefit": 0,
    "benefitCode": "benefitCode",
    "benefitName": "benefitName",
    "code": "code",
    "coverageLevel": "coverageLevel",
    "fund": "fund",
    "guid": "guid",
    "id": 0,
    "levelsApplicable": [
      "string"
    ],
    "name": "name",
    "packageCombinations": [
      "string"
    ],
    "parentBenefitCode": "parentBenefitCode",
    "parentBenefitName": "parentBenefitName",
    "paymentMechanism": "paymentMechanism",
    "replicated": "replicated",
    "status": "status",
    "supportedScheme": "supportedScheme"
  },
  "replicated": "replicated",
  "status": "status"
}

json

application/json

Create prescription

POST

https://ilm-dev.dha.go.ke/uat-middleware

/api/v1/prescriptions

Creates a new prescription for a patient

Create prescription › Request Body

consent_token

string · required

Consent token

intervention_code

string · required

Intervention code

object[] · minItems: 1 · required

List of prescribed medication items

identification_number

string

Doctor's ID number

identification_type

string

Identification type e.g. 'registration_number', 'National ID', 'Alien ID', 'Refugee ID'

regulation_body

string

Regulation body e.g. 'KMPDC', 'COC', 'NCK'

Create prescription › Responses

Prescription created successfully

object

code

string

doctorReviewStatus

string

object[]

guid

string

id

integer

object

replicated

string

status

string

POST/api/v1/prescriptions

curl --request POST \
  --url https://ilm-dev.dha.go.ke/uat-middleware/api/v1/prescriptions \
  --header 'Content-Type: application/json' \
  --data '
{
  "consent_token": "consent_token",
  "identification_number": "identification_number",
  "identification_type": "identification_type",
  "intervention_code": "intervention_code",
  "items": [
    {
      "additional_instruction": "additional_instruction",
      "dose_quantity": 0,
      "dose_unit": "dose_unit",
      "duration": 0,
      "duration_unit": "duration_unit",
      "end_date": "end_date",
      "frequency": 0,
      "generic_concept_code": "generic_concept_code",
      "needs_refill": true,
      "patient_instruction": "patient_instruction",
      "period_unit": "period_unit",
      "refill_count": 0,
      "start_date": "start_date"
    }
  ],
  "regulation_body": "regulation_body"
}
'

shell

Example Request Body

{
  "consent_token": "consent_token",
  "identification_number": "identification_number",
  "identification_type": "identification_type",
  "intervention_code": "intervention_code",
  "items": [
    {
      "additional_instruction": "additional_instruction",
      "dose_quantity": 0,
      "dose_unit": "dose_unit",
      "duration": 0,
      "duration_unit": "duration_unit",
      "end_date": "end_date",
      "frequency": 0,
      "generic_concept_code": "generic_concept_code",
      "needs_refill": true,
      "patient_instruction": "patient_instruction",
      "period_unit": "period_unit",
      "refill_count": 0,
      "start_date": "start_date"
    }
  ],
  "regulation_body": "regulation_body"
}

json

Example Responses

{
  "authorization": {
    "authCode": "authCode",
    "beneficiaryCode": "beneficiaryCode",
    "beneficiaryName": "beneficiaryName",
    "beneficiaryNumber": "beneficiaryNumber",
    "expiry": "expiry",
    "guid": "guid",
    "id": 0,
    "payerName": "payerName",
    "providerName": "providerName",
    "replicated": "replicated",
    "status": "status",
    "token": "token"
  },
  "beneficiary": {
    "age": 0,
    "beneficiaryCode": "beneficiaryCode",
    "contacts": [
      {
        "active": true,
        "contactType": "contactType",
        "contactValue": "contactValue",
        "id": 0,
        "isMainContact": true,
        "ownerType": "ownerType"
      }
    ],
    "dob": "dob",
    "gender": "gender",
    "guid": "guid",
    "id": 0,
    "identifiers": [
      {
        "id": 0,
        "identifier": "identifier",
        "identifierType": "identifierType",
        "isMainIdentifier": true
      }
    ],
    "isPrincipal": true,
    "mainIdentifier": "mainIdentifier",
    "names": "names"
  },
  "code": "code",
  "doctorReviewStatus": "doctorReviewStatus",
  "dosage": [
    {
      "doseQuantity": "doseQuantity",
      "doseUnit": "doseUnit",
      "duration": "duration",
      "durationUnit": "durationUnit",
      "endDate": "endDate",
      "frequency": 0,
      "guid": "guid",
      "id": 0,
      "medication": "medication",
      "medicationIdentifier": "medicationIdentifier",
      "medicationPrice": 0,
      "patientInstruction": "patientInstruction",
      "periodUnit": "periodUnit",
      "practitionerId": "practitionerId",
      "prescription": 0,
      "replicated": "replicated",
      "route": "route",
      "routeCode": "routeCode",
      "startDate": "startDate"
    }
  ],
  "guid": "guid",
  "id": 0,
  "intervention": {
    "accessPoint": "accessPoint",
    "active": true,
    "activeForUhc": true,
    "applicableFacilityOwnership": "applicableFacilityOwnership",
    "applicableGender": "applicableGender",
    "applicableSchemes": [
      "string"
    ],
    "benefit": 0,
    "benefitCode": "benefitCode",
    "benefitName": "benefitName",
    "code": "code",
    "coverageLevel": "coverageLevel",
    "fund": "fund",
    "guid": "guid",
    "id": 0,
    "levelsApplicable": [
      "string"
    ],
    "name": "name",
    "packageCombinations": [
      "string"
    ],
    "parentBenefitCode": "parentBenefitCode",
    "parentBenefitName": "parentBenefitName",
    "paymentMechanism": "paymentMechanism",
    "replicated": "replicated",
    "status": "status",
    "supportedScheme": "supportedScheme"
  },
  "replicated": "replicated",
  "status": "status"
}

json

application/json

Create dispense

POST

https://ilm-dev.dha.go.ke/uat-middleware

/api/v1/prescriptions/dispenses

Creates a dispense for a prescription using the provided dispense details

Create dispense › Request Body

object[] · required

List of actual products dispensed

consent_token

string · required

Consent token

object[] · required

Information from the healthcare professional dispensing the drug

intervention_code

string · required

Intervention code

Create dispense › Responses

Dispense created successfully

object[]

id

integer

object

status

string

POST/api/v1/prescriptions/dispenses

curl --request POST \
  --url https://ilm-dev.dha.go.ke/uat-middleware/api/v1/prescriptions/dispenses \
  --header 'Content-Type: application/json' \
  --data '
{
  "actual_products": [
    {
      "actual_product_code": "actual_product_code",
      "medication_price": 0,
      "total_quantity": 0
    }
  ],
  "consent_token": "consent_token",
  "doctors": [
    {
      "identification_number": "identification_number",
      "identification_type": "identification_type"
    }
  ],
  "intervention_code": "intervention_code"
}
'

shell

Example Request Body

{
  "actual_products": [
    {
      "actual_product_code": "actual_product_code",
      "medication_price": 0,
      "total_quantity": 0
    }
  ],
  "consent_token": "consent_token",
  "doctors": [
    {
      "identification_number": "identification_number",
      "identification_type": "identification_type"
    }
  ],
  "intervention_code": "intervention_code"
}

json

Example Responses

{
  "dispenseDosages": [
    {
      "dispense": 0,
      "doseQuantity": 0,
      "doseUnit": "doseUnit",
      "duration": "duration",
      "durationUnit": "durationUnit",
      "endDate": "endDate",
      "frequency": 0,
      "genericDosageInstruction": 0,
      "guid": "guid",
      "id": 0,
      "medication": "medication",
      "medicationIdentifier": "medicationIdentifier",
      "medicationPrice": "medicationPrice",
      "medicationRequestId": "medicationRequestId",
      "periodUnit": "periodUnit",
      "practitionerId": "practitionerId",
      "route": "route",
      "routeCode": "routeCode",
      "startDate": "startDate",
      "status": "status",
      "totalQuantity": "totalQuantity"
    }
  ],
  "dispensingDoctors": [
    {
      "dispense": 0,
      "id": 0
    }
  ],
  "id": 0,
  "prescription": {
    "authorization": {
      "authCode": "authCode",
      "beneficiaryCode": "beneficiaryCode",
      "beneficiaryName": "beneficiaryName",
      "beneficiaryNumber": "beneficiaryNumber",
      "expiry": "expiry",
      "guid": "guid",
      "id": 0,
      "payerName": "payerName",
      "providerName": "providerName",
      "replicated": "replicated",
      "status": "status",
      "token": "token"
    },
    "beneficiary": {
      "age": 0,
      "beneficiaryCode": "beneficiaryCode",
      "contacts": [
        {
          "active": true,
          "contactType": "contactType",
          "contactValue": "contactValue",
          "id": 0,
          "isMainContact": true,
          "ownerType": "ownerType"
        }
      ],
      "dob": "dob",
      "gender": "gender",
      "guid": "guid",
      "id": 0,
      "identifiers": [
        {
          "id": 0,
          "identifier": "identifier",
          "identifierType": "identifierType",
          "isMainIdentifier": true
        }
      ],
      "isPrincipal": true,
      "mainIdentifier": "mainIdentifier",
      "names": "names"
    },
    "code": "code",
    "doctorReviewStatus": "doctorReviewStatus",
    "dosage": [
      {
        "doseQuantity": "doseQuantity",
        "doseUnit": "doseUnit",
        "duration": "duration",
        "durationUnit": "durationUnit",
        "endDate": "endDate",
        "frequency": 0,
        "guid": "guid",
        "id": 0,
        "medication": "medication",
        "medicationIdentifier": "medicationIdentifier",
        "medicationPrice": 0,
        "patientInstruction": "patientInstruction",
        "periodUnit": "periodUnit",
        "practitionerId": "practitionerId",
        "prescription": 0,
        "replicated": "replicated",
        "route": "route",
        "routeCode": "routeCode",
        "startDate": "startDate"
      }
    ],
    "guid": "guid",
    "id": 0,
    "intervention": {
      "accessPoint": "accessPoint",
      "active": true,
      "activeForUhc": true,
      "applicableFacilityOwnership": "applicableFacilityOwnership",
      "applicableGender": "applicableGender",
      "applicableSchemes": [
        "string"
      ],
      "benefit": 0,
      "benefitCode": "benefitCode",
      "benefitName": "benefitName",
      "code": "code",
      "coverageLevel": "coverageLevel",
      "fund": "fund",
      "guid": "guid",
      "id": 0,
      "levelsApplicable": [
        "string"
      ],
      "name": "name",
      "packageCombinations": [
        "string"
      ],
      "parentBenefitCode": "parentBenefitCode",
      "parentBenefitName": "parentBenefitName",
      "paymentMechanism": "paymentMechanism",
      "replicated": "replicated",
      "status": "status",
      "supportedScheme": "supportedScheme"
    },
    "replicated": "replicated",
    "status": "status"
  },
  "status": "status"
}

json

application/json

Remove prescription doctor

DELETE

https://ilm-dev.dha.go.ke/uat-middleware

/api/v1/prescriptions/doctors

Removes a doctor associated with a prescription using the provided details

Remove prescription doctor › Request Body

consent_token

string · required

Consent token

intervention_code

string · required

Intervention code

practitioner_registration_number

string · required

Registration number of the practitioner to remove

Remove prescription doctor › Responses

Doctor prescription successfully removed

string

DELETE/api/v1/prescriptions/doctors

curl --request DELETE \
  --url https://ilm-dev.dha.go.ke/uat-middleware/api/v1/prescriptions/doctors \
  --header 'Content-Type: application/json' \
  --data '
{
  "consent_token": "consent_token",
  "intervention_code": "intervention_code",
  "practitioner_registration_number": "practitioner_registration_number"
}
'

shell

Example Request Body

{
  "consent_token": "consent_token",
  "intervention_code": "intervention_code",
  "practitioner_registration_number": "practitioner_registration_number"
}

json

Example Responses

{}

json

application/json

Preauth Doctor Consent Claim Dispatch

Preview prescription

GET

https://ilm-dev.dha.go.ke/uat-middleware

/api/v1/prescriptions

Fetches a preview of a prescription using a consent token

Preview prescription › query Parameters

consent_token

string · required

Consent token

Preview prescription › Responses

Prescription preview fetched successfully

object

code

string

doctorReviewStatus

string

object[]

guid

string

id

integer

object

replicated

string

status

string

{ "authorization": { "authCode": "authCode", "beneficiaryCode": "beneficiaryCode", "beneficiaryName": "beneficiaryName", "beneficiaryNumber": "beneficiaryNumber", "expiry": "expiry", "guid": "guid", "id": 0, "payerName": "payerName", "providerName": "providerName", "replicated": "replicated", "status": "status", "token": "token" }, "beneficiary": { "age": 0, "beneficiaryCode": "beneficiaryCode", "contacts": [ { "active": true, "contactType": "contactType", "contactValue": "contactValue", "id": 0, "isMainContact": true, "ownerType": "ownerType" } ], "dob": "dob", "gender": "gender", "guid": "guid", "id": 0, "identifiers": [ { "id": 0, "identifier": "identifier", "identifierType": "identifierType", "isMainIdentifier": true } ], "isPrincipal": true, "mainIdentifier": "mainIdentifier", "names": "names" }, "code": "code", "doctorReviewStatus": "doctorReviewStatus", "dosage": [ { "doseQuantity": "doseQuantity", "doseUnit": "doseUnit", "duration": "duration", "durationUnit": "durationUnit", "endDate": "endDate", "frequency": 0, "guid": "guid", "id": 0, "medication": "medication", "medicationIdentifier": "medicationIdentifier", "medicationPrice": 0, "patientInstruction": "patientInstruction", "periodUnit": "periodUnit", "practitionerId": "practitionerId", "prescription": 0, "replicated": "replicated", "route": "route", "routeCode": "routeCode", "startDate": "startDate" } ], "guid": "guid", "id": 0, "intervention": { "accessPoint": "accessPoint", "active": true, "activeForUhc": true, "applicableFacilityOwnership": "applicableFacilityOwnership", "applicableGender": "applicableGender", "applicableSchemes": [ "string" ], "benefit": 0, "benefitCode": "benefitCode", "benefitName": "benefitName", "code": "code", "coverageLevel": "coverageLevel", "fund": "fund", "guid": "guid", "id": 0, "levelsApplicable": [ "string" ], "name": "name", "packageCombinations": [ "string" ], "parentBenefitCode": "parentBenefitCode", "parentBenefitName": "parentBenefitName", "paymentMechanism": "paymentMechanism", "replicated": "replicated", "status": "status", "supportedScheme": "supportedScheme" }, "replicated": "replicated", "status": "status" }

Create prescription

POST

https://ilm-dev.dha.go.ke/uat-middleware

/api/v1/prescriptions

Creates a new prescription for a patient

Create prescription › Request Body

consent_token

string · required

Consent token

intervention_code

string · required

Intervention code

object[] · minItems: 1 · required

List of prescribed medication items

identification_number

string

Doctor's ID number

identification_type

string

Identification type e.g. 'registration_number', 'National ID', 'Alien ID', 'Refugee ID'

regulation_body

string

Regulation body e.g. 'KMPDC', 'COC', 'NCK'

Create prescription › Responses

Prescription created successfully

object

code

string

doctorReviewStatus

string

object[]

guid

string

id

integer

object

replicated

string

status

string

curl --request POST \ --url https://ilm-dev.dha.go.ke/uat-middleware/api/v1/prescriptions \ --header 'Content-Type: application/json' \ --data ' { "consent_token": "consent_token", "identification_number": "identification_number", "identification_type": "identification_type", "intervention_code": "intervention_code", "items": [ { "additional_instruction": "additional_instruction", "dose_quantity": 0, "dose_unit": "dose_unit", "duration": 0, "duration_unit": "duration_unit", "end_date": "end_date", "frequency": 0, "generic_concept_code": "generic_concept_code", "needs_refill": true, "patient_instruction": "patient_instruction", "period_unit": "period_unit", "refill_count": 0, "start_date": "start_date" } ], "regulation_body": "regulation_body" } '

{ "consent_token": "consent_token", "identification_number": "identification_number", "identification_type": "identification_type", "intervention_code": "intervention_code", "items": [ { "additional_instruction": "additional_instruction", "dose_quantity": 0, "dose_unit": "dose_unit", "duration": 0, "duration_unit": "duration_unit", "end_date": "end_date", "frequency": 0, "generic_concept_code": "generic_concept_code", "needs_refill": true, "patient_instruction": "patient_instruction", "period_unit": "period_unit", "refill_count": 0, "start_date": "start_date" } ], "regulation_body": "regulation_body" }

Create dispense

POST

https://ilm-dev.dha.go.ke/uat-middleware

/api/v1/prescriptions/dispenses

Creates a dispense for a prescription using the provided dispense details

Create dispense › Request Body

object[] · required

List of actual products dispensed

consent_token

string · required

Consent token

object[] · required

Information from the healthcare professional dispensing the drug

intervention_code

string · required

Intervention code

Create dispense › Responses

Dispense created successfully

object[]

id

integer

object

status

string

curl --request POST \ --url https://ilm-dev.dha.go.ke/uat-middleware/api/v1/prescriptions/dispenses \ --header 'Content-Type: application/json' \ --data ' { "actual_products": [ { "actual_product_code": "actual_product_code", "medication_price": 0, "total_quantity": 0 } ], "consent_token": "consent_token", "doctors": [ { "identification_number": "identification_number", "identification_type": "identification_type" } ], "intervention_code": "intervention_code" } '

{ "actual_products": [ { "actual_product_code": "actual_product_code", "medication_price": 0, "total_quantity": 0 } ], "consent_token": "consent_token", "doctors": [ { "identification_number": "identification_number", "identification_type": "identification_type" } ], "intervention_code": "intervention_code" }

{ "dispenseDosages": [ { "dispense": 0, "doseQuantity": 0, "doseUnit": "doseUnit", "duration": "duration", "durationUnit": "durationUnit", "endDate": "endDate", "frequency": 0, "genericDosageInstruction": 0, "guid": "guid", "id": 0, "medication": "medication", "medicationIdentifier": "medicationIdentifier", "medicationPrice": "medicationPrice", "medicationRequestId": "medicationRequestId", "periodUnit": "periodUnit", "practitionerId": "practitionerId", "route": "route", "routeCode": "routeCode", "startDate": "startDate", "status": "status", "totalQuantity": "totalQuantity" } ], "dispensingDoctors": [ { "dispense": 0, "id": 0 } ], "id": 0, "prescription": { "authorization": { "authCode": "authCode", "beneficiaryCode": "beneficiaryCode", "beneficiaryName": "beneficiaryName", "beneficiaryNumber": "beneficiaryNumber", "expiry": "expiry", "guid": "guid", "id": 0, "payerName": "payerName", "providerName": "providerName", "replicated": "replicated", "status": "status", "token": "token" }, "beneficiary": { "age": 0, "beneficiaryCode": "beneficiaryCode", "contacts": [ { "active": true, "contactType": "contactType", "contactValue": "contactValue", "id": 0, "isMainContact": true, "ownerType": "ownerType" } ], "dob": "dob", "gender": "gender", "guid": "guid", "id": 0, "identifiers": [ { "id": 0, "identifier": "identifier", "identifierType": "identifierType", "isMainIdentifier": true } ], "isPrincipal": true, "mainIdentifier": "mainIdentifier", "names": "names" }, "code": "code", "doctorReviewStatus": "doctorReviewStatus", "dosage": [ { "doseQuantity": "doseQuantity", "doseUnit": "doseUnit", "duration": "duration", "durationUnit": "durationUnit", "endDate": "endDate", "frequency": 0, "guid": "guid", "id": 0, "medication": "medication", "medicationIdentifier": "medicationIdentifier", "medicationPrice": 0, "patientInstruction": "patientInstruction", "periodUnit": "periodUnit", "practitionerId": "practitionerId", "prescription": 0, "replicated": "replicated", "route": "route", "routeCode": "routeCode", "startDate": "startDate" } ], "guid": "guid", "id": 0, "intervention": { "accessPoint": "accessPoint", "active": true, "activeForUhc": true, "applicableFacilityOwnership": "applicableFacilityOwnership", "applicableGender": "applicableGender", "applicableSchemes": [ "string" ], "benefit": 0, "benefitCode": "benefitCode", "benefitName": "benefitName", "code": "code", "coverageLevel": "coverageLevel", "fund": "fund", "guid": "guid", "id": 0, "levelsApplicable": [ "string" ], "name": "name", "packageCombinations": [ "string" ], "parentBenefitCode": "parentBenefitCode", "parentBenefitName": "parentBenefitName", "paymentMechanism": "paymentMechanism", "replicated": "replicated", "status": "status", "supportedScheme": "supportedScheme" }, "replicated": "replicated", "status": "status" }, "status": "status" }

Remove prescription doctor

DELETE

https://ilm-dev.dha.go.ke/uat-middleware

/api/v1/prescriptions/doctors

Removes a doctor associated with a prescription using the provided details

Remove prescription doctor › Request Body

consent_token

string · required

Consent token

intervention_code

string · required

Intervention code

practitioner_registration_number

string · required

Registration number of the practitioner to remove

Remove prescription doctor › Responses

Doctor prescription successfully removed

string