DHIS2 Example FHIR Implementation Guide
1.0.0 - ci-build
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
| 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. |
| Short | HIV Patient Data Model |
| Logical Model | Instances 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. |
| Short | The organization unit that first registered the person. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. HIVPatientInfo.programNationaId | |
| Definition | ... |
| Short | ... |
| Control | 0..* |
| Type | Identifier |
| 6. HIVPatientInfo.deceased | |
| Definition | ... |
| Short | ... |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. HIVPatientInfo.deceasedDate | |
| Definition | ... |
| Short | ... |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. HIVPatientInfo.gender | |
| Comments | (valueset depends on the program) |
| Control | 1..1 |
| Binding | For example codes, see Patient Gender Value Set |
| Type | Coding |
| 12. HIVPatientInfo.healthFacilityCode | |
| Definition | Health facility code. |
| Short | Health facility code. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. HIVPatientInfo.nhisId | |
| Definition | ... |
| Short | ... |
| Control | 0..1 |
| Type | string |
| Primitive Value | This 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. |
| Short | HIV Patient Data Model |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances 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 |
| Short | Date-Time information was entered |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This 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 |
| Short | The Org unit where the patient was first registered |
| Control | 1..1 |
| Type | Reference(Organization) |
| 6. HIVPatientInfo.dateOfBirth | |
| Definition | ... |
| Short | ... |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. HIVPatientInfo.sexAtBirth | |
| Definition | ... |
| Short | ... |
| Comments | (valueset depends on the program) |
| Control | 1..1 |
| Binding | For example codes, see Patient Sex at Birth Value Set |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. HIVPatientInfo.currentHomeAddress | |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. HIVPatientInfo.contactPhoneNumber | |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. HIVPatientInfo.hivEnrollmentUnit | |
| Definition | The organization unit that first registered the person. |
| Short | The organization unit that first registered the person. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. HIVPatientInfo.programNationaId | |
| Definition | ... |
| Short | ... |
| Control | 0..* |
| Type | Identifier |
| 18. HIVPatientInfo.deceased | |
| Definition | ... |
| Short | ... |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. HIVPatientInfo.deceasedDate | |
| Definition | ... |
| Short | ... |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. HIVPatientInfo.gender | |
| Comments | (valueset depends on the program) |
| Control | 1..1 |
| Binding | For example codes, see Patient Gender Value Set |
| Type | Coding |
| 24. HIVPatientInfo.healthFacilityCode | |
| Definition | Health facility code. |
| Short | Health facility code. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. HIVPatientInfo.nhisId | |
| Definition | ... |
| Short | ... |
| Control | 0..1 |
| Type | string |
| Primitive Value | This 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. |
| Short | HIV Patient Data Model |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances 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 |
| Short | Date-Time information was entered |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This 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 |
| Short | The Org unit where the patient was first registered |
| Control | 1..1 |
| Type | Reference(Organization) |
| 6. HIVPatientInfo.firstName | |
| Definition | Given name of the patient |
| Short | Given name of the patient |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. HIVPatientInfo.lastName | |
| Definition | Family name |
| Short | Family name |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. HIVPatientInfo.dateOfBirth | |
| Definition | ... |
| Short | ... |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. HIVPatientInfo.dateOfBirthIsEstimated | |
| Definition | ... |
| Short | ... |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. HIVPatientInfo.sexAtBirth | |
| Definition | ... |
| Short | ... |
| Comments | (valueset depends on the program) |
| Control | 1..1 |
| Binding | For example codes, see Patient Sex at Birth Value Set |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. HIVPatientInfo.currentHomeAddress | |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. HIVPatientInfo.contactPhoneNumber | |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. HIVPatientInfo.countryOfBirth | |
| Definition | ... |
| Short | ... |
| Control | 0..1 |
| Binding | For example codes, see urn:iso:std:iso:3166 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. HIVPatientInfo.nationaId | |
| Definition | ... |
| Short | ... |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. HIVPatientInfo.consent | |
| Definition | ... |
| Short | ... |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. HIVPatientInfo.hivEnrollmentUnit | |
| Definition | The organization unit that first registered the person. |
| Short | The organization unit that first registered the person. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. HIVPatientInfo.programNationaId | |
| Definition | ... |
| Short | ... |
| Control | 0..* |
| Type | Identifier |
| 30. HIVPatientInfo.deceased | |
| Definition | ... |
| Short | ... |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. HIVPatientInfo.deceasedDate | |
| Definition | ... |
| Short | ... |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. HIVPatientInfo.gender | |
| Comments | (valueset depends on the program) |
| Control | 1..1 |
| Binding | For example codes, see Patient Gender Value Set |
| Type | Coding |
| 36. HIVPatientInfo.healthFacilityCode | |
| Definition | Health facility code. |
| Short | Health facility code. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. HIVPatientInfo.nhisId | |
| Definition | ... |
| Short | ... |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |