HL7 FHIR Implementation Guide: Rwanda HIV
0.1.0 - ci-build International flag

HL7 FHIR Implementation Guide: Rwanda HIV, published by Jembi Health Systems. 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/jembi/Rwanda-HIV/ and changes regularly. 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 Initiated Observation

Represents a patient who is initiated on ART.

ART Regimen Switched Or Substituted Observation

Represents a patient whose ARV regimen has been switched to a new ARV regimen or has been substituted by another ARV regimen.

ARV Regimen Change Observation

Represents a patient whose ARV regimen was changed.

ARV Regimen Medication Request

Represents a prescription request for an ARV regimen for a patient.

ARV Treatment CarePlan

Represents a patient’s Antiretroviral Therapy (ART) treatment record, starting from ART initiation.

Adherence to ARV Treatment Observation

Represents a patient’s adherence to ARV treatment.

Breastfeeding Patient Observation

Represents a breastfeeding patient.

Funding Organization

Funding organization.

HIV Lab Order Activity Definition

Represents more specific information regarding the task’s lab order request.

HIV Organization

Organization providing HIV Testing Services.

HIV Patient

Is used to document demographics and other administrative information about a HIV individual receiving care or other health-related services.

HIV Patient Is New Observation

Represents whether this is a new patient.

HIV VL Lab Order Task

Is primarily used to track the progress of a HIV VL lab order. More specifically, the lab order ID for the service request is documented in this profile and is also used to document other key data such as the reason(s) for sample cancellation or rejection and the type of output that, when applicable, will be produced by the task.

HIV VL Lab Result Observation

Represents the result of the VL test.

HIV VL Service Request

Represents the record of request for the HIV VL lab order.

HIV Viral Load Diagnostic Report

Represents the findings and interpretations for a VL test.

Implementing Partner Organization

Implementing partner organization.

Laboratory Report For Viral Load Testing

Logically groups all resources into a single document structure.

Patient Pregnancy Status Observation

Represents the pregnancy status of a patient.

Performing Organization

Organization responsible for carrying out the HIV testing services.

Practitioner

Represents the practitioners: (1) who requested the VL lab order, (2) who must perform the VL examination and (3) who is responsible for interpreting the results.

Reason for HIV testing Observation

Represents the reason for HIV VL testing services.

Receive SMS Messages Consent

Represents a patient’s consent to receive Short Message Service (SMS) messages.

Repeat HIV VL Lab Result Observation

Represents the result of the repeat VL test.

Requesting Organization

Organization requesting for HIV testing services.

Result Dispatched

Represents the transport request for the VL examination result to be returned to the requesting facility.

Sample Dispatched

Represents the transport request for the VL specimen to be sent to the lab.

Specimen Conservation

Is used to store specimen conservation data for the VL lab order. In other words, this profile is useful for documenting the ideal preservation and/or transportation temperatures (low/high) of the specimen before it gets tested. In addition, this resource is used to document the maximum preservation time for these temperatures and also includes preservation instructions.

Suspended Treatment HIV VL Lab Result Observation

Represents the result of the VL test for patient's who suspended treatment.

Target Facility Encounter

Represents the current facility at which the patient is receiving health services.

Testing Platform

The device platform used for testing.

Transport Location

Represents the names of the requested and current locations associated with the transport activity (VL specimen sent to lab, VL result returned to facility).

Viral Load Log Observation

Represents the log value for the routine VL test result.

Viral Load Result Absolute Decimal Observation

Represents the absolute decimal value for the routine VL test result

Viral Load Specimen

Represents the VL test sample that was collected for the service request.

Structures: Extension Definitions

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

Clinician User Index

The user index for the person who is requesting or performing the service request.

Funding Organization

The index for the funding organization.

HIV Lab Task Approved By

The user index for the person who approved the HIV lab task.

HIV Lab Task Reviewed By

The user index for the person who reviewed the HIV lab task.

HIV Viral Load Result Revised By

The user index for the person who reviewed the viral load result.

HIV Viral Load Result Tested By

The user index for the person who tested the viral load specimen.

Implementing Partner Organization

The index for the implementing partner organization.

Patient Age In Months

Age of the patient calculated in months.

Patient Age In Years

Age of the patient calculated in years.

Performing Organization District

The district index for the performing organization.

Performing Organization Province

The province index for the performing organization.

Result Status Index

The result status index.

Sample Rejected Index

The sample rejection index.

Sample reordered

An indication whether the sample was reordered.

Test Result Entered Manually

An indication whether the test result was entered manually.

Terminology: Value Sets

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

ARV Regimen

A list of ARV regimen.

Adherence to ARV Treatment

Adherence to ARV Treatment.

HIV Test Types

A list of HIV test types.

Lab Order Reasons For Cancelling/Rejecting Lab Order

Reasons why a lab order was cancelled or rejected.

Patient Consent for SMS Notifications

Patient Consent for SMS Notifications

Patient Pregnant

Used by the observation to indicate whether a patient is pregnant.

Reason for Assessment or Test Not Performed

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

Reasons for ARV Regimen Change

Used by the ARV treatment careplan to indicate the reason why a patient had their ARV regimen changed.

Specimen Type Used In Viral Load testing

A list of specimen types.

Viral Load Suppressions Status

Describes a patient's current viral load status.

Terminology: Code Systems

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

Laboratory Report Organization Information Codes

Used by the relevant section defintions in the Composition resource.

Laboratory Report Specimen Information Codes

Used by the relevant section defintions in the Composition resource.

Laboratory Report Specimen Transportation Codes

Used by the relevant section defintions in the Composition resource.

VLSMS Provided Reasons For Cancelling/Rejecting Lab Order

Reasons why a lab order was cancelled or rejected.

VLSMS Provided Reasons For Testing

Reasons why a sample will be tested.

Example: Example Instances

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

ART Initiated Observation

Represents a patient who is initiated on ART.

ART Regimen Switched Or Substituted Observation

Represents a patient whose ARV regimen has been switched to a new ARV regimen or has been substituted by another ARV regimen.

ARV Regimen Change Observation

Represents a patient whose ARV regimen was changed.

ARV Regimen Medication Request

Represents a prescription request for a patient's ARV. This resource will be used for ART initiated patient's as well as for routine ARV prescriptions.

ARV Regimen Medication Request

Represents a prescription request for a patient whose ARV regimen was changed.

ARV Treatment CarePlan

Represents an ARV CarePlan for a patient on ART. This resource will be used for ART initiated patient's as well as for routine ARV prescriptions.

ARV Treatment CarePlan

Represents an ARV CarePlan for a patient whose regimen was changed.

Adherence to ARV Treatment Observation

Represents a patient’s adherence to ARV treatment.

Breastfeeding Patient Observation

Represents a breastfeeding patient.

Funding Organization

Funding organization.

HIV Lab Order Activity Definition

Represents more specific information regarding the task’s lab order request EXCLUDING specimenRequirement Reference.

HIV Lab Order Activity Definition

Represents more specific information regarding the task’s lab order request INCLUDING specimenRequirement Reference.

HIV Patient

Is used to document demographics and other administrative information about a HIV individual receiving care or other health-related services.

HIV Patient Is New Observation

Represents whether this is a new patient.

HIV VL Lab Order Task

Represents HIV Lab Order Cancellation.

HIV VL Lab Order Task

Represents HIV Lab Order Rejection

HIV VL Lab Order Task

Represents a New Lab Order.

HIV VL Lab Order Task

Represents a Lab Result.

HIV VL Lab Result Observation

Represents the result of the VL test.

HIV VL Service Request

Represents the record of request for the HIV VL lab order.

HIV Viral Load Diagnostic Report

Represents the findings and interpretations for a VL test.

Implementing Partner Organization

Implementing partner organization.

Lab Result Bundle

Represents a Lab Result Bundle.

Laboratory Report For Viral Load Testing

Logically groups all resources into a single document structure.

Organization

Represents an organization associated with health services.

Patient Pregnancy Status Observation

Represents the pregnancy status of a patient.

Performing Organization

Organization responsible for carrying out the HIV testing services.

Practitioner

Represents the practitioner who is responsible for the observation.

Practitioner

Represents the practitioner who must perform the VL examination.

Practitioner

Represents the practitioner who requested the VL lab order.

Practitioner

Represents the practitioner who is responsible for interpreting the results.

Reason for HIV testing Observation

Represents the reason for HIV VL testing services.

Receive SMS Messages Consent

Represents an indication that a patient does not consent to receiving SMS messages.

Receive SMS Messages Consent

Represents an indication that a patient does consent to receiving SMS messages.

Repeat HIV VL Lab Result Observation

Represents the result of the repeat VL test.

Requesting Organization

Organization requesting for HIV testing services.

Result Dispatched

Represents the transport request for the VL examination result to be returned to the requesting facility.

Sample Dispatched

Represents the transport request for the VL specimen to be sent to the lab.

Specimen Conservation

Is used to store specimen conservation data for the VL lab order. In other words, this profile is useful for documenting the ideal preservation and/or transportation temperatures (low/high) of the specimen before it gets tested. In addition, this resource is used to document the maximum preservation time for these temperatures and also includes preservation instructions.

Suspended Treatment HIV VL Lab Result Observation

Represents the result of the VL test for patient's who suspended treatment.

Target Facility Encounter

Represents the current facility at which the patient is receiving health services.

Testing Platform

The device platform used for testing.

Transport Location

Represents the name of the current location associated with the transport activity.

Transport Location

Represents the name of the requested location associated with the transport activity.

VLSMS VL Request Bundle

Represents the VLSMS VL Request Bundle (Document Type).

VLSMS VL Request Bundle

Represents the VLSMS VL Request Bundle (Transactional Type).

VLSMS VL Result Bundle

Represents the VLSMS VL Result Bundle.

Viral Load Log Observation

Represents the log value for the routine VL test result.

Viral Load Result Absolute Decimal Observation

Represents the absolute decimal value for the routine VL test result

Viral Load Specimen

Represents the VL test sample that was collected for the service request.