WHO SMART Guidelines - HIV
1.0.0 - release
WHO SMART Guidelines - HIV
1.0.0 - release
This page is part of the WHO SMART Guidelines - HIV (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Active as of 2025-07-08 |
Definitions for the HIVHFollowup logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. HIVHFollowup | |
| Definition | This tab describes the data that are collected during the follow-up and contacting clients workflow (HIV.H) |
| Short | HIV.H Follow-up |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. HIVHFollowup.reasonForFollowUp | |
| Definition | The reason why the client is being followed up |
| Short | Reason for follow-up |
| Control | 1..* |
| Binding | The codes SHALL be taken from Reason for follow-up ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE1) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE1 |
| 4. HIVHFollowup.otherFollowUpReasonSpecify | |
| Definition | Client was followed up for another reason (specify) |
| Short | Other follow-up reason (specify) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE9 |
| 6. HIVHFollowup.clientContactAttempted | |
| Definition | An attempt to locate the client was made |
| Short | Client contact attempted |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE10 |
| 8. HIVHFollowup.dateOfContactAttempt | |
| Definition | Date of attempt to contact client |
| Short | Date of contact attempt |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE11 |
| 10. HIVHFollowup.contactAttemptedBy | |
| Definition | Who attempted to reach out to the client |
| Short | Contact attempted by |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE12 |
| 12. HIVHFollowup.contactMethod | |
| Definition | Method used to try to reach out to the client |
| Short | Contact method |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Contact method ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE13) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE13 |
| 14. HIVHFollowup.sourceOfInformation | |
| Definition | Source of information about the client |
| Short | Source of information |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Source of information ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE17) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE17 |
| 16. HIVHFollowup.otherSourceOfInformationSpecify | |
| Definition | Information about the client's status was provided by someone else (specify) |
| Short | Other source of information (specify) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE22 |
| 18. HIVHFollowup.outcomeFromOutreachAttempt | |
| Definition | Detailed outcome from the attempt to locate the client |
| Short | Outcome from outreach attempt |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Outcome from outreach attempt ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE23) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE23 |
| 20. HIVHFollowup.movedFromCatchmentArea | |
| Definition | The client moved from the catchment area (may be reported from the community level) |
| Short | Moved from catchment area |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE30 |
| 22. HIVHFollowup.dateClientMovedFromCatchmentArea | |
| Definition | The date on which the client moved from the catchment area, if known |
| Short | Date client moved from catchment area |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE31 |
| 24. HIVHFollowup.newCatchmentArea | |
| Definition | New catchment area where the client resides |
| Short | New catchment area |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE32 |
| 26. HIVHFollowup.partnerOrContactOfIndexCase | |
| Definition | The client was identified by an index case as a partner or contact |
| Short | Partner or contact of index case |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE33 |
| 28. HIVHFollowup.hivStatusOfPartnerOrContact | |
| Definition | HIV status of the partner or contact given by the index case |
| Short | HIV status of partner or contact |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HIV status of partner or contact ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE34) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE34 |
| 30. HIVHFollowup.dateOfDeath | |
| Definition | If deceased, the date that the client died |
| Short | Date of death |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE38 |
| 32. HIVHFollowup.causeOfDeath | |
| Definition | Cause of death, if known |
| Short | Cause of death |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE39 |
| 34. HIVHFollowup.placeOfDeath | |
| Definition | Where the client died, if known |
| Short | Place of death |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE40 |
| 36. HIVHFollowup.hivTreatmentOutcome | |
| Definition | The outcome for the client which is used for reporting retention/attrition. |
| Short | HIV treatment outcome |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HIV treatment outcome ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE41) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE41 |
| 38. HIVHFollowup.datePatientLostToFollowUp | |
| Definition | Date patient was lost to follow-up (LTFU) |
| Short | Date patient lost to follow-up |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE46 |
| 40. HIVHFollowup.onArt | |
| Definition | Client is currently taking ART |
| Short | On ART |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE47 |
| 42. HIVHFollowup.dateHivTreatmentOutcomeChanged | |
| Definition | The date on which the client's outcome (lost to follow-up, transferred out, death (documented), or refused (stopped) treatment) changed |
| Short | Date HIV treatment outcome changed |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE48 |
| 44. HIVHFollowup.transferConfirmed | |
| Definition | Select if transfer to another facility is confirmed |
| Short | Transfer confirmed |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE49 |
| 46. HIVHFollowup.transferToFacility | |
| Definition | Name of health facility client was transferred to |
| Short | Transfer to facility |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Transfer to facility ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE50) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE50 |
| 48. HIVHFollowup.dateOfTransferOut | |
| Definition | The date the client transferred out of the facility to be provided with care at another facility |
| Short | Date of transfer out |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE51 |
| 50. HIVHFollowup.adherenceAssessment | |
| Definition | Whether client is adherent or not to ART regimen per national guidelines (immunological or virological monitoring) |
| Short | Adherence assessment |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE52 |
| 52. HIVHFollowup.reasonsForAdherenceProblem | |
| Definition | Reason why client is not adherent |
| Short | Reason(s) for adherence problem |
| Control | 0..* |
| Binding | The codes SHALL be taken from Reason(s) for adherence problem ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE53) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE53 |
| 54. HIVHFollowup.otherReasonsForAdherenceProblem | |
| Definition | Client reported not being adherent because of other reason (specify) |
| Short | Other (specify) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE72 |
| 56. HIVHFollowup.dateArtStopped | |
| Definition | Date on which client stopped ART |
| Short | Date ART stopped |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE73 |
| 58. HIVHFollowup.reasonArtStopped | |
| Definition | Reason why client intentionally stopped ART |
| Short | Reason ART stopped |
| Control | 0..* |
| Binding | The codes SHALL be taken from Reason ART stopped ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE74) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE74 |
| 60. HIVHFollowup.otherReasonForStoppingArtSpecify | |
| Definition | Client stopped ART for other reason (specify) |
| Short | Other reason for stopping ART (specify) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE81 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. HIVHFollowup | |
| Definition | This tab describes the data that are collected during the follow-up and contacting clients workflow (HIV.H) |
| Short | HIV.H Follow-up |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. HIVHFollowup.reasonForFollowUp | |
| Definition | The reason why the client is being followed up |
| Short | Reason for follow-up |
| Control | 1..* |
| Binding | The codes SHALL be taken from Reason for follow-up ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE1) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE1 |
| 4. HIVHFollowup.otherFollowUpReasonSpecify | |
| Definition | Client was followed up for another reason (specify) |
| Short | Other follow-up reason (specify) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE9 |
| 6. HIVHFollowup.clientContactAttempted | |
| Definition | An attempt to locate the client was made |
| Short | Client contact attempted |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE10 |
| 8. HIVHFollowup.dateOfContactAttempt | |
| Definition | Date of attempt to contact client |
| Short | Date of contact attempt |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE11 |
| 10. HIVHFollowup.contactAttemptedBy | |
| Definition | Who attempted to reach out to the client |
| Short | Contact attempted by |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE12 |
| 12. HIVHFollowup.contactMethod | |
| Definition | Method used to try to reach out to the client |
| Short | Contact method |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Contact method ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE13) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE13 |
| 14. HIVHFollowup.sourceOfInformation | |
| Definition | Source of information about the client |
| Short | Source of information |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Source of information ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE17) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE17 |
| 16. HIVHFollowup.otherSourceOfInformationSpecify | |
| Definition | Information about the client's status was provided by someone else (specify) |
| Short | Other source of information (specify) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE22 |
| 18. HIVHFollowup.outcomeFromOutreachAttempt | |
| Definition | Detailed outcome from the attempt to locate the client |
| Short | Outcome from outreach attempt |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Outcome from outreach attempt ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE23) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE23 |
| 20. HIVHFollowup.movedFromCatchmentArea | |
| Definition | The client moved from the catchment area (may be reported from the community level) |
| Short | Moved from catchment area |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE30 |
| 22. HIVHFollowup.dateClientMovedFromCatchmentArea | |
| Definition | The date on which the client moved from the catchment area, if known |
| Short | Date client moved from catchment area |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE31 |
| 24. HIVHFollowup.newCatchmentArea | |
| Definition | New catchment area where the client resides |
| Short | New catchment area |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE32 |
| 26. HIVHFollowup.partnerOrContactOfIndexCase | |
| Definition | The client was identified by an index case as a partner or contact |
| Short | Partner or contact of index case |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE33 |
| 28. HIVHFollowup.hivStatusOfPartnerOrContact | |
| Definition | HIV status of the partner or contact given by the index case |
| Short | HIV status of partner or contact |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HIV status of partner or contact ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE34) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE34 |
| 30. HIVHFollowup.dateOfDeath | |
| Definition | If deceased, the date that the client died |
| Short | Date of death |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE38 |
| 32. HIVHFollowup.causeOfDeath | |
| Definition | Cause of death, if known |
| Short | Cause of death |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE39 |
| 34. HIVHFollowup.placeOfDeath | |
| Definition | Where the client died, if known |
| Short | Place of death |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE40 |
| 36. HIVHFollowup.hivTreatmentOutcome | |
| Definition | The outcome for the client which is used for reporting retention/attrition. |
| Short | HIV treatment outcome |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HIV treatment outcome ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE41) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE41 |
| 38. HIVHFollowup.datePatientLostToFollowUp | |
| Definition | Date patient was lost to follow-up (LTFU) |
| Short | Date patient lost to follow-up |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE46 |
| 40. HIVHFollowup.onArt | |
| Definition | Client is currently taking ART |
| Short | On ART |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE47 |
| 42. HIVHFollowup.dateHivTreatmentOutcomeChanged | |
| Definition | The date on which the client's outcome (lost to follow-up, transferred out, death (documented), or refused (stopped) treatment) changed |
| Short | Date HIV treatment outcome changed |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE48 |
| 44. HIVHFollowup.transferConfirmed | |
| Definition | Select if transfer to another facility is confirmed |
| Short | Transfer confirmed |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE49 |
| 46. HIVHFollowup.transferToFacility | |
| Definition | Name of health facility client was transferred to |
| Short | Transfer to facility |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Transfer to facility ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE50) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE50 |
| 48. HIVHFollowup.dateOfTransferOut | |
| Definition | The date the client transferred out of the facility to be provided with care at another facility |
| Short | Date of transfer out |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE51 |
| 50. HIVHFollowup.adherenceAssessment | |
| Definition | Whether client is adherent or not to ART regimen per national guidelines (immunological or virological monitoring) |
| Short | Adherence assessment |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE52 |
| 52. HIVHFollowup.reasonsForAdherenceProblem | |
| Definition | Reason why client is not adherent |
| Short | Reason(s) for adherence problem |
| Control | 0..* |
| Binding | The codes SHALL be taken from Reason(s) for adherence problem ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE53) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE53 |
| 54. HIVHFollowup.otherReasonsForAdherenceProblem | |
| Definition | Client reported not being adherent because of other reason (specify) |
| Short | Other (specify) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE72 |
| 56. HIVHFollowup.dateArtStopped | |
| Definition | Date on which client stopped ART |
| Short | Date ART stopped |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE73 |
| 58. HIVHFollowup.reasonArtStopped | |
| Definition | Reason why client intentionally stopped ART |
| Short | Reason ART stopped |
| Control | 0..* |
| Binding | The codes SHALL be taken from Reason ART stopped ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE74) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE74 |
| 60. HIVHFollowup.otherReasonForStoppingArtSpecify | |
| Definition | Client stopped ART for other reason (specify) |
| Short | Other reason for stopping ART (specify) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE81 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. HIVHFollowup | |
| Definition | This tab describes the data that are collected during the follow-up and contacting clients workflow (HIV.H) |
| Short | HIV.H Follow-up |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. HIVHFollowup.reasonForFollowUp | |
| Definition | The reason why the client is being followed up |
| Short | Reason for follow-up |
| Control | 1..* |
| Binding | The codes SHALL be taken from Reason for follow-up ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE1) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE1 |
| 4. HIVHFollowup.otherFollowUpReasonSpecify | |
| Definition | Client was followed up for another reason (specify) |
| Short | Other follow-up reason (specify) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE9 |
| 6. HIVHFollowup.clientContactAttempted | |
| Definition | An attempt to locate the client was made |
| Short | Client contact attempted |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE10 |
| 8. HIVHFollowup.dateOfContactAttempt | |
| Definition | Date of attempt to contact client |
| Short | Date of contact attempt |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE11 |
| 10. HIVHFollowup.contactAttemptedBy | |
| Definition | Who attempted to reach out to the client |
| Short | Contact attempted by |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE12 |
| 12. HIVHFollowup.contactMethod | |
| Definition | Method used to try to reach out to the client |
| Short | Contact method |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Contact method ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE13) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE13 |
| 14. HIVHFollowup.sourceOfInformation | |
| Definition | Source of information about the client |
| Short | Source of information |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Source of information ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE17) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE17 |
| 16. HIVHFollowup.otherSourceOfInformationSpecify | |
| Definition | Information about the client's status was provided by someone else (specify) |
| Short | Other source of information (specify) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE22 |
| 18. HIVHFollowup.outcomeFromOutreachAttempt | |
| Definition | Detailed outcome from the attempt to locate the client |
| Short | Outcome from outreach attempt |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Outcome from outreach attempt ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE23) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE23 |
| 20. HIVHFollowup.movedFromCatchmentArea | |
| Definition | The client moved from the catchment area (may be reported from the community level) |
| Short | Moved from catchment area |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE30 |
| 22. HIVHFollowup.dateClientMovedFromCatchmentArea | |
| Definition | The date on which the client moved from the catchment area, if known |
| Short | Date client moved from catchment area |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE31 |
| 24. HIVHFollowup.newCatchmentArea | |
| Definition | New catchment area where the client resides |
| Short | New catchment area |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE32 |
| 26. HIVHFollowup.partnerOrContactOfIndexCase | |
| Definition | The client was identified by an index case as a partner or contact |
| Short | Partner or contact of index case |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE33 |
| 28. HIVHFollowup.hivStatusOfPartnerOrContact | |
| Definition | HIV status of the partner or contact given by the index case |
| Short | HIV status of partner or contact |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HIV status of partner or contact ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE34) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE34 |
| 30. HIVHFollowup.dateOfDeath | |
| Definition | If deceased, the date that the client died |
| Short | Date of death |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE38 |
| 32. HIVHFollowup.causeOfDeath | |
| Definition | Cause of death, if known |
| Short | Cause of death |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE39 |
| 34. HIVHFollowup.placeOfDeath | |
| Definition | Where the client died, if known |
| Short | Place of death |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE40 |
| 36. HIVHFollowup.hivTreatmentOutcome | |
| Definition | The outcome for the client which is used for reporting retention/attrition. |
| Short | HIV treatment outcome |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HIV treatment outcome ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE41) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE41 |
| 38. HIVHFollowup.datePatientLostToFollowUp | |
| Definition | Date patient was lost to follow-up (LTFU) |
| Short | Date patient lost to follow-up |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE46 |
| 40. HIVHFollowup.onArt | |
| Definition | Client is currently taking ART |
| Short | On ART |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE47 |
| 42. HIVHFollowup.dateHivTreatmentOutcomeChanged | |
| Definition | The date on which the client's outcome (lost to follow-up, transferred out, death (documented), or refused (stopped) treatment) changed |
| Short | Date HIV treatment outcome changed |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE48 |
| 44. HIVHFollowup.transferConfirmed | |
| Definition | Select if transfer to another facility is confirmed |
| Short | Transfer confirmed |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE49 |
| 46. HIVHFollowup.transferToFacility | |
| Definition | Name of health facility client was transferred to |
| Short | Transfer to facility |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Transfer to facility ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE50) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE50 |
| 48. HIVHFollowup.dateOfTransferOut | |
| Definition | The date the client transferred out of the facility to be provided with care at another facility |
| Short | Date of transfer out |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE51 |
| 50. HIVHFollowup.adherenceAssessment | |
| Definition | Whether client is adherent or not to ART regimen per national guidelines (immunological or virological monitoring) |
| Short | Adherence assessment |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE52 |
| 52. HIVHFollowup.reasonsForAdherenceProblem | |
| Definition | Reason why client is not adherent |
| Short | Reason(s) for adherence problem |
| Control | 0..* |
| Binding | The codes SHALL be taken from Reason(s) for adherence problem ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE53) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE53 |
| 54. HIVHFollowup.otherReasonsForAdherenceProblem | |
| Definition | Client reported not being adherent because of other reason (specify) |
| Short | Other (specify) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE72 |
| 56. HIVHFollowup.dateArtStopped | |
| Definition | Date on which client stopped ART |
| Short | Date ART stopped |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE73 |
| 58. HIVHFollowup.reasonArtStopped | |
| Definition | Reason why client intentionally stopped ART |
| Short | Reason ART stopped |
| Control | 0..* |
| Binding | The codes SHALL be taken from Reason ART stopped ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.H.DE74) |
| Type | Coding |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE74 |
| 60. HIVHFollowup.otherReasonForStoppingArtSpecify | |
| Definition | Client stopped ART for other reason (specify) |
| Short | Other reason for stopping ART (specify) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.H.DE81 |