HIVHFollowup
type: StructureDefinition
node role: treeRoot
id:
  v: HIVHFollowup
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 HIVHFollowup Profiles: CRMI Shareable StructureDefinition, CRMI Publishable StructureDefinition Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> HIVHFollowup 0..* Base HIV.H Follow-up Instances of this logical model can be the target of a Reference #xD; reasonForFollowUp 1..* Coding Reason for follow-up Binding: Reason for follow-up ValueSet (required) #xD; otherFollowUpReasonSpecify 0..1 string Other follow-up reason (specify) #xD; clientContactAttempted 0..1 boolean Client contact attempted #xD; dateOfContactAttempt 1..1 dateTime Date of contact attempt #xD; contactAttemptedBy 1..1 string Contact attempted by #xD; contactMethod 1..1 Coding Contact method Binding: Contact method ValueSet (required) #xD; sourceOfInformation 1..1 Coding Source of information Binding: Source of information ValueSet (required) #xD; otherSourceOfInformationSpecify 0..1 string Other source of information (specify) #xD; outcomeFromOutreachAttempt 0..1 Coding Outcome from outreach attempt Binding: Outcome from outreach attempt ValueSet (required) #xD; movedFromCatchmentArea 0..1 boolean Moved from catchment area #xD; dateClientMovedFromCatchmentArea 0..1 date Date client moved from catchment area #xD; newCatchmentArea 0..1 string New catchment area #xD; partnerOrContactOfIndexCase 0..1 boolean Partner or contact of index case #xD; hivStatusOfPartnerOrContact 0..1 Coding HIV status of partner or contact Binding: HIV status of partner or contact ValueSet (required) #xD; dateOfDeath 0..1 date Date of death #xD; causeOfDeath 0..1 string Cause of death #xD; placeOfDeath 0..1 string Place of death #xD; hivTreatmentOutcome 0..1 Coding HIV treatment outcome Binding: HIV treatment outcome ValueSet (required) #xD; datePatientLostToFollowUp 0..1 date Date patient lost to follow-up #xD; onArt 0..1 boolean On ART #xD; dateHivTreatmentOutcomeChanged 0..1 date Date HIV treatment outcome changed #xD; …
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/HIVHFollowup
  l: HIVHFollowup
version:
  v: 0.4.4
name:
  v: HIVHFollowup
title:
  v: HIV.H Follow-up
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 follow-up and contacting clients workflow (HIV.H)
fhir version:
  v: 4.0.1
kind:
  v: logical
abstract:
  v: false
type:
  v: http://smart.who.int/hiv/StructureDefinition/HIVHFollowup
  l: HIVHFollowup
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: HIVHFollowup
    path:
      v: HIVHFollowup
    short:
      v: HIV.H Follow-up
    definition:
      v: This tab describes the data that are collected during the follow-up and contacting clients workflow (HIV.H)
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    is modifier:
      v: false
  element:
    id:
      v: HIVHFollowup.reasonForFollowUp
    path:
      v: HIVHFollowup.reasonForFollowUp
    code:
      system:
        v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
        l: HIVConcepts
      code:
        v: HIV.H.DE1
    short:
      v: Reason for follow-up
    definition:
      v: The reason why the client is being followed up
    min:
      v: 1
    max:
      v: *
    base:
      path:
        v: HIVHFollowup.reasonForFollowUp
      min:
        v: 1
      max:
        v: *
    type:
      code:
        v: Coding
        l: Coding
    binding:
      strength:
        v: required
      value set:
        v: http://smart.who.int/hiv/ValueSet/HIV.H.DE1
        l: HIV.H.DE1
  element:
    id:
      v: HIVHFollowup.otherFollowUpReasonSpecify
    path:
      v: HIVHFollowup.otherFollowUpReasonSpecify
    code:
      system:
        v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
        l: HIVConcepts
      code:
        v: HIV.H.DE9
    short:
      v: Other follow-up reason (specify)
    definition:
      v: Client was followed up for another reason (specify)
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: HIVHFollowup.otherFollowUpReasonSpecify
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: string
        l: string
  element:
    id:
      v: HIVHFollowup.clientContactAttempted
    path:
      v: HIVHFollowup.clientContactAttempted
    code:
      system:
        v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
        l: HIVConcepts
      code:
        v: HIV.H.DE10
    short:
      v: Client contact attempted
    definition:
      v: An attempt to locate the client was made
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: HIVHFollowup.clientContactAttempted
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: boolean
        l: boolean
  element:
    id:
      v: HIVHFollowup.dateOfContactAttempt
    path:
      v: HIVHFollowup.dateOfContactAttempt
    code:
      system:
        v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
        l: HIVConcepts
      code:
        v: HIV.H.DE11
    short:
      v: Date of contact attempt
    definition:
      v: Date of attempt to contact client

v: 1

v: 1

path:
  v: HIVHFollowup.dateOfContactAttempt
min:
  v: 1
max:
  v: 1

code:
  v: dateTime
  l: dateTime

id:
  v: HIVHFollowup.contactAttemptedBy
path:
  v: HIVHFollowup.contactAttemptedBy
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE12
short:
  v: Contact attempted by
definition:
  v: Who attempted to reach out to the client
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HIVHFollowup.contactAttemptedBy
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVHFollowup.contactMethod
path:
  v: HIVHFollowup.contactMethod
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE13
short:
  v: Contact method
definition:
  v: Method used to try to reach out to the client
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HIVHFollowup.contactMethod
  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.H.DE13
    l: HIV.H.DE13

id:
  v: HIVHFollowup.sourceOfInformation
path:
  v: HIVHFollowup.sourceOfInformation
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE17
short:
  v: Source of information
definition:
  v: Source of information about the client
min:
  v: 1
max:
  v: 1
base:
  path:
    v: HIVHFollowup.sourceOfInformation
  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.H.DE17
    l: HIV.H.DE17

id:
  v: HIVHFollowup.otherSourceOfInformationSpecify
path:
  v: HIVHFollowup.otherSourceOfInformationSpecify
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE22
short:
  v: Other source of information (specify)
definition:
  v: Information about the client's status was provided by someone else (specify)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.otherSourceOfInformationSpecify
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVHFollowup.outcomeFromOutreachAttempt
path:
  v: HIVHFollowup.outcomeFromOutreachAttempt
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE23
short:
  v: Outcome from outreach attempt
definition:
  v: Detailed outcome from the attempt to locate the client
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.outcomeFromOutreachAttempt
  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.H.DE23
    l: HIV.H.DE23

id:
  v: HIVHFollowup.movedFromCatchmentArea
path:
  v: HIVHFollowup.movedFromCatchmentArea
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE30
short:
  v: Moved from catchment area
definition:
  v: The client moved from the catchment area (may be reported from the community level)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.movedFromCatchmentArea
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVHFollowup.dateClientMovedFromCatchmentArea
path:
  v: HIVHFollowup.dateClientMovedFromCatchmentArea
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE31
short:
  v: Date client moved from catchment area
definition:
  v: The date on which the client moved from the catchment area, if known
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.dateClientMovedFromCatchmentArea
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVHFollowup.newCatchmentArea
path:
  v: HIVHFollowup.newCatchmentArea
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE32
short:
  v: New catchment area
definition:
  v: New catchment area where the client resides
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.newCatchmentArea
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVHFollowup.partnerOrContactOfIndexCase
path:
  v: HIVHFollowup.partnerOrContactOfIndexCase
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE33
short:
  v: Partner or contact of index case
definition:
  v: The client was identified by an index case as a partner or contact
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.partnerOrContactOfIndexCase
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVHFollowup.hivStatusOfPartnerOrContact
path:
  v: HIVHFollowup.hivStatusOfPartnerOrContact
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE34
short:
  v: HIV status of partner or contact
definition:
  v: HIV status of the partner or contact given by the index case
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.hivStatusOfPartnerOrContact
  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.H.DE34
    l: HIV.H.DE34

id:
  v: HIVHFollowup.dateOfDeath
path:
  v: HIVHFollowup.dateOfDeath
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE38
short:
  v: Date of death
definition:
  v: If deceased, the date that the client died
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.dateOfDeath
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVHFollowup.causeOfDeath
path:
  v: HIVHFollowup.causeOfDeath
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE39
short:
  v: Cause of death
definition:
  v: Cause of death, if known
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.causeOfDeath
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVHFollowup.placeOfDeath
path:
  v: HIVHFollowup.placeOfDeath
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE40
short:
  v: Place of death
definition:
  v: Where the client died, if known
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.placeOfDeath
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVHFollowup.hivTreatmentOutcome
path:
  v: HIVHFollowup.hivTreatmentOutcome
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE41
short:
  v: HIV treatment outcome
definition:
  v: The outcome for the client which is used for reporting retention/attrition.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.hivTreatmentOutcome
  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.H.DE41
    l: HIV.H.DE41

id:
  v: HIVHFollowup.datePatientLostToFollowUp
path:
  v: HIVHFollowup.datePatientLostToFollowUp
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE46
short:
  v: Date patient lost to follow-up
definition:
  v: Date patient was lost to follow-up (LTFU)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.datePatientLostToFollowUp
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVHFollowup.onArt
path:
  v: HIVHFollowup.onArt
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE47
short:
  v: On ART
definition:
  v: Client is currently taking ART
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.onArt
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVHFollowup.dateHivTreatmentOutcomeChanged
path:
  v: HIVHFollowup.dateHivTreatmentOutcomeChanged
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE48
short:
  v: Date HIV treatment outcome changed
definition:
  v: The date on which the client's outcome (lost to follow-up, transferred out, death (documented), or refused (stopped) treatment) changed
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.dateHivTreatmentOutcomeChanged
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVHFollowup.transferConfirmed
path:
  v: HIVHFollowup.transferConfirmed
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE49
short:
  v: Transfer confirmed
definition:
  v: Select if transfer to another facility is confirmed
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.transferConfirmed
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVHFollowup.transferToFacility
path:
  v: HIVHFollowup.transferToFacility
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE50
short:
  v: Transfer to facility
definition:
  v: Name of health facility client was transferred to
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.transferToFacility
  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.H.DE50
    l: HIV.H.DE50

id:
  v: HIVHFollowup.dateOfTransferOut
path:
  v: HIVHFollowup.dateOfTransferOut
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE51
short:
  v: Date of transfer out
definition:
  v: The date the client transferred out of the facility to be provided with care at another facility
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.dateOfTransferOut
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVHFollowup.adherenceAssessment
path:
  v: HIVHFollowup.adherenceAssessment
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE52
short:
  v: Adherence assessment
definition:
  v: Whether client is adherent or not to ART regimen per national guidelines (immunological or virological monitoring)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.adherenceAssessment
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVHFollowup.reasonsForAdherenceProblem
path:
  v: HIVHFollowup.reasonsForAdherenceProblem
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE53
short:
  v: Reason(s) for adherence problem
definition:
  v: Reason why client is not adherent
min:
  v: 0
max:
  v: *
base:
  path:
    v: HIVHFollowup.reasonsForAdherenceProblem
  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.H.DE53
    l: HIV.H.DE53

id:
  v: HIVHFollowup.otherReasonsForAdherenceProblem
path:
  v: HIVHFollowup.otherReasonsForAdherenceProblem
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE72
short:
  v: Other (specify)
definition:
  v: Client reported not being adherent because of other reason (specify)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.otherReasonsForAdherenceProblem
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVHFollowup.dateArtStopped
path:
  v: HIVHFollowup.dateArtStopped
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE73
short:
  v: Date ART stopped
definition:
  v: Date on which client stopped ART
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.dateArtStopped
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVHFollowup.reasonArtStopped
path:
  v: HIVHFollowup.reasonArtStopped
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE74
short:
  v: Reason ART stopped
definition:
  v: Reason why client intentionally stopped ART
min:
  v: 0
max:
  v: *
base:
  path:
    v: HIVHFollowup.reasonArtStopped
  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.H.DE74
    l: HIV.H.DE74

id:
  v: HIVHFollowup.otherReasonForStoppingArtSpecify
path:
  v: HIVHFollowup.otherReasonForStoppingArtSpecify
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE81
short:
  v: Other reason for stopping ART (specify)
definition:
  v: Client stopped ART for other reason (specify)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HIVHFollowup.otherReasonForStoppingArtSpecify
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

element:
  id:
    v: HIVHFollowup
  path:
    v: HIVHFollowup
  short:
    v: HIV.H Follow-up
  definition:
    v: This tab describes the data that are collected during the follow-up and contacting clients workflow (HIV.H)
element:
  id:
    v: HIVHFollowup.reasonForFollowUp
  path:
    v: HIVHFollowup.reasonForFollowUp
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.H.DE1
  short:
    v: Reason for follow-up
  definition:
    v: The reason why the client is being followed up
  min:
    v: 1
  max:
    v: *
  type:
    code:
      v: Coding
      l: Coding
  binding:
    strength:
      v: required
    value set:
      v: http://smart.who.int/hiv/ValueSet/HIV.H.DE1
      l: HIV.H.DE1
element:
  id:
    v: HIVHFollowup.otherFollowUpReasonSpecify
  path:
    v: HIVHFollowup.otherFollowUpReasonSpecify
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.H.DE9
  short:
    v: Other follow-up reason (specify)
  definition:
    v: Client was followed up for another reason (specify)
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: HIVHFollowup.clientContactAttempted
  path:
    v: HIVHFollowup.clientContactAttempted
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.H.DE10
  short:
    v: Client contact attempted
  definition:
    v: An attempt to locate the client was made
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: boolean
      l: boolean
element:
  id:
    v: HIVHFollowup.dateOfContactAttempt
  path:
    v: HIVHFollowup.dateOfContactAttempt
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.H.DE11
  short:
    v: Date of contact attempt
  definition:
    v: Date of attempt to contact client
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: dateTime
      l: dateTime
element:
  id:
    v: HIVHFollowup.contactAttemptedBy
  path:
    v: HIVHFollowup.contactAttemptedBy
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.H.DE12
  short:
    v: Contact attempted by
  definition:
    v: Who attempted to reach out to the client
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: HIVHFollowup.contactMethod
  path:
    v: HIVHFollowup.contactMethod
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.H.DE13
  short:
    v: Contact method
  definition:
    v: Method used to try to reach out to 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.H.DE13
      l: HIV.H.DE13
element:
  id:
    v: HIVHFollowup.sourceOfInformation
  path:
    v: HIVHFollowup.sourceOfInformation
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.H.DE17
  short:
    v: Source of information
  definition:
    v: Source of information about 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.H.DE17
      l: HIV.H.DE17
element:
  id:
    v: HIVHFollowup.otherSourceOfInformationSpecify
  path:
    v: HIVHFollowup.otherSourceOfInformationSpecify
  code:
    system:
      v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
      l: HIVConcepts
    code:
      v: HIV.H.DE22
  short:
    v: Other source of information (specify)

v: Information about the client's status was provided by someone else (specify)

v: 0

v: 1

code:
  v: string
  l: string

id:
  v: HIVHFollowup.outcomeFromOutreachAttempt
path:
  v: HIVHFollowup.outcomeFromOutreachAttempt
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE23
short:
  v: Outcome from outreach attempt
definition:
  v: Detailed outcome from the attempt to locate the client
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.H.DE23
    l: HIV.H.DE23

id:
  v: HIVHFollowup.movedFromCatchmentArea
path:
  v: HIVHFollowup.movedFromCatchmentArea
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE30
short:
  v: Moved from catchment area
definition:
  v: The client moved from the catchment area (may be reported from the community level)
min:
  v: 0
max:
  v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVHFollowup.dateClientMovedFromCatchmentArea
path:
  v: HIVHFollowup.dateClientMovedFromCatchmentArea
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE31
short:
  v: Date client moved from catchment area
definition:
  v: The date on which the client moved from the catchment area, if known
min:
  v: 0
max:
  v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVHFollowup.newCatchmentArea
path:
  v: HIVHFollowup.newCatchmentArea
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE32
short:
  v: New catchment area
definition:
  v: New catchment area where the client resides
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVHFollowup.partnerOrContactOfIndexCase
path:
  v: HIVHFollowup.partnerOrContactOfIndexCase
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE33
short:
  v: Partner or contact of index case
definition:
  v: The client was identified by an index case as a partner or contact
min:
  v: 0
max:
  v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVHFollowup.hivStatusOfPartnerOrContact
path:
  v: HIVHFollowup.hivStatusOfPartnerOrContact
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE34
short:
  v: HIV status of partner or contact
definition:
  v: HIV status of the partner or contact given by the index case
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.H.DE34
    l: HIV.H.DE34

id:
  v: HIVHFollowup.dateOfDeath
path:
  v: HIVHFollowup.dateOfDeath
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE38
short:
  v: Date of death
definition:
  v: If deceased, the date that the client died
min:
  v: 0
max:
  v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVHFollowup.causeOfDeath
path:
  v: HIVHFollowup.causeOfDeath
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE39
short:
  v: Cause of death
definition:
  v: Cause of death, if known
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVHFollowup.placeOfDeath
path:
  v: HIVHFollowup.placeOfDeath
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE40
short:
  v: Place of death
definition:
  v: Where the client died, if known
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVHFollowup.hivTreatmentOutcome
path:
  v: HIVHFollowup.hivTreatmentOutcome
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE41
short:
  v: HIV treatment outcome
definition:
  v: The outcome for the client which is used for reporting retention/attrition.
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.H.DE41
    l: HIV.H.DE41

id:
  v: HIVHFollowup.datePatientLostToFollowUp
path:
  v: HIVHFollowup.datePatientLostToFollowUp
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE46
short:
  v: Date patient lost to follow-up
definition:
  v: Date patient was lost to follow-up (LTFU)
min:
  v: 0
max:
  v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVHFollowup.onArt
path:
  v: HIVHFollowup.onArt
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE47
short:
  v: On ART
definition:
  v: Client is currently taking ART
min:
  v: 0
max:
  v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVHFollowup.dateHivTreatmentOutcomeChanged
path:
  v: HIVHFollowup.dateHivTreatmentOutcomeChanged
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE48
short:
  v: Date HIV treatment outcome changed
definition:
  v: The date on which the client's outcome (lost to follow-up, transferred out, death (documented), or refused (stopped) treatment) changed
min:
  v: 0
max:
  v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVHFollowup.transferConfirmed
path:
  v: HIVHFollowup.transferConfirmed
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE49
short:
  v: Transfer confirmed
definition:
  v: Select if transfer to another facility is confirmed
min:
  v: 0
max:
  v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVHFollowup.transferToFacility
path:
  v: HIVHFollowup.transferToFacility
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE50
short:
  v: Transfer to facility
definition:
  v: Name of health facility client was transferred to
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.H.DE50
    l: HIV.H.DE50

id:
  v: HIVHFollowup.dateOfTransferOut
path:
  v: HIVHFollowup.dateOfTransferOut
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE51
short:
  v: Date of transfer out
definition:
  v: The date the client transferred out of the facility to be provided with care at another facility
min:
  v: 0
max:
  v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVHFollowup.adherenceAssessment
path:
  v: HIVHFollowup.adherenceAssessment
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE52
short:
  v: Adherence assessment
definition:
  v: Whether client is adherent or not to ART regimen per national guidelines (immunological or virological monitoring)
min:
  v: 0
max:
  v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: HIVHFollowup.reasonsForAdherenceProblem
path:
  v: HIVHFollowup.reasonsForAdherenceProblem
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE53
short:
  v: Reason(s) for adherence problem
definition:
  v: Reason why client is not adherent
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.H.DE53
    l: HIV.H.DE53

id:
  v: HIVHFollowup.otherReasonsForAdherenceProblem
path:
  v: HIVHFollowup.otherReasonsForAdherenceProblem
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE72
short:
  v: Other (specify)
definition:
  v: Client reported not being adherent because of other reason (specify)
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string

id:
  v: HIVHFollowup.dateArtStopped
path:
  v: HIVHFollowup.dateArtStopped
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE73
short:
  v: Date ART stopped
definition:
  v: Date on which client stopped ART
min:
  v: 0
max:
  v: 1
type:
  code:
    v: date
    l: date

id:
  v: HIVHFollowup.reasonArtStopped
path:
  v: HIVHFollowup.reasonArtStopped
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE74
short:
  v: Reason ART stopped
definition:
  v: Reason why client intentionally stopped ART
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.H.DE74
    l: HIV.H.DE74

id:
  v: HIVHFollowup.otherReasonForStoppingArtSpecify
path:
  v: HIVHFollowup.otherReasonForStoppingArtSpecify
code:
  system:
    v: http://smart.who.int/hiv/CodeSystem/HIVConcepts
    l: HIVConcepts
  code:
    v: HIV.H.DE81
short:
  v: Other reason for stopping ART (specify)
definition:
  v: Client stopped ART for other reason (specify)
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string