DHIS2 Example FHIR Implementation Guide
1.0.0 - ci-build
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
| 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. |
| Short | HIV Visit |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. HIVCaseVisitData.visitDate | |
| Definition | Viral load test date |
| Short | Viral load test date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. HIVCaseVisitData.dueDate | |
| Definition | Visit due date |
| Short | Visit due date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. HIVCaseVisitData.reasonForVisit | |
| Definition | The reason for this visit |
| Short | The reason for this visit |
| Control | 0..1 |
| Binding | For example codes, see HIV Reasons for Visit Value Set |
| Type | Coding |
| 8. HIVCaseVisitData.treatmentStarted | |
| Definition | Is the patient currently on treatment |
| Short | Is the patient currently on treatment |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. HIVCaseVisitData.dateARTInitiation | |
| Definition | Date of ART initiation |
| Short | Date of ART initiation |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. HIVCaseVisitData.eligibleforTBPreventiveTreatment | |
| Definition | Is patient eligible for preventive treatment |
| Short | Is patient eligible for preventive treatment |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. HIVCaseVisitData.TPTEligibleDate | |
| Definition | TPT Date Eligible |
| Short | TPT Date Eligible |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. HIVCaseVisitData.TPTInitiatedDate | |
| Definition | TPT Date Initiated |
| Short | TPT Date Initiated |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. HIVCaseVisitData.TPTRegimen | |
| Definition | TPT Regimen |
| Short | TPT Regimen |
| Control | 0..1 |
| Binding | For example codes, see HIV TPT Regimen Value Set |
| Type | Coding |
| 20. HIVCaseVisitData.TPTCompletedDate | |
| Definition | TPT Date Completed |
| Short | TPT Date Completed |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. HIVCaseVisitData.TPTrestartTreatment | |
| Definition | TPT restart treatment |
| Short | TPT restart treatment |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. HIVCaseVisitData.treatmentStatus | |
| Definition | Treatment status |
| Short | Treatment status |
| Control | 0..1 |
| Binding | For example codes, see HIV Treatment Status Value Set |
| Type | Coding |
| 26. HIVCaseVisitData.viralLoadTestDate | |
| Definition | Viral load test date |
| Short | Viral load test date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. HIVCaseVisitData.viralLoadLessThanThousand | |
| Definition | Viral load < 1000 |
| Short | Viral load < 1000 |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. HIVCaseVisitData.numberOfviralLoadTestResults | |
| Definition | Viral load test results |
| Short | Viral load test results |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. HIVCaseVisitData.previousViralLoadValue | |
| Definition | Previous viral load value |
| Short | Previous viral load value |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. HIVCaseVisitData.lastDateWithART | |
| Definition | Last day with ART |
| Short | Last day with ART |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. HIVCaseVisitData.dateOfDeath | |
| Definition | Date of death |
| Short | Date of death |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. HIVCaseVisitData.statusChangeDate | |
| Definition | Status change date |
| Short | Status change date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. HIVCaseVisitData.currentlyPregnant | |
| Definition | Currently pregnant? |
| Short | Currently pregnant? |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 42. HIVCaseVisitData.daysARTdispensed | |
| Definition | Days of ART provided |
| Short | Days of ART provided |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This 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. |
| Short | HIV Visit |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. HIVCaseVisitData.visitDate | |
| Definition | Viral load test date |
| Short | Viral load test date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. HIVCaseVisitData.dueDate | |
| Definition | Visit due date |
| Short | Visit due date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. HIVCaseVisitData.reasonForVisit | |
| Definition | The reason for this visit |
| Short | The reason for this visit |
| Control | 0..1 |
| Binding | For example codes, see HIV Reasons for Visit Value Set |
| Type | Coding |
| 8. HIVCaseVisitData.treatmentStarted | |
| Definition | Is the patient currently on treatment |
| Short | Is the patient currently on treatment |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. HIVCaseVisitData.dateARTInitiation | |
| Definition | Date of ART initiation |
| Short | Date of ART initiation |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. HIVCaseVisitData.eligibleforTBPreventiveTreatment | |
| Definition | Is patient eligible for preventive treatment |
| Short | Is patient eligible for preventive treatment |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. HIVCaseVisitData.TPTEligibleDate | |
| Definition | TPT Date Eligible |
| Short | TPT Date Eligible |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. HIVCaseVisitData.TPTInitiatedDate | |
| Definition | TPT Date Initiated |
| Short | TPT Date Initiated |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. HIVCaseVisitData.TPTRegimen | |
| Definition | TPT Regimen |
| Short | TPT Regimen |
| Control | 0..1 |
| Binding | For example codes, see HIV TPT Regimen Value Set |
| Type | Coding |
| 20. HIVCaseVisitData.TPTCompletedDate | |
| Definition | TPT Date Completed |
| Short | TPT Date Completed |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. HIVCaseVisitData.TPTrestartTreatment | |
| Definition | TPT restart treatment |
| Short | TPT restart treatment |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. HIVCaseVisitData.treatmentStatus | |
| Definition | Treatment status |
| Short | Treatment status |
| Control | 0..1 |
| Binding | For example codes, see HIV Treatment Status Value Set |
| Type | Coding |
| 26. HIVCaseVisitData.viralLoadTestDate | |
| Definition | Viral load test date |
| Short | Viral load test date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. HIVCaseVisitData.viralLoadLessThanThousand | |
| Definition | Viral load < 1000 |
| Short | Viral load < 1000 |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. HIVCaseVisitData.numberOfviralLoadTestResults | |
| Definition | Viral load test results |
| Short | Viral load test results |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. HIVCaseVisitData.previousViralLoadValue | |
| Definition | Previous viral load value |
| Short | Previous viral load value |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. HIVCaseVisitData.lastDateWithART | |
| Definition | Last day with ART |
| Short | Last day with ART |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. HIVCaseVisitData.dateOfDeath | |
| Definition | Date of death |
| Short | Date of death |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. HIVCaseVisitData.statusChangeDate | |
| Definition | Status change date |
| Short | Status change date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. HIVCaseVisitData.currentlyPregnant | |
| Definition | Currently pregnant? |
| Short | Currently pregnant? |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 42. HIVCaseVisitData.daysARTdispensed | |
| Definition | Days of ART provided |
| Short | Days of ART provided |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This 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. |
| Short | HIV Visit |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. HIVCaseVisitData.visitDate | |
| Definition | Viral load test date |
| Short | Viral load test date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. HIVCaseVisitData.dueDate | |
| Definition | Visit due date |
| Short | Visit due date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. HIVCaseVisitData.reasonForVisit | |
| Definition | The reason for this visit |
| Short | The reason for this visit |
| Control | 0..1 |
| Binding | For example codes, see HIV Reasons for Visit Value Set |
| Type | Coding |
| 8. HIVCaseVisitData.treatmentStarted | |
| Definition | Is the patient currently on treatment |
| Short | Is the patient currently on treatment |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. HIVCaseVisitData.dateARTInitiation | |
| Definition | Date of ART initiation |
| Short | Date of ART initiation |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. HIVCaseVisitData.eligibleforTBPreventiveTreatment | |
| Definition | Is patient eligible for preventive treatment |
| Short | Is patient eligible for preventive treatment |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. HIVCaseVisitData.TPTEligibleDate | |
| Definition | TPT Date Eligible |
| Short | TPT Date Eligible |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. HIVCaseVisitData.TPTInitiatedDate | |
| Definition | TPT Date Initiated |
| Short | TPT Date Initiated |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. HIVCaseVisitData.TPTRegimen | |
| Definition | TPT Regimen |
| Short | TPT Regimen |
| Control | 0..1 |
| Binding | For example codes, see HIV TPT Regimen Value Set |
| Type | Coding |
| 20. HIVCaseVisitData.TPTCompletedDate | |
| Definition | TPT Date Completed |
| Short | TPT Date Completed |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. HIVCaseVisitData.TPTrestartTreatment | |
| Definition | TPT restart treatment |
| Short | TPT restart treatment |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. HIVCaseVisitData.treatmentStatus | |
| Definition | Treatment status |
| Short | Treatment status |
| Control | 0..1 |
| Binding | For example codes, see HIV Treatment Status Value Set |
| Type | Coding |
| 26. HIVCaseVisitData.viralLoadTestDate | |
| Definition | Viral load test date |
| Short | Viral load test date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. HIVCaseVisitData.viralLoadLessThanThousand | |
| Definition | Viral load < 1000 |
| Short | Viral load < 1000 |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. HIVCaseVisitData.numberOfviralLoadTestResults | |
| Definition | Viral load test results |
| Short | Viral load test results |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. HIVCaseVisitData.previousViralLoadValue | |
| Definition | Previous viral load value |
| Short | Previous viral load value |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. HIVCaseVisitData.lastDateWithART | |
| Definition | Last day with ART |
| Short | Last day with ART |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. HIVCaseVisitData.dateOfDeath | |
| Definition | Date of death |
| Short | Date of death |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. HIVCaseVisitData.statusChangeDate | |
| Definition | Status change date |
| Short | Status change date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. HIVCaseVisitData.currentlyPregnant | |
| Definition | Currently pregnant? |
| Short | Currently pregnant? |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 42. HIVCaseVisitData.daysARTdispensed | |
| Definition | Days of ART provided |
| Short | Days of ART provided |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |