eClaims and Preauth APIs

ePrescriptions

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

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 so it can be reviewed before the prescription is created or dispensed.

Preview prescription › query Parameters

consent_token

string · required

Consent token

Example: K5HLPJVDNV

Preview prescription › Headers

X-Facility-Id

string

Facility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.

Example: FID-47-115307-8

X-Facility-Id-Type

string

Type of identifier supplied in X-Facility-Id. Currently only fr-code is supported.

Example: fr-code

Preview prescription › Responses

Prescription preview fetched successfully

object

code

string

doctorReviewStatus

string

object[]

guid

string

id

integer

object

replicated

string

status

string

GET/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, capturing the medication items to be prescribed. The prescribing doctor is identified via identification_type (one of registration_number, National ID, Alien ID or Refugee ID) together with regulation_body (one of KMPDC, COC, NCK or PPB).

Create prescription › Headers

X-Facility-Id

string

Facility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.

Example: FID-47-115307-8

X-Facility-Id-Type

string

Type of identifier supplied in X-Facility-Id. Currently only fr-code is supported.

Example: fr-code

Create prescription › Request Body

consent_token

string · required

Patient consent token authorising the prescription request.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention code the prescription is issued against.

Example: SHA-18-005

object[] · minItems: 1 · required

List of medication items to be prescribed.

identification_number

string

Identification number of the prescribing practitioner, matching the identification type. Example is dummy data.

Example: A00000

identification_type

string · enum

Type of identifier supplied for the prescribing practitioner.

Enum values:

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

regulation_body

string · enum

Regulatory body that registered the prescribing practitioner.

Enum values:

KMPDC

COC

NCK

PPB

Example: KMPDC

Create prescription › Responses

Prescription created successfully

object

code

string

doctorReviewStatus

string

object[]

guid

string

id

integer

object

replicated

string

status

string

POST/prescriptions

curl --request POST \
  --url https://ilm-dev.dha.go.ke/uat-middleware/api/v1/prescriptions \
  --header 'Content-Type: application/json' \
  --data '
{
  "consent_token": "K5HLPJVDNV",
  "identification_number": "A00000",
  "identification_type": "registration_number",
  "intervention_code": "SHA-18-005",
  "items": [
    {
      "additional_instruction": "Take after meals.",
      "dose_quantity": 1,
      "dose_unit": "tablet",
      "duration": 7,
      "duration_unit": "day",
      "end_date": "2026-06-08",
      "frequency": 3,
      "generic_concept_code": "387517004",
      "needs_refill": false,
      "patient_instruction": "Take one tablet twice daily for five days.",
      "period_unit": "day",
      "refill_count": 2,
      "start_date": "2026-06-08"
    }
  ],
  "regulation_body": "KMPDC"
}
'

shell

Example Request Body

{
  "consent_token": "K5HLPJVDNV",
  "identification_number": "A00000",
  "identification_type": "registration_number",
  "intervention_code": "SHA-18-005",
  "items": [
    {
      "additional_instruction": "Take after meals.",
      "dose_quantity": 1,
      "dose_unit": "tablet",
      "duration": 7,
      "duration_unit": "day",
      "end_date": "2026-06-08",
      "frequency": 3,
      "generic_concept_code": "387517004",
      "needs_refill": false,
      "patient_instruction": "Take one tablet twice daily for five days.",
      "period_unit": "day",
      "refill_count": 2,
      "start_date": "2026-06-08"
    }
  ],
  "regulation_body": "KMPDC"
}

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/dispense

Dispenses against an existing prescription, recording the actual products supplied to the patient and the dispensing doctors who fulfilled the prescription.

Create dispense › Headers

X-Facility-Id

string

Facility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.

Example: FID-47-115307-8

X-Facility-Id-Type

string

Type of identifier supplied in X-Facility-Id. Currently only fr-code is supported.

Example: fr-code

Create dispense › Request Body

object[] · required

Products actually dispensed to the patient for this intervention.

consent_token

string · required

Patient consent token authorising the dispense.

Example: K5HLPJVDNV

object[] · required

Doctors associated with the dispense (e.g. prescriber).

intervention_code

string · required

SHA intervention code the dispense is recorded against.

Example: SHA-18-005

Create dispense › Responses

Dispense created successfully

object[]

id

integer

object

status

string

POST/prescriptions/dispense

curl --request POST \
  --url https://ilm-dev.dha.go.ke/uat-middleware/api/v1/prescriptions/dispense \
  --header 'Content-Type: application/json' \
  --data '
{
  "actual_products": [
    {
      "actual_product_code": "SHA-19-SC-13",
      "medication_price": 1500,
      "total_quantity": 30
    }
  ],
  "consent_token": "K5HLPJVDNV",
  "doctors": [
    {
      "identification_number": "A00000",
      "identification_type": "registration_number"
    }
  ],
  "intervention_code": "SHA-18-005"
}
'

shell

Example Request Body

{
  "actual_products": [
    {
      "actual_product_code": "SHA-19-SC-13",
      "medication_price": 1500,
      "total_quantity": 30
    }
  ],
  "consent_token": "K5HLPJVDNV",
  "doctors": [
    {
      "identification_number": "A00000",
      "identification_type": "registration_number"
    }
  ],
  "intervention_code": "SHA-18-005"
}

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 a doctor from a prescription

DELETE

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

/prescriptions/doctors

Removes a doctor that was previously associated with a prescription, using the details in the request payload.

Remove a doctor from a prescription › Headers

X-Facility-Id

string

Facility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.

Example: FID-47-115307-8

X-Facility-Id-Type

string

Type of identifier supplied in X-Facility-Id. Currently only fr-code is supported.

Example: fr-code

Remove a doctor from a prescription › Request Body

consent_token

string · required

Consent token authorising the action on the beneficiary's prescription.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention code the doctor is associated with.

Example: SHA-18-005

practitioner_registration_number

string · required

Regulatory registration number of the prescribing doctor to remove. Example is dummy data.

Example: A00000

Remove a doctor from a prescription › Responses

Doctor prescription successfully removed

string

DELETE/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": "K5HLPJVDNV",
  "intervention_code": "SHA-18-005",
  "practitioner_registration_number": "A00000"
}
'

shell

Example Request Body

{
  "consent_token": "K5HLPJVDNV",
  "intervention_code": "SHA-18-005",
  "practitioner_registration_number": "A00000"
}

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 so it can be reviewed before the prescription is created or dispensed.

Preview prescription › query Parameters

consent_token

string · required

Consent token

Example: K5HLPJVDNV

Preview prescription › Headers

X-Facility-Id

string

Facility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.

Example: FID-47-115307-8

X-Facility-Id-Type

string

Type of identifier supplied in X-Facility-Id. Currently only fr-code is supported.

Example: fr-code

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

Create prescription › Headers

X-Facility-Id

string

Facility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.

Example: FID-47-115307-8

X-Facility-Id-Type

string

Type of identifier supplied in X-Facility-Id. Currently only fr-code is supported.

Example: fr-code

Create prescription › Request Body

consent_token

string · required

Patient consent token authorising the prescription request.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention code the prescription is issued against.

Example: SHA-18-005

object[] · minItems: 1 · required

List of medication items to be prescribed.

identification_number

string

Identification number of the prescribing practitioner, matching the identification type. Example is dummy data.

Example: A00000

identification_type

string · enum

Type of identifier supplied for the prescribing practitioner.

Enum values:

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

regulation_body

string · enum

Regulatory body that registered the prescribing practitioner.

Enum values:

KMPDC

COC

NCK

PPB

Example: KMPDC

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": "K5HLPJVDNV", "identification_number": "A00000", "identification_type": "registration_number", "intervention_code": "SHA-18-005", "items": [ { "additional_instruction": "Take after meals.", "dose_quantity": 1, "dose_unit": "tablet", "duration": 7, "duration_unit": "day", "end_date": "2026-06-08", "frequency": 3, "generic_concept_code": "387517004", "needs_refill": false, "patient_instruction": "Take one tablet twice daily for five days.", "period_unit": "day", "refill_count": 2, "start_date": "2026-06-08" } ], "regulation_body": "KMPDC" } '

{ "consent_token": "K5HLPJVDNV", "identification_number": "A00000", "identification_type": "registration_number", "intervention_code": "SHA-18-005", "items": [ { "additional_instruction": "Take after meals.", "dose_quantity": 1, "dose_unit": "tablet", "duration": 7, "duration_unit": "day", "end_date": "2026-06-08", "frequency": 3, "generic_concept_code": "387517004", "needs_refill": false, "patient_instruction": "Take one tablet twice daily for five days.", "period_unit": "day", "refill_count": 2, "start_date": "2026-06-08" } ], "regulation_body": "KMPDC" }

Create dispense

POST

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

/prescriptions/dispense

Dispenses against an existing prescription, recording the actual products supplied to the patient and the dispensing doctors who fulfilled the prescription.

Create dispense › Headers

X-Facility-Id

string

Facility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.

Example: FID-47-115307-8

X-Facility-Id-Type

string

Type of identifier supplied in X-Facility-Id. Currently only fr-code is supported.

Example: fr-code

Create dispense › Request Body

object[] · required

Products actually dispensed to the patient for this intervention.

consent_token

string · required

Patient consent token authorising the dispense.

Example: K5HLPJVDNV

object[] · required

Doctors associated with the dispense (e.g. prescriber).

intervention_code

string · required

SHA intervention code the dispense is recorded against.

Example: SHA-18-005

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/dispense \ --header 'Content-Type: application/json' \ --data ' { "actual_products": [ { "actual_product_code": "SHA-19-SC-13", "medication_price": 1500, "total_quantity": 30 } ], "consent_token": "K5HLPJVDNV", "doctors": [ { "identification_number": "A00000", "identification_type": "registration_number" } ], "intervention_code": "SHA-18-005" } '

{ "actual_products": [ { "actual_product_code": "SHA-19-SC-13", "medication_price": 1500, "total_quantity": 30 } ], "consent_token": "K5HLPJVDNV", "doctors": [ { "identification_number": "A00000", "identification_type": "registration_number" } ], "intervention_code": "SHA-18-005" }

{ "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 a doctor from a prescription

DELETE

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

/prescriptions/doctors

Removes a doctor that was previously associated with a prescription, using the details in the request payload.

Remove a doctor from a prescription › Headers

X-Facility-Id

string

Facility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.

Example: FID-47-115307-8

X-Facility-Id-Type

string

Type of identifier supplied in X-Facility-Id. Currently only fr-code is supported.

Example: fr-code

Remove a doctor from a prescription › Request Body

consent_token

string · required

Consent token authorising the action on the beneficiary's prescription.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention code the doctor is associated with.

Example: SHA-18-005

practitioner_registration_number

string · required

Regulatory registration number of the prescribing doctor to remove. Example is dummy data.

Example: A00000

Remove a doctor from a prescription › Responses

Doctor prescription successfully removed

string