Ethiopia Base Implementation Guide
0.1.0 - ci-build International flag

Ethiopia Base Implementation Guide, published by MOH Ethiopia. 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/MoH-Ethiopia/ETBase/ and changes regularly. See the Directory of published versions

Artifact Index

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

ART Start Date

Date when antiretroviral therapy was initiated

Accepted social network-based/partner services

Indicates whether the client accepted partner or social network-based services

Adolescent Girl Indicator

Indicates whether the client is an adolescent girl

Chlamydia trachomatis Test Type Observation

Type of Chlamydia trachomatis test performed

Clinical Enquiry for Intimate Partner Violence (IPV)

Indicates whether clinical enquiry for intimate partner violence (IPV) was conducted

Confirmatory STI Test Result Observation

Captures confirmatory STI result and treatment details

Confirmatory Syphilis Test Observation

Captures syphilis confirmatory test type and related details

Counselling Provided

Indicates types of counselling provided to the client

Count of contacts or partners given for social network/partner services

Number of contacts or partners elicited for partner notification or social network-based services

Date HIV Test Sent

Date when the HIV test specimen was sent to the laboratory

Date of First HIV Positive Test

Date of first positive test indicative of HIV diagnosis

Ethiopian Master Facility Registry Location

Physical service delivery locations registered in the Ethiopian MFR.

Ethiopian patient profile

This profile represents a standard Ethiopian patient, applicable across all use cases and health information systems.

EthiopianMfrOrganization
EthiopianMfrOrganizationAffiliation
Expected Date of Delivery (EDD)

Estimated date when the patient is expected to deliver

Gestational Age

Gestational age in weeks (and optionally days)

Gonorrhoea Testing and Treatment

Captures gonorrhoea test date, specimen type, test result, treatment start date, and other specimen specification

HIV Assay Number

Assay number used in HIV testing strategy

HIV Client Informed of Result

Indicates whether the client has been informed of their HIV test result.

HIV Diagnosis Date

Date when HIV diagnosis was established

HIV Diagnosis Facility

Facility where the client received an HIV-positive diagnosis

HIV Exposure Ways Observation

Records ways in which the client was exposed to HIV

HIV Partner / Contact Person

Represents a partner or contact identified during HIV testing services

HIV Program Patient

Patient profile for individuals enrolled in the national HIV program

HIV Retest and Risk Assessment

Captures whether HIV retesting prior to ART initiation was conducted and whether the client is at elevated risk for HIV acquisition

HIV Self-test Result
HIV Serotype

Type of HIV infection (HIV-1 or HIV-2)

HIV Test Conducted (Boolean)

Indicates whether an HIV test was conducted

HIV Test Ordered (Boolean)

Indicates whether an HIV test was ordered

HIV Test Type

Type of HIV test performed

HIV Testing Services Encounter
HIVPositiveConfirmedDateObservation
HIVPositiveConfirmedSiteObservation
HIVStatusObservation
HIVTestResultObservation
HIVTransmissionRouteObservation
Herpes Simplex Virus (HSV) Test Type Observation

Type of Herpes simplex virus (HSV) test performed

History of HIV Self-Testing

Indicates whether the client reported having used an HIV self-test before

IPV Enquiry Result

Outcome of intimate partner violence enquiry

Infant Breastfeeding Status

Indicates whether the infant is currently being breastfed by the mother

Key Population Member Type

Specifies the type of key population the client belongs to

Key Population Membership

Indicates whether the client is a member of a key population with increased risk of HIV

Mycoplasma genitalium Test Type Observation

Type of Mycoplasma genitalium test performed

Neisseria gonorrhoeae Test Type Observation

Type of Neisseria gonorrhoeae test performed

Offered Voluntary Partner Services

Indicates whether voluntary partner services were offered

Offered social network-based/partner services

Indicates whether partner or social network-based services were offered

Other Clinical Services Offered

Indicates other clinical services offered to the client

Other Support Services

Indicates other support services provided to the client

Partner HIV Status

HIV status of the client's partner

Partner High Risk Population Category

Indicates whether the client's partner belongs to a high-risk population

Partner Notification and Disclosure Status

Captures HIV status disclosure and notification planning for partner services

PartnerHIVTestConductedObservation
PartnerHIVTestDateObservation
PartnerHIVTestOrderedObservation
PartnerHIVTestResultObservation
PartnerOnARTObservation
PartnerViralSuppressionObservation
Pregnancy Status (Boolean)

Indicates whether the client is currently pregnant

Prevention Services Offered and Referrals

Indicates HIV prevention services offered and referrals provided to the client

STI Test Result Observation

Observation for STI test result with confirmatory test date

STI Testing and Diagnosis

Captures whether any STI syndrome was diagnosed, date of STI test, and STI(s) tested for

Sexual and Reproductive Health Integrated Services

Indicates SRH integrated services provided to the client

Suspected HIV Exposure (Boolean)

Indicates whether the client is reported to have had suspected exposure to HIV

Syndrome/STI Diagnosed

Captures the syndrome or STI diagnosed, including option to specify other conditions

Syphilis Test Type Observation

Type of syphilis test performed

Syphilis Testing and Treatment

Captures syphilis test date, test result, and treatment initiation date

Trichomonas vaginalis Test Type Observation

Type of Trichomonas vaginalis test performed

Type of Follow-Up

Captures follow-up type, recommended date, scheduled appointment date/time, and additional details

VMMC Adverse Events

Captures adverse events following VMMC, including severity, timing, seriousness, and date

VMMC Procedure

Indicates whether Voluntary Medical Male Circumcision (VMMC) procedure was performed

VMMC Procedure Date

Captures the date/time when the VMMC procedure was performed

Young Woman Indicator

Indicates whether the client is a young woman

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Address Kebele

Administrative sub-district (Kebele) within a Woreda.

Address Ketena/Gott

Administrative subdivision within a Kebele, also called Ketena or Gott.

Address Zone

Administrative zone within a state or region.

Community Entry Point
ConfirmedSite
Consent to Receive Family Planning Follow-up Messages

Indicates whether the client consents to receive SMS or other messages for family planning follow-up

Consent to be Contacted

Indicates whether the patient consents to be contacted for follow-up or program communication

Date of Birth Estimated

Indicates whether the date of birth is estimated rather than exact.

Educational Status

Extension to record the educational status of the patient

Facility Created Date

Date the facility was registered or created in the Ethiopian Master Facility Registry.

Facility Entry Point
Grandfather's Family Name

The family name of the person's grandfather.

Occupation Extension

Extension to record the occupation of the patient

Preferred Contact Method

Patient’s preferred communication channel.

Referred through partner services

Indicates whether the client was referred through partner services and the type of referral

Reporting Hierarchy ID

Identifier for reporting hierarchy

ReportingHierarchyExtension
cachment Area

Catchment area of the HIV patient (such as villages, districts, etc)

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Chlamydia trachomatis Test Type Value Set

Allowed values for Chlamydia trachomatis test types

Confirmatory Syphilis Test Type ValueSet

Value set for confirmatory syphilis test types

Counselling Provided
Ethiopia Education Status ValueSet

ValueSet containing all education status codes used in Ethiopia

Ethiopia Gender ValueSet

A ValueSet containing only male and female genders

Ethiopia Marital Status ValueSet

Subset of HL7 v3 MaritalStatus including only Never married, Married, Divorced, and Widowed.

Ethiopia Occupation ValueSet

ValueSet containing all occupation codes used in Ethiopia

Ethiopia State / Region ValueSet

Allowed list of Ethiopian states and city administrations.

Facility Entry Point ValueSet

ValueSet for facility entry points

Follow-Up Types
Gonorrhoea Specimen Type
Gonorrhoea Test Result
HIV Assay Number

Permitted assay numbers in HIV testing strategy

HIV Assay Result

Allowed HIV assay results

HIV Prevention Services and Referrals
HIV Self-test Result ValueSet
HIV Serotype

HIV serotype classification

HIV Test Type

Permitted HIV test types

HIV Testing Entry Point ValueSet

ValueSet of HIV Testing Service entry points

HIV Testing Reason ValueSet

Reasons for HIV testing

HIVStatusVS
HIVTestResultVS
HIVTransmissionRouteVS
Herpes Simplex Virus Test Type Value Set

Allowed values for Herpes simplex virus (HSV) test types

IPV Enquiry Result
Key Population Type ValueSet
Mycoplasma genitalium Test Type Value Set

Allowed values for Mycoplasma genitalium test types

Neisseria gonorrhoeae Test Type Value Set

Allowed values for Neisseria gonorrhoeae test types

Other Clinical Services Offered
Other Support Services
Partner Contact Type ValueSet
Partner High Risk Category ValueSet
Partner Services Referral ValueSet
Preferred Contact Method Value Set
STI Test Result ValueSet

Value set for STI test results

STI Tested For
Sexual and Reproductive Health Integrated Services
Syndrome/STI Diagnosed
Syphilis Test Result
Syphilis Test Type Value Set

Allowed syphilis test type values

Timing of VMMC Adverse Event
Trichomonas vaginalis Test Type Value Set

Allowed values for Trichomonas vaginalis test types

VMMC Adverse Event Severity
Ways of HIV Exposure

Ways in which the client was exposed to HIV

community Entry Point ValueSet

ValueSet for community entry points

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Chlamydia trachomatis Test Type Code System

Codes for Chlamydia trachomatis test types

Confirmatory Syphilis Test Type CodeSystem

Codes for confirmatory syphilis test types

Counselling Provided

Types of counselling provided to client

Ethiopia Education Status CodeSystem

CodeSystem representing the educational status categories used in Ethiopia

Ethiopia Occupation CodeSystem

CodeSystem representing the occupation categories used in Ethiopia

Ethiopia State / Region CodeSystem

Administrative states and city administrations of Ethiopia

Follow-Up Type Codes
Gonorrhoea Specimen Types
Gonorrhoea Test Result Codes
HIV Assay Number

Assay sequence in HIV testing strategy

HIV Assay Result

Result of HIV assay

HIV Exposure Ways CodeSystem

Codes representing possible HIV exposure routes

HIV Prevention Services and Referrals

Prevention services offered and referrals provided

HIV Self-test Result Codes
HIV Serotype Codes

Codes for HIV-1 and HIV-2

HIV Test Type Codes

Types of HIV tests

HIV Testing Entry Point CodeSystem

Defines entry points for HIV Testing Services

HIV Testing Reason CodeSystem
HIV Testing for community entry point CodeSystem

Defines entry points for community entry point

HIV Testing for facility entry point CodeSystem

Defines entry points for facility entry point

HIVStatusCS
HIVTestResultCS
HIVTransmissionRouteCS
Herpes Simplex Virus Test Type Code System

Codes for Herpes simplex virus (HSV) test types

IPV Enquiry Result

Results of intimate partner violence enquiry

Key Population Type Codes
Mycoplasma genitalium Test Type Code System

Codes for Mycoplasma genitalium test types

Neisseria gonorrhoeae Test Type Code System

Codes for Neisseria gonorrhoeae test types

Other Clinical Services Offered

Other clinical services offered to the client

Other Support Services

Support services provided to the client

Partner Contact Type Codes

Types of contacts or partners for partner services

Partner HIV Status Codes
Partner High Risk Category Codes
Partner Services Referral Codes

Codes for referral through partner services

Prefered contact CodeSystem

CodeSystem representing the Prefered Contact

STI Test Result CodeSystem

Codes for STI test results

STI Test Types
Sexual and Reproductive Health Integrated Services

Types of SRH integrated services provided

Syndrome/STI Codes
Syphilis Test Result Codes
Syphilis Test Type Code System

Codes for syphilis test types

Timing of Adverse Event
Trichomonas vaginalis Test Type Code System

Codes for Trichomonas vaginalis test types

VMMC Adverse Event Severity Codes

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Example Ethiopian Patient

Example instance conforming to the Ethiopian Patient profile

ExampleChlamydiaTrachomatisTestType
ExampleHSVTestType
ExampleMycoplasmaGenitaliumTestType
ExampleNeisseriaGonorrhoeaeTestType
ExampleSyphilisTestType
ExampleTrichomonasVaginalisTestType