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 |
XML representation of the HIVCaseVisitData logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="HIVCaseVisitData"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml">Placeholder</div>
</text>
<url value="https://dhis2.org/StructureDefinition/HIVCaseVisitData"/>
<version value="1.0.0"/>
<name value="HIVCaseVisitData"/>
<title value="HIV Visit"/>
<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="Report filled out during facility visit."/>
<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/HIVCaseVisitData"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
<derivation value="specialization"/>
<snapshot>
<element id="HIVCaseVisitData">
<path value="HIVCaseVisitData"/>
<short value="HIV Visit"/>
<definition value="Report filled out during facility visit."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<isModifier value="false"/>
</element>
<element id="HIVCaseVisitData.visitDate">
<path value="HIVCaseVisitData.visitDate"/>
<short value="Viral load test date"/>
<definition value="Viral load test date"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.visitDate"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.dueDate">
<path value="HIVCaseVisitData.dueDate"/>
<short value="Visit due date"/>
<definition value="Visit due date"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.dueDate"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.reasonForVisit">
<path value="HIVCaseVisitData.reasonForVisit"/>
<short value="The reason for this visit"/>
<definition value="The reason for this visit"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.reasonForVisit"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Coding"/>
</type>
<binding>
<strength value="example"/>
<valueSet value="https://dhis2.org/ValueSet/HIVreasonsForVisitVS"/>
</binding>
</element>
<element id="HIVCaseVisitData.treatmentStarted">
<path value="HIVCaseVisitData.treatmentStarted"/>
<short value="Is the patient currently on treatment"/>
<definition value="Is the patient currently on treatment"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.treatmentStarted"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</type>
</element>
<element id="HIVCaseVisitData.dateARTInitiation">
<path value="HIVCaseVisitData.dateARTInitiation"/>
<short value="Date of ART initiation"/>
<definition value="Date of ART initiation"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.dateARTInitiation"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.eligibleforTBPreventiveTreatment">
<path value="HIVCaseVisitData.eligibleforTBPreventiveTreatment"/>
<short value="Is patient eligible for preventive treatment"/>
<definition value="Is patient eligible for preventive treatment"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.eligibleforTBPreventiveTreatment"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</type>
</element>
<element id="HIVCaseVisitData.TPTEligibleDate">
<path value="HIVCaseVisitData.TPTEligibleDate"/>
<short value="TPT Date Eligible"/>
<definition value="TPT Date Eligible"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.TPTEligibleDate"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.TPTInitiatedDate">
<path value="HIVCaseVisitData.TPTInitiatedDate"/>
<short value="TPT Date Initiated"/>
<definition value="TPT Date Initiated"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.TPTInitiatedDate"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.TPTRegimen">
<path value="HIVCaseVisitData.TPTRegimen"/>
<short value="TPT Regimen"/>
<definition value="TPT Regimen"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.TPTRegimen"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Coding"/>
</type>
<binding>
<strength value="example"/>
<valueSet value="https://dhis2.org/ValueSet/HIVtptRegimenVS"/>
</binding>
</element>
<element id="HIVCaseVisitData.TPTCompletedDate">
<path value="HIVCaseVisitData.TPTCompletedDate"/>
<short value="TPT Date Completed"/>
<definition value="TPT Date Completed"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.TPTCompletedDate"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.TPTrestartTreatment">
<path value="HIVCaseVisitData.TPTrestartTreatment"/>
<short value="TPT restart treatment"/>
<definition value="TPT restart treatment"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.TPTrestartTreatment"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</type>
</element>
<element id="HIVCaseVisitData.treatmentStatus">
<path value="HIVCaseVisitData.treatmentStatus"/>
<short value="Treatment status"/>
<definition value="Treatment status"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.treatmentStatus"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Coding"/>
</type>
<binding>
<strength value="example"/>
<valueSet value="https://dhis2.org/ValueSet/HIVtreatmentStatusVS"/>
</binding>
</element>
<element id="HIVCaseVisitData.viralLoadTestDate">
<path value="HIVCaseVisitData.viralLoadTestDate"/>
<short value="Viral load test date"/>
<definition value="Viral load test date"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.viralLoadTestDate"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.viralLoadLessThanThousand">
<path value="HIVCaseVisitData.viralLoadLessThanThousand"/>
<short value="Viral load < 1000"/>
<definition value="Viral load < 1000"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.viralLoadLessThanThousand"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</type>
</element>
<element id="HIVCaseVisitData.numberOfviralLoadTestResults">
<path value="HIVCaseVisitData.numberOfviralLoadTestResults"/>
<short value="Viral load test results"/>
<definition value="Viral load test results"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.numberOfviralLoadTestResults"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="integer"/>
</type>
</element>
<element id="HIVCaseVisitData.previousViralLoadValue">
<path value="HIVCaseVisitData.previousViralLoadValue"/>
<short value="Previous viral load value"/>
<definition value="Previous viral load value"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.previousViralLoadValue"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="integer"/>
</type>
</element>
<element id="HIVCaseVisitData.lastDateWithART">
<path value="HIVCaseVisitData.lastDateWithART"/>
<short value="Last day with ART"/>
<definition value="Last day with ART"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.lastDateWithART"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.dateOfDeath">
<path value="HIVCaseVisitData.dateOfDeath"/>
<short value="Date of death"/>
<definition value="Date of death"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.dateOfDeath"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.statusChangeDate">
<path value="HIVCaseVisitData.statusChangeDate"/>
<short value="Status change date"/>
<definition value="Status change date"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.statusChangeDate"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.currentlyPregnant">
<path value="HIVCaseVisitData.currentlyPregnant"/>
<short value="Currently pregnant?"/>
<definition value="Currently pregnant?"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.currentlyPregnant"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</type>
</element>
<element id="HIVCaseVisitData.daysARTdispensed">
<path value="HIVCaseVisitData.daysARTdispensed"/>
<short value="Days of ART provided"/>
<definition value="Days of ART provided"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HIVCaseVisitData.daysARTdispensed"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="integer"/>
</type>
</element>
</snapshot>
<differential>
<element id="HIVCaseVisitData">
<path value="HIVCaseVisitData"/>
<short value="HIV Visit"/>
<definition value="Report filled out during facility visit."/>
</element>
<element id="HIVCaseVisitData.visitDate">
<path value="HIVCaseVisitData.visitDate"/>
<short value="Viral load test date"/>
<definition value="Viral load test date"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.dueDate">
<path value="HIVCaseVisitData.dueDate"/>
<short value="Visit due date"/>
<definition value="Visit due date"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.reasonForVisit">
<path value="HIVCaseVisitData.reasonForVisit"/>
<short value="The reason for this visit"/>
<definition value="The reason for this visit"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Coding"/>
</type>
<binding>
<strength value="example"/>
<valueSet value="https://dhis2.org/ValueSet/HIVreasonsForVisitVS"/>
</binding>
</element>
<element id="HIVCaseVisitData.treatmentStarted">
<path value="HIVCaseVisitData.treatmentStarted"/>
<short value="Is the patient currently on treatment"/>
<definition value="Is the patient currently on treatment"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="boolean"/>
</type>
</element>
<element id="HIVCaseVisitData.dateARTInitiation">
<path value="HIVCaseVisitData.dateARTInitiation"/>
<short value="Date of ART initiation"/>
<definition value="Date of ART initiation"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.eligibleforTBPreventiveTreatment">
<path value="HIVCaseVisitData.eligibleforTBPreventiveTreatment"/>
<short value="Is patient eligible for preventive treatment"/>
<definition value="Is patient eligible for preventive treatment"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="boolean"/>
</type>
</element>
<element id="HIVCaseVisitData.TPTEligibleDate">
<path value="HIVCaseVisitData.TPTEligibleDate"/>
<short value="TPT Date Eligible"/>
<definition value="TPT Date Eligible"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.TPTInitiatedDate">
<path value="HIVCaseVisitData.TPTInitiatedDate"/>
<short value="TPT Date Initiated"/>
<definition value="TPT Date Initiated"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.TPTRegimen">
<path value="HIVCaseVisitData.TPTRegimen"/>
<short value="TPT Regimen"/>
<definition value="TPT Regimen"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Coding"/>
</type>
<binding>
<strength value="example"/>
<valueSet value="https://dhis2.org/ValueSet/HIVtptRegimenVS"/>
</binding>
</element>
<element id="HIVCaseVisitData.TPTCompletedDate">
<path value="HIVCaseVisitData.TPTCompletedDate"/>
<short value="TPT Date Completed"/>
<definition value="TPT Date Completed"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.TPTrestartTreatment">
<path value="HIVCaseVisitData.TPTrestartTreatment"/>
<short value="TPT restart treatment"/>
<definition value="TPT restart treatment"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="boolean"/>
</type>
</element>
<element id="HIVCaseVisitData.treatmentStatus">
<path value="HIVCaseVisitData.treatmentStatus"/>
<short value="Treatment status"/>
<definition value="Treatment status"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Coding"/>
</type>
<binding>
<strength value="example"/>
<valueSet value="https://dhis2.org/ValueSet/HIVtreatmentStatusVS"/>
</binding>
</element>
<element id="HIVCaseVisitData.viralLoadTestDate">
<path value="HIVCaseVisitData.viralLoadTestDate"/>
<short value="Viral load test date"/>
<definition value="Viral load test date"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.viralLoadLessThanThousand">
<path value="HIVCaseVisitData.viralLoadLessThanThousand"/>
<short value="Viral load < 1000"/>
<definition value="Viral load < 1000"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="boolean"/>
</type>
</element>
<element id="HIVCaseVisitData.numberOfviralLoadTestResults">
<path value="HIVCaseVisitData.numberOfviralLoadTestResults"/>
<short value="Viral load test results"/>
<definition value="Viral load test results"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="integer"/>
</type>
</element>
<element id="HIVCaseVisitData.previousViralLoadValue">
<path value="HIVCaseVisitData.previousViralLoadValue"/>
<short value="Previous viral load value"/>
<definition value="Previous viral load value"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="integer"/>
</type>
</element>
<element id="HIVCaseVisitData.lastDateWithART">
<path value="HIVCaseVisitData.lastDateWithART"/>
<short value="Last day with ART"/>
<definition value="Last day with ART"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.dateOfDeath">
<path value="HIVCaseVisitData.dateOfDeath"/>
<short value="Date of death"/>
<definition value="Date of death"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.statusChangeDate">
<path value="HIVCaseVisitData.statusChangeDate"/>
<short value="Status change date"/>
<definition value="Status change date"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="date"/>
</type>
</element>
<element id="HIVCaseVisitData.currentlyPregnant">
<path value="HIVCaseVisitData.currentlyPregnant"/>
<short value="Currently pregnant?"/>
<definition value="Currently pregnant?"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="boolean"/>
</type>
</element>
<element id="HIVCaseVisitData.daysARTdispensed">
<path value="HIVCaseVisitData.daysARTdispensed"/>
<short value="Days of ART provided"/>
<definition value="Days of ART provided"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="integer"/>
</type>
</element>
</differential>
</StructureDefinition>
IG © 2023+ DHIS2. Package org.hisp.dhis.alldevs.demo#1.0.0 based on FHIR 4.0.1. Generated 2023-09-28
Links: Table of Contents |
QA Report |
Version History |