SIL HIE Implementation Guide
0.1.0 - sil-hie-active
SIL HIE Implementation Guide, published by Kathurima Kimathi. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/hie-fhir-ig-profile/ and changes regularly. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These define constraints on FHIR resources for systems conforming to this implementation guide.
| HIE AllergyIntolerance |
R4B AllergyIntolerance constrained for HIE capture and exchange. |
| HIE Appointment |
R4B Appointment constrained for HIE scheduling, requiring clear status, timing, participants, and reason context. |
| HIE AppointmentResponse |
R4B AppointmentResponse constrained for HIE scheduling responses, requiring clear linkage to the appointment, a well-typed actor, and a participant status. |
| HIE Claim |
R4B Claim constrained for HIE submission and exchange. Emphasizes core administrative data, patient, provider, insurer, billable period, coverage, diagnosis, items, and totals. |
| HIE ClaimResponse |
R4B ClaimResponse constrained for HIE payer adjudication exchanges. Focus on request linkage, parties, outcome, adjudication details, totals, and payment. |
| HIE Condition |
R4B Condition constrained for HIE capture and exchange. |
| HIE Consent |
R4B Consent profiled for HIE workflows, emphasizing clear scope, category, subject, policy, and computable provisions. |
| HIE DiagnosticReport |
R4B DiagnosticReport constrained for HIE capture and exchange. |
| HIE DocumentReference |
R4B DocumentReference constrained for HIE exchange. Requires strong typing, subject linkage, and well-formed attachments. |
| HIE Encounter |
An interaction between a patient and healthcare providers to deliver services or assess health status. |
| HIE EpisodeOfCare |
EpisodeOfCare is the representation of EpisodeOfCare FHIR resource to be used with national HIE |
| HIE Medication |
R4B Medication profiled for HIE directories, e-prescribing, and dispensing. Focus on stable identifiers, clinical code, status, form, ingredients with strength, manufacturer, and batch. |
| HIE MedicationDispense |
R4B MedicationDispense for HIE fulfillment. Focus on status, medication, subject, authorship, quantity, daysSupply, timing, performer, prescription linkage, and substitution. |
| HIE MedicationRequest |
R4B MedicationRequest constrained for HIE ordering and e-prescribing. Focus on status, intent, medication, subject, timing, requester, reasons, dosage, dispense, substitution, and coverage. |
| HIE Observation |
Observation is a Kenya HIE representation of Observation FHIR resource to be used within KHIE |
| HIE Organization |
Organization profile for with shared core rules |
| HIE Patient |
R4B Patient constrained for HIE workflows. |
| HIE Practitioner |
R4B Practitioner constrained for HIE directories and clinical attribution. Focus on identifiers, name, telecom, gender, qualifications, and communication. |
| HIE PractitionerRole |
R4B PractitionerRole for HIE directories, scheduling, and attribution. Emphasizes identifiers, practitioner, organization, role codes, specialties, service locations, telecom, and availability. |
| HIE Questionnaire |
R4B Questionnaire profiled for HIE data capture. Emphasizes status, metadata, subject typing, stable linkIds, clear item typing, conditional logic, and controlled answer options. |
| HIE QuestionnaireResponse |
R4B QuestionnaireResponse profiled for HIE capture. Emphasizes linkage to Questionnaire, subject and encounter context, authorship, and structured item answers. |
| HIE ServiceRequest |
R4B ServiceRequest constrained for HIE ordering and referral. Emphasizes status, intent, code, subject, reasons, timing, requester, performers, and context. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| HIE Annotation |
A text note with author and time. |
| HIE CodeableConcept |
A CodeableConcept for HIE use. Codes are required, text is optional. |
| HIE CodeableReference |
A CodeableReference constrained for HIE use. |
| HIE ContactPoint |
A custom contact point with stricter cardinality |
| HIE HumanName |
A specialized human name data type with stricter cardinalities. |
| HIE Reference |
A Reference that is resolvable, with display for UX. |
These define sets of codes used by systems conforming to this implementation guide.
| All ICD-11 codes |
All codes from ICD-11 |
| Episode of Care Service Types |
EpisodeOfCare service types used in HIE |
| HIE Condition Severity |
Local ValueSet of condition severity. |
| HIE Person Identifier Types |
Identifier types used to identify a person (patient, practitioner, animal, etc.) in the wider HIE system |
| Organization Identifier Types |
Identifier types used to identify healthcare organizations in HIE |
| Route Of Administration |
A ValueSet defining the possible routes of drug administration. |
These define new code systems used by systems conforming to this implementation guide.
| HIE Condition Severity Codes |
Local severity codes. |
| HIEIdentifierCodeSystem | |
| HIEServiceTypesCodeSystem |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| Example HIE AllergyIntolerance |
Peanut allergy with urticaria reaction |
| Example HIE Appointment |
Booked outpatient consultation, 30 minutes, with participant roles and clinical reason |
| Example HIE AppointmentResponse |
HIEPractitioner accepts a booked appointment window |
| Example HIE Claim |
Outpatient professional claim with one diagnosis and one item |
| Example HIE ClaimResponse |
Adjudication response for outpatient consult with approved payment |
| Example HIE Condition |
Encounter diagnosis of headache, moderate severity |
| Example HIE DiagnosticReport |
CBC panel with key hematology results |
| Example HIE DocumentReference |
Discharge summary PDF for outpatient encounter |
| Example HIE Encounter |
Ambulatory encounter for headache |
| Example HIE Medication |
Amoxicillin 500 mg oral capsule, active, with ingredient strength, manufacturer, and batch |
| Example HIE MedicationDispense |
Dispense of amoxicillin 500 mg capsules, completed, no substitution |
| Example HIE MedicationRequest |
E-prescription for Amoxicillin 500 mg capsules, outpatient treatment for acute otitis media |
| Example HIE Patient |
R4B patient record for HIE workflows |
| Example HIE Practitioner |
Licensed general medical practitioner with directory details |
| Example HIE PractitionerRole |
Cardiologist at Acme Health Center, available weekdays |
| Example HIE Questionnaire |
HIE questionnaire for demographics, symptoms, and visit intent |
| Example HIE QuestionnaireResponse |
Completed intake form for ambulatory visit |
| Example HIE ServiceRequest |
Outpatient lab order for Complete Blood Count, fasting serum sample |
| Example Kenya EpisodeOfCare |
Example EpisodeOfCare instance conforming to EpisodeOfCare profile |
| Example Kenya Observation |
Example instance conforming to the HIEObservation profile |
| ExampleOrganizationR4B |
An example Organization resource conforming to the OrganizationR4B profile. |