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: HIVCaseData - Detailed Descriptions

Draft as of 2023-09-28

Definitions for the HIVCaseData logical model.

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

0. HIVCaseData
Definition

Initial case report filled out after enrollment.

ShortHIV Initial Case Report
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVCaseData.initialCaseReportDate
Definition

Initial Case Report

ShortInitial Case Report
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. HIVCaseData.dateHIVPositiveTest
Definition

Date of documented positive HIV test

ShortDate of documented positive HIV test
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. HIVCaseData.ageWhenDiagnosedWithHiv
Definition

Age at diagnosis

ShortAge at diagnosis
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. HIVCaseData.verticalTransmission
Definition

Vertical transmission

ShortVertical transmission
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. HIVCaseData.typeOfTesting
Definition

Type of community-level testing

ShortType of community-level testing
Control0..1
BindingFor example codes, see HIV Type of Testing Value Set
TypeCoding
12. HIVCaseData.facilityLevelTestingEntryPoint
Definition

Entry point for facility-level testing

ShortEntry point for facility-level testing
Control0..1
BindingFor example codes, see HIV Entry Points for Facility-Level Testing Value Set
TypeCoding
14. HIVCaseData.patientInKeyPopGroup
Definition

Does this person belong to any Key Population groups

ShortDoes this person belong to any Key Population groups
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. HIVCaseData.keyPopGroupMenWhoHaveSexWithMen
Definition

Key population - Men who have sex with men

ShortKey population - Men who have sex with men
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. HIVCaseData.keyPopGroupInjectionDrugUser
Definition

Key population - Injection drug user

ShortKey population - Injection drug user
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. HIVCaseData.keyPopGroupPrisoner
Definition

Key population - Prisoner

ShortKey population - Prisoner
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. HIVCaseData.keyPopGroupSexWorker
Definition

Key population - Sex worker

ShortKey population - Sex worker
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. HIVCaseData.keyPopGroupTransgender
Definition

Key population - Transgender

ShortKey population - Transgender
Control0..1
Typeboolean
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. HIVCaseData
Definition

Initial case report filled out after enrollment.

ShortHIV Initial Case Report
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVCaseData.initialCaseReportDate
Definition

Initial Case Report

ShortInitial Case Report
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. HIVCaseData.dateHIVPositiveTest
Definition

Date of documented positive HIV test

ShortDate of documented positive HIV test
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. HIVCaseData.ageWhenDiagnosedWithHiv
Definition

Age at diagnosis

ShortAge at diagnosis
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. HIVCaseData.verticalTransmission
Definition

Vertical transmission

ShortVertical transmission
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. HIVCaseData.typeOfTesting
Definition

Type of community-level testing

ShortType of community-level testing
Control0..1
BindingFor example codes, see HIV Type of Testing Value Set
TypeCoding
12. HIVCaseData.facilityLevelTestingEntryPoint
Definition

Entry point for facility-level testing

ShortEntry point for facility-level testing
Control0..1
BindingFor example codes, see HIV Entry Points for Facility-Level Testing Value Set
TypeCoding
14. HIVCaseData.patientInKeyPopGroup
Definition

Does this person belong to any Key Population groups

ShortDoes this person belong to any Key Population groups
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. HIVCaseData.keyPopGroupMenWhoHaveSexWithMen
Definition

Key population - Men who have sex with men

ShortKey population - Men who have sex with men
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. HIVCaseData.keyPopGroupInjectionDrugUser
Definition

Key population - Injection drug user

ShortKey population - Injection drug user
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. HIVCaseData.keyPopGroupPrisoner
Definition

Key population - Prisoner

ShortKey population - Prisoner
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. HIVCaseData.keyPopGroupSexWorker
Definition

Key population - Sex worker

ShortKey population - Sex worker
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. HIVCaseData.keyPopGroupTransgender
Definition

Key population - Transgender

ShortKey population - Transgender
Control0..1
Typeboolean
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. HIVCaseData
Definition

Initial case report filled out after enrollment.

ShortHIV Initial Case Report
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HIVCaseData.initialCaseReportDate
Definition

Initial Case Report

ShortInitial Case Report
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. HIVCaseData.dateHIVPositiveTest
Definition

Date of documented positive HIV test

ShortDate of documented positive HIV test
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. HIVCaseData.ageWhenDiagnosedWithHiv
Definition

Age at diagnosis

ShortAge at diagnosis
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. HIVCaseData.verticalTransmission
Definition

Vertical transmission

ShortVertical transmission
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. HIVCaseData.typeOfTesting
Definition

Type of community-level testing

ShortType of community-level testing
Control0..1
BindingFor example codes, see HIV Type of Testing Value Set
TypeCoding
12. HIVCaseData.facilityLevelTestingEntryPoint
Definition

Entry point for facility-level testing

ShortEntry point for facility-level testing
Control0..1
BindingFor example codes, see HIV Entry Points for Facility-Level Testing Value Set
TypeCoding
14. HIVCaseData.patientInKeyPopGroup
Definition

Does this person belong to any Key Population groups

ShortDoes this person belong to any Key Population groups
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. HIVCaseData.keyPopGroupMenWhoHaveSexWithMen
Definition

Key population - Men who have sex with men

ShortKey population - Men who have sex with men
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. HIVCaseData.keyPopGroupInjectionDrugUser
Definition

Key population - Injection drug user

ShortKey population - Injection drug user
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. HIVCaseData.keyPopGroupPrisoner
Definition

Key population - Prisoner

ShortKey population - Prisoner
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. HIVCaseData.keyPopGroupSexWorker
Definition

Key population - Sex worker

ShortKey population - Sex worker
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. HIVCaseData.keyPopGroupTransgender
Definition

Key population - Transgender

ShortKey population - Transgender
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension