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

DHIS2 Example FHIR Implementation Guide, published by DHIS2. This is not an authorized publication; it is the continuous build for version 1.0.0). 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: HIVPatientInfo - Detailed Descriptions

Draft as of 2023-09-28

Definitions for the HIVPatientInfo logical model.

Guidance on how to interpret the contents of this table can be found here

0. HIVPatientInfo
Definition

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

ShortHIV Patient Data Model
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVPatientInfo.hivEnrollmentUnit
Definition

The organization unit that first registered the person.

ShortThe organization unit that first registered the person.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. HIVPatientInfo.programNationaId
Definition

...

Short...
Control0..*
TypeIdentifier
6. HIVPatientInfo.deceased
Definition

...

Short...
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. HIVPatientInfo.deceasedDate
Definition

...

Short...
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. HIVPatientInfo.gender
Comments

(valueset depends on the program)

Control1..1
BindingFor example codes, see Patient Gender Value Set
TypeCoding
12. HIVPatientInfo.healthFacilityCode
Definition

Health facility code.

ShortHealth facility code.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. HIVPatientInfo.nhisId
Definition

...

Short...
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. HIVPatientInfo
Definition

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

ShortHIV Patient Data Model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVPatientInfo.registrationDateTime
Definition

Date and Time when the patient information was entered into DHIS2

ShortDate-Time information was entered
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. HIVPatientInfo.firstregisteredAt
Definition

The Org unit where the patient was first registered

ShortThe Org unit where the patient was first registered
Control1..1
TypeReference(Organization)
6. HIVPatientInfo.dateOfBirth
Definition

...

Short...
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. HIVPatientInfo.sexAtBirth
Definition

...

Short...
Comments

(valueset depends on the program)

Control1..1
BindingFor example codes, see Patient Sex at Birth Value Set
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. HIVPatientInfo.currentHomeAddress
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. HIVPatientInfo.contactPhoneNumber
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. HIVPatientInfo.hivEnrollmentUnit
Definition

The organization unit that first registered the person.

ShortThe organization unit that first registered the person.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. HIVPatientInfo.programNationaId
Definition

...

Short...
Control0..*
TypeIdentifier
18. HIVPatientInfo.deceased
Definition

...

Short...
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. HIVPatientInfo.deceasedDate
Definition

...

Short...
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. HIVPatientInfo.gender
Comments

(valueset depends on the program)

Control1..1
BindingFor example codes, see Patient Gender Value Set
TypeCoding
24. HIVPatientInfo.healthFacilityCode
Definition

Health facility code.

ShortHealth facility code.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. HIVPatientInfo.nhisId
Definition

...

Short...
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. HIVPatientInfo
Definition

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

ShortHIV Patient Data Model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVPatientInfo.registrationDateTime
Definition

Date and Time when the patient information was entered into DHIS2

ShortDate-Time information was entered
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. HIVPatientInfo.firstregisteredAt
Definition

The Org unit where the patient was first registered

ShortThe Org unit where the patient was first registered
Control1..1
TypeReference(Organization)
6. HIVPatientInfo.firstName
Definition

Given name of the patient

ShortGiven name of the patient
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. HIVPatientInfo.lastName
Definition

Family name

ShortFamily name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. HIVPatientInfo.dateOfBirth
Definition

...

Short...
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. HIVPatientInfo.dateOfBirthIsEstimated
Definition

...

Short...
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. HIVPatientInfo.sexAtBirth
Definition

...

Short...
Comments

(valueset depends on the program)

Control1..1
BindingFor example codes, see Patient Sex at Birth Value Set
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. HIVPatientInfo.currentHomeAddress
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. HIVPatientInfo.contactPhoneNumber
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. HIVPatientInfo.countryOfBirth
Definition

...

Short...
Control0..1
BindingFor example codes, see urn:iso:std:iso:3166
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. HIVPatientInfo.nationaId
Definition

...

Short...
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. HIVPatientInfo.consent
Definition

...

Short...
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. HIVPatientInfo.hivEnrollmentUnit
Definition

The organization unit that first registered the person.

ShortThe organization unit that first registered the person.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. HIVPatientInfo.programNationaId
Definition

...

Short...
Control0..*
TypeIdentifier
30. HIVPatientInfo.deceased
Definition

...

Short...
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. HIVPatientInfo.deceasedDate
Definition

...

Short...
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. HIVPatientInfo.gender
Comments

(valueset depends on the program)

Control1..1
BindingFor example codes, see Patient Gender Value Set
TypeCoding
36. HIVPatientInfo.healthFacilityCode
Definition

Health facility code.

ShortHealth facility code.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. HIVPatientInfo.nhisId
Definition

...

Short...
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension