WHO SMART Guidelines - HIV
0.4.4 - ci-build

WHO SMART Guidelines - HIV, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.4.4 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/DIGI-UW/smart-hiv/tree/main and changes regularly. See the Directory of published versions

Logical Model: HIV.H Follow-up ( Experimental )

Official URL: http://smart.who.int/hiv/StructureDefinition/HIVHFollowup Version: 0.4.4
Active as of 2025-12-08 Computable Name: HIVHFollowup

This tab describes the data that are collected during the follow-up and contacting clients workflow (HIV.H)

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVHFollowup 0..* Base HIV.H Follow-up
Instances of this logical model can be the target of a Reference
... reasonForFollowUp 1..* Coding Reason for follow-up
Binding: Reason for follow-up ValueSet (required)
... otherFollowUpReasonSpecify 0..1 string Other follow-up reason (specify)
... clientContactAttempted 0..1 boolean Client contact attempted
... dateOfContactAttempt 1..1 dateTime Date of contact attempt
... contactAttemptedBy 1..1 string Contact attempted by
... contactMethod 1..1 Coding Contact method
Binding: Contact method ValueSet (required)
... sourceOfInformation 1..1 Coding Source of information
Binding: Source of information ValueSet (required)
... otherSourceOfInformationSpecify 0..1 string Other source of information (specify)
... outcomeFromOutreachAttempt 0..1 Coding Outcome from outreach attempt
Binding: Outcome from outreach attempt ValueSet (required)
... movedFromCatchmentArea 0..1 boolean Moved from catchment area
... dateClientMovedFromCatchmentArea 0..1 date Date client moved from catchment area
... newCatchmentArea 0..1 string New catchment area
... partnerOrContactOfIndexCase 0..1 boolean Partner or contact of index case
... hivStatusOfPartnerOrContact 0..1 Coding HIV status of partner or contact
Binding: HIV status of partner or contact ValueSet (required)
... dateOfDeath 0..1 date Date of death
... causeOfDeath 0..1 string Cause of death
... placeOfDeath 0..1 string Place of death
... hivTreatmentOutcome 0..1 Coding HIV treatment outcome
Binding: HIV treatment outcome ValueSet (required)
... datePatientLostToFollowUp 0..1 date Date patient lost to follow-up
... onArt 0..1 boolean On ART
... dateHivTreatmentOutcomeChanged 0..1 date Date HIV treatment outcome changed
... transferConfirmed 0..1 boolean Transfer confirmed
... transferToFacility 0..1 Coding Transfer to facility
Binding: Transfer to facility ValueSet (required)
... dateOfTransferOut 0..1 date Date of transfer out
... adherenceAssessment 0..1 boolean Adherence assessment
... reasonsForAdherenceProblem 0..* Coding Reason(s) for adherence problem
Binding: Reason(s) for adherence problem ValueSet (required)
... otherReasonsForAdherenceProblem 0..1 string Other (specify)
... dateArtStopped 0..1 date Date ART stopped
... reasonArtStopped 0..* Coding Reason ART stopped
Binding: Reason ART stopped ValueSet (required)
... otherReasonForStoppingArtSpecify 0..1 string Other reason for stopping ART (specify)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HIVHFollowup.reasonForFollowUp Base required Reason for follow-up ValueSet 📦0.4.4 This IG
HIVHFollowup.contactMethod Base required Contact method ValueSet 📦0.4.4 This IG
HIVHFollowup.sourceOfInformation Base required Source of information ValueSet 📦0.4.4 This IG
HIVHFollowup.outcomeFromOutreachAttempt Base required Outcome from outreach attempt ValueSet 📦0.4.4 This IG
HIVHFollowup.hivStatusOfPartnerOrContact Base required HIV status of partner or contact ValueSet 📦0.4.4 This IG
HIVHFollowup.hivTreatmentOutcome Base required HIV treatment outcome ValueSet 📦0.4.4 This IG
HIVHFollowup.transferToFacility Base required Transfer to facility ValueSet 📦0.4.4 This IG
HIVHFollowup.reasonsForAdherenceProblem Base required Reason(s) for adherence problem ValueSet 📦0.4.4 This IG
HIVHFollowup.reasonArtStopped Base required Reason ART stopped ValueSet 📦0.4.4 This IG

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVHFollowup 0..* Base HIV.H Follow-up
Instances of this logical model can be the target of a Reference
... reasonForFollowUp 1..* Coding Reason for follow-up
Binding: Reason for follow-up ValueSet (required)
... otherFollowUpReasonSpecify 0..1 string Other follow-up reason (specify)
... clientContactAttempted 0..1 boolean Client contact attempted
... dateOfContactAttempt 1..1 dateTime Date of contact attempt
... contactAttemptedBy 1..1 string Contact attempted by
... contactMethod 1..1 Coding Contact method
Binding: Contact method ValueSet (required)
... sourceOfInformation 1..1 Coding Source of information
Binding: Source of information ValueSet (required)
... otherSourceOfInformationSpecify 0..1 string Other source of information (specify)
... outcomeFromOutreachAttempt 0..1 Coding Outcome from outreach attempt
Binding: Outcome from outreach attempt ValueSet (required)
... movedFromCatchmentArea 0..1 boolean Moved from catchment area
... dateClientMovedFromCatchmentArea 0..1 date Date client moved from catchment area
... newCatchmentArea 0..1 string New catchment area
... partnerOrContactOfIndexCase 0..1 boolean Partner or contact of index case
... hivStatusOfPartnerOrContact 0..1 Coding HIV status of partner or contact
Binding: HIV status of partner or contact ValueSet (required)
... dateOfDeath 0..1 date Date of death
... causeOfDeath 0..1 string Cause of death
... placeOfDeath 0..1 string Place of death
... hivTreatmentOutcome 0..1 Coding HIV treatment outcome
Binding: HIV treatment outcome ValueSet (required)
... datePatientLostToFollowUp 0..1 date Date patient lost to follow-up
... onArt 0..1 boolean On ART
... dateHivTreatmentOutcomeChanged 0..1 date Date HIV treatment outcome changed
... transferConfirmed 0..1 boolean Transfer confirmed
... transferToFacility 0..1 Coding Transfer to facility
Binding: Transfer to facility ValueSet (required)
... dateOfTransferOut 0..1 date Date of transfer out
... adherenceAssessment 0..1 boolean Adherence assessment
... reasonsForAdherenceProblem 0..* Coding Reason(s) for adherence problem
Binding: Reason(s) for adherence problem ValueSet (required)
... otherReasonsForAdherenceProblem 0..1 string Other (specify)
... dateArtStopped 0..1 date Date ART stopped
... reasonArtStopped 0..* Coding Reason ART stopped
Binding: Reason ART stopped ValueSet (required)
... otherReasonForStoppingArtSpecify 0..1 string Other reason for stopping ART (specify)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HIVHFollowup.reasonForFollowUp Base required Reason for follow-up ValueSet 📦0.4.4 This IG
HIVHFollowup.contactMethod Base required Contact method ValueSet 📦0.4.4 This IG
HIVHFollowup.sourceOfInformation Base required Source of information ValueSet 📦0.4.4 This IG
HIVHFollowup.outcomeFromOutreachAttempt Base required Outcome from outreach attempt ValueSet 📦0.4.4 This IG
HIVHFollowup.hivStatusOfPartnerOrContact Base required HIV status of partner or contact ValueSet 📦0.4.4 This IG
HIVHFollowup.hivTreatmentOutcome Base required HIV treatment outcome ValueSet 📦0.4.4 This IG
HIVHFollowup.transferToFacility Base required Transfer to facility ValueSet 📦0.4.4 This IG
HIVHFollowup.reasonsForAdherenceProblem Base required Reason(s) for adherence problem ValueSet 📦0.4.4 This IG
HIVHFollowup.reasonArtStopped Base required Reason ART stopped ValueSet 📦0.4.4 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVHFollowup 0..* Base HIV.H Follow-up
Instances of this logical model can be the target of a Reference
... reasonForFollowUp 1..* Coding Reason for follow-up
Binding: Reason for follow-up ValueSet (required)
... otherFollowUpReasonSpecify 0..1 string Other follow-up reason (specify)
... clientContactAttempted 0..1 boolean Client contact attempted
... dateOfContactAttempt 1..1 dateTime Date of contact attempt
... contactAttemptedBy 1..1 string Contact attempted by
... contactMethod 1..1 Coding Contact method
Binding: Contact method ValueSet (required)
... sourceOfInformation 1..1 Coding Source of information
Binding: Source of information ValueSet (required)
... otherSourceOfInformationSpecify 0..1 string Other source of information (specify)
... outcomeFromOutreachAttempt 0..1 Coding Outcome from outreach attempt
Binding: Outcome from outreach attempt ValueSet (required)
... movedFromCatchmentArea 0..1 boolean Moved from catchment area
... dateClientMovedFromCatchmentArea 0..1 date Date client moved from catchment area
... newCatchmentArea 0..1 string New catchment area
... partnerOrContactOfIndexCase 0..1 boolean Partner or contact of index case
... hivStatusOfPartnerOrContact 0..1 Coding HIV status of partner or contact
Binding: HIV status of partner or contact ValueSet (required)
... dateOfDeath 0..1 date Date of death
... causeOfDeath 0..1 string Cause of death
... placeOfDeath 0..1 string Place of death
... hivTreatmentOutcome 0..1 Coding HIV treatment outcome
Binding: HIV treatment outcome ValueSet (required)
... datePatientLostToFollowUp 0..1 date Date patient lost to follow-up
... onArt 0..1 boolean On ART
... dateHivTreatmentOutcomeChanged 0..1 date Date HIV treatment outcome changed
... transferConfirmed 0..1 boolean Transfer confirmed
... transferToFacility 0..1 Coding Transfer to facility
Binding: Transfer to facility ValueSet (required)
... dateOfTransferOut 0..1 date Date of transfer out
... adherenceAssessment 0..1 boolean Adherence assessment
... reasonsForAdherenceProblem 0..* Coding Reason(s) for adherence problem
Binding: Reason(s) for adherence problem ValueSet (required)
... otherReasonsForAdherenceProblem 0..1 string Other (specify)
... dateArtStopped 0..1 date Date ART stopped
... reasonArtStopped 0..* Coding Reason ART stopped
Binding: Reason ART stopped ValueSet (required)
... otherReasonForStoppingArtSpecify 0..1 string Other reason for stopping ART (specify)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HIVHFollowup.reasonForFollowUp Base required Reason for follow-up ValueSet 📦0.4.4 This IG
HIVHFollowup.contactMethod Base required Contact method ValueSet 📦0.4.4 This IG
HIVHFollowup.sourceOfInformation Base required Source of information ValueSet 📦0.4.4 This IG
HIVHFollowup.outcomeFromOutreachAttempt Base required Outcome from outreach attempt ValueSet 📦0.4.4 This IG
HIVHFollowup.hivStatusOfPartnerOrContact Base required HIV status of partner or contact ValueSet 📦0.4.4 This IG
HIVHFollowup.hivTreatmentOutcome Base required HIV treatment outcome ValueSet 📦0.4.4 This IG
HIVHFollowup.transferToFacility Base required Transfer to facility ValueSet 📦0.4.4 This IG
HIVHFollowup.reasonsForAdherenceProblem Base required Reason(s) for adherence problem ValueSet 📦0.4.4 This IG
HIVHFollowup.reasonArtStopped Base required Reason ART stopped ValueSet 📦0.4.4 This IG

This structure is derived from Base

Summary

Mandatory: 0 element(5 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVHFollowup 0..* Base HIV.H Follow-up
Instances of this logical model can be the target of a Reference
... reasonForFollowUp 1..* Coding Reason for follow-up
Binding: Reason for follow-up ValueSet (required)
... otherFollowUpReasonSpecify 0..1 string Other follow-up reason (specify)
... clientContactAttempted 0..1 boolean Client contact attempted
... dateOfContactAttempt 1..1 dateTime Date of contact attempt
... contactAttemptedBy 1..1 string Contact attempted by
... contactMethod 1..1 Coding Contact method
Binding: Contact method ValueSet (required)
... sourceOfInformation 1..1 Coding Source of information
Binding: Source of information ValueSet (required)
... otherSourceOfInformationSpecify 0..1 string Other source of information (specify)
... outcomeFromOutreachAttempt 0..1 Coding Outcome from outreach attempt
Binding: Outcome from outreach attempt ValueSet (required)
... movedFromCatchmentArea 0..1 boolean Moved from catchment area
... dateClientMovedFromCatchmentArea 0..1 date Date client moved from catchment area
... newCatchmentArea 0..1 string New catchment area
... partnerOrContactOfIndexCase 0..1 boolean Partner or contact of index case
... hivStatusOfPartnerOrContact 0..1 Coding HIV status of partner or contact
Binding: HIV status of partner or contact ValueSet (required)
... dateOfDeath 0..1 date Date of death
... causeOfDeath 0..1 string Cause of death
... placeOfDeath 0..1 string Place of death
... hivTreatmentOutcome 0..1 Coding HIV treatment outcome
Binding: HIV treatment outcome ValueSet (required)
... datePatientLostToFollowUp 0..1 date Date patient lost to follow-up
... onArt 0..1 boolean On ART
... dateHivTreatmentOutcomeChanged 0..1 date Date HIV treatment outcome changed
... transferConfirmed 0..1 boolean Transfer confirmed
... transferToFacility 0..1 Coding Transfer to facility
Binding: Transfer to facility ValueSet (required)
... dateOfTransferOut 0..1 date Date of transfer out
... adherenceAssessment 0..1 boolean Adherence assessment
... reasonsForAdherenceProblem 0..* Coding Reason(s) for adherence problem
Binding: Reason(s) for adherence problem ValueSet (required)
... otherReasonsForAdherenceProblem 0..1 string Other (specify)
... dateArtStopped 0..1 date Date ART stopped
... reasonArtStopped 0..* Coding Reason ART stopped
Binding: Reason ART stopped ValueSet (required)
... otherReasonForStoppingArtSpecify 0..1 string Other reason for stopping ART (specify)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HIVHFollowup.reasonForFollowUp Base required Reason for follow-up ValueSet 📦0.4.4 This IG
HIVHFollowup.contactMethod Base required Contact method ValueSet 📦0.4.4 This IG
HIVHFollowup.sourceOfInformation Base required Source of information ValueSet 📦0.4.4 This IG
HIVHFollowup.outcomeFromOutreachAttempt Base required Outcome from outreach attempt ValueSet 📦0.4.4 This IG
HIVHFollowup.hivStatusOfPartnerOrContact Base required HIV status of partner or contact ValueSet 📦0.4.4 This IG
HIVHFollowup.hivTreatmentOutcome Base required HIV treatment outcome ValueSet 📦0.4.4 This IG
HIVHFollowup.transferToFacility Base required Transfer to facility ValueSet 📦0.4.4 This IG
HIVHFollowup.reasonsForAdherenceProblem Base required Reason(s) for adherence problem ValueSet 📦0.4.4 This IG
HIVHFollowup.reasonArtStopped Base required Reason ART stopped ValueSet 📦0.4.4 This IG

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVHFollowup 0..* Base HIV.H Follow-up
Instances of this logical model can be the target of a Reference
... reasonForFollowUp 1..* Coding Reason for follow-up
Binding: Reason for follow-up ValueSet (required)
... otherFollowUpReasonSpecify 0..1 string Other follow-up reason (specify)
... clientContactAttempted 0..1 boolean Client contact attempted
... dateOfContactAttempt 1..1 dateTime Date of contact attempt
... contactAttemptedBy 1..1 string Contact attempted by
... contactMethod 1..1 Coding Contact method
Binding: Contact method ValueSet (required)
... sourceOfInformation 1..1 Coding Source of information
Binding: Source of information ValueSet (required)
... otherSourceOfInformationSpecify 0..1 string Other source of information (specify)
... outcomeFromOutreachAttempt 0..1 Coding Outcome from outreach attempt
Binding: Outcome from outreach attempt ValueSet (required)
... movedFromCatchmentArea 0..1 boolean Moved from catchment area
... dateClientMovedFromCatchmentArea 0..1 date Date client moved from catchment area
... newCatchmentArea 0..1 string New catchment area
... partnerOrContactOfIndexCase 0..1 boolean Partner or contact of index case
... hivStatusOfPartnerOrContact 0..1 Coding HIV status of partner or contact
Binding: HIV status of partner or contact ValueSet (required)
... dateOfDeath 0..1 date Date of death
... causeOfDeath 0..1 string Cause of death
... placeOfDeath 0..1 string Place of death
... hivTreatmentOutcome 0..1 Coding HIV treatment outcome
Binding: HIV treatment outcome ValueSet (required)
... datePatientLostToFollowUp 0..1 date Date patient lost to follow-up
... onArt 0..1 boolean On ART
... dateHivTreatmentOutcomeChanged 0..1 date Date HIV treatment outcome changed
... transferConfirmed 0..1 boolean Transfer confirmed
... transferToFacility 0..1 Coding Transfer to facility
Binding: Transfer to facility ValueSet (required)
... dateOfTransferOut 0..1 date Date of transfer out
... adherenceAssessment 0..1 boolean Adherence assessment
... reasonsForAdherenceProblem 0..* Coding Reason(s) for adherence problem
Binding: Reason(s) for adherence problem ValueSet (required)
... otherReasonsForAdherenceProblem 0..1 string Other (specify)
... dateArtStopped 0..1 date Date ART stopped
... reasonArtStopped 0..* Coding Reason ART stopped
Binding: Reason ART stopped ValueSet (required)
... otherReasonForStoppingArtSpecify 0..1 string Other reason for stopping ART (specify)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HIVHFollowup.reasonForFollowUp Base required Reason for follow-up ValueSet 📦0.4.4 This IG
HIVHFollowup.contactMethod Base required Contact method ValueSet 📦0.4.4 This IG
HIVHFollowup.sourceOfInformation Base required Source of information ValueSet 📦0.4.4 This IG
HIVHFollowup.outcomeFromOutreachAttempt Base required Outcome from outreach attempt ValueSet 📦0.4.4 This IG
HIVHFollowup.hivStatusOfPartnerOrContact Base required HIV status of partner or contact ValueSet 📦0.4.4 This IG
HIVHFollowup.hivTreatmentOutcome Base required HIV treatment outcome ValueSet 📦0.4.4 This IG
HIVHFollowup.transferToFacility Base required Transfer to facility ValueSet 📦0.4.4 This IG
HIVHFollowup.reasonsForAdherenceProblem Base required Reason(s) for adherence problem ValueSet 📦0.4.4 This IG
HIVHFollowup.reasonArtStopped Base required Reason ART stopped ValueSet 📦0.4.4 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVHFollowup 0..* Base HIV.H Follow-up
Instances of this logical model can be the target of a Reference
... reasonForFollowUp 1..* Coding Reason for follow-up
Binding: Reason for follow-up ValueSet (required)
... otherFollowUpReasonSpecify 0..1 string Other follow-up reason (specify)
... clientContactAttempted 0..1 boolean Client contact attempted
... dateOfContactAttempt 1..1 dateTime Date of contact attempt
... contactAttemptedBy 1..1 string Contact attempted by
... contactMethod 1..1 Coding Contact method
Binding: Contact method ValueSet (required)
... sourceOfInformation 1..1 Coding Source of information
Binding: Source of information ValueSet (required)
... otherSourceOfInformationSpecify 0..1 string Other source of information (specify)
... outcomeFromOutreachAttempt 0..1 Coding Outcome from outreach attempt
Binding: Outcome from outreach attempt ValueSet (required)
... movedFromCatchmentArea 0..1 boolean Moved from catchment area
... dateClientMovedFromCatchmentArea 0..1 date Date client moved from catchment area
... newCatchmentArea 0..1 string New catchment area
... partnerOrContactOfIndexCase 0..1 boolean Partner or contact of index case
... hivStatusOfPartnerOrContact 0..1 Coding HIV status of partner or contact
Binding: HIV status of partner or contact ValueSet (required)
... dateOfDeath 0..1 date Date of death
... causeOfDeath 0..1 string Cause of death
... placeOfDeath 0..1 string Place of death
... hivTreatmentOutcome 0..1 Coding HIV treatment outcome
Binding: HIV treatment outcome ValueSet (required)
... datePatientLostToFollowUp 0..1 date Date patient lost to follow-up
... onArt 0..1 boolean On ART
... dateHivTreatmentOutcomeChanged 0..1 date Date HIV treatment outcome changed
... transferConfirmed 0..1 boolean Transfer confirmed
... transferToFacility 0..1 Coding Transfer to facility
Binding: Transfer to facility ValueSet (required)
... dateOfTransferOut 0..1 date Date of transfer out
... adherenceAssessment 0..1 boolean Adherence assessment
... reasonsForAdherenceProblem 0..* Coding Reason(s) for adherence problem
Binding: Reason(s) for adherence problem ValueSet (required)
... otherReasonsForAdherenceProblem 0..1 string Other (specify)
... dateArtStopped 0..1 date Date ART stopped
... reasonArtStopped 0..* Coding Reason ART stopped
Binding: Reason ART stopped ValueSet (required)
... otherReasonForStoppingArtSpecify 0..1 string Other reason for stopping ART (specify)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HIVHFollowup.reasonForFollowUp Base required Reason for follow-up ValueSet 📦0.4.4 This IG
HIVHFollowup.contactMethod Base required Contact method ValueSet 📦0.4.4 This IG
HIVHFollowup.sourceOfInformation Base required Source of information ValueSet 📦0.4.4 This IG
HIVHFollowup.outcomeFromOutreachAttempt Base required Outcome from outreach attempt ValueSet 📦0.4.4 This IG
HIVHFollowup.hivStatusOfPartnerOrContact Base required HIV status of partner or contact ValueSet 📦0.4.4 This IG
HIVHFollowup.hivTreatmentOutcome Base required HIV treatment outcome ValueSet 📦0.4.4 This IG
HIVHFollowup.transferToFacility Base required Transfer to facility ValueSet 📦0.4.4 This IG
HIVHFollowup.reasonsForAdherenceProblem Base required Reason(s) for adherence problem ValueSet 📦0.4.4 This IG
HIVHFollowup.reasonArtStopped Base required Reason ART stopped ValueSet 📦0.4.4 This IG

This structure is derived from Base

Summary

Mandatory: 0 element(5 nested mandatory elements)

 

Other representations of profile: CSV, Excel