DHIS2 Example FHIR Implementation Guide
1.0.0 - ci-build International flag

DHIS2 Example FHIR Implementation Guide, published by DHIS2. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/JohanGHole/alldevs-demo-ig and changes regularly. See the Directory of published versions

Logical Model: HIV Patient Data Model

Official URL: https://dhis2.org/StructureDefinition/HIVPatientInfo Version: 1.0.0
Draft as of 2026-06-03 Computable Name: HIVPatientInfo

Extension of the base patient data model. Includes properties specific to the HIV program.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVPatientInfo 0..* PatientInfo HIV Patient Data Model

Elements defined in Ancestors:registrationDateTime, firstregisteredAt, firstName, lastName, dateOfBirth, dateOfBirthIsEstimated, sexAtBirth, currentHomeAddress, contactPhoneNumber, countryOfBirth, nationaId, consent
... hivEnrollmentUnit 0..1 string The organization unit that first registered the person.
... programNationaId 0..* Identifier ...
... deceased 0..1 boolean ...
... gender 1..1 Coding Binding: Patient Gender Value Set (example)
... healthFacilityCode 0..1 string Health facility code.
... nhisId 0..1 string ...

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HIVPatientInfo.gender Base example Patient Gender Value Set 📦1.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVPatientInfo 0..* PatientInfo HIV Patient Data Model

Elements defined in Ancestors:registrationDateTime, firstregisteredAt, firstName, lastName, dateOfBirth, dateOfBirthIsEstimated, sexAtBirth, currentHomeAddress, contactPhoneNumber, countryOfBirth, nationaId, consent
... registrationDateTime 1..1 dateTime Date-Time information was entered
... firstregisteredAt 1..1 Reference(Organization) The Org unit where the patient was first registered
... firstName 0..1 string Given name of the patient
... dateOfBirth 1..1 string ...
... dateOfBirthIsEstimated 0..1 boolean ...
... sexAtBirth 1..1 code ...
Binding: Patient Sex at Birth Value Set (example)
... currentHomeAddress 1..1 string
... contactPhoneNumber 1..1 string
... countryOfBirth 0..1 string ...
Binding: urn:iso:std:iso:3166 (example)
... nationaId 0..1 string ...
... consent 0..1 boolean ...
... hivEnrollmentUnit 0..1 string The organization unit that first registered the person.
... programNationaId 0..* Identifier ...
... deceased 0..1 boolean ...
... deceasedDate 0..1 boolean ...
... gender 1..1 Coding Binding: Patient Gender Value Set (example)
... healthFacilityCode 0..1 string Health facility code.
... nhisId 0..1 string ...

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HIVPatientInfo.sexAtBirth Base example Patient Sex at Birth Value Set 📦1.0.0 This IG
HIVPatientInfo.countryOfBirth Base example

urn:iso:std:iso:3166

 Not State Unknown
HIVPatientInfo.gender Base example Patient Gender Value Set 📦1.0.0 This IG

Summary

Mandatory: 0 element(1 nested mandatory element)

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVPatientInfo 0..* PatientInfo HIV Patient Data Model

Elements defined in Ancestors:registrationDateTime, firstregisteredAt, firstName, lastName, dateOfBirth, dateOfBirthIsEstimated, sexAtBirth, currentHomeAddress, contactPhoneNumber, countryOfBirth, nationaId, consent
... hivEnrollmentUnit 0..1 string The organization unit that first registered the person.
... programNationaId 0..* Identifier ...
... deceased 0..1 boolean ...
... gender 1..1 Coding Binding: Patient Gender Value Set (example)
... healthFacilityCode 0..1 string Health facility code.
... nhisId 0..1 string ...

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HIVPatientInfo.gender Base example Patient Gender Value Set 📦1.0.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HIVPatientInfo 0..* PatientInfo HIV Patient Data Model

Elements defined in Ancestors:registrationDateTime, firstregisteredAt, firstName, lastName, dateOfBirth, dateOfBirthIsEstimated, sexAtBirth, currentHomeAddress, contactPhoneNumber, countryOfBirth, nationaId, consent
... registrationDateTime 1..1 dateTime Date-Time information was entered
... firstregisteredAt 1..1 Reference(Organization) The Org unit where the patient was first registered
... firstName 0..1 string Given name of the patient
... dateOfBirth 1..1 string ...
... dateOfBirthIsEstimated 0..1 boolean ...
... sexAtBirth 1..1 code ...
Binding: Patient Sex at Birth Value Set (example)
... currentHomeAddress 1..1 string
... contactPhoneNumber 1..1 string
... countryOfBirth 0..1 string ...
Binding: urn:iso:std:iso:3166 (example)
... nationaId 0..1 string ...
... consent 0..1 boolean ...
... hivEnrollmentUnit 0..1 string The organization unit that first registered the person.
... programNationaId 0..* Identifier ...
... deceased 0..1 boolean ...
... deceasedDate 0..1 boolean ...
... gender 1..1 Coding Binding: Patient Gender Value Set (example)
... healthFacilityCode 0..1 string Health facility code.
... nhisId 0..1 string ...

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HIVPatientInfo.sexAtBirth Base example Patient Sex at Birth Value Set 📦1.0.0 This IG
HIVPatientInfo.countryOfBirth Base example

urn:iso:std:iso:3166

 Not State Unknown
HIVPatientInfo.gender Base example Patient Gender Value Set 📦1.0.0 This IG

Summary

Mandatory: 0 element(1 nested mandatory element)

 

Other representations of profile: CSV, Excel