HIV Patient Data Model - XML Representation - DHIS2 Example FHIR Implementation Guide v1.0.0

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 - XML Profile

Draft as of 2023-09-28
XML representation of the HIVPatientInfo logical model.
Raw xml | Download


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="HIVPatientInfo"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml">Placeholder</div>
  </text>
  <url value="https://dhis2.org/StructureDefinition/HIVPatientInfo"/>
  <version value="1.0.0"/>
  <name value="HIVPatientInfo"/>
  <title value="HIV Patient Data Model"/>
  <status value="draft"/>
  <date value="2023-09-28T13:33:49+00:00"/>
  <publisher value="DHIS2"/>
  <contact>
    <name value="DHIS2"/>
    <telecom>
      <system value="url"/>
      <value value="https://dhis2.org"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="integration@dhis2.org"/>
    </telecom>
  </contact>
  <contact>
    <name value="Johan Hole"/>
    <telecom>
      <system value="email"/>
      <value value="Johan@Devotta.no"/>
      <use value="work"/>
    </telecom>
  </contact>
  <description
               value="Extension of the base patient data model. Includes properties specific to the HIV program."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <fhirVersion value="4.0.1"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="https://dhis2.org/StructureDefinition/HIVPatientInfo"/>
  <baseDefinition value="https://dhis2.org/StructureDefinition/PatientInfo"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="HIVPatientInfo">
      <path value="HIVPatientInfo"/>
      <short value="HIV Patient Data Model"/>
      <definition
                  value="Extension of the base patient data model. Includes properties specific to the HIV program."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <isModifier value="false"/>
    </element>
    <element id="HIVPatientInfo.registrationDateTime">
      <path value="HIVPatientInfo.registrationDateTime"/>
      <short value="Date-Time information was entered"/>
      <definition
                  value="Date and Time when the patient information was entered into DHIS2"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="PatientInfo.registrationDateTime"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="dateTime"/>
      </type>
    </element>
    <element id="HIVPatientInfo.firstregisteredAt">
      <path value="HIVPatientInfo.firstregisteredAt"/>
      <short value="The Org unit where the patient was first registered"/>
      <definition
                  value="The Org unit where the patient was first registered"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="PatientInfo.firstregisteredAt"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/StructureDefinition/Organization"/>
      </type>
    </element>
    <element id="HIVPatientInfo.firstName">
      <path value="HIVPatientInfo.firstName"/>
      <short value="Given name of the patient"/>
      <definition value="Given name of the patient"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="PatientInfo.firstName"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="HIVPatientInfo.lastName">
      <path value="HIVPatientInfo.lastName"/>
      <short value="Family name"/>
      <definition value="Family name"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="PatientInfo.lastName"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="HIVPatientInfo.dateOfBirth">
      <path value="HIVPatientInfo.dateOfBirth"/>
      <short value="..."/>
      <definition value="..."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="PatientInfo.dateOfBirth"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="HIVPatientInfo.dateOfBirthIsEstimated">
      <path value="HIVPatientInfo.dateOfBirthIsEstimated"/>
      <short value="..."/>
      <definition value="..."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="PatientInfo.dateOfBirthIsEstimated"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="boolean"/>
      </type>
    </element>
    <element id="HIVPatientInfo.sexAtBirth">
      <path value="HIVPatientInfo.sexAtBirth"/>
      <short value="..."/>
      <definition value="..."/>
      <comment value="(valueset depends on the program)"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="PatientInfo.sexAtBirth"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="example"/>
        <valueSet value="https://dhis2.org/ValueSet/patient-sex-at-birth-vs"/>
      </binding>
    </element>
    <element id="HIVPatientInfo.currentHomeAddress">
      <path value="HIVPatientInfo.currentHomeAddress"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="PatientInfo.currentHomeAddress"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="HIVPatientInfo.contactPhoneNumber">
      <path value="HIVPatientInfo.contactPhoneNumber"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="PatientInfo.contactPhoneNumber"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="HIVPatientInfo.countryOfBirth">
      <path value="HIVPatientInfo.countryOfBirth"/>
      <short value="..."/>
      <definition value="..."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="PatientInfo.countryOfBirth"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <binding>
        <strength value="example"/>
        <valueSet value="urn:iso:std:iso:3166"/>
      </binding>
    </element>
    <element id="HIVPatientInfo.nationaId">
      <path value="HIVPatientInfo.nationaId"/>
      <short value="..."/>
      <definition value="..."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="PatientInfo.nationaId"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="HIVPatientInfo.consent">
      <path value="HIVPatientInfo.consent"/>
      <short value="..."/>
      <definition value="..."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="PatientInfo.consent"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="boolean"/>
      </type>
    </element>
    <element id="HIVPatientInfo.hivEnrollmentUnit">
      <path value="HIVPatientInfo.hivEnrollmentUnit"/>
      <short value="The organization unit that first registered the person."/>
      <definition
                  value="The organization unit that first registered the person."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="HIVPatientInfo.hivEnrollmentUnit"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="HIVPatientInfo.programNationaId">
      <path value="HIVPatientInfo.programNationaId"/>
      <short value="..."/>
      <definition value="..."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="HIVPatientInfo.programNationaId"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Identifier"/>
      </type>
    </element>
    <element id="HIVPatientInfo.deceased">
      <path value="HIVPatientInfo.deceased"/>
      <short value="..."/>
      <definition value="..."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="HIVPatientInfo.deceased"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="boolean"/>
      </type>
    </element>
    <element id="HIVPatientInfo.deceasedDate">
      <path value="HIVPatientInfo.deceasedDate"/>
      <short value="..."/>
      <definition value="..."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="HIVPatientInfo.deceasedDate"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="boolean"/>
      </type>
    </element>
    <element id="HIVPatientInfo.gender">
      <path value="HIVPatientInfo.gender"/>
      <comment value="(valueset depends on the program)"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="HIVPatientInfo.gender"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <binding>
        <strength value="example"/>
        <valueSet value="https://dhis2.org/ValueSet/HIVPatientGenderVS"/>
      </binding>
    </element>
    <element id="HIVPatientInfo.healthFacilityCode">
      <path value="HIVPatientInfo.healthFacilityCode"/>
      <short value="Health facility code."/>
      <definition value="Health facility code."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="HIVPatientInfo.healthFacilityCode"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="HIVPatientInfo.nhisId">
      <path value="HIVPatientInfo.nhisId"/>
      <short value="..."/>
      <definition value="..."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="HIVPatientInfo.nhisId"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="HIVPatientInfo">
      <path value="HIVPatientInfo"/>
      <short value="HIV Patient Data Model"/>
      <definition
                  value="Extension of the base patient data model. Includes properties specific to the HIV program."/>
    </element>
    <element id="HIVPatientInfo.hivEnrollmentUnit">
      <path value="HIVPatientInfo.hivEnrollmentUnit"/>
      <short value="The organization unit that first registered the person."/>
      <definition
                  value="The organization unit that first registered the person."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="HIVPatientInfo.programNationaId">
      <path value="HIVPatientInfo.programNationaId"/>
      <short value="..."/>
      <definition value="..."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Identifier"/>
      </type>
    </element>
    <element id="HIVPatientInfo.deceased">
      <path value="HIVPatientInfo.deceased"/>
      <short value="..."/>
      <definition value="..."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="boolean"/>
      </type>
    </element>
    <element id="HIVPatientInfo.deceasedDate">
      <path value="HIVPatientInfo.deceasedDate"/>
      <short value="..."/>
      <definition value="..."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="boolean"/>
      </type>
    </element>
    <element id="HIVPatientInfo.gender">
      <path value="HIVPatientInfo.gender"/>
      <comment value="(valueset depends on the program)"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Coding"/>
      </type>
      <binding>
        <strength value="example"/>
        <valueSet value="https://dhis2.org/ValueSet/HIVPatientGenderVS"/>
      </binding>
    </element>
    <element id="HIVPatientInfo.healthFacilityCode">
      <path value="HIVPatientInfo.healthFacilityCode"/>
      <short value="Health facility code."/>
      <definition value="Health facility code."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="HIVPatientInfo.nhisId">
      <path value="HIVPatientInfo.nhisId"/>
      <short value="..."/>
      <definition value="..."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
  </differential>
</StructureDefinition>