HIVARegistration
type: StructureDefinition
node role: treeRoot
id:
  v: HIVARegistration
meta:
  profile:
    v: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablestructuredefinition
    l: crmi-shareablestructuredefinition
  profile:
    v: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablestructuredefinition
    l: crmi-publishablestructuredefinition
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition HIVARegistration Profiles: CRMI Shareable StructureDefinition, CRMI Publishable StructureDefinition Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> HIVARegistration 0..* Base HIV.A Registration Instances of this logical model can be the target of a Reference #xD; firstName 1..1 string First name #xD; familyName 1..1 string Family name #xD; visitDate 1..1 dateTime Visit date #xD; referral 1..1 boolean Referral #xD; referredBy 0..1 Coding Referred by Binding: Referred by ValueSet (required) #xD; uniqueIdentifier 1..1 Identifier Unique identifier #xD; nationalId 0..1 Identifier National ID #xD; nationalHealthId 0..1 Identifier National health ID #xD; nationalProgrammeId 0..1 Identifier National programme ID #xD; nationalHealthInsuranceId 0..1 Identifier National health insurance ID #xD; countryOfBirth 1..1 Coding Country of birth Binding: Country of birth ValueSet (required) #xD; dateOfBirth 0..1 date Date of birth #xD; dateOfBirthUnknown 0..1 boolean Date of birth unknown #xD; estimatedAge 0..1 integer Estimated age #xD; age 0..1 integer Age #xD; gender 1..1 Coding Gender Binding: Gender ValueSet (required) #xD; otherGender 0..1 string Other (specify) #xD; sex 1..1 Coding Sex Binding: Sex ValueSet (required) #xD; address 1..1 string Address #xD; maritalStatus 0..1 Coding Marital Status Binding: Marital Status ValueSet (required) #xD; telephoneNumber 1..1 integer Telephone number #xD; <a href="StructureDefinition-HIVARegistration-definitions.html#HIVARegistration.administrativeArea" title="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.">administrativeArea 1..1 Codi…
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-target
    l: logical-target
  value: Boolean
    v: true
url:
  v: http://smart.who.int/hiv/StructureDefinition/HIVARegistration
  l: HIVARegistration
version:
  v: 0.4.4
name:
  v: HIVARegistration
title:
  v: HIV.A Registration
status:
  v: active
experimental:
  v: true
date:
  v: 2025-12-10T09:22:27+00:00
publisher:
  v: WHO
contact:
  name:
    v: WHO
  telecom:
    system:
      v: url
    value:
      v: http://who.int
description:
  v: This tab describes the data that are collected during the registration workflow (HIV.A)
fhir version:
  v: 4.0.1
kind:
  v: logical
abstract:
  v: false
type:
  v: http://smart.who.int/hiv/StructureDefinition/HIVARegistration
  l: HIVARegistration
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Base
  l: Base
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 4.0.1
  element:
    id:
      v: HIVARegistration
    path:
      v: HIVARegistration
    short:
      v: HIV.A Registration
    definition:
      v: This tab describes the data that are collected during the registration workflow (HIV.A)
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    is modifier:
      v: false
  element:
    id:
      v: HIVARegistration.firstName
    path:
      v: HIVARegistration.firstName
    code:
      system:
        v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
        l: HIVConcepts
      code:
        v: HIV.A.DE1
    short:
      v: First name
    definition:
      v: Client's first or given name
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: HIVARegistration.firstName
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: string
        l: string
  element:
    id:
      v: HIVARegistration.familyName
    path:
      v: HIVARegistration.familyName
    code:
      system:
        v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
        l: HIVConcepts
      code:
        v: HIV.A.DE2
    short:
      v: Family name
    definition:
      v: Client's family name or last name
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: HIVARegistration.familyName
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: string
        l: string
  element:
    id:
      v: HIVARegistration.visitDate
    path:
      v: HIVARegistration.visitDate
    code:
      system:
        v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
        l: HIVConcepts
      code:
        v: HIV.A.DE3
    short:
      v: Visit date
    definition:
      v: The date and time of the client's visit
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: HIVARegistration.visitDate
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: dateTime
        l: dateTime
  element:
    id:
      v: HIVARegistration.referral
    path:
      v: HIVARegistration.referral
    code:
      system:
        v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
        l: HIVConcepts
      code:
        v: HIV.A.DE4
    short:
      v: Referral
    definition:
      v: If client was referred for care
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: HIVARegistration.referral

v: 1

v: 1

code:
  v: boolean
  l: boolean

id:
  v: HIVARegistration.referredBy
path:
  v: HIVARegistration.referredBy
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE5
short:
  v: Referred by
definition:
  v: How the client was referred
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.referredBy
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/hiv/ValueSet/HIV.A.DE5
    l: HIV.A.DE5

id:
  v: HIVARegistration.uniqueIdentifier
path:
  v: HIVARegistration.uniqueIdentifier
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE8
short:
  v: Unique identifier
definition:
  v: Unique identifier generated for new clients or a universal ID, if used in the country
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HIVARegistration.uniqueIdentifier
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier

id:
  v: HIVARegistration.nationalId
path:
  v: HIVARegistration.nationalId
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE9
short:
  v: National ID
definition:
  v: National unique identifier assigned to the client, if used in the country
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.nationalId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier

id:
  v: HIVARegistration.nationalHealthId
path:
  v: HIVARegistration.nationalHealthId
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE10
short:
  v: National health ID
definition:
  v: National health unique identifier assigned to the client, if used in the country
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.nationalHealthId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier

id:
  v: HIVARegistration.nationalProgrammeId
path:
  v: HIVARegistration.nationalProgrammeId
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE11
short:
  v: National programme ID
definition:
  v: National programme unique identifier assigned to the client, if used in the country
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.nationalProgrammeId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier

id:
  v: HIVARegistration.nationalHealthInsuranceId
path:
  v: HIVARegistration.nationalHealthInsuranceId
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE12
short:
  v: National health insurance ID
definition:
  v: National health insurance unique identifier assigned to the client, if used in the country
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.nationalHealthInsuranceId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier

id:
  v: HIVARegistration.countryOfBirth
path:
  v: HIVARegistration.countryOfBirth
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE13
short:
  v: Country of birth
definition:
  v: Country where the client was born
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HIVARegistration.countryOfBirth
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/hiv/ValueSet/HIV.A.DE13
    l: HIV.A.DE13

id:
  v: HIVARegistration.dateOfBirth
path:
  v: HIVARegistration.dateOfBirth
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE14
short:
  v: Date of birth
definition:
  v: The client's date of birth (DOB) if known
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.dateOfBirth
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVARegistration.dateOfBirthUnknown
path:
  v: HIVARegistration.dateOfBirthUnknown
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE15
short:
  v: Date of birth unknown
definition:
  v: Is the client's DOB is unknown?
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.dateOfBirthUnknown
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVARegistration.estimatedAge
path:
  v: HIVARegistration.estimatedAge
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE16
short:
  v: Estimated age
definition:
  v: If DOB is unknown, enter the client's estimated age. Display client's age in number of years.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.estimatedAge
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: integer
    l: integer

id:
  v: HIVARegistration.age
path:
  v: HIVARegistration.age
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE17
short:
  v: Age
definition:
  v: Calculated age (number of years) of the client based on date of birth
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.age
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: integer
    l: integer

id:
  v: HIVARegistration.gender
path:
  v: HIVARegistration.gender
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE18
short:
  v: Gender
definition:
  v: Gender of the client
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HIVARegistration.gender
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/hiv/ValueSet/HIV.A.DE18
    l: HIV.A.DE18

id:
  v: HIVARegistration.otherGender
path:
  v: HIVARegistration.otherGender
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE24
short:
  v: Other (specify)
definition:
  v: Additional category (please specify)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.otherGender
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVARegistration.sex
path:
  v: HIVARegistration.sex
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE25
short:
  v: Sex
definition:
  v: Sex of the client assigned at birth
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HIVARegistration.sex
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/hiv/ValueSet/HIV.A.DE25
    l: HIV.A.DE25

id:
  v: HIVARegistration.address
path:
  v: HIVARegistration.address
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE29
short:
  v: Address
definition:
  v: Client's home address or address which the client is consenting to disclose
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HIVARegistration.address
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVARegistration.maritalStatus
path:
  v: HIVARegistration.maritalStatus
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE30
short:
  v: Marital Status
definition:
  v: Client's current marital status
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.maritalStatus
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/hiv/ValueSet/HIV.A.DE30
    l: HIV.A.DE30

id:
  v: HIVARegistration.telephoneNumber
path:
  v: HIVARegistration.telephoneNumber
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE42
short:
  v: Telephone number
definition:
  v: Client's telephone number (a landline or a mobile phone number)
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HIVARegistration.telephoneNumber
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: integer
    l: integer

id:
  v: HIVARegistration.administrativeArea
path:
  v: HIVARegistration.administrativeArea
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE43
short:
  v: Administrative Area
definition:
  v: 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.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HIVARegistration.administrativeArea
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/hiv/ValueSet/HIV.A.DE43
    l: HIV.A.DE43

id:
  v: HIVARegistration.communicationConsent
path:
  v: HIVARegistration.communicationConsent
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE44
short:
  v: Communication consent
definition:
  v: Indication that client gave consent to be contacted
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.communicationConsent
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVARegistration.reminderMessages
path:
  v: HIVARegistration.reminderMessages
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE45
short:
  v: Reminder messages
definition:
  v: Whether client wants to receive text or other messages as follow-up for HIV services
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.reminderMessages
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVARegistration.communicationPreferences
path:
  v: HIVARegistration.communicationPreferences
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE46
short:
  v: Communication preference(s)
definition:
  v: How the client would like to receive family planning communications
min:
  v: 0
max:
  v: *
base:
  path:
    v: HIVARegistration.communicationPreferences
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/hiv/ValueSet/HIV.A.DE46
    l: HIV.A.DE46

id:
  v: HIVARegistration.clientEmail
path:
  v: HIVARegistration.clientEmail
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE49
short:
  v: Client's email
definition:
  v: Client's primary email account where the client can be contacted
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.clientEmail
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVARegistration.alternateContactName
path:
  v: HIVARegistration.alternateContactName
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE50
short:
  v: Alternate contact's name
definition:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.alternateContactName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVARegistration.alternateContactPhoneNumber
path:
  v: HIVARegistration.alternateContactPhoneNumber
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE51
short:
  v: Alternate contact's phone number
definition:
  v: Phone number of the alternate contact
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.alternateContactPhoneNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: integer
    l: integer

id:
  v: HIVARegistration.alternateContactAddress
path:
  v: HIVARegistration.alternateContactAddress
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE52
short:
  v: Alternate contact's address
definition:
  v: Alternate contact's home address or address which the client is consenting to disclose
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.alternateContactAddress
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVARegistration.alternateContactRelationship
path:
  v: HIVARegistration.alternateContactRelationship
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE53
short:
  v: Alternate contact relationship
definition:
  v: The alternate contact's relationship to the client (e.g. partner, husband, mother, sibling, etc.)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVARegistration.alternateContactRelationship
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

element:
  id:
    v: HIVARegistration
  path:
    v: HIVARegistration
  short:
    v: HIV.A Registration
  definition:
    v: This tab describes the data that are collected during the registration workflow (HIV.A)
element:
  id:
    v: HIVARegistration.firstName
  path:
    v: HIVARegistration.firstName
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.A.DE1
  short:
    v: First name
  definition:
    v: Client's first or given name
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: HIVARegistration.familyName
  path:
    v: HIVARegistration.familyName
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.A.DE2
  short:
    v: Family name
  definition:
    v: Client's family name or last name
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: HIVARegistration.visitDate
  path:
    v: HIVARegistration.visitDate
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.A.DE3
  short:
    v: Visit date
  definition:
    v: The date and time of the client's visit
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: dateTime
      l: dateTime
element:
  id:
    v: HIVARegistration.referral
  path:
    v: HIVARegistration.referral
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.A.DE4
  short:
    v: Referral
  definition:
    v: If client was referred for care
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: boolean
      l: boolean
element:
  id:
    v: HIVARegistration.referredBy
  path:
    v: HIVARegistration.referredBy
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.A.DE5
  short:
    v: Referred by
  definition:
    v: How the client was referred
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Coding
      l: Coding
  binding:
    strength:
      v: required
    value set:
      v: http://smart.who.int/hiv/ValueSet/HIV.A.DE5
      l: HIV.A.DE5
element:
  id:
    v: HIVARegistration.uniqueIdentifier
  path:
    v: HIVARegistration.uniqueIdentifier
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.A.DE8
  short:
    v: Unique identifier
  definition:
    v: Unique identifier generated for new clients or a universal ID, if used in the country
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Identifier
      l: Identifier
element:
  id:
    v: HIVARegistration.nationalId
  path:
    v: HIVARegistration.nationalId
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.A.DE9
  short:
    v: National ID
  definition:
    v: National unique identifier assigned to the client, if used in the country
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Identifier
      l: Identifier
element:
  id:
    v: HIVARegistration.nationalHealthId
  path:
    v: HIVARegistration.nationalHealthId
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.A.DE10
  short:
    v: National health ID
  definition:
    v: National health unique identifier assigned to the client, if used in the country
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Identifier
      l: Identifier
element:
  id:
    v: HIVARegistration.nationalProgrammeId

v: HIVARegistration.nationalProgrammeId

system:
  v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
  l: HIVConcepts
code:
  v: HIV.A.DE11

v: National programme ID

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

v: 0

v: 1

code:
  v: Identifier
  l: Identifier

id:
  v: HIVARegistration.nationalHealthInsuranceId
path:
  v: HIVARegistration.nationalHealthInsuranceId
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE12
short:
  v: National health insurance ID
definition:
  v: National health insurance unique identifier assigned to the client, if used in the country
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Identifier
    l: Identifier

id:
  v: HIVARegistration.countryOfBirth
path:
  v: HIVARegistration.countryOfBirth
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE13
short:
  v: Country of birth
definition:
  v: Country where the client was born
min:
  v: 1
max:
  v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/hiv/ValueSet/HIV.A.DE13
    l: HIV.A.DE13

id:
  v: HIVARegistration.dateOfBirth
path:
  v: HIVARegistration.dateOfBirth
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE14
short:
  v: Date of birth
definition:
  v: The client's date of birth (DOB) if known
min:
  v: 0
max:
  v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVARegistration.dateOfBirthUnknown
path:
  v: HIVARegistration.dateOfBirthUnknown
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE15
short:
  v: Date of birth unknown
definition:
  v: Is the client's DOB is unknown?
min:
  v: 0
max:
  v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVARegistration.estimatedAge
path:
  v: HIVARegistration.estimatedAge
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE16
short:
  v: Estimated age
definition:
  v: If DOB is unknown, enter the client's estimated age. Display client's age in number of years.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: integer
    l: integer

id:
  v: HIVARegistration.age
path:
  v: HIVARegistration.age
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE17
short:
  v: Age
definition:
  v: Calculated age (number of years) of the client based on date of birth
min:
  v: 0
max:
  v: 1
type:
  code:
    v: integer
    l: integer

id:
  v: HIVARegistration.gender
path:
  v: HIVARegistration.gender
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE18
short:
  v: Gender
definition:
  v: Gender of the client
min:
  v: 1
max:
  v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/hiv/ValueSet/HIV.A.DE18
    l: HIV.A.DE18

id:
  v: HIVARegistration.otherGender
path:
  v: HIVARegistration.otherGender
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE24
short:
  v: Other (specify)
definition:
  v: Additional category (please specify)
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVARegistration.sex
path:
  v: HIVARegistration.sex
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE25
short:
  v: Sex
definition:
  v: Sex of the client assigned at birth
min:
  v: 1
max:
  v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/hiv/ValueSet/HIV.A.DE25
    l: HIV.A.DE25

id:
  v: HIVARegistration.address
path:
  v: HIVARegistration.address
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE29
short:
  v: Address
definition:
  v: Client's home address or address which the client is consenting to disclose
min:
  v: 1
max:
  v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVARegistration.maritalStatus
path:
  v: HIVARegistration.maritalStatus
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE30
short:
  v: Marital Status
definition:
  v: Client's current marital status
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/hiv/ValueSet/HIV.A.DE30
    l: HIV.A.DE30

id:
  v: HIVARegistration.telephoneNumber
path:
  v: HIVARegistration.telephoneNumber
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE42
short:
  v: Telephone number
definition:
  v: Client's telephone number (a landline or a mobile phone number)
min:
  v: 1
max:
  v: 1
type:
  code:
    v: integer
    l: integer

id:
  v: HIVARegistration.administrativeArea
path:
  v: HIVARegistration.administrativeArea
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE43
short:
  v: Administrative Area
definition:
  v: 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.
min:
  v: 1
max:
  v: 1
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/hiv/ValueSet/HIV.A.DE43
    l: HIV.A.DE43

id:
  v: HIVARegistration.communicationConsent
path:
  v: HIVARegistration.communicationConsent
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE44
short:
  v: Communication consent
definition:
  v: Indication that client gave consent to be contacted
min:
  v: 0
max:
  v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVARegistration.reminderMessages
path:
  v: HIVARegistration.reminderMessages
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE45
short:
  v: Reminder messages
definition:
  v: Whether client wants to receive text or other messages as follow-up for HIV services
min:
  v: 0
max:
  v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVARegistration.communicationPreferences
path:
  v: HIVARegistration.communicationPreferences
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE46
short:
  v: Communication preference(s)
definition:
  v: How the client would like to receive family planning communications
min:
  v: 0
max:
  v: *
type:
  code:
    v: Coding
    l: Coding
binding:
  strength:
    v: required
  value set:
    v: http://smart.who.int/hiv/ValueSet/HIV.A.DE46
    l: HIV.A.DE46

id:
  v: HIVARegistration.clientEmail
path:
  v: HIVARegistration.clientEmail
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE49
short:
  v: Client's email
definition:
  v: Client's primary email account where the client can be contacted
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVARegistration.alternateContactName
path:
  v: HIVARegistration.alternateContactName
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE50
short:
  v: Alternate contact's name
definition:
  v: 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.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVARegistration.alternateContactPhoneNumber
path:
  v: HIVARegistration.alternateContactPhoneNumber
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE51
short:
  v: Alternate contact's phone number
definition:
  v: Phone number of the alternate contact
min:
  v: 0
max:
  v: 1
type:
  code:
    v: integer
    l: integer

id:
  v: HIVARegistration.alternateContactAddress
path:
  v: HIVARegistration.alternateContactAddress
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE52
short:
  v: Alternate contact's address
definition:
  v: Alternate contact's home address or address which the client is consenting to disclose
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVARegistration.alternateContactRelationship
path:
  v: HIVARegistration.alternateContactRelationship
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.A.DE53
short:
  v: Alternate contact relationship
definition:
  v: The alternate contact's relationship to the client (e.g. partner, husband, mother, sibling, etc.)
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string