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
Active as of 2024-12-06 |
Definitions for the HIVARegistration logical model.
Guidance on how to interpret the contents of this table can be found here
0. HIVARegistration | |
Definition | This tab describes the data that are collected during the registration workflow (HIV.A) |
Short | HIV.A Registration |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. HIVARegistration.firstName | |
Definition | Client's first or given name |
Short | First name |
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.A.DE1 |
4. HIVARegistration.familyName | |
Definition | Client's family name or last name |
Short | Family name |
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.A.DE2 |
6. HIVARegistration.visitDate | |
Definition | The date and time of the client's visit |
Short | Visit date |
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.A.DE3 |
8. HIVARegistration.referral | |
Definition | If client was referred for care |
Short | Referral |
Control | 1..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.A.DE4 |
10. HIVARegistration.referredBy | |
Definition | How the client was referred |
Short | Referred by |
Control | 0..1 |
Binding | The codes SHALL be taken from Referred by ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE5 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE5 |
12. HIVARegistration.uniqueIdentifier | |
Definition | Unique identifier generated for new clients or a universal ID, if used in the country |
Short | Unique identifier |
Control | 1..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE8 |
14. HIVARegistration.nationalId | |
Definition | National unique identifier assigned to the client, if used in the country |
Short | National ID |
Control | 0..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE9 |
16. HIVARegistration.nationalHealthId | |
Definition | National health unique identifier assigned to the client, if used in the country |
Short | National health ID |
Control | 0..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE10 |
18. HIVARegistration.nationalProgrammeId | |
Definition | National programme unique identifier assigned to the client, if used in the country |
Short | National programme ID |
Control | 0..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE11 |
20. HIVARegistration.nationalHealthInsuranceId | |
Definition | National health insurance unique identifier assigned to the client, if used in the country |
Short | National health insurance ID |
Control | 0..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE12 |
22. HIVARegistration.countryOfBirth | |
Definition | Country where the client was born |
Short | Country of birth |
Control | 1..1 |
Binding | The codes SHALL be taken from Country of birth ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE13 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE13 |
24. HIVARegistration.dateOfBirth | |
Definition | The client's date of birth (DOB) if known |
Short | Date of birth |
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.A.DE14 |
26. HIVARegistration.dateOfBirthUnknown | |
Definition | Is the client's DOB is unknown? |
Short | Date of birth unknown |
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.A.DE15 |
28. HIVARegistration.estimatedAge | |
Definition | If DOB is unknown, enter the client's estimated age. Display client's age in number of years. |
Short | Estimated age |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE16 |
30. HIVARegistration.age | |
Definition | Calculated age (number of years) of the client based on date of birth |
Short | Age |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE17 |
32. HIVARegistration.gender | |
Definition | Gender of the client |
Short | Gender |
Control | 1..1 |
Binding | The codes SHALL be taken from Gender ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE18 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE18 |
34. HIVARegistration.otherGender | |
Definition | Additional category (please 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.A.DE24 |
36. HIVARegistration.sex | |
Definition | Sex of the client assigned at birth |
Short | Sex |
Control | 1..1 |
Binding | The codes SHALL be taken from Sex ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE25 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE25 |
38. HIVARegistration.address | |
Definition | Client's home address or address which the client is consenting to disclose |
Short | Address |
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.A.DE29 |
40. HIVARegistration.maritalStatus | |
Definition | Client's current marital status |
Short | Marital Status |
Control | 0..1 |
Binding | The codes SHALL be taken from Marital Status ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE30 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE30 |
42. HIVARegistration.telephoneNumber | |
Definition | Client's telephone number (a landline or a mobile phone number) |
Short | Telephone number |
Control | 1..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE42 |
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. |
Short | Administrative Area |
Control | 1..1 |
Binding | The codes SHALL be taken from Administrative Area ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE43 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE43 |
46. HIVARegistration.communicationConsent | |
Definition | Indication that client gave consent to be contacted |
Short | Communication consent |
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.A.DE44 |
48. HIVARegistration.reminderMessages | |
Definition | Whether client wants to receive text or other messages as follow-up for HIV services |
Short | Reminder messages |
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.A.DE45 |
50. HIVARegistration.communicationPreferences | |
Definition | How the client would like to receive family planning communications |
Short | Communication preference(s) |
Control | 0..* |
Binding | The codes SHALL be taken from Communication preference(s) ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE46 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE46 |
52. HIVARegistration.clientEmail | |
Definition | Client's primary email account where the client can be contacted |
Short | Client's email |
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.A.DE49 |
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. |
Short | Alternate contact's name |
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.A.DE50 |
56. HIVARegistration.alternateContactPhoneNumber | |
Definition | Phone number of the alternate contact |
Short | Alternate contact's phone number |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE51 |
58. HIVARegistration.alternateContactAddress | |
Definition | Alternate contact's home address or address which the client is consenting to disclose |
Short | Alternate contact's address |
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.A.DE52 |
60. HIVARegistration.alternateContactRelationship | |
Definition | The alternate contact's relationship to the client (e.g. partner, husband, mother, sibling, etc.) |
Short | Alternate contact relationship |
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.A.DE53 |
Guidance on how to interpret the contents of this table can be found here
0. HIVARegistration | |
Definition | This tab describes the data that are collected during the registration workflow (HIV.A) |
Short | HIV.A Registration |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. HIVARegistration.firstName | |
Definition | Client's first or given name |
Short | First name |
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.A.DE1 |
4. HIVARegistration.familyName | |
Definition | Client's family name or last name |
Short | Family name |
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.A.DE2 |
6. HIVARegistration.visitDate | |
Definition | The date and time of the client's visit |
Short | Visit date |
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.A.DE3 |
8. HIVARegistration.referral | |
Definition | If client was referred for care |
Short | Referral |
Control | 1..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.A.DE4 |
10. HIVARegistration.referredBy | |
Definition | How the client was referred |
Short | Referred by |
Control | 0..1 |
Binding | The codes SHALL be taken from Referred by ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE5 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE5 |
12. HIVARegistration.uniqueIdentifier | |
Definition | Unique identifier generated for new clients or a universal ID, if used in the country |
Short | Unique identifier |
Control | 1..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE8 |
14. HIVARegistration.nationalId | |
Definition | National unique identifier assigned to the client, if used in the country |
Short | National ID |
Control | 0..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE9 |
16. HIVARegistration.nationalHealthId | |
Definition | National health unique identifier assigned to the client, if used in the country |
Short | National health ID |
Control | 0..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE10 |
18. HIVARegistration.nationalProgrammeId | |
Definition | National programme unique identifier assigned to the client, if used in the country |
Short | National programme ID |
Control | 0..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE11 |
20. HIVARegistration.nationalHealthInsuranceId | |
Definition | National health insurance unique identifier assigned to the client, if used in the country |
Short | National health insurance ID |
Control | 0..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE12 |
22. HIVARegistration.countryOfBirth | |
Definition | Country where the client was born |
Short | Country of birth |
Control | 1..1 |
Binding | The codes SHALL be taken from Country of birth ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE13 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE13 |
24. HIVARegistration.dateOfBirth | |
Definition | The client's date of birth (DOB) if known |
Short | Date of birth |
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.A.DE14 |
26. HIVARegistration.dateOfBirthUnknown | |
Definition | Is the client's DOB is unknown? |
Short | Date of birth unknown |
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.A.DE15 |
28. HIVARegistration.estimatedAge | |
Definition | If DOB is unknown, enter the client's estimated age. Display client's age in number of years. |
Short | Estimated age |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE16 |
30. HIVARegistration.age | |
Definition | Calculated age (number of years) of the client based on date of birth |
Short | Age |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE17 |
32. HIVARegistration.gender | |
Definition | Gender of the client |
Short | Gender |
Control | 1..1 |
Binding | The codes SHALL be taken from Gender ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE18 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE18 |
34. HIVARegistration.otherGender | |
Definition | Additional category (please 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.A.DE24 |
36. HIVARegistration.sex | |
Definition | Sex of the client assigned at birth |
Short | Sex |
Control | 1..1 |
Binding | The codes SHALL be taken from Sex ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE25 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE25 |
38. HIVARegistration.address | |
Definition | Client's home address or address which the client is consenting to disclose |
Short | Address |
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.A.DE29 |
40. HIVARegistration.maritalStatus | |
Definition | Client's current marital status |
Short | Marital Status |
Control | 0..1 |
Binding | The codes SHALL be taken from Marital Status ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE30 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE30 |
42. HIVARegistration.telephoneNumber | |
Definition | Client's telephone number (a landline or a mobile phone number) |
Short | Telephone number |
Control | 1..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE42 |
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. |
Short | Administrative Area |
Control | 1..1 |
Binding | The codes SHALL be taken from Administrative Area ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE43 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE43 |
46. HIVARegistration.communicationConsent | |
Definition | Indication that client gave consent to be contacted |
Short | Communication consent |
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.A.DE44 |
48. HIVARegistration.reminderMessages | |
Definition | Whether client wants to receive text or other messages as follow-up for HIV services |
Short | Reminder messages |
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.A.DE45 |
50. HIVARegistration.communicationPreferences | |
Definition | How the client would like to receive family planning communications |
Short | Communication preference(s) |
Control | 0..* |
Binding | The codes SHALL be taken from Communication preference(s) ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE46 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE46 |
52. HIVARegistration.clientEmail | |
Definition | Client's primary email account where the client can be contacted |
Short | Client's email |
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.A.DE49 |
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. |
Short | Alternate contact's name |
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.A.DE50 |
56. HIVARegistration.alternateContactPhoneNumber | |
Definition | Phone number of the alternate contact |
Short | Alternate contact's phone number |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE51 |
58. HIVARegistration.alternateContactAddress | |
Definition | Alternate contact's home address or address which the client is consenting to disclose |
Short | Alternate contact's address |
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.A.DE52 |
60. HIVARegistration.alternateContactRelationship | |
Definition | The alternate contact's relationship to the client (e.g. partner, husband, mother, sibling, etc.) |
Short | Alternate contact relationship |
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.A.DE53 |
Guidance on how to interpret the contents of this table can be found here
0. HIVARegistration | |
Definition | This tab describes the data that are collected during the registration workflow (HIV.A) |
Short | HIV.A Registration |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. HIVARegistration.firstName | |
Definition | Client's first or given name |
Short | First name |
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.A.DE1 |
4. HIVARegistration.familyName | |
Definition | Client's family name or last name |
Short | Family name |
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.A.DE2 |
6. HIVARegistration.visitDate | |
Definition | The date and time of the client's visit |
Short | Visit date |
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.A.DE3 |
8. HIVARegistration.referral | |
Definition | If client was referred for care |
Short | Referral |
Control | 1..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.A.DE4 |
10. HIVARegistration.referredBy | |
Definition | How the client was referred |
Short | Referred by |
Control | 0..1 |
Binding | The codes SHALL be taken from Referred by ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE5 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE5 |
12. HIVARegistration.uniqueIdentifier | |
Definition | Unique identifier generated for new clients or a universal ID, if used in the country |
Short | Unique identifier |
Control | 1..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE8 |
14. HIVARegistration.nationalId | |
Definition | National unique identifier assigned to the client, if used in the country |
Short | National ID |
Control | 0..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE9 |
16. HIVARegistration.nationalHealthId | |
Definition | National health unique identifier assigned to the client, if used in the country |
Short | National health ID |
Control | 0..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE10 |
18. HIVARegistration.nationalProgrammeId | |
Definition | National programme unique identifier assigned to the client, if used in the country |
Short | National programme ID |
Control | 0..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE11 |
20. HIVARegistration.nationalHealthInsuranceId | |
Definition | National health insurance unique identifier assigned to the client, if used in the country |
Short | National health insurance ID |
Control | 0..1 |
Type | Identifier |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE12 |
22. HIVARegistration.countryOfBirth | |
Definition | Country where the client was born |
Short | Country of birth |
Control | 1..1 |
Binding | The codes SHALL be taken from Country of birth ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE13 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE13 |
24. HIVARegistration.dateOfBirth | |
Definition | The client's date of birth (DOB) if known |
Short | Date of birth |
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.A.DE14 |
26. HIVARegistration.dateOfBirthUnknown | |
Definition | Is the client's DOB is unknown? |
Short | Date of birth unknown |
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.A.DE15 |
28. HIVARegistration.estimatedAge | |
Definition | If DOB is unknown, enter the client's estimated age. Display client's age in number of years. |
Short | Estimated age |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE16 |
30. HIVARegistration.age | |
Definition | Calculated age (number of years) of the client based on date of birth |
Short | Age |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE17 |
32. HIVARegistration.gender | |
Definition | Gender of the client |
Short | Gender |
Control | 1..1 |
Binding | The codes SHALL be taken from Gender ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE18 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE18 |
34. HIVARegistration.otherGender | |
Definition | Additional category (please 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.A.DE24 |
36. HIVARegistration.sex | |
Definition | Sex of the client assigned at birth |
Short | Sex |
Control | 1..1 |
Binding | The codes SHALL be taken from Sex ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE25 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE25 |
38. HIVARegistration.address | |
Definition | Client's home address or address which the client is consenting to disclose |
Short | Address |
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.A.DE29 |
40. HIVARegistration.maritalStatus | |
Definition | Client's current marital status |
Short | Marital Status |
Control | 0..1 |
Binding | The codes SHALL be taken from Marital Status ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE30 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE30 |
42. HIVARegistration.telephoneNumber | |
Definition | Client's telephone number (a landline or a mobile phone number) |
Short | Telephone number |
Control | 1..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE42 |
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. |
Short | Administrative Area |
Control | 1..1 |
Binding | The codes SHALL be taken from Administrative Area ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE43 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE43 |
46. HIVARegistration.communicationConsent | |
Definition | Indication that client gave consent to be contacted |
Short | Communication consent |
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.A.DE44 |
48. HIVARegistration.reminderMessages | |
Definition | Whether client wants to receive text or other messages as follow-up for HIV services |
Short | Reminder messages |
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.A.DE45 |
50. HIVARegistration.communicationPreferences | |
Definition | How the client would like to receive family planning communications |
Short | Communication preference(s) |
Control | 0..* |
Binding | The codes SHALL be taken from Communication preference(s) ValueSet (required to http://smart.who.int/hiv/ValueSet/HIV.A.DE46 ) |
Type | Coding |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE46 |
52. HIVARegistration.clientEmail | |
Definition | Client's primary email account where the client can be contacted |
Short | Client's email |
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.A.DE49 |
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. |
Short | Alternate contact's name |
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.A.DE50 |
56. HIVARegistration.alternateContactPhoneNumber | |
Definition | Phone number of the alternate contact |
Short | Alternate contact's phone number |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | WHO SMART HIV Concepts CodeSystem HIV.A.DE51 |
58. HIVARegistration.alternateContactAddress | |
Definition | Alternate contact's home address or address which the client is consenting to disclose |
Short | Alternate contact's address |
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.A.DE52 |
60. HIVARegistration.alternateContactRelationship | |
Definition | The alternate contact's relationship to the client (e.g. partner, husband, mother, sibling, etc.) |
Short | Alternate contact relationship |
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.A.DE53 |