DHIS2 Example FHIR Implementation Guide
1.0.0 - ci-build International flag

DHIS2 Example FHIR Implementation Guide, published by DHIS2. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/JohanGHole/alldevs-demo-ig and changes regularly. See the Directory of published versions

Logical Model: HIVCaseVisitData - Detailed Descriptions

Draft as of 2023-09-28

Definitions for the HIVCaseVisitData logical model.

Guidance on how to interpret the contents of this table can be found here

0. HIVCaseVisitData
Definition

Report filled out during facility visit.

ShortHIV Visit
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVCaseVisitData.visitDate
Definition

Viral load test date

ShortViral load test date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. HIVCaseVisitData.dueDate
Definition

Visit due date

ShortVisit due date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. HIVCaseVisitData.reasonForVisit
Definition

The reason for this visit

ShortThe reason for this visit
Control0..1
BindingFor example codes, see HIV Reasons for Visit Value Set
TypeCoding
8. HIVCaseVisitData.treatmentStarted
Definition

Is the patient currently on treatment

ShortIs the patient currently on treatment
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. HIVCaseVisitData.dateARTInitiation
Definition

Date of ART initiation

ShortDate of ART initiation
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. HIVCaseVisitData.eligibleforTBPreventiveTreatment
Definition

Is patient eligible for preventive treatment

ShortIs patient eligible for preventive treatment
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. HIVCaseVisitData.TPTEligibleDate
Definition

TPT Date Eligible

ShortTPT Date Eligible
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. HIVCaseVisitData.TPTInitiatedDate
Definition

TPT Date Initiated

ShortTPT Date Initiated
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. HIVCaseVisitData.TPTRegimen
Definition

TPT Regimen

ShortTPT Regimen
Control0..1
BindingFor example codes, see HIV TPT Regimen Value Set
TypeCoding
20. HIVCaseVisitData.TPTCompletedDate
Definition

TPT Date Completed

ShortTPT Date Completed
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. HIVCaseVisitData.TPTrestartTreatment
Definition

TPT restart treatment

ShortTPT restart treatment
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. HIVCaseVisitData.treatmentStatus
Definition

Treatment status

ShortTreatment status
Control0..1
BindingFor example codes, see HIV Treatment Status Value Set
TypeCoding
26. HIVCaseVisitData.viralLoadTestDate
Definition

Viral load test date

ShortViral load test date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. HIVCaseVisitData.viralLoadLessThanThousand
Definition

Viral load < 1000

ShortViral load < 1000
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. HIVCaseVisitData.numberOfviralLoadTestResults
Definition

Viral load test results

ShortViral load test results
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. HIVCaseVisitData.previousViralLoadValue
Definition

Previous viral load value

ShortPrevious viral load value
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. HIVCaseVisitData.lastDateWithART
Definition

Last day with ART

ShortLast day with ART
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. HIVCaseVisitData.dateOfDeath
Definition

Date of death

ShortDate of death
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. HIVCaseVisitData.statusChangeDate
Definition

Status change date

ShortStatus change date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. HIVCaseVisitData.currentlyPregnant
Definition

Currently pregnant?

ShortCurrently pregnant?
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. HIVCaseVisitData.daysARTdispensed
Definition

Days of ART provided

ShortDays of ART provided
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. HIVCaseVisitData
Definition

Report filled out during facility visit.

ShortHIV Visit
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVCaseVisitData.visitDate
Definition

Viral load test date

ShortViral load test date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. HIVCaseVisitData.dueDate
Definition

Visit due date

ShortVisit due date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. HIVCaseVisitData.reasonForVisit
Definition

The reason for this visit

ShortThe reason for this visit
Control0..1
BindingFor example codes, see HIV Reasons for Visit Value Set
TypeCoding
8. HIVCaseVisitData.treatmentStarted
Definition

Is the patient currently on treatment

ShortIs the patient currently on treatment
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. HIVCaseVisitData.dateARTInitiation
Definition

Date of ART initiation

ShortDate of ART initiation
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. HIVCaseVisitData.eligibleforTBPreventiveTreatment
Definition

Is patient eligible for preventive treatment

ShortIs patient eligible for preventive treatment
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. HIVCaseVisitData.TPTEligibleDate
Definition

TPT Date Eligible

ShortTPT Date Eligible
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. HIVCaseVisitData.TPTInitiatedDate
Definition

TPT Date Initiated

ShortTPT Date Initiated
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. HIVCaseVisitData.TPTRegimen
Definition

TPT Regimen

ShortTPT Regimen
Control0..1
BindingFor example codes, see HIV TPT Regimen Value Set
TypeCoding
20. HIVCaseVisitData.TPTCompletedDate
Definition

TPT Date Completed

ShortTPT Date Completed
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. HIVCaseVisitData.TPTrestartTreatment
Definition

TPT restart treatment

ShortTPT restart treatment
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. HIVCaseVisitData.treatmentStatus
Definition

Treatment status

ShortTreatment status
Control0..1
BindingFor example codes, see HIV Treatment Status Value Set
TypeCoding
26. HIVCaseVisitData.viralLoadTestDate
Definition

Viral load test date

ShortViral load test date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. HIVCaseVisitData.viralLoadLessThanThousand
Definition

Viral load < 1000

ShortViral load < 1000
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. HIVCaseVisitData.numberOfviralLoadTestResults
Definition

Viral load test results

ShortViral load test results
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. HIVCaseVisitData.previousViralLoadValue
Definition

Previous viral load value

ShortPrevious viral load value
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. HIVCaseVisitData.lastDateWithART
Definition

Last day with ART

ShortLast day with ART
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. HIVCaseVisitData.dateOfDeath
Definition

Date of death

ShortDate of death
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. HIVCaseVisitData.statusChangeDate
Definition

Status change date

ShortStatus change date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. HIVCaseVisitData.currentlyPregnant
Definition

Currently pregnant?

ShortCurrently pregnant?
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. HIVCaseVisitData.daysARTdispensed
Definition

Days of ART provided

ShortDays of ART provided
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. HIVCaseVisitData
Definition

Report filled out during facility visit.

ShortHIV Visit
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVCaseVisitData.visitDate
Definition

Viral load test date

ShortViral load test date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. HIVCaseVisitData.dueDate
Definition

Visit due date

ShortVisit due date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. HIVCaseVisitData.reasonForVisit
Definition

The reason for this visit

ShortThe reason for this visit
Control0..1
BindingFor example codes, see HIV Reasons for Visit Value Set
TypeCoding
8. HIVCaseVisitData.treatmentStarted
Definition

Is the patient currently on treatment

ShortIs the patient currently on treatment
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. HIVCaseVisitData.dateARTInitiation
Definition

Date of ART initiation

ShortDate of ART initiation
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. HIVCaseVisitData.eligibleforTBPreventiveTreatment
Definition

Is patient eligible for preventive treatment

ShortIs patient eligible for preventive treatment
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. HIVCaseVisitData.TPTEligibleDate
Definition

TPT Date Eligible

ShortTPT Date Eligible
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. HIVCaseVisitData.TPTInitiatedDate
Definition

TPT Date Initiated

ShortTPT Date Initiated
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. HIVCaseVisitData.TPTRegimen
Definition

TPT Regimen

ShortTPT Regimen
Control0..1
BindingFor example codes, see HIV TPT Regimen Value Set
TypeCoding
20. HIVCaseVisitData.TPTCompletedDate
Definition

TPT Date Completed

ShortTPT Date Completed
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. HIVCaseVisitData.TPTrestartTreatment
Definition

TPT restart treatment

ShortTPT restart treatment
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. HIVCaseVisitData.treatmentStatus
Definition

Treatment status

ShortTreatment status
Control0..1
BindingFor example codes, see HIV Treatment Status Value Set
TypeCoding
26. HIVCaseVisitData.viralLoadTestDate
Definition

Viral load test date

ShortViral load test date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. HIVCaseVisitData.viralLoadLessThanThousand
Definition

Viral load < 1000

ShortViral load < 1000
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. HIVCaseVisitData.numberOfviralLoadTestResults
Definition

Viral load test results

ShortViral load test results
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. HIVCaseVisitData.previousViralLoadValue
Definition

Previous viral load value

ShortPrevious viral load value
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. HIVCaseVisitData.lastDateWithART
Definition

Last day with ART

ShortLast day with ART
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. HIVCaseVisitData.dateOfDeath
Definition

Date of death

ShortDate of death
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. HIVCaseVisitData.statusChangeDate
Definition

Status change date

ShortStatus change date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. HIVCaseVisitData.currentlyPregnant
Definition

Currently pregnant?

ShortCurrently pregnant?
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. HIVCaseVisitData.daysARTdispensed
Definition

Days of ART provided

ShortDays of ART provided
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension