WHO SMART Guidelines - HIV
0.4.4 - ci-build

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

Logical Model: HIV.A Registration ( Experimental )

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

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

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVARegistration 0..* Base HIV.A Registration
Instances of this logical model can be the target of a Reference
... firstName 1..1 string First name
... familyName 1..1 string Family name
... visitDate 1..1 dateTime Visit date
... referral 1..1 boolean Referral
... referredBy 0..1 Coding Referred by
Binding: Referred by ValueSet (required)
... uniqueIdentifier 1..1 Identifier Unique identifier
... nationalId 0..1 Identifier National ID
... nationalHealthId 0..1 Identifier National health ID
... nationalProgrammeId 0..1 Identifier National programme ID
... nationalHealthInsuranceId 0..1 Identifier National health insurance ID
... countryOfBirth 1..1 Coding Country of birth
Binding: Country of birth ValueSet (required)
... dateOfBirth 0..1 date Date of birth
... dateOfBirthUnknown 0..1 boolean Date of birth unknown
... estimatedAge 0..1 integer Estimated age
... age 0..1 integer Age
... gender 1..1 Coding Gender
Binding: Gender ValueSet (required)
... otherGender 0..1 string Other (specify)
... sex 1..1 Coding Sex
Binding: Sex ValueSet (required)
... address 1..1 string Address
... maritalStatus 0..1 Coding Marital Status
Binding: Marital Status ValueSet (required)
... telephoneNumber 1..1 integer Telephone number
... administrativeArea 1..1 Coding Administrative Area
Binding: Administrative Area ValueSet (required)
... communicationConsent 0..1 boolean Communication consent
... reminderMessages 0..1 boolean Reminder messages
... communicationPreferences 0..* Coding Communication preference(s)
Binding: Communication preference(s) ValueSet (required)
... clientEmail 0..1 string Client's email
... alternateContactName 0..1 string Alternate contact's name
... alternateContactPhoneNumber 0..1 integer Alternate contact's phone number
... alternateContactAddress 0..1 string Alternate contact's address
... alternateContactRelationship 0..1 string Alternate contact relationship

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HIVARegistration.referredBy Base required Referred by ValueSet 📦0.4.4 This IG
HIVARegistration.countryOfBirth Base required Country of birth ValueSet 📦0.4.4 This IG
HIVARegistration.gender Base required Gender ValueSet 📦0.4.4 This IG
HIVARegistration.sex Base required Sex ValueSet 📦0.4.4 This IG
HIVARegistration.maritalStatus Base required Marital Status ValueSet 📦0.4.4 This IG
HIVARegistration.administrativeArea Base required Administrative Area ValueSet 📦0.4.4 This IG
HIVARegistration.communicationPreferences Base required Communication preference(s) ValueSet 📦0.4.4 This IG

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVARegistration 0..* Base HIV.A Registration
Instances of this logical model can be the target of a Reference
... firstName 1..1 string First name
... familyName 1..1 string Family name
... visitDate 1..1 dateTime Visit date
... referral 1..1 boolean Referral
... referredBy 0..1 Coding Referred by
Binding: Referred by ValueSet (required)
... uniqueIdentifier 1..1 Identifier Unique identifier
... nationalId 0..1 Identifier National ID
... nationalHealthId 0..1 Identifier National health ID
... nationalProgrammeId 0..1 Identifier National programme ID
... nationalHealthInsuranceId 0..1 Identifier National health insurance ID
... countryOfBirth 1..1 Coding Country of birth
Binding: Country of birth ValueSet (required)
... dateOfBirth 0..1 date Date of birth
... dateOfBirthUnknown 0..1 boolean Date of birth unknown
... estimatedAge 0..1 integer Estimated age
... age 0..1 integer Age
... gender 1..1 Coding Gender
Binding: Gender ValueSet (required)
... otherGender 0..1 string Other (specify)
... sex 1..1 Coding Sex
Binding: Sex ValueSet (required)
... address 1..1 string Address
... maritalStatus 0..1 Coding Marital Status
Binding: Marital Status ValueSet (required)
... telephoneNumber 1..1 integer Telephone number
... administrativeArea 1..1 Coding Administrative Area
Binding: Administrative Area ValueSet (required)
... communicationConsent 0..1 boolean Communication consent
... reminderMessages 0..1 boolean Reminder messages
... communicationPreferences 0..* Coding Communication preference(s)
Binding: Communication preference(s) ValueSet (required)
... clientEmail 0..1 string Client's email
... alternateContactName 0..1 string Alternate contact's name
... alternateContactPhoneNumber 0..1 integer Alternate contact's phone number
... alternateContactAddress 0..1 string Alternate contact's address
... alternateContactRelationship 0..1 string Alternate contact relationship

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HIVARegistration.referredBy Base required Referred by ValueSet 📦0.4.4 This IG
HIVARegistration.countryOfBirth Base required Country of birth ValueSet 📦0.4.4 This IG
HIVARegistration.gender Base required Gender ValueSet 📦0.4.4 This IG
HIVARegistration.sex Base required Sex ValueSet 📦0.4.4 This IG
HIVARegistration.maritalStatus Base required Marital Status ValueSet 📦0.4.4 This IG
HIVARegistration.administrativeArea Base required Administrative Area ValueSet 📦0.4.4 This IG
HIVARegistration.communicationPreferences Base required Communication preference(s) ValueSet 📦0.4.4 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVARegistration 0..* Base HIV.A Registration
Instances of this logical model can be the target of a Reference
... firstName 1..1 string First name
... familyName 1..1 string Family name
... visitDate 1..1 dateTime Visit date
... referral 1..1 boolean Referral
... referredBy 0..1 Coding Referred by
Binding: Referred by ValueSet (required)
... uniqueIdentifier 1..1 Identifier Unique identifier
... nationalId 0..1 Identifier National ID
... nationalHealthId 0..1 Identifier National health ID
... nationalProgrammeId 0..1 Identifier National programme ID
... nationalHealthInsuranceId 0..1 Identifier National health insurance ID
... countryOfBirth 1..1 Coding Country of birth
Binding: Country of birth ValueSet (required)
... dateOfBirth 0..1 date Date of birth
... dateOfBirthUnknown 0..1 boolean Date of birth unknown
... estimatedAge 0..1 integer Estimated age
... age 0..1 integer Age
... gender 1..1 Coding Gender
Binding: Gender ValueSet (required)
... otherGender 0..1 string Other (specify)
... sex 1..1 Coding Sex
Binding: Sex ValueSet (required)
... address 1..1 string Address
... maritalStatus 0..1 Coding Marital Status
Binding: Marital Status ValueSet (required)
... telephoneNumber 1..1 integer Telephone number
... administrativeArea 1..1 Coding Administrative Area
Binding: Administrative Area ValueSet (required)
... communicationConsent 0..1 boolean Communication consent
... reminderMessages 0..1 boolean Reminder messages
... communicationPreferences 0..* Coding Communication preference(s)
Binding: Communication preference(s) ValueSet (required)
... clientEmail 0..1 string Client's email
... alternateContactName 0..1 string Alternate contact's name
... alternateContactPhoneNumber 0..1 integer Alternate contact's phone number
... alternateContactAddress 0..1 string Alternate contact's address
... alternateContactRelationship 0..1 string Alternate contact relationship

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HIVARegistration.referredBy Base required Referred by ValueSet 📦0.4.4 This IG
HIVARegistration.countryOfBirth Base required Country of birth ValueSet 📦0.4.4 This IG
HIVARegistration.gender Base required Gender ValueSet 📦0.4.4 This IG
HIVARegistration.sex Base required Sex ValueSet 📦0.4.4 This IG
HIVARegistration.maritalStatus Base required Marital Status ValueSet 📦0.4.4 This IG
HIVARegistration.administrativeArea Base required Administrative Area ValueSet 📦0.4.4 This IG
HIVARegistration.communicationPreferences Base required Communication preference(s) ValueSet 📦0.4.4 This IG

This structure is derived from Base

Summary

Mandatory: 0 element(11 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVARegistration 0..* Base HIV.A Registration
Instances of this logical model can be the target of a Reference
... firstName 1..1 string First name
... familyName 1..1 string Family name
... visitDate 1..1 dateTime Visit date
... referral 1..1 boolean Referral
... referredBy 0..1 Coding Referred by
Binding: Referred by ValueSet (required)
... uniqueIdentifier 1..1 Identifier Unique identifier
... nationalId 0..1 Identifier National ID
... nationalHealthId 0..1 Identifier National health ID
... nationalProgrammeId 0..1 Identifier National programme ID
... nationalHealthInsuranceId 0..1 Identifier National health insurance ID
... countryOfBirth 1..1 Coding Country of birth
Binding: Country of birth ValueSet (required)
... dateOfBirth 0..1 date Date of birth
... dateOfBirthUnknown 0..1 boolean Date of birth unknown
... estimatedAge 0..1 integer Estimated age
... age 0..1 integer Age
... gender 1..1 Coding Gender
Binding: Gender ValueSet (required)
... otherGender 0..1 string Other (specify)
... sex 1..1 Coding Sex
Binding: Sex ValueSet (required)
... address 1..1 string Address
... maritalStatus 0..1 Coding Marital Status
Binding: Marital Status ValueSet (required)
... telephoneNumber 1..1 integer Telephone number
... administrativeArea 1..1 Coding Administrative Area
Binding: Administrative Area ValueSet (required)
... communicationConsent 0..1 boolean Communication consent
... reminderMessages 0..1 boolean Reminder messages
... communicationPreferences 0..* Coding Communication preference(s)
Binding: Communication preference(s) ValueSet (required)
... clientEmail 0..1 string Client's email
... alternateContactName 0..1 string Alternate contact's name
... alternateContactPhoneNumber 0..1 integer Alternate contact's phone number
... alternateContactAddress 0..1 string Alternate contact's address
... alternateContactRelationship 0..1 string Alternate contact relationship

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HIVARegistration.referredBy Base required Referred by ValueSet 📦0.4.4 This IG
HIVARegistration.countryOfBirth Base required Country of birth ValueSet 📦0.4.4 This IG
HIVARegistration.gender Base required Gender ValueSet 📦0.4.4 This IG
HIVARegistration.sex Base required Sex ValueSet 📦0.4.4 This IG
HIVARegistration.maritalStatus Base required Marital Status ValueSet 📦0.4.4 This IG
HIVARegistration.administrativeArea Base required Administrative Area ValueSet 📦0.4.4 This IG
HIVARegistration.communicationPreferences Base required Communication preference(s) ValueSet 📦0.4.4 This IG

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVARegistration 0..* Base HIV.A Registration
Instances of this logical model can be the target of a Reference
... firstName 1..1 string First name
... familyName 1..1 string Family name
... visitDate 1..1 dateTime Visit date
... referral 1..1 boolean Referral
... referredBy 0..1 Coding Referred by
Binding: Referred by ValueSet (required)
... uniqueIdentifier 1..1 Identifier Unique identifier
... nationalId 0..1 Identifier National ID
... nationalHealthId 0..1 Identifier National health ID
... nationalProgrammeId 0..1 Identifier National programme ID
... nationalHealthInsuranceId 0..1 Identifier National health insurance ID
... countryOfBirth 1..1 Coding Country of birth
Binding: Country of birth ValueSet (required)
... dateOfBirth 0..1 date Date of birth
... dateOfBirthUnknown 0..1 boolean Date of birth unknown
... estimatedAge 0..1 integer Estimated age
... age 0..1 integer Age
... gender 1..1 Coding Gender
Binding: Gender ValueSet (required)
... otherGender 0..1 string Other (specify)
... sex 1..1 Coding Sex
Binding: Sex ValueSet (required)
... address 1..1 string Address
... maritalStatus 0..1 Coding Marital Status
Binding: Marital Status ValueSet (required)
... telephoneNumber 1..1 integer Telephone number
... administrativeArea 1..1 Coding Administrative Area
Binding: Administrative Area ValueSet (required)
... communicationConsent 0..1 boolean Communication consent
... reminderMessages 0..1 boolean Reminder messages
... communicationPreferences 0..* Coding Communication preference(s)
Binding: Communication preference(s) ValueSet (required)
... clientEmail 0..1 string Client's email
... alternateContactName 0..1 string Alternate contact's name
... alternateContactPhoneNumber 0..1 integer Alternate contact's phone number
... alternateContactAddress 0..1 string Alternate contact's address
... alternateContactRelationship 0..1 string Alternate contact relationship

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HIVARegistration.referredBy Base required Referred by ValueSet 📦0.4.4 This IG
HIVARegistration.countryOfBirth Base required Country of birth ValueSet 📦0.4.4 This IG
HIVARegistration.gender Base required Gender ValueSet 📦0.4.4 This IG
HIVARegistration.sex Base required Sex ValueSet 📦0.4.4 This IG
HIVARegistration.maritalStatus Base required Marital Status ValueSet 📦0.4.4 This IG
HIVARegistration.administrativeArea Base required Administrative Area ValueSet 📦0.4.4 This IG
HIVARegistration.communicationPreferences Base required Communication preference(s) ValueSet 📦0.4.4 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVARegistration 0..* Base HIV.A Registration
Instances of this logical model can be the target of a Reference
... firstName 1..1 string First name
... familyName 1..1 string Family name
... visitDate 1..1 dateTime Visit date
... referral 1..1 boolean Referral
... referredBy 0..1 Coding Referred by
Binding: Referred by ValueSet (required)
... uniqueIdentifier 1..1 Identifier Unique identifier
... nationalId 0..1 Identifier National ID
... nationalHealthId 0..1 Identifier National health ID
... nationalProgrammeId 0..1 Identifier National programme ID
... nationalHealthInsuranceId 0..1 Identifier National health insurance ID
... countryOfBirth 1..1 Coding Country of birth
Binding: Country of birth ValueSet (required)
... dateOfBirth 0..1 date Date of birth
... dateOfBirthUnknown 0..1 boolean Date of birth unknown
... estimatedAge 0..1 integer Estimated age
... age 0..1 integer Age
... gender 1..1 Coding Gender
Binding: Gender ValueSet (required)
... otherGender 0..1 string Other (specify)
... sex 1..1 Coding Sex
Binding: Sex ValueSet (required)
... address 1..1 string Address
... maritalStatus 0..1 Coding Marital Status
Binding: Marital Status ValueSet (required)
... telephoneNumber 1..1 integer Telephone number
... administrativeArea 1..1 Coding Administrative Area
Binding: Administrative Area ValueSet (required)
... communicationConsent 0..1 boolean Communication consent
... reminderMessages 0..1 boolean Reminder messages
... communicationPreferences 0..* Coding Communication preference(s)
Binding: Communication preference(s) ValueSet (required)
... clientEmail 0..1 string Client's email
... alternateContactName 0..1 string Alternate contact's name
... alternateContactPhoneNumber 0..1 integer Alternate contact's phone number
... alternateContactAddress 0..1 string Alternate contact's address
... alternateContactRelationship 0..1 string Alternate contact relationship

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HIVARegistration.referredBy Base required Referred by ValueSet 📦0.4.4 This IG
HIVARegistration.countryOfBirth Base required Country of birth ValueSet 📦0.4.4 This IG
HIVARegistration.gender Base required Gender ValueSet 📦0.4.4 This IG
HIVARegistration.sex Base required Sex ValueSet 📦0.4.4 This IG
HIVARegistration.maritalStatus Base required Marital Status ValueSet 📦0.4.4 This IG
HIVARegistration.administrativeArea Base required Administrative Area ValueSet 📦0.4.4 This IG
HIVARegistration.communicationPreferences Base required Communication preference(s) ValueSet 📦0.4.4 This IG

This structure is derived from Base

Summary

Mandatory: 0 element(11 nested mandatory elements)

 

Other representations of profile: CSV, Excel