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: HIV Visit

Official URL: https://dhis2.org/StructureDefinition/HIVCaseVisitData Version: 1.0.0
Draft as of 2023-09-28 Computable Name: HIVCaseVisitData

Report filled out during facility visit.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. HIVCaseVisitData 0..*BaseHIV Visit
Instances of this logical model are not marked to be the target of a Reference
... visitDate 1..1dateViral load test date
... dueDate 1..1dateVisit due date
... reasonForVisit 0..1CodingThe reason for this visit
Binding: HIV Reasons for Visit Value Set (example)
... dateARTInitiation 0..1dateDate of ART initiation
... eligibleforTBPreventiveTreatment 0..1booleanIs patient eligible for preventive treatment
... TPTEligibleDate 0..1dateTPT Date Eligible
... TPTInitiatedDate 0..1dateTPT Date Initiated
... TPTRegimen 0..1CodingTPT Regimen
Binding: HIV TPT Regimen Value Set (example)
... TPTCompletedDate 0..1dateTPT Date Completed
... TPTrestartTreatment 0..1booleanTPT restart treatment
... treatmentStatus 0..1CodingTreatment status
Binding: HIV Treatment Status Value Set (example)
... viralLoadTestDate 0..1dateViral load test date
... viralLoadLessThanThousand 0..1booleanViral load < 1000
... numberOfviralLoadTestResults 0..1integerViral load test results
... previousViralLoadValue 0..1integerPrevious viral load value
... lastDateWithART 0..1dateLast day with ART
... dateOfDeath 0..1dateDate of death
... statusChangeDate 0..1dateStatus change date
... currentlyPregnant 0..1booleanCurrently pregnant?
... daysARTdispensed 0..1integerDays of ART provided

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
HIVCaseVisitData.reasonForVisitexampleHIVreasonsForVisitVS (a valid code from HIV Reasons for Visit)
HIVCaseVisitData.TPTRegimenexampleHIVtptRegimenVS (a valid code from HIV TPT Regimen)
HIVCaseVisitData.treatmentStatusexampleHIVtreatmentStatusVS (a valid code from HIV Treatment Status)
NameFlagsCard.TypeDescription & Constraintsdoco
.. HIVCaseVisitData 0..*BaseHIV Visit
Instances of this logical model are not marked to be the target of a Reference
... visitDate 1..1dateViral load test date
... dueDate 1..1dateVisit due date
... reasonForVisit 0..1CodingThe reason for this visit
Binding: HIV Reasons for Visit Value Set (example)
... dateARTInitiation 0..1dateDate of ART initiation
... eligibleforTBPreventiveTreatment 0..1booleanIs patient eligible for preventive treatment
... TPTEligibleDate 0..1dateTPT Date Eligible
... TPTInitiatedDate 0..1dateTPT Date Initiated
... TPTRegimen 0..1CodingTPT Regimen
Binding: HIV TPT Regimen Value Set (example)
... TPTCompletedDate 0..1dateTPT Date Completed
... TPTrestartTreatment 0..1booleanTPT restart treatment
... treatmentStatus 0..1CodingTreatment status
Binding: HIV Treatment Status Value Set (example)
... viralLoadTestDate 0..1dateViral load test date
... viralLoadLessThanThousand 0..1booleanViral load < 1000
... numberOfviralLoadTestResults 0..1integerViral load test results
... previousViralLoadValue 0..1integerPrevious viral load value
... lastDateWithART 0..1dateLast day with ART
... dateOfDeath 0..1dateDate of death
... statusChangeDate 0..1dateStatus change date
... currentlyPregnant 0..1booleanCurrently pregnant?
... daysARTdispensed 0..1integerDays of ART provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HIVCaseVisitData.reasonForVisitexampleHIVreasonsForVisitVS (a valid code from HIV Reasons for Visit)
HIVCaseVisitData.TPTRegimenexampleHIVtptRegimenVS (a valid code from HIV TPT Regimen)
HIVCaseVisitData.treatmentStatusexampleHIVtreatmentStatusVS (a valid code from HIV Treatment Status)
NameFlagsCard.TypeDescription & Constraintsdoco
.. HIVCaseVisitData 0..*BaseHIV Visit
Instances of this logical model are not marked to be the target of a Reference
... visitDate 1..1dateViral load test date
... dueDate 1..1dateVisit due date
... reasonForVisit 0..1CodingThe reason for this visit
Binding: HIV Reasons for Visit Value Set (example)
... dateARTInitiation 0..1dateDate of ART initiation
... eligibleforTBPreventiveTreatment 0..1booleanIs patient eligible for preventive treatment
... TPTEligibleDate 0..1dateTPT Date Eligible
... TPTInitiatedDate 0..1dateTPT Date Initiated
... TPTRegimen 0..1CodingTPT Regimen
Binding: HIV TPT Regimen Value Set (example)
... TPTCompletedDate 0..1dateTPT Date Completed
... TPTrestartTreatment 0..1booleanTPT restart treatment
... treatmentStatus 0..1CodingTreatment status
Binding: HIV Treatment Status Value Set (example)
... viralLoadTestDate 0..1dateViral load test date
... viralLoadLessThanThousand 0..1booleanViral load < 1000
... numberOfviralLoadTestResults 0..1integerViral load test results
... previousViralLoadValue 0..1integerPrevious viral load value
... lastDateWithART 0..1dateLast day with ART
... dateOfDeath 0..1dateDate of death
... statusChangeDate 0..1dateStatus change date
... currentlyPregnant 0..1booleanCurrently pregnant?
... daysARTdispensed 0..1integerDays of ART provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HIVCaseVisitData.reasonForVisitexampleHIVreasonsForVisitVS (a valid code from HIV Reasons for Visit)
HIVCaseVisitData.TPTRegimenexampleHIVtptRegimenVS (a valid code from HIV TPT Regimen)
HIVCaseVisitData.treatmentStatusexampleHIVtreatmentStatusVS (a valid code from HIV Treatment Status)

This structure is derived from Base

Summary

Mandatory: 0 element (2 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. HIVCaseVisitData 0..*BaseHIV Visit
Instances of this logical model are not marked to be the target of a Reference
... visitDate 1..1dateViral load test date
... dueDate 1..1dateVisit due date
... reasonForVisit 0..1CodingThe reason for this visit
Binding: HIV Reasons for Visit Value Set (example)
... dateARTInitiation 0..1dateDate of ART initiation
... eligibleforTBPreventiveTreatment 0..1booleanIs patient eligible for preventive treatment
... TPTEligibleDate 0..1dateTPT Date Eligible
... TPTInitiatedDate 0..1dateTPT Date Initiated
... TPTRegimen 0..1CodingTPT Regimen
Binding: HIV TPT Regimen Value Set (example)
... TPTCompletedDate 0..1dateTPT Date Completed
... TPTrestartTreatment 0..1booleanTPT restart treatment
... treatmentStatus 0..1CodingTreatment status
Binding: HIV Treatment Status Value Set (example)
... viralLoadTestDate 0..1dateViral load test date
... viralLoadLessThanThousand 0..1booleanViral load < 1000
... numberOfviralLoadTestResults 0..1integerViral load test results
... previousViralLoadValue 0..1integerPrevious viral load value
... lastDateWithART 0..1dateLast day with ART
... dateOfDeath 0..1dateDate of death
... statusChangeDate 0..1dateStatus change date
... currentlyPregnant 0..1booleanCurrently pregnant?
... daysARTdispensed 0..1integerDays of ART provided

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
HIVCaseVisitData.reasonForVisitexampleHIVreasonsForVisitVS (a valid code from HIV Reasons for Visit)
HIVCaseVisitData.TPTRegimenexampleHIVtptRegimenVS (a valid code from HIV TPT Regimen)
HIVCaseVisitData.treatmentStatusexampleHIVtreatmentStatusVS (a valid code from HIV Treatment Status)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HIVCaseVisitData 0..*BaseHIV Visit
Instances of this logical model are not marked to be the target of a Reference
... visitDate 1..1dateViral load test date
... dueDate 1..1dateVisit due date
... reasonForVisit 0..1CodingThe reason for this visit
Binding: HIV Reasons for Visit Value Set (example)
... dateARTInitiation 0..1dateDate of ART initiation
... eligibleforTBPreventiveTreatment 0..1booleanIs patient eligible for preventive treatment
... TPTEligibleDate 0..1dateTPT Date Eligible
... TPTInitiatedDate 0..1dateTPT Date Initiated
... TPTRegimen 0..1CodingTPT Regimen
Binding: HIV TPT Regimen Value Set (example)
... TPTCompletedDate 0..1dateTPT Date Completed
... TPTrestartTreatment 0..1booleanTPT restart treatment
... treatmentStatus 0..1CodingTreatment status
Binding: HIV Treatment Status Value Set (example)
... viralLoadTestDate 0..1dateViral load test date
... viralLoadLessThanThousand 0..1booleanViral load < 1000
... numberOfviralLoadTestResults 0..1integerViral load test results
... previousViralLoadValue 0..1integerPrevious viral load value
... lastDateWithART 0..1dateLast day with ART
... dateOfDeath 0..1dateDate of death
... statusChangeDate 0..1dateStatus change date
... currentlyPregnant 0..1booleanCurrently pregnant?
... daysARTdispensed 0..1integerDays of ART provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HIVCaseVisitData.reasonForVisitexampleHIVreasonsForVisitVS (a valid code from HIV Reasons for Visit)
HIVCaseVisitData.TPTRegimenexampleHIVtptRegimenVS (a valid code from HIV TPT Regimen)
HIVCaseVisitData.treatmentStatusexampleHIVtreatmentStatusVS (a valid code from HIV Treatment Status)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HIVCaseVisitData 0..*BaseHIV Visit
Instances of this logical model are not marked to be the target of a Reference
... visitDate 1..1dateViral load test date
... dueDate 1..1dateVisit due date
... reasonForVisit 0..1CodingThe reason for this visit
Binding: HIV Reasons for Visit Value Set (example)
... dateARTInitiation 0..1dateDate of ART initiation
... eligibleforTBPreventiveTreatment 0..1booleanIs patient eligible for preventive treatment
... TPTEligibleDate 0..1dateTPT Date Eligible
... TPTInitiatedDate 0..1dateTPT Date Initiated
... TPTRegimen 0..1CodingTPT Regimen
Binding: HIV TPT Regimen Value Set (example)
... TPTCompletedDate 0..1dateTPT Date Completed
... TPTrestartTreatment 0..1booleanTPT restart treatment
... treatmentStatus 0..1CodingTreatment status
Binding: HIV Treatment Status Value Set (example)
... viralLoadTestDate 0..1dateViral load test date
... viralLoadLessThanThousand 0..1booleanViral load < 1000
... numberOfviralLoadTestResults 0..1integerViral load test results
... previousViralLoadValue 0..1integerPrevious viral load value
... lastDateWithART 0..1dateLast day with ART
... dateOfDeath 0..1dateDate of death
... statusChangeDate 0..1dateStatus change date
... currentlyPregnant 0..1booleanCurrently pregnant?
... daysARTdispensed 0..1integerDays of ART provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HIVCaseVisitData.reasonForVisitexampleHIVreasonsForVisitVS (a valid code from HIV Reasons for Visit)
HIVCaseVisitData.TPTRegimenexampleHIVtptRegimenVS (a valid code from HIV TPT Regimen)
HIVCaseVisitData.treatmentStatusexampleHIVtreatmentStatusVS (a valid code from HIV Treatment Status)

This structure is derived from Base

Summary

Mandatory: 0 element (2 nested mandatory elements)

 

Other representations of profile: CSV, Excel