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: HIV Patient Data Model

Official URL: https://dhis2.org/StructureDefinition/HIVPatientInfo Version: 1.0.0
Draft as of 2023-09-28 Computable Name: HIVPatientInfo

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

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from PatientInfo

NameFlagsCard.TypeDescription & Constraintsdoco
.. HIVPatientInfo 0..*PatientInfoHIV Patient Data Model
Instances of this logical model are not marked to be the target of a Reference
... hivEnrollmentUnit 0..1stringThe organization unit that first registered the person.
... programNationaId 0..*Identifier...
... deceased 0..1boolean...
... gender 1..1CodingBinding: Patient Gender Value Set (example)
... healthFacilityCode 0..1stringHealth facility code.
... nhisId 0..1string...

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
HIVPatientInfo.genderexampleHIVPatientGenderVS (a valid code from Patient Gender)
NameFlagsCard.TypeDescription & Constraintsdoco
.. HIVPatientInfo 0..*PatientInfoHIV Patient Data Model
Instances of this logical model are not marked to be the target of a Reference
... registrationDateTime 1..1dateTimeDate-Time information was entered
... firstregisteredAt 1..1Reference(Organization)The Org unit where the patient was first registered
... dateOfBirth 1..1string...
... currentHomeAddress 1..1string
... contactPhoneNumber 1..1string
... hivEnrollmentUnit 0..1stringThe organization unit that first registered the person.
... programNationaId 0..*Identifier...
... deceased 0..1boolean...
... deceasedDate 0..1boolean...
... gender 1..1CodingBinding: Patient Gender Value Set (example)
... healthFacilityCode 0..1stringHealth facility code.
... nhisId 0..1string...

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HIVPatientInfo.sexAtBirthexamplePatientSexAtBirthVS (a valid code from Patient Sex at Birth)
HIVPatientInfo.genderexampleHIVPatientGenderVS (a valid code from Patient Gender)
NameFlagsCard.TypeDescription & Constraintsdoco
.. HIVPatientInfo 0..*PatientInfoHIV Patient Data Model
Instances of this logical model are not marked to be the target of a Reference
... registrationDateTime 1..1dateTimeDate-Time information was entered
... firstregisteredAt 1..1Reference(Organization)The Org unit where the patient was first registered
... firstName 0..1stringGiven name of the patient
... dateOfBirth 1..1string...
... dateOfBirthIsEstimated 0..1boolean...
... sexAtBirth 1..1code...
Binding: Patient Sex at Birth Value Set (example)
... currentHomeAddress 1..1string
... contactPhoneNumber 1..1string
... countryOfBirth 0..1string...
Binding: urn:iso:std:iso:3166 (example)
... nationaId 0..1string...
... consent 0..1boolean...
... hivEnrollmentUnit 0..1stringThe organization unit that first registered the person.
... programNationaId 0..*Identifier...
... deceased 0..1boolean...
... deceasedDate 0..1boolean...
... gender 1..1CodingBinding: Patient Gender Value Set (example)
... healthFacilityCode 0..1stringHealth facility code.
... nhisId 0..1string...

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HIVPatientInfo.sexAtBirthexamplePatientSexAtBirthVS (a valid code from Patient Sex at Birth)
HIVPatientInfo.countryOfBirthexample

urn:iso:std:iso:3166

HIVPatientInfo.genderexampleHIVPatientGenderVS (a valid code from Patient Gender)

This structure is derived from PatientInfo

Summary

Mandatory: 0 element (1 nested mandatory element)

Differential View

This structure is derived from PatientInfo

NameFlagsCard.TypeDescription & Constraintsdoco
.. HIVPatientInfo 0..*PatientInfoHIV Patient Data Model
Instances of this logical model are not marked to be the target of a Reference
... hivEnrollmentUnit 0..1stringThe organization unit that first registered the person.
... programNationaId 0..*Identifier...
... deceased 0..1boolean...
... gender 1..1CodingBinding: Patient Gender Value Set (example)
... healthFacilityCode 0..1stringHealth facility code.
... nhisId 0..1string...

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
HIVPatientInfo.genderexampleHIVPatientGenderVS (a valid code from Patient Gender)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HIVPatientInfo 0..*PatientInfoHIV Patient Data Model
Instances of this logical model are not marked to be the target of a Reference
... registrationDateTime 1..1dateTimeDate-Time information was entered
... firstregisteredAt 1..1Reference(Organization)The Org unit where the patient was first registered
... dateOfBirth 1..1string...
... currentHomeAddress 1..1string
... contactPhoneNumber 1..1string
... hivEnrollmentUnit 0..1stringThe organization unit that first registered the person.
... programNationaId 0..*Identifier...
... deceased 0..1boolean...
... deceasedDate 0..1boolean...
... gender 1..1CodingBinding: Patient Gender Value Set (example)
... healthFacilityCode 0..1stringHealth facility code.
... nhisId 0..1string...

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HIVPatientInfo.sexAtBirthexamplePatientSexAtBirthVS (a valid code from Patient Sex at Birth)
HIVPatientInfo.genderexampleHIVPatientGenderVS (a valid code from Patient Gender)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HIVPatientInfo 0..*PatientInfoHIV Patient Data Model
Instances of this logical model are not marked to be the target of a Reference
... registrationDateTime 1..1dateTimeDate-Time information was entered
... firstregisteredAt 1..1Reference(Organization)The Org unit where the patient was first registered
... firstName 0..1stringGiven name of the patient
... dateOfBirth 1..1string...
... dateOfBirthIsEstimated 0..1boolean...
... sexAtBirth 1..1code...
Binding: Patient Sex at Birth Value Set (example)
... currentHomeAddress 1..1string
... contactPhoneNumber 1..1string
... countryOfBirth 0..1string...
Binding: urn:iso:std:iso:3166 (example)
... nationaId 0..1string...
... consent 0..1boolean...
... hivEnrollmentUnit 0..1stringThe organization unit that first registered the person.
... programNationaId 0..*Identifier...
... deceased 0..1boolean...
... deceasedDate 0..1boolean...
... gender 1..1CodingBinding: Patient Gender Value Set (example)
... healthFacilityCode 0..1stringHealth facility code.
... nhisId 0..1string...

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HIVPatientInfo.sexAtBirthexamplePatientSexAtBirthVS (a valid code from Patient Sex at Birth)
HIVPatientInfo.countryOfBirthexample

urn:iso:std:iso:3166

HIVPatientInfo.genderexampleHIVPatientGenderVS (a valid code from Patient Gender)

This structure is derived from PatientInfo

Summary

Mandatory: 0 element (1 nested mandatory element)

 

Other representations of profile: CSV, Excel