WHO SMART Guidelines - HIV
0.3.0 - ci-build

WHO SMART Guidelines - HIV - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: HIVPrevention - Detailed Descriptions

Active as of 2024-12-06

Definitions for the HIVPrevention logical model.

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

0. HIVPrevention
Definition

This tab describes the data that are collected during HIV prevention activities (not covered in the previous business processes)

ShortHIV.Prevention
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVPrevention.atElevatedRiskForHivAcquisition
Definition

Client is at elevated risk for HIV acquisition, defined according to country/programme context

ShortAt elevated risk for HIV acquisition
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE1
4. HIVPrevention.hivPreventionIntervention
Definition

HIV prevention intervention that client accessed

ShortHIV prevention intervention
Control0..*
BindingThe codes SHALL be taken from HIV prevention intervention ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.PRV.DE2)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE2
6. HIVPrevention.otherHivPreventionIntervention
Definition

Client accessed other HIV prevention services (specify)

ShortOther (specify)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE9
8. HIVPrevention.dateAccessedHivPreventionIntervention
Definition

Date the client accessed HIV prevention intervention

ShortDate accessed HIV prevention intervention
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE10
10. HIVPrevention.hivStatusOfContact
Definition

The HIV status of the client's contact

ShortHIV status of contact
Control0..1
BindingThe codes SHALL be taken from HIV status of contact ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.PRV.DE11)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE11
12. HIVPrevention.dateInjectingEquipmentProvided
Definition

Date client was provided with injecting equipment

ShortDate injecting equipment provided
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE15
14. HIVPrevention.numberOfNeedlesSyringesProvided
Definition

Number of needles-syringes provided to client

ShortNumber of needles-syringes provided
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE16
16. HIVPrevention.dateOamtInitiated
Definition

Date client initiated opioid agonist maintenance treatment (OAMT)

ShortDate OAMT initiated
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE17
18. HIVPrevention.dateOamtDoseReceived
Definition

Date client received opioid agonist maintenance treatment (OAMT) dose

ShortDate OAMT dose received
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE18
20. HIVPrevention.dateOamtTakeAwayDosesDispensed
Definition

Date the client was dispensed opioid agonist maintenance treatment (OAMT) take-away dose(s)

ShortDate OAMT take-away dose(s) dispensed
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE19
22. HIVPrevention.currentlyOnOamt
Definition

Client is currently on opioid agonist maintenance treatment (OAMT) at reporting date, defined according to country/program to account for medication dispensed and LTFU criterion

ShortCurrently on OAMT
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE20
24. HIVPrevention.retainedOnOamt
Definition

Client is retained on opioid agonist maintenance treatment (OAMT) at reporting date, defined according to country/program to account for medication dispensed and LTFU criterion

ShortRetained on OAMT
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE21
26. HIVPrevention.clientBeingInductedOnOamt
Definition

Client is currently being inducted on opioid agonist maintenance treatment (OAMT), defined according to country/program

ShortClient being inducted on OAMT
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE22
28. HIVPrevention.clientOnReducingDosesOfOamt
Definition

Client is current on reducing doses of opioid agonist maintenance treatment (OAMT), defined according to country/program

ShortClient on reducing doses of OAMT
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE23
30. HIVPrevention.dateFirstMaintenanceDoseReceived
Definition

First date on which client received maintenance dose

ShortDate first maintenance dose received
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE24
32. HIVPrevention.dateOfLossToFollowUpOrOamtStopped
Definition

Date of loss to follow-up or opioid agonist maintenance treatment (OAMT) stopped

ShortDate of loss to follow-up or OAMT stopped
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE25
34. HIVPrevention.dateMedicationsDispensed
Definition

Date the client was dispensed medications

ShortDate medications dispensed
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE26
36. HIVPrevention.dateMedicationsPrescribed
Definition

Date the client was prescribed medications

ShortDate medications prescribed
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE27
38. HIVPrevention.numberOfDaysPrescribed
Definition

Days of medication client has been prescribed

ShortNumber of days prescribed
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE28

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

0. HIVPrevention
Definition

This tab describes the data that are collected during HIV prevention activities (not covered in the previous business processes)

ShortHIV.Prevention
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVPrevention.atElevatedRiskForHivAcquisition
Definition

Client is at elevated risk for HIV acquisition, defined according to country/programme context

ShortAt elevated risk for HIV acquisition
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE1
4. HIVPrevention.hivPreventionIntervention
Definition

HIV prevention intervention that client accessed

ShortHIV prevention intervention
Control0..*
BindingThe codes SHALL be taken from HIV prevention intervention ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.PRV.DE2)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE2
6. HIVPrevention.otherHivPreventionIntervention
Definition

Client accessed other HIV prevention services (specify)

ShortOther (specify)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE9
8. HIVPrevention.dateAccessedHivPreventionIntervention
Definition

Date the client accessed HIV prevention intervention

ShortDate accessed HIV prevention intervention
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE10
10. HIVPrevention.hivStatusOfContact
Definition

The HIV status of the client's contact

ShortHIV status of contact
Control0..1
BindingThe codes SHALL be taken from HIV status of contact ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.PRV.DE11)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE11
12. HIVPrevention.dateInjectingEquipmentProvided
Definition

Date client was provided with injecting equipment

ShortDate injecting equipment provided
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE15
14. HIVPrevention.numberOfNeedlesSyringesProvided
Definition

Number of needles-syringes provided to client

ShortNumber of needles-syringes provided
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE16
16. HIVPrevention.dateOamtInitiated
Definition

Date client initiated opioid agonist maintenance treatment (OAMT)

ShortDate OAMT initiated
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE17
18. HIVPrevention.dateOamtDoseReceived
Definition

Date client received opioid agonist maintenance treatment (OAMT) dose

ShortDate OAMT dose received
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE18
20. HIVPrevention.dateOamtTakeAwayDosesDispensed
Definition

Date the client was dispensed opioid agonist maintenance treatment (OAMT) take-away dose(s)

ShortDate OAMT take-away dose(s) dispensed
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE19
22. HIVPrevention.currentlyOnOamt
Definition

Client is currently on opioid agonist maintenance treatment (OAMT) at reporting date, defined according to country/program to account for medication dispensed and LTFU criterion

ShortCurrently on OAMT
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE20
24. HIVPrevention.retainedOnOamt
Definition

Client is retained on opioid agonist maintenance treatment (OAMT) at reporting date, defined according to country/program to account for medication dispensed and LTFU criterion

ShortRetained on OAMT
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE21
26. HIVPrevention.clientBeingInductedOnOamt
Definition

Client is currently being inducted on opioid agonist maintenance treatment (OAMT), defined according to country/program

ShortClient being inducted on OAMT
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE22
28. HIVPrevention.clientOnReducingDosesOfOamt
Definition

Client is current on reducing doses of opioid agonist maintenance treatment (OAMT), defined according to country/program

ShortClient on reducing doses of OAMT
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE23
30. HIVPrevention.dateFirstMaintenanceDoseReceived
Definition

First date on which client received maintenance dose

ShortDate first maintenance dose received
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE24
32. HIVPrevention.dateOfLossToFollowUpOrOamtStopped
Definition

Date of loss to follow-up or opioid agonist maintenance treatment (OAMT) stopped

ShortDate of loss to follow-up or OAMT stopped
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE25
34. HIVPrevention.dateMedicationsDispensed
Definition

Date the client was dispensed medications

ShortDate medications dispensed
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE26
36. HIVPrevention.dateMedicationsPrescribed
Definition

Date the client was prescribed medications

ShortDate medications prescribed
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE27
38. HIVPrevention.numberOfDaysPrescribed
Definition

Days of medication client has been prescribed

ShortNumber of days prescribed
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE28

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

0. HIVPrevention
Definition

This tab describes the data that are collected during HIV prevention activities (not covered in the previous business processes)

ShortHIV.Prevention
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVPrevention.atElevatedRiskForHivAcquisition
Definition

Client is at elevated risk for HIV acquisition, defined according to country/programme context

ShortAt elevated risk for HIV acquisition
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE1
4. HIVPrevention.hivPreventionIntervention
Definition

HIV prevention intervention that client accessed

ShortHIV prevention intervention
Control0..*
BindingThe codes SHALL be taken from HIV prevention intervention ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.PRV.DE2)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE2
6. HIVPrevention.otherHivPreventionIntervention
Definition

Client accessed other HIV prevention services (specify)

ShortOther (specify)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE9
8. HIVPrevention.dateAccessedHivPreventionIntervention
Definition

Date the client accessed HIV prevention intervention

ShortDate accessed HIV prevention intervention
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE10
10. HIVPrevention.hivStatusOfContact
Definition

The HIV status of the client's contact

ShortHIV status of contact
Control0..1
BindingThe codes SHALL be taken from HIV status of contact ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.PRV.DE11)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE11
12. HIVPrevention.dateInjectingEquipmentProvided
Definition

Date client was provided with injecting equipment

ShortDate injecting equipment provided
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE15
14. HIVPrevention.numberOfNeedlesSyringesProvided
Definition

Number of needles-syringes provided to client

ShortNumber of needles-syringes provided
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE16
16. HIVPrevention.dateOamtInitiated
Definition

Date client initiated opioid agonist maintenance treatment (OAMT)

ShortDate OAMT initiated
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE17
18. HIVPrevention.dateOamtDoseReceived
Definition

Date client received opioid agonist maintenance treatment (OAMT) dose

ShortDate OAMT dose received
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE18
20. HIVPrevention.dateOamtTakeAwayDosesDispensed
Definition

Date the client was dispensed opioid agonist maintenance treatment (OAMT) take-away dose(s)

ShortDate OAMT take-away dose(s) dispensed
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE19
22. HIVPrevention.currentlyOnOamt
Definition

Client is currently on opioid agonist maintenance treatment (OAMT) at reporting date, defined according to country/program to account for medication dispensed and LTFU criterion

ShortCurrently on OAMT
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE20
24. HIVPrevention.retainedOnOamt
Definition

Client is retained on opioid agonist maintenance treatment (OAMT) at reporting date, defined according to country/program to account for medication dispensed and LTFU criterion

ShortRetained on OAMT
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE21
26. HIVPrevention.clientBeingInductedOnOamt
Definition

Client is currently being inducted on opioid agonist maintenance treatment (OAMT), defined according to country/program

ShortClient being inducted on OAMT
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE22
28. HIVPrevention.clientOnReducingDosesOfOamt
Definition

Client is current on reducing doses of opioid agonist maintenance treatment (OAMT), defined according to country/program

ShortClient on reducing doses of OAMT
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE23
30. HIVPrevention.dateFirstMaintenanceDoseReceived
Definition

First date on which client received maintenance dose

ShortDate first maintenance dose received
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE24
32. HIVPrevention.dateOfLossToFollowUpOrOamtStopped
Definition

Date of loss to follow-up or opioid agonist maintenance treatment (OAMT) stopped

ShortDate of loss to follow-up or OAMT stopped
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE25
34. HIVPrevention.dateMedicationsDispensed
Definition

Date the client was dispensed medications

ShortDate medications dispensed
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE26
36. HIVPrevention.dateMedicationsPrescribed
Definition

Date the client was prescribed medications

ShortDate medications prescribed
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE27
38. HIVPrevention.numberOfDaysPrescribed
Definition

Days of medication client has been prescribed

ShortNumber of days prescribed
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem HIV.PRV.DE28