Ethiopia HIV IG (sandbox demo subset)
0.1.0 - ci-build

Ethiopia HIV IG (sandbox demo subset) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Artifacts Summary

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

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

CurrentlyOnPrEP
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

ExposureSourceObservation
HIV ART Medication Dispense

Dispensing of antiretroviral medication in the national HIV program.

HIV ART Medication Statement

A statement that an HIV-program patient is (or was) on a given antiretroviral therapy regimen.

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 Encounter

An encounter within the national HIV program (testing, treatment, or follow-up visit) for an HIV-program patient.

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 Document Bundle

A FHIR document bundle (not a transaction) used to submit a coherent, point-in-time HIV-program record — a clinical document whose first entry is an HIVDocumentComposition that indexes the patient, encounter, dispenses and observations that follow.

Because type = document, base FHIR enforces that the first entry is a Composition, that every entry carries a fullUrl, and that the bundle has an identifier and timestamp (invariants bdl-9/10/11). This profile pins those expectations explicitly for the HIV program.

HIV Program Document Composition

Header/index for an HIVDocumentBundle: identifies the subject and the clinical content that follows.

HIV Program Patient

Patient profile for individuals enrolled in the national HIV program

HIV Program QuestionnaireResponse

A completed questionnaire in the national HIV program (e.g. ART eligibility / intake screening) for an HIV-program patient.

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 Self-test Result profile.

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

HIV Testing Services Encounter.

HIVARTMedicationRequest
HIVAdherenceObservation
HIVCD4Observation
HIVCarePlan
HIVCondition
HIVConsent
HIVExposureDateTime
HIVFollowUpAppointment
HIVLabReport
HIVLibrary
HIVMeasure
HIVPositiveConfirmedDateObservation
HIVPositiveConfirmedSiteObservation
HIVStatusObservation
HIVTestResult
HIVTestResultObservation
HIVTestingServiceRequest
HIVTransmissionRouteObservation
History of HIV Self-Testing

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

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

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
PrEP Encounter

Encounter profile for PrEP/PEP services.

PrEP Visit Observation

Indicates attendance of a scheduled PrEP visit by interval.

PrEPDosingType
Prevention Services Offered and Referrals

Indicates HIV prevention services offered and referrals provided to the client

Suspected HIV Exposure (Boolean)

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

Suspected HIV Exposure Observation

Indicates contact with and suspected exposure to HIV.

Structures: Extension Definitions

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

Reason for PrEP Visit

Reason for PrEP Visit extension.

Terminology: Value Sets

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

ART Adherence Value Set

Value set for documenting ART adherence

ART Regimen Value Set

Antiretroviral therapy regimens dispensed in the Ethiopia HIV program.

HIV Assay Number

Permitted assay numbers in HIV testing strategy

HIV Assay Result

Allowed HIV assay results

HIV Condition Value Set

Value set representing HIV-related conditions and statuses

HIV Prevention Services and Referrals

Value set of HIV Prevention Services and Referrals values.

HIV Self-test Result ValueSet

Value set of HIV Self-test Result values.

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
HTS Service Types ValueSet

Value set for HTS service delivery types.

Key Population Type ValueSet

Value set of Key Population Type values.

Other Clinical Services Offered

Value set of Other Clinical Services Offered values.

Other Support Services

Value set of Other Support Services values.

Partner Contact Type ValueSet

Value set of Partner Contact Type values.

Partner High Risk Category ValueSet

Value set of Partner High Risk Category values.

Partner Services Referral ValueSet

Value set of Partner Services Referral values.

PrEP Dosing Type ValueSet

Value set of PrEP Dosing Type values.

PrEP Visit Interval ValueSet

Value set of PrEP Visit Interval values.

PrEP Visit Reason ValueSet

Value set of PrEP Visit Reason values.

Source of Exposure ValueSet

Value set of Source of Exposure values.

Ways of HIV Exposure

Ways in which the client was exposed to HIV

Terminology: Code Systems

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

ART Regimen Code System

National antiretroviral therapy (ART) regimen codes used by the Ethiopia HIV program, mirroring the codes recorded on the national ART register. Demo subset — to be expanded.

ExposureSourceCS
HIV ART Adherence Code System

Codes representing the client's adherence to ART treatment

HIV Assay Number

Assay sequence in HIV testing strategy

HIV Assay Result

Result of HIV assay

HIV Condition Code System

Clinical HIV-related conditions and diagnoses

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

Code system of 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

Code system of HIV Testing Reason codes.

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
HTS Service CodeSystem

Codes for HIV Testing Services (HTS) service types.

Key Population Type Codes

Code system of Key Population Type codes.

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

Code system of Partner HIV Status codes.

Partner High Risk Category Codes

Code system of Partner High Risk Category codes.

Partner Services Referral Codes

Codes for referral through partner services

PrEP Dosing Type CodeSystem

Code system of PrEP Dosing Type codes.

PrEP Visit Interval CodeSystem

Represents scheduled PrEP visit intervals.

PrEP Visit Reason CodeSystem

Codes representing reasons for PrEP/PEP visits.