FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagefhir.kenyaPSIG
Resource TypeStructureDefinition
IdStructureDefinition-ClientTreatmentModel.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/IntelliSOFT-Consulting/Kenya-Patient-Summary-FHIR-IG/StructureDefinition-ClientTreatmentModel.html
URLhttps://nshr-uat.sha.go.ke/fhir/StructureDefinition/ClientTreatmentModel
Version0.1.0
Statusdraft
Date2026-06-19T10:10:16+00:00
NameClientTreatmentModel
TitleKPS.D Treatment
Realmus
Authorityhl7
DescriptionLogical model for documenting patient treatments under the Kenya Patient Summary (KPS.D) standard.
CopyrightCopyright © 2024+ Digital Health Agency of Kenya. This content is licensed under Creative Commons Zero v1.0 Universal (CC0 1.0). No rights reserved.
Typehttps://nshr-uat.sha.go.ke/fhir/StructureDefinition/ClientTreatmentModel
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

ValueSet
fhir.kenyaPSIG#currentkps-medication-vsMedication ValueSet
fhir.kenyaPSIG#currentmedication-form-vsForm ValueSet

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition ClientTreatmentModel

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClientTreatmentModel 0..*BaseKPS.D Treatment
... medicationReason 1..1stringReason for prescribing or using the medication. May link to past/current conditions.
... intendedUse 1..1stringIndication for use: prevention, treatment, diagnostic, anaesthesia, equipment care.
... medicationCode 1..1CodeableConceptMedication that was or is to be administered (coded).
... medicationStatus 0..1codeCurrent usage status of the medication.
Binding: medicationrequest Status (required)
... medicationForm 0..1codeForm of medication (tablet, capsule, liquid, etc.).
Binding: Form ValueSet (required)
... activeIngredient 1..1codeActive substance in the medication (e.g. paracetamol).
Binding: Medication ValueSet (required)
... strength 1..1QuantityContent of active ingredient per dosage unit (e.g. 500 mg/tablet).
... dosageRegimen 1..1stringDosage instructions: quantity, frequency, and duration (e.g. 1 tab every 24h for 10 days).
... routeOfAdministration 1..1stringPath of administration (e.g. oral, intravenous).
... treatmentStartDate 1..1dateDate to start the treatment or medication.
... planOfCare 1..1stringTherapeutic recommendations excluding medication: diet, surgery, exercise, etc.
... externalReference 0..1stringExternal reference to guidelines or other clinical knowledge.
... relatedWith 0..1stringLink to related entries in the Patient Summary (e.g. rare disease).

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "ClientTreatmentModel",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ClientTreatmentModel",
  "version": "0.1.0",
  "name": "ClientTreatmentModel",
  "title": "KPS.D Treatment",
  "status": "draft",
  "date": "2026-06-19T10:10:16+00:00",
  "publisher": "Digital Health Agency of Kenya",
  "contact": [
    {
      "name": "Digital Health Agency of Kenya",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.dha.go.ke"
        },
        {
          "system": "email",
          "value": "interoperability@dha.go.ke"
        }
      ]
    },
    {
      "name": "Digital Health Agency of Kenya – Interoperability Team",
      "telecom": [
        {
          "system": "email",
          "value": "interoperability@dha.go.ke",
          "use": "work"
        },
        {
          "system": "url",
          "value": "https://www.dha.go.ke",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Logical model for documenting patient treatments under the Kenya Patient Summary (KPS.D) standard.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "KE",
          "display": "Kenya"
        }
      ]
    }
  ],
  "copyright": "Copyright © 2024+ Digital Health Agency of Kenya. This content is licensed under Creative Commons Zero v1.0 Universal (CC0 1.0). No rights reserved.\n",
  "fhirVersion": "4.0.1",
  "kind": "logical",
  "abstract": false,
  "type": "https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ClientTreatmentModel",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "4.0.1"
      }
    ],
    "element": [
      {
        "id": "ClientTreatmentModel",
        "path": "ClientTreatmentModel",
        "short": "KPS.D Treatment",
        "definition": "Logical model for documenting patient treatments under the Kenya Patient Summary (KPS.D) standard.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false
      },
      {
        "id": "ClientTreatmentModel.medicationReason",
        "path": "ClientTreatmentModel.medicationReason",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.1"
          }
        ],
        "short": "Reason for prescribing or using the medication. May link to past/current conditions.",
        "definition": "Reason for prescribing or using the medication. May link to past/current conditions.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ClientTreatmentModel.medicationReason",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.intendedUse",
        "path": "ClientTreatmentModel.intendedUse",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.2"
          }
        ],
        "short": "Indication for use: prevention, treatment, diagnostic, anaesthesia, equipment care.",
        "definition": "Indication for use: prevention, treatment, diagnostic, anaesthesia, equipment care.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ClientTreatmentModel.intendedUse",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.medicationCode",
        "path": "ClientTreatmentModel.medicationCode",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.3"
          }
        ],
        "short": "Medication that was or is to be administered (coded).",
        "definition": "Medication that was or is to be administered (coded).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ClientTreatmentModel.medicationCode",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.medicationStatus",
        "path": "ClientTreatmentModel.medicationStatus",
        "short": "Current usage status of the medication.",
        "definition": "Current usage status of the medication.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ClientTreatmentModel.medicationStatus",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/ValueSet/medicationrequest-status"
        }
      },
      {
        "id": "ClientTreatmentModel.medicationForm",
        "path": "ClientTreatmentModel.medicationForm",
        "short": "Form of medication (tablet, capsule, liquid, etc.).",
        "definition": "Form of medication (tablet, capsule, liquid, etc.).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ClientTreatmentModel.medicationForm",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "https://nshr-uat.sha.go.ke/fhir/ValueSet/medication-form-vs"
        }
      },
      {
        "id": "ClientTreatmentModel.activeIngredient",
        "path": "ClientTreatmentModel.activeIngredient",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.4"
          }
        ],
        "short": "Active substance in the medication (e.g. paracetamol).",
        "definition": "Active substance in the medication (e.g. paracetamol).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ClientTreatmentModel.activeIngredient",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "https://nshr-uat.sha.go.ke/fhir/ValueSet/kps-medication-vs"
        }
      },
      {
        "id": "ClientTreatmentModel.strength",
        "path": "ClientTreatmentModel.strength",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.5"
          }
        ],
        "short": "Content of active ingredient per dosage unit (e.g. 500 mg/tablet).",
        "definition": "Content of active ingredient per dosage unit (e.g. 500 mg/tablet).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ClientTreatmentModel.strength",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Quantity"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.dosageRegimen",
        "path": "ClientTreatmentModel.dosageRegimen",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.7"
          }
        ],
        "short": "Dosage instructions: quantity, frequency, and duration (e.g. 1 tab every 24h for 10 days).",
        "definition": "Dosage instructions: quantity, frequency, and duration (e.g. 1 tab every 24h for 10 days).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ClientTreatmentModel.dosageRegimen",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.routeOfAdministration",
        "path": "ClientTreatmentModel.routeOfAdministration",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.8"
          }
        ],
        "short": "Path of administration (e.g. oral, intravenous).",
        "definition": "Path of administration (e.g. oral, intravenous).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ClientTreatmentModel.routeOfAdministration",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.treatmentStartDate",
        "path": "ClientTreatmentModel.treatmentStartDate",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.9"
          }
        ],
        "short": "Date to start the treatment or medication.",
        "definition": "Date to start the treatment or medication.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ClientTreatmentModel.treatmentStartDate",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.planOfCare",
        "path": "ClientTreatmentModel.planOfCare",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.10"
          }
        ],
        "short": "Therapeutic recommendations excluding medication: diet, surgery, exercise, etc.",
        "definition": "Therapeutic recommendations excluding medication: diet, surgery, exercise, etc.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ClientTreatmentModel.planOfCare",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.externalReference",
        "path": "ClientTreatmentModel.externalReference",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.11"
          }
        ],
        "short": "External reference to guidelines or other clinical knowledge.",
        "definition": "External reference to guidelines or other clinical knowledge.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ClientTreatmentModel.externalReference",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.relatedWith",
        "path": "ClientTreatmentModel.relatedWith",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.12"
          }
        ],
        "short": "Link to related entries in the Patient Summary (e.g. rare disease).",
        "definition": "Link to related entries in the Patient Summary (e.g. rare disease).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ClientTreatmentModel.relatedWith",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "ClientTreatmentModel",
        "path": "ClientTreatmentModel",
        "short": "KPS.D Treatment",
        "definition": "Logical model for documenting patient treatments under the Kenya Patient Summary (KPS.D) standard."
      },
      {
        "id": "ClientTreatmentModel.medicationReason",
        "path": "ClientTreatmentModel.medicationReason",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.1"
          }
        ],
        "short": "Reason for prescribing or using the medication. May link to past/current conditions.",
        "definition": "Reason for prescribing or using the medication. May link to past/current conditions.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.intendedUse",
        "path": "ClientTreatmentModel.intendedUse",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.2"
          }
        ],
        "short": "Indication for use: prevention, treatment, diagnostic, anaesthesia, equipment care.",
        "definition": "Indication for use: prevention, treatment, diagnostic, anaesthesia, equipment care.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.medicationCode",
        "path": "ClientTreatmentModel.medicationCode",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.3"
          }
        ],
        "short": "Medication that was or is to be administered (coded).",
        "definition": "Medication that was or is to be administered (coded).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.medicationStatus",
        "path": "ClientTreatmentModel.medicationStatus",
        "short": "Current usage status of the medication.",
        "definition": "Current usage status of the medication.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/ValueSet/medicationrequest-status"
        }
      },
      {
        "id": "ClientTreatmentModel.medicationForm",
        "path": "ClientTreatmentModel.medicationForm",
        "short": "Form of medication (tablet, capsule, liquid, etc.).",
        "definition": "Form of medication (tablet, capsule, liquid, etc.).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "https://nshr-uat.sha.go.ke/fhir/ValueSet/medication-form-vs"
        }
      },
      {
        "id": "ClientTreatmentModel.activeIngredient",
        "path": "ClientTreatmentModel.activeIngredient",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.4"
          }
        ],
        "short": "Active substance in the medication (e.g. paracetamol).",
        "definition": "Active substance in the medication (e.g. paracetamol).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "https://nshr-uat.sha.go.ke/fhir/ValueSet/kps-medication-vs"
        }
      },
      {
        "id": "ClientTreatmentModel.strength",
        "path": "ClientTreatmentModel.strength",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.5"
          }
        ],
        "short": "Content of active ingredient per dosage unit (e.g. 500 mg/tablet).",
        "definition": "Content of active ingredient per dosage unit (e.g. 500 mg/tablet).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Quantity"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.dosageRegimen",
        "path": "ClientTreatmentModel.dosageRegimen",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.7"
          }
        ],
        "short": "Dosage instructions: quantity, frequency, and duration (e.g. 1 tab every 24h for 10 days).",
        "definition": "Dosage instructions: quantity, frequency, and duration (e.g. 1 tab every 24h for 10 days).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.routeOfAdministration",
        "path": "ClientTreatmentModel.routeOfAdministration",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.8"
          }
        ],
        "short": "Path of administration (e.g. oral, intravenous).",
        "definition": "Path of administration (e.g. oral, intravenous).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.treatmentStartDate",
        "path": "ClientTreatmentModel.treatmentStartDate",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.9"
          }
        ],
        "short": "Date to start the treatment or medication.",
        "definition": "Date to start the treatment or medication.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.planOfCare",
        "path": "ClientTreatmentModel.planOfCare",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.10"
          }
        ],
        "short": "Therapeutic recommendations excluding medication: diet, surgery, exercise, etc.",
        "definition": "Therapeutic recommendations excluding medication: diet, surgery, exercise, etc.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.externalReference",
        "path": "ClientTreatmentModel.externalReference",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.11"
          }
        ],
        "short": "External reference to guidelines or other clinical knowledge.",
        "definition": "External reference to guidelines or other clinical knowledge.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ClientTreatmentModel.relatedWith",
        "path": "ClientTreatmentModel.relatedWith",
        "code": [
          {
            "system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
            "code": "KPS.D.DE.12"
          }
        ],
        "short": "Link to related entries in the Patient Summary (e.g. rare disease).",
        "definition": "Link to related entries in the Patient Summary (e.g. rare disease).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  }
}