01 · Identify

Server

Calls made at Identify. Taught at /rail/stops/Identify.

The document types a desk may choose from today. Cache by version; never embed.

GET

https://api-dev.slade360edi.com/orchestrator

/api/v1/terminology/concepts

The document types a desk may choose from today. Cache by version; never embed.

Keep from the response: codes[].code

Taught in: 01 · Identify

The document types a desk may choose from today. Cache by version; never embed. › query Parameters

code_system

string · required

code system

version

string · required

version

The document types a desk may choose from today. Cache by version; never embed. › Headers

X-Facility-Id

string · required

The facility this call is made from.

X-Facility-Id-Type

string · required

How to read X-Facility-Id: mfl, license-number, fr-code, registration-number or fid.

The document types a desk may choose from today. Cache by version; never embed. › Responses

200

Returns codes[].code.

value_set

string

version

string

object[]

GET/api/v1/terminology/concepts

curl 'https://api-dev.slade360edi.com/orchestrator/api/v1/terminology/concepts?code_system=<string>&version=<string>' \
  --header 'X-Facility-Id: <string>' \
  --header 'X-Facility-Id-Type: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "value_set": "identifier-types",
  "version": "2026-08-06.1",
  "codes": [
    {
      "code": "NATIONAL_ID",
      "status": "active"
    },
    {
      "code": "CR_NUMBER",
      "status": "active"
    },
    {
      "code": "BIRTH_NOTIFICATION",
      "status": "active"
    },
    {
      "code": "BIRTH_CERTIFICATE",
      "status": "active"
    },
    {
      "code": "ALIEN_ID",
      "status": "active"
    },
    {
      "code": "REFUGEE_ID",
      "status": "active"
    },
    {
      "code": "MANDATE_NUMBER",
      "status": "active"
    },
    {
      "code": "TEMPORARY_REGISTRATION",
      "status": "active"
    },
    {
      "code": "PASSPORT",
      "status": "active"
    }
  ]
}

json

application/json

Resolve an identifier pair to one unique_patient_id, with masked details to confirm the human.

POST

https://api-dev.slade360edi.com/orchestrator

/api/v2/patients/lookup

Resolve an identifier pair to one unique_patient_id, with masked details to confirm the human.

Keep from the response: unique_patient_id

Taught in: 01 · Identify

Resolve an identifier pair to one unique_patient_id, with masked details to confirm the human. › Headers

X-Facility-Id

string · required

The facility this call is made from.

X-Facility-Id-Type

string · required

How to read X-Facility-Id: mfl, license-number, fr-code, registration-number or fid.

Resolve an identifier pair to one unique_patient_id, with masked details to confirm the human. › Request Body

object

Resolve an identifier pair to one unique_patient_id, with masked details to confirm the human. › Responses

Returns unique_patient_id.

lookup_ref

string

unique_patient_id

string

is_alive

boolean

object

object[]

object

POST/api/v2/patients/lookup

curl https://api-dev.slade360edi.com/orchestrator/api/v2/patients/lookup \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-Facility-Id: <string>' \
  --header 'X-Facility-Id-Type: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "identifier": {
    "type": "NATIONAL_ID",
    "value": "{{national_id}}"
  }
}'

Example Request Body

{
  "identifier": {
    "type": "NATIONAL_ID",
    "value": "{{national_id}}"
  }
}

json

application/json

Example Responses

{
  "lookup_ref": "LKP-2026-08-05-000512",
  "unique_patient_id": "SIL-UPI-0091774",
  "is_alive": true,
  "biodata": {
    "name": "Wanjiru M****i M****i",
    "date_of_birth": "2000-06-29",
    "gender": "MALE",
    "registered_on": "2024-10-09"
  },
  "matched_on": {
    "type": "NATIONAL_ID",
    "value": "3312****"
  },
  "identifiers": [
    {
      "type": "NATIONAL_ID",
      "value": "3312****",
      "verified": true
    },
    {
      "type": "CLIENT_REGISTRY_NO",
      "value": "CR61*************",
      "verified": true
    },
    {
      "type": "SHA_NUMBER",
      "value": "SHA0*********",
      "verified": true
    }
  ],
  "contacts": {
    "phones": [
      {
        "value": "+254700****848",
        "verified": true
      }
    ],
    "emails": [
      {
        "value": "roy***@example.co.ke",
        "verified": false
      }
    ]
  },
  "next_action": {
    "type": "select_cover",
    "endpoint": "/api/v2/patients/SIL-UPI-0091774/covers"
  }
}

json

application/json

Health worker registry — one practitioner, with a licence verdict you do not have to derive.

GET

https://api-dev.slade360edi.com/orchestrator

/api/v1/professionals

Health worker registry — one practitioner, with a licence verdict you do not have to derive.

Keep from the response: licence.status

Taught in: 01 · Identify

Health worker registry — one practitioner, with a licence verdict you do not have to derive. › query Parameters

identification_number

string · required

practitioner license

identification_type

string · required

identification type

regulator

string · required

regulator

Health worker registry — one practitioner, with a licence verdict you do not have to derive. › Headers

X-Facility-Id

string · required

The facility this call is made from.

X-Facility-Id-Type

string · required

How to read X-Facility-Id: mfl, license-number, fr-code, registration-number or fid.

Health worker registry — one practitioner, with a licence verdict you do not have to derive. › Responses

Returns licence.status.

registration_number

string

name

string

regulator

string

object

GET/api/v1/professionals

curl 'https://api-dev.slade360edi.com/orchestrator/api/v1/professionals?identification_number=<string>&identification_type=<string>&regulator=<string>' \
  --header 'X-Facility-Id: <string>' \
  --header 'X-Facility-Id-Type: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "registration_number": "A8***1",
  "name": "Dr J*** W*** M***",
  "regulator": "KMPDC",
  "licence": {
    "status": "ACTIVE",
    "valid_to": "2027-03-31",
    "checked_at": "2026-08-13T09:41:02+03:00"
  },
  "professional_details": {
    "cadre": "Medical Practitioner",
    "specialty": "General Surgery",
    "discipline_name": "Surgery"
  },
  "next_action": {
    "type": "none"
  }
}

json

application/json

00 · Authenticate 02 · Verify cover

The Rail

01 · Identify

Server

Calls made at Identify. Taught at /rail/stops/Identify.

The document types a desk may choose from today. Cache by version; never embed.

GET

https://api-dev.slade360edi.com/orchestrator

/api/v1/terminology/concepts

The document types a desk may choose from today. Cache by version; never embed.

Keep from the response: codes[].code

Taught in: 01 · Identify

The document types a desk may choose from today. Cache by version; never embed. › query Parameters

code_system

string · required

code system

version

string · required

version

The document types a desk may choose from today. Cache by version; never embed. › Headers

X-Facility-Id

string · required

The facility this call is made from.

X-Facility-Id-Type

string · required

How to read X-Facility-Id: mfl, license-number, fr-code, registration-number or fid.

The document types a desk may choose from today. Cache by version; never embed. › Responses

200

Returns codes[].code.

value_set

string

version

string

object[]

GET/api/v1/terminology/concepts

curl 'https://api-dev.slade360edi.com/orchestrator/api/v1/terminology/concepts?code_system=<string>&version=<string>' \
  --header 'X-Facility-Id: <string>' \
  --header 'X-Facility-Id-Type: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "value_set": "identifier-types",
  "version": "2026-08-06.1",
  "codes": [
    {
      "code": "NATIONAL_ID",
      "status": "active"
    },
    {
      "code": "CR_NUMBER",
      "status": "active"
    },
    {
      "code": "BIRTH_NOTIFICATION",
      "status": "active"
    },
    {
      "code": "BIRTH_CERTIFICATE",
      "status": "active"
    },
    {
      "code": "ALIEN_ID",
      "status": "active"
    },
    {
      "code": "REFUGEE_ID",
      "status": "active"
    },
    {
      "code": "MANDATE_NUMBER",
      "status": "active"
    },
    {
      "code": "TEMPORARY_REGISTRATION",
      "status": "active"
    },
    {
      "code": "PASSPORT",
      "status": "active"
    }
  ]
}

json

application/json

Resolve an identifier pair to one unique_patient_id, with masked details to confirm the human.

POST

https://api-dev.slade360edi.com/orchestrator

/api/v2/patients/lookup

Resolve an identifier pair to one unique_patient_id, with masked details to confirm the human.

Keep from the response: unique_patient_id

Taught in: 01 · Identify

Resolve an identifier pair to one unique_patient_id, with masked details to confirm the human. › Headers

X-Facility-Id

string · required

The facility this call is made from.

X-Facility-Id-Type

string · required

How to read X-Facility-Id: mfl, license-number, fr-code, registration-number or fid.

Resolve an identifier pair to one unique_patient_id, with masked details to confirm the human. › Request Body

object

Resolve an identifier pair to one unique_patient_id, with masked details to confirm the human. › Responses

Returns unique_patient_id.

lookup_ref

string

unique_patient_id

string

is_alive

boolean

object

object[]

object

POST/api/v2/patients/lookup

curl https://api-dev.slade360edi.com/orchestrator/api/v2/patients/lookup \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-Facility-Id: <string>' \
  --header 'X-Facility-Id-Type: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "identifier": {
    "type": "NATIONAL_ID",
    "value": "{{national_id}}"
  }
}'

Example Request Body

{
  "identifier": {
    "type": "NATIONAL_ID",
    "value": "{{national_id}}"
  }
}

json

application/json

Example Responses

{
  "lookup_ref": "LKP-2026-08-05-000512",
  "unique_patient_id": "SIL-UPI-0091774",
  "is_alive": true,
  "biodata": {
    "name": "Wanjiru M****i M****i",
    "date_of_birth": "2000-06-29",
    "gender": "MALE",
    "registered_on": "2024-10-09"
  },
  "matched_on": {
    "type": "NATIONAL_ID",
    "value": "3312****"
  },
  "identifiers": [
    {
      "type": "NATIONAL_ID",
      "value": "3312****",
      "verified": true
    },
    {
      "type": "CLIENT_REGISTRY_NO",
      "value": "CR61*************",
      "verified": true
    },
    {
      "type": "SHA_NUMBER",
      "value": "SHA0*********",
      "verified": true
    }
  ],
  "contacts": {
    "phones": [
      {
        "value": "+254700****848",
        "verified": true
      }
    ],
    "emails": [
      {
        "value": "roy***@example.co.ke",
        "verified": false
      }
    ]
  },
  "next_action": {
    "type": "select_cover",
    "endpoint": "/api/v2/patients/SIL-UPI-0091774/covers"
  }
}

json

application/json

Health worker registry — one practitioner, with a licence verdict you do not have to derive.

GET

https://api-dev.slade360edi.com/orchestrator

/api/v1/professionals

Health worker registry — one practitioner, with a licence verdict you do not have to derive.

Keep from the response: licence.status

Taught in: 01 · Identify

Health worker registry — one practitioner, with a licence verdict you do not have to derive. › query Parameters

identification_number

string · required

practitioner license

identification_type

string · required

identification type

regulator

string · required

regulator

Health worker registry — one practitioner, with a licence verdict you do not have to derive. › Headers

X-Facility-Id

string · required

The facility this call is made from.

X-Facility-Id-Type

string · required

How to read X-Facility-Id: mfl, license-number, fr-code, registration-number or fid.

Health worker registry — one practitioner, with a licence verdict you do not have to derive. › Responses

Returns licence.status.

registration_number

string

name

string

regulator

string

object

GET/api/v1/professionals

curl 'https://api-dev.slade360edi.com/orchestrator/api/v1/professionals?identification_number=<string>&identification_type=<string>&regulator=<string>' \
  --header 'X-Facility-Id: <string>' \
  --header 'X-Facility-Id-Type: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "registration_number": "A8***1",
  "name": "Dr J*** W*** M***",
  "regulator": "KMPDC",
  "licence": {
    "status": "ACTIVE",
    "valid_to": "2027-03-31",
    "checked_at": "2026-08-13T09:41:02+03:00"
  },
  "professional_details": {
    "cadre": "Medical Practitioner",
    "specialty": "General Surgery",
    "discipline_name": "Surgery"
  },
  "next_action": {
    "type": "none"
  }
}

json

application/json

00 · Authenticate 02 · Verify cover