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
| Draft as of 2026-06-03 |
JSON representation of the HIVPatientInfo logical model.
{
"resourceType" : "StructureDefinition",
"id" : "HIVPatientInfo",
"language" : "en",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition HIVPatientInfo</b></p><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HIVPatientInfo-definitions.html#HIVPatientInfo\" title=\"Extension of the base patient data model. Includes properties specific to the HIV program.\">HIVPatientInfo</a><a name=\"HIVPatientInfo\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-PatientInfo.html\">PatientInfo</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">HIV Patient Data Model<br/><br/>Elements defined in Ancestors:<a href=\"StructureDefinition-PatientInfo.html\" title=\"Date and Time when the patient information was entered into DHIS2\">registrationDateTime</a>, <a href=\"StructureDefinition-PatientInfo.html\" title=\"The Org unit where the patient was first registered\">firstregisteredAt</a>, <a href=\"StructureDefinition-PatientInfo.html\" title=\"Given name of the patient\">firstName</a>, <a href=\"StructureDefinition-PatientInfo.html\" title=\"Family name\">lastName</a>, <a href=\"StructureDefinition-PatientInfo.html\" title=\"...\">dateOfBirth</a>, <a href=\"StructureDefinition-PatientInfo.html\" title=\"...\">dateOfBirthIsEstimated</a>, <a href=\"StructureDefinition-PatientInfo.html\" title=\"...\">sexAtBirth</a>, <a href=\"StructureDefinition-PatientInfo.html\">currentHomeAddress</a>, <a href=\"StructureDefinition-PatientInfo.html\">contactPhoneNumber</a>, <a href=\"StructureDefinition-PatientInfo.html\" title=\"...\">countryOfBirth</a>, <a href=\"StructureDefinition-PatientInfo.html\" title=\"...\">nationaId</a>, <a href=\"StructureDefinition-PatientInfo.html\" title=\"...\">consent</a></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HIVPatientInfo-definitions.html#HIVPatientInfo.hivEnrollmentUnit\" title=\"The organization unit that first registered the person.\">hivEnrollmentUnit</a><a name=\"HIVPatientInfo.hivEnrollmentUnit\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The organization unit that first registered the person.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HIVPatientInfo-definitions.html#HIVPatientInfo.programNationaId\" title=\"...\">programNationaId</a><a name=\"HIVPatientInfo.programNationaId\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..*</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">...<br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HIVPatientInfo-definitions.html#HIVPatientInfo.deceased\" title=\"...\">deceased</a><a name=\"HIVPatientInfo.deceased\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">...</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HIVPatientInfo-definitions.html#HIVPatientInfo.deceasedDate\" title=\"...\">deceasedDate</a><a name=\"HIVPatientInfo.deceasedDate\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">...</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HIVPatientInfo-definitions.html#HIVPatientInfo.gender\">gender</a><a name=\"HIVPatientInfo.gender\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\" title=\"null\" class=\"binding\">Binding: </span><a href=\"ValueSet-HIVPatientGenderVS.html\" title=\"https://dhis2.org/ValueSet/HIVPatientGenderVS\" class=\"binding\">Patient Gender Value Set</a><span title=\"null\" class=\"binding\"> (</span><a href=\"http://hl7.org/fhir/R4/terminologies.html#example\" title=\"Instances are not expected or even encouraged to draw from the specified value set. The value set merely provides examples of the types of concepts intended to be included.\" class=\"binding\">example</a><span title=\"null\" class=\"binding\">)</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HIVPatientInfo-definitions.html#HIVPatientInfo.healthFacilityCode\" title=\"Health facility code.\">healthFacilityCode</a><a name=\"HIVPatientInfo.healthFacilityCode\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Health facility code.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-HIVPatientInfo-definitions.html#HIVPatientInfo.nhisId\" title=\"...\">nhisId</a><a name=\"HIVPatientInfo.nhisId\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">...</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "https://dhis2.org/StructureDefinition/HIVPatientInfo",
"version" : "1.0.0",
"name" : "HIVPatientInfo",
"title" : "HIV Patient Data Model",
"status" : "draft",
"date" : "2026-06-03T19:24:40+00:00",
"publisher" : "DHIS2",
"contact" : [
{
"name" : "DHIS2",
"telecom" : [
{
"system" : "url",
"value" : "https://dhis2.org"
},
{
"system" : "email",
"value" : "integration@dhis2.org"
}
]
},
{
"name" : "Johan Hole",
"telecom" : [
{
"system" : "email",
"value" : "Johan@Devotta.no",
"use" : "work"
}
]
}
],
"description" : "Extension of the base patient data model. Includes properties specific to the HIV program.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"fhirVersion" : "4.0.1",
"kind" : "logical",
"abstract" : false,
"type" : "https://dhis2.org/StructureDefinition/HIVPatientInfo",
"baseDefinition" : "https://dhis2.org/StructureDefinition/PatientInfo",
"derivation" : "specialization",
"snapshot" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString" : "1.0.0"
}
],
"element" : [
{
"id" : "HIVPatientInfo",
"path" : "HIVPatientInfo",
"short" : "HIV Patient Data Model",
"definition" : "Extension of the base patient data model. Includes properties specific to the HIV program.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false
},
{
"id" : "HIVPatientInfo.registrationDateTime",
"path" : "HIVPatientInfo.registrationDateTime",
"short" : "Date-Time information was entered",
"definition" : "Date and Time when the patient information was entered into DHIS2",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PatientInfo.registrationDateTime",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
]
},
{
"id" : "HIVPatientInfo.firstregisteredAt",
"path" : "HIVPatientInfo.firstregisteredAt",
"short" : "The Org unit where the patient was first registered",
"definition" : "The Org unit where the patient was first registered",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PatientInfo.firstregisteredAt",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Organization"
]
}
]
},
{
"id" : "HIVPatientInfo.firstName",
"path" : "HIVPatientInfo.firstName",
"short" : "Given name of the patient",
"definition" : "Given name of the patient",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PatientInfo.firstName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "HIVPatientInfo.lastName",
"path" : "HIVPatientInfo.lastName",
"short" : "Family name",
"definition" : "Family name",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PatientInfo.lastName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "HIVPatientInfo.dateOfBirth",
"path" : "HIVPatientInfo.dateOfBirth",
"short" : "...",
"definition" : "...",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PatientInfo.dateOfBirth",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "HIVPatientInfo.dateOfBirthIsEstimated",
"path" : "HIVPatientInfo.dateOfBirthIsEstimated",
"short" : "...",
"definition" : "...",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PatientInfo.dateOfBirthIsEstimated",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "HIVPatientInfo.sexAtBirth",
"path" : "HIVPatientInfo.sexAtBirth",
"short" : "...",
"definition" : "...",
"comment" : "(valueset depends on the program)",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PatientInfo.sexAtBirth",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "https://dhis2.org/ValueSet/patient-sex-at-birth-vs"
}
},
{
"id" : "HIVPatientInfo.currentHomeAddress",
"path" : "HIVPatientInfo.currentHomeAddress",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PatientInfo.currentHomeAddress",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "HIVPatientInfo.contactPhoneNumber",
"path" : "HIVPatientInfo.contactPhoneNumber",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PatientInfo.contactPhoneNumber",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "HIVPatientInfo.countryOfBirth",
"path" : "HIVPatientInfo.countryOfBirth",
"short" : "...",
"definition" : "...",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PatientInfo.countryOfBirth",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "urn:iso:std:iso:3166"
}
},
{
"id" : "HIVPatientInfo.nationaId",
"path" : "HIVPatientInfo.nationaId",
"short" : "...",
"definition" : "...",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PatientInfo.nationaId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "HIVPatientInfo.consent",
"path" : "HIVPatientInfo.consent",
"short" : "...",
"definition" : "...",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PatientInfo.consent",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "HIVPatientInfo.hivEnrollmentUnit",
"path" : "HIVPatientInfo.hivEnrollmentUnit",
"short" : "The organization unit that first registered the person.",
"definition" : "The organization unit that first registered the person.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HIVPatientInfo.hivEnrollmentUnit",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "HIVPatientInfo.programNationaId",
"path" : "HIVPatientInfo.programNationaId",
"short" : "...",
"definition" : "...",
"min" : 0,
"max" : "*",
"base" : {
"path" : "HIVPatientInfo.programNationaId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
]
},
{
"id" : "HIVPatientInfo.deceased",
"path" : "HIVPatientInfo.deceased",
"short" : "...",
"definition" : "...",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HIVPatientInfo.deceased",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "HIVPatientInfo.deceasedDate",
"path" : "HIVPatientInfo.deceasedDate",
"short" : "...",
"definition" : "...",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HIVPatientInfo.deceasedDate",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "HIVPatientInfo.gender",
"path" : "HIVPatientInfo.gender",
"comment" : "(valueset depends on the program)",
"min" : 1,
"max" : "1",
"base" : {
"path" : "HIVPatientInfo.gender",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "https://dhis2.org/ValueSet/HIVPatientGenderVS"
}
},
{
"id" : "HIVPatientInfo.healthFacilityCode",
"path" : "HIVPatientInfo.healthFacilityCode",
"short" : "Health facility code.",
"definition" : "Health facility code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HIVPatientInfo.healthFacilityCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "HIVPatientInfo.nhisId",
"path" : "HIVPatientInfo.nhisId",
"short" : "...",
"definition" : "...",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HIVPatientInfo.nhisId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "HIVPatientInfo",
"path" : "HIVPatientInfo",
"short" : "HIV Patient Data Model",
"definition" : "Extension of the base patient data model. Includes properties specific to the HIV program."
},
{
"id" : "HIVPatientInfo.hivEnrollmentUnit",
"path" : "HIVPatientInfo.hivEnrollmentUnit",
"short" : "The organization unit that first registered the person.",
"definition" : "The organization unit that first registered the person.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "HIVPatientInfo.programNationaId",
"path" : "HIVPatientInfo.programNationaId",
"short" : "...",
"definition" : "...",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "Identifier"
}
]
},
{
"id" : "HIVPatientInfo.deceased",
"path" : "HIVPatientInfo.deceased",
"short" : "...",
"definition" : "...",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "HIVPatientInfo.deceasedDate",
"path" : "HIVPatientInfo.deceasedDate",
"short" : "...",
"definition" : "...",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "HIVPatientInfo.gender",
"path" : "HIVPatientInfo.gender",
"comment" : "(valueset depends on the program)",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "Coding"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "https://dhis2.org/ValueSet/HIVPatientGenderVS"
}
},
{
"id" : "HIVPatientInfo.healthFacilityCode",
"path" : "HIVPatientInfo.healthFacilityCode",
"short" : "Health facility code.",
"definition" : "Health facility code.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "HIVPatientInfo.nhisId",
"path" : "HIVPatientInfo.nhisId",
"short" : "...",
"definition" : "...",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
}
]
}
}
IG © 2023+ DHIS2.
Package org.hisp.dhis.alldevs.demo#1.0.0 based on FHIR 4.0.1.
Generated
2026-06-03
Links: Table of Contents |
QA Report |
Version History |
