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: HIVARegistration - Detailed Descriptions

Active as of 2025-12-08

Definitions for the HIVARegistration logical model.

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

0. HIVARegistration
Definition

This tab describes the data that are collected during the registration workflow (HIV.A)

ShortHIV.A Registration
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVARegistration.firstName
Definition

Client's first or given name

ShortFirst name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE1 (First name)
4. HIVARegistration.familyName
Definition

Client's family name or last name

ShortFamily name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE2 (Family name)
6. HIVARegistration.visitDate
Definition

The date and time of the client's visit

ShortVisit date
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE3 (Visit date)
8. HIVARegistration.referral
Definition

If client was referred for care

ShortReferral
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE4 (Referral)
10. HIVARegistration.referredBy
Definition

How the client was referred

ShortReferred by
Control0..1
BindingThe codes SHALL be taken from Referred by ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE5)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE5 (Referred by)
12. HIVARegistration.uniqueIdentifier
Definition

Unique identifier generated for new clients or a universal ID, if used in the country

ShortUnique identifier
Control1..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE8 (Unique identifier)
14. HIVARegistration.nationalId
Definition

National unique identifier assigned to the client, if used in the country

ShortNational ID
Control0..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE9 (National ID)
16. HIVARegistration.nationalHealthId
Definition

National health unique identifier assigned to the client, if used in the country

ShortNational health ID
Control0..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE10 (National health ID)
18. HIVARegistration.nationalProgrammeId
Definition

National programme unique identifier assigned to the client, if used in the country

ShortNational programme ID
Control0..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE11 (National programme ID)
20. HIVARegistration.nationalHealthInsuranceId
Definition

National health insurance unique identifier assigned to the client, if used in the country

ShortNational health insurance ID
Control0..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE12 (National health insurance ID)
22. HIVARegistration.countryOfBirth
Definition

Country where the client was born

ShortCountry of birth
Control1..1
BindingThe codes SHALL be taken from Country of birth ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE13)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE13 (Country of birth)
24. HIVARegistration.dateOfBirth
Definition

The client's date of birth (DOB) if known

ShortDate of birth
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE14 (Date of birth)
26. HIVARegistration.dateOfBirthUnknown
Definition

Is the client's DOB is unknown?

ShortDate of birth unknown
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE15 (Date of birth unknown)
28. HIVARegistration.estimatedAge
Definition

If DOB is unknown, enter the client's estimated age. Display client's age in number of years.

ShortEstimated age
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE16 (Estimated age)
30. HIVARegistration.age
Definition

Calculated age (number of years) of the client based on date of birth

ShortAge
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE17 (Age)
32. HIVARegistration.gender
Definition

Gender of the client

ShortGender
Control1..1
BindingThe codes SHALL be taken from Gender ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE18)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE18 (Gender)
34. HIVARegistration.otherGender
Definition

Additional category (please 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.A.DE24 (Other (specify))
36. HIVARegistration.sex
Definition

Sex of the client assigned at birth

ShortSex
Control1..1
BindingThe codes SHALL be taken from Sex ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE25)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE25 (Sex)
38. HIVARegistration.address
Definition

Client's home address or address which the client is consenting to disclose

ShortAddress
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE29 (Address)
40. HIVARegistration.maritalStatus
Definition

Client's current marital status

ShortMarital Status
Control0..1
BindingThe codes SHALL be taken from Marital Status ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE30)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE30 (Marital Status)
42. HIVARegistration.telephoneNumber
Definition

Client's telephone number (a landline or a mobile phone number)

ShortTelephone number
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE42 (Telephone number)
44. HIVARegistration.administrativeArea
Definition

This should be a context-specific list of administrative areas, such as villages, districts, etc. The purpose of this data element is to allow for grouping and flagging of client data to a particular facility's catchment area. This can be input into the system by the end user OR it can be automated in the database based on the end user's attributes.

ShortAdministrative Area
Control1..1
BindingThe codes SHALL be taken from Administrative Area ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE43)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE43 (Administrative Area)
46. HIVARegistration.communicationConsent
Definition

Indication that client gave consent to be contacted

ShortCommunication consent
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE44 (Communication consent)
48. HIVARegistration.reminderMessages
Definition

Whether client wants to receive text or other messages as follow-up for HIV services

ShortReminder messages
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE45 (Reminder messages)
50. HIVARegistration.communicationPreferences
Definition

How the client would like to receive family planning communications

ShortCommunication preference(s)
Control0..*
BindingThe codes SHALL be taken from Communication preference(s) ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE46)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE46 (Communication preference(s))
52. HIVARegistration.clientEmail
Definition

Client's primary email account where the client can be contacted

ShortClient's email
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE49 (Client's email)
54. HIVARegistration.alternateContactName
Definition

Name of an alternate contact, which could be next of kin (e.g. partner, husband, mother, sibling, etc.). The alternate contact would be used in the case of an emergency situation.

ShortAlternate contact's name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE50 (Alternate contact's name)
56. HIVARegistration.alternateContactPhoneNumber
Definition

Phone number of the alternate contact

ShortAlternate contact's phone number
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE51 (Alternate contact's phone number)
58. HIVARegistration.alternateContactAddress
Definition

Alternate contact's home address or address which the client is consenting to disclose

ShortAlternate contact's address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE52 (Alternate contact's address)
60. HIVARegistration.alternateContactRelationship
Definition

The alternate contact's relationship to the client (e.g. partner, husband, mother, sibling, etc.)

ShortAlternate contact relationship
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE53 (Alternate contact relationship)

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

0. HIVARegistration
Definition

This tab describes the data that are collected during the registration workflow (HIV.A)

ShortHIV.A Registration
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVARegistration.firstName
Definition

Client's first or given name

ShortFirst name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE1 (First name)
4. HIVARegistration.familyName
Definition

Client's family name or last name

ShortFamily name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE2 (Family name)
6. HIVARegistration.visitDate
Definition

The date and time of the client's visit

ShortVisit date
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE3 (Visit date)
8. HIVARegistration.referral
Definition

If client was referred for care

ShortReferral
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE4 (Referral)
10. HIVARegistration.referredBy
Definition

How the client was referred

ShortReferred by
Control0..1
BindingThe codes SHALL be taken from Referred by ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE5)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE5 (Referred by)
12. HIVARegistration.uniqueIdentifier
Definition

Unique identifier generated for new clients or a universal ID, if used in the country

ShortUnique identifier
Control1..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE8 (Unique identifier)
14. HIVARegistration.nationalId
Definition

National unique identifier assigned to the client, if used in the country

ShortNational ID
Control0..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE9 (National ID)
16. HIVARegistration.nationalHealthId
Definition

National health unique identifier assigned to the client, if used in the country

ShortNational health ID
Control0..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE10 (National health ID)
18. HIVARegistration.nationalProgrammeId
Definition

National programme unique identifier assigned to the client, if used in the country

ShortNational programme ID
Control0..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE11 (National programme ID)
20. HIVARegistration.nationalHealthInsuranceId
Definition

National health insurance unique identifier assigned to the client, if used in the country

ShortNational health insurance ID
Control0..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE12 (National health insurance ID)
22. HIVARegistration.countryOfBirth
Definition

Country where the client was born

ShortCountry of birth
Control1..1
BindingThe codes SHALL be taken from Country of birth ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE13)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE13 (Country of birth)
24. HIVARegistration.dateOfBirth
Definition

The client's date of birth (DOB) if known

ShortDate of birth
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE14 (Date of birth)
26. HIVARegistration.dateOfBirthUnknown
Definition

Is the client's DOB is unknown?

ShortDate of birth unknown
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE15 (Date of birth unknown)
28. HIVARegistration.estimatedAge
Definition

If DOB is unknown, enter the client's estimated age. Display client's age in number of years.

ShortEstimated age
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE16 (Estimated age)
30. HIVARegistration.age
Definition

Calculated age (number of years) of the client based on date of birth

ShortAge
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE17 (Age)
32. HIVARegistration.gender
Definition

Gender of the client

ShortGender
Control1..1
BindingThe codes SHALL be taken from Gender ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE18)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE18 (Gender)
34. HIVARegistration.otherGender
Definition

Additional category (please 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.A.DE24 (Other (specify))
36. HIVARegistration.sex
Definition

Sex of the client assigned at birth

ShortSex
Control1..1
BindingThe codes SHALL be taken from Sex ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE25)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE25 (Sex)
38. HIVARegistration.address
Definition

Client's home address or address which the client is consenting to disclose

ShortAddress
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE29 (Address)
40. HIVARegistration.maritalStatus
Definition

Client's current marital status

ShortMarital Status
Control0..1
BindingThe codes SHALL be taken from Marital Status ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE30)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE30 (Marital Status)
42. HIVARegistration.telephoneNumber
Definition

Client's telephone number (a landline or a mobile phone number)

ShortTelephone number
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE42 (Telephone number)
44. HIVARegistration.administrativeArea
Definition

This should be a context-specific list of administrative areas, such as villages, districts, etc. The purpose of this data element is to allow for grouping and flagging of client data to a particular facility's catchment area. This can be input into the system by the end user OR it can be automated in the database based on the end user's attributes.

ShortAdministrative Area
Control1..1
BindingThe codes SHALL be taken from Administrative Area ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE43)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE43 (Administrative Area)
46. HIVARegistration.communicationConsent
Definition

Indication that client gave consent to be contacted

ShortCommunication consent
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE44 (Communication consent)
48. HIVARegistration.reminderMessages
Definition

Whether client wants to receive text or other messages as follow-up for HIV services

ShortReminder messages
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE45 (Reminder messages)
50. HIVARegistration.communicationPreferences
Definition

How the client would like to receive family planning communications

ShortCommunication preference(s)
Control0..*
BindingThe codes SHALL be taken from Communication preference(s) ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE46)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE46 (Communication preference(s))
52. HIVARegistration.clientEmail
Definition

Client's primary email account where the client can be contacted

ShortClient's email
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE49 (Client's email)
54. HIVARegistration.alternateContactName
Definition

Name of an alternate contact, which could be next of kin (e.g. partner, husband, mother, sibling, etc.). The alternate contact would be used in the case of an emergency situation.

ShortAlternate contact's name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE50 (Alternate contact's name)
56. HIVARegistration.alternateContactPhoneNumber
Definition

Phone number of the alternate contact

ShortAlternate contact's phone number
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE51 (Alternate contact's phone number)
58. HIVARegistration.alternateContactAddress
Definition

Alternate contact's home address or address which the client is consenting to disclose

ShortAlternate contact's address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE52 (Alternate contact's address)
60. HIVARegistration.alternateContactRelationship
Definition

The alternate contact's relationship to the client (e.g. partner, husband, mother, sibling, etc.)

ShortAlternate contact relationship
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE53 (Alternate contact relationship)

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

0. HIVARegistration
Definition

This tab describes the data that are collected during the registration workflow (HIV.A)

ShortHIV.A Registration
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVARegistration.firstName
Definition

Client's first or given name

ShortFirst name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE1 (First name)
4. HIVARegistration.familyName
Definition

Client's family name or last name

ShortFamily name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE2 (Family name)
6. HIVARegistration.visitDate
Definition

The date and time of the client's visit

ShortVisit date
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE3 (Visit date)
8. HIVARegistration.referral
Definition

If client was referred for care

ShortReferral
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE4 (Referral)
10. HIVARegistration.referredBy
Definition

How the client was referred

ShortReferred by
Control0..1
BindingThe codes SHALL be taken from Referred by ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE5)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE5 (Referred by)
12. HIVARegistration.uniqueIdentifier
Definition

Unique identifier generated for new clients or a universal ID, if used in the country

ShortUnique identifier
Control1..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE8 (Unique identifier)
14. HIVARegistration.nationalId
Definition

National unique identifier assigned to the client, if used in the country

ShortNational ID
Control0..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE9 (National ID)
16. HIVARegistration.nationalHealthId
Definition

National health unique identifier assigned to the client, if used in the country

ShortNational health ID
Control0..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE10 (National health ID)
18. HIVARegistration.nationalProgrammeId
Definition

National programme unique identifier assigned to the client, if used in the country

ShortNational programme ID
Control0..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE11 (National programme ID)
20. HIVARegistration.nationalHealthInsuranceId
Definition

National health insurance unique identifier assigned to the client, if used in the country

ShortNational health insurance ID
Control0..1
TypeIdentifier
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE12 (National health insurance ID)
22. HIVARegistration.countryOfBirth
Definition

Country where the client was born

ShortCountry of birth
Control1..1
BindingThe codes SHALL be taken from Country of birth ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE13)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE13 (Country of birth)
24. HIVARegistration.dateOfBirth
Definition

The client's date of birth (DOB) if known

ShortDate of birth
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE14 (Date of birth)
26. HIVARegistration.dateOfBirthUnknown
Definition

Is the client's DOB is unknown?

ShortDate of birth unknown
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE15 (Date of birth unknown)
28. HIVARegistration.estimatedAge
Definition

If DOB is unknown, enter the client's estimated age. Display client's age in number of years.

ShortEstimated age
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE16 (Estimated age)
30. HIVARegistration.age
Definition

Calculated age (number of years) of the client based on date of birth

ShortAge
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE17 (Age)
32. HIVARegistration.gender
Definition

Gender of the client

ShortGender
Control1..1
BindingThe codes SHALL be taken from Gender ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE18)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE18 (Gender)
34. HIVARegistration.otherGender
Definition

Additional category (please 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.A.DE24 (Other (specify))
36. HIVARegistration.sex
Definition

Sex of the client assigned at birth

ShortSex
Control1..1
BindingThe codes SHALL be taken from Sex ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE25)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE25 (Sex)
38. HIVARegistration.address
Definition

Client's home address or address which the client is consenting to disclose

ShortAddress
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE29 (Address)
40. HIVARegistration.maritalStatus
Definition

Client's current marital status

ShortMarital Status
Control0..1
BindingThe codes SHALL be taken from Marital Status ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE30)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE30 (Marital Status)
42. HIVARegistration.telephoneNumber
Definition

Client's telephone number (a landline or a mobile phone number)

ShortTelephone number
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE42 (Telephone number)
44. HIVARegistration.administrativeArea
Definition

This should be a context-specific list of administrative areas, such as villages, districts, etc. The purpose of this data element is to allow for grouping and flagging of client data to a particular facility's catchment area. This can be input into the system by the end user OR it can be automated in the database based on the end user's attributes.

ShortAdministrative Area
Control1..1
BindingThe codes SHALL be taken from Administrative Area ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE43)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE43 (Administrative Area)
46. HIVARegistration.communicationConsent
Definition

Indication that client gave consent to be contacted

ShortCommunication consent
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE44 (Communication consent)
48. HIVARegistration.reminderMessages
Definition

Whether client wants to receive text or other messages as follow-up for HIV services

ShortReminder messages
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE45 (Reminder messages)
50. HIVARegistration.communicationPreferences
Definition

How the client would like to receive family planning communications

ShortCommunication preference(s)
Control0..*
BindingThe codes SHALL be taken from Communication preference(s) ValueSet
(required to http://smart.who.int/hiv/ValueSet/HIV.A.DE46)
TypeCoding
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE46 (Communication preference(s))
52. HIVARegistration.clientEmail
Definition

Client's primary email account where the client can be contacted

ShortClient's email
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE49 (Client's email)
54. HIVARegistration.alternateContactName
Definition

Name of an alternate contact, which could be next of kin (e.g. partner, husband, mother, sibling, etc.). The alternate contact would be used in the case of an emergency situation.

ShortAlternate contact's name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE50 (Alternate contact's name)
56. HIVARegistration.alternateContactPhoneNumber
Definition

Phone number of the alternate contact

ShortAlternate contact's phone number
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE51 (Alternate contact's phone number)
58. HIVARegistration.alternateContactAddress
Definition

Alternate contact's home address or address which the client is consenting to disclose

ShortAlternate contact's address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE52 (Alternate contact's address)
60. HIVARegistration.alternateContactRelationship
Definition

The alternate contact's relationship to the client (e.g. partner, husband, mother, sibling, etc.)

ShortAlternate contact relationship
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesWHO SMART HIV Concepts CodeSystem: HIV.A.DE53 (Alternate contact relationship)