HIV Case-Based Surveillance
0.2.0 - CI Build International flag

HIV Case-Based Surveillance, published by Jembi Health Systems. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/openhie/HIV-CBS and changes regularly. See the Directory of published versions

Artifacts Summary

Contents:

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.

Patient

A patient resource for an HIV Patient
Lab Results

The result of the lab test which determines whether the patient is infected with HIV or not.
HIV Recency Test

This profile is to record the HIV recency testing data for a patient.
ARV Treatment

This profile is to record prescribed ARV regimen against a given therapeutic line.
Practitioner

The healthcare professional who has been assigned to a given lab task.
HIV Care Medication Request

This profile is for recording the Patient’s ARV Dispensing quantity in days.
Lab Order Request Location

What is the location of the organization responsible for conducting the examination of the individual’s sample?
Patient Enrollment Type

This profile is used to enrol the patient into HIV care.
HIV Organization Patient Is Transferred To

Organization who is receiving the patient as being transferred in.
Absolute CD4 Count

This profile is for recording the Patient’s CD4 Count.
Date HIV Test Done

This profile is to record the date when HIV test was done for a patient.
Lab Task

Assists with tracking the state of the lab order and its completion status.
HIV Recency Test Result

This profile is to record the HIV recency test result data for a patient.
Patient Death

This profile captures the death outcome for a patient.
HIV Organization

Organization providing HIV Testing Services.
Lab Order

A service request that initiates the need for the lab to collect the test sample.
Diagnostic Report

A report as a result of the lab task being completed.
Diagnosis

This profile represents the confirmation of HIV diagnosis.
Target Facility Encounter

This profile represents the current facility at which the patient is receiving treatment.
CD4 Percentage

This profile is for recording the patient’s CD4 percentage.
Transferred Out Service Request

A service request that initiates the need for a patient to be transferred to another organization.
Transferring Facility Encounter

This profile represents the facility the patient is being transferred from.
Viral Load Specimen

The test sample that was collected for the initiated lab order.

Structures: Extension Definitions

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

Next Appointment Date

A date representing the patient’s next scheduled appointment.
Key HIV Population

Populations who are at higher risk for HIV.
ART Regimen Switched Or Substituted

The ARV regimen has been switched to a new ARV regimen or has been substituted by another ARV regimen.
ART Regimen Line

Therapeutic lines that are used to classify the patient’s currently prescribed ARV regimen.

Terminology: Value Sets

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

Key Population Status

A list of key population types
ART Regimen Change Types

A list of options to determine whether an ARV regimen was switched or substituted.
Recency HIV Test

Used by the observation to indicate that a HIV recency test was performed.
Viral Load Result Code

A code used to indicate the category for the lab result.
ART Regimen Lines

A list of ART regimen therapeutic lines.
Specimen Type Used In Viral Load testing

A list of specimen types.
Death

A list of possible HIV deaths
ARV treatment outcomes

A list of possible ARV treatment outcomes.
CD4 test result code

A list of CD4 test result codes
Reason for Assessment or Test Not Performed

A list of reasons associated with the service request for the lab order.
CD4 percentage code

A list of CD4 percentage codes
HIV Test Done

Used by the observation to indicate that a HIV test was performed.
A list of ARV regimen

A list of ARV regimen.
ARV Treatment Medication Request

Codes used to represent a medication request for ART.
Yes No Unknown

A list of options used to provide an answer
Causes of Death

A list of possible HIV causes of deaths
HIV Recency Testing Status

A list of HIV recency statuses
Reasons why a lab order was cancelled or rejected

Reasons why a lab order was cancelled or rejected.
Test Types

A list of HIV test types
Conditions

A list of possible HIV conditions.
Viral Load Suppressions Status

Describes a patient’s current viral load status.
Recency HIV Test Result

A list of HIV recency test result codes.
Transferred out

Transferred out codes

Terminology: Code Systems

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

Key Population Status

A list of key population types
ART Regimen Change Types

A list of options to determine whether an ARV regimen was switched or substituted.

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 Practitioner - PractitionerExample
Example CarePlan - ARVTreatmentExample
Example MedicationRequest - HIVCareMedicationRequestExample
Example Observation - CD4TestResultExample
Example Bundle - LabOrder
Example Organization - HIVOrganizationExample
Example Encounter - TransferringFacilityEncounterExample
Example Observation - CD4PercentageExample
Example Encounter - TargetFacilityEncounterExample
Example CarePlan - ARVTreatmentRefusedExample
Example Observation - DateHIVTestDoneExample
Example Bundle - LabRejection
Example ServiceRequest - TransferredOutServiceRequestExample
Example Bundle - LabCancellation
Example Observation - HIVRecencyTestDoneExample
Example Observation - DeathExample
Example Organization - HIVServiceRequestLocationExample
Example CarePlan - ARVTreatmentContactedExample
Example Bundle - LabResult
Example Patient - HIVPatientExample
Example Task - HIVLabOrderTaskExample
Example Condition - HIVDiagnosisExample
Example Observation - HIVTestResultExample
Example Bundle - EMR
Example Task - HIVLabResultTaskExample
Example Task - HIVLabOrderRejectionTaskExample
Example Task - HIVLabOrderCancellationTaskExample
Example DiagnosticReport - HIVLabResultsDiagnosticReportExample
Example ServiceRequest - HIVServiceRequestExample
Example CarePlan - ARVTreatmentRegimenSwitchedOrSubstitutedExample
Example EpisodeOfCare - HIVEpisodeOfCareExample
Example Specimen - VLSpecimenExample
Example Organization - HIVOrganizationPatientTransferredToExample
Example Observation - HIVRecencyTestResultExample