VLSMS VL Request Bundle - HL7 FHIR Implementation Guide: Rwanda HIV v0.1.0

HL7 FHIR Implementation Guide: Rwanda HIV, published by Jembi Health Systems. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/openhie/Rwanda-HIV and changes regularly. See the Directory of published versions

Example Bundle: VLSMS VL Request Bundle

Jane Maria Smith (OFFICIAL) Female, DoB: 1990-12-12

Generated Narrative: Composition

Resource Composition "VLCompositionExample"

Profile: Laboratory Report For Viral Load Testing

identifier: id: PAT0001-v1

status: FINAL

type: 11502-2 (LOINC#11502-2)

encounter: See above (Encounter/TargetFacilityEncounterExample)

date: 2023-08-22

author:

See above (Practitioner/RequestingPractitionerExample)
See above (Practitioner/PerformingPractitionerExample)
See above (Practitioner/ResultsInterpreterExample)

title: Laboratory Report For Viral Load Testing

Funding Organization Information

To be added

See above (Organization/FundingOrganizationExample)

Implementing Partner Information

To be added

See above (Organization/ImplementingPartnerOrganizationExample)

Pregnancy Status

To be added

See above (Observation/PatientPregnantExample)

New Patient Consultation

To be added

See above (Observation/HIVPatientIsNewExample)

Breastfeeding Status

To be added

See above (Observation/BreastfeedingExample)

Consent Status

To be added

See above (Consent/ReceiveSMSMessagesExample)

Viral Load Specimen

To be added

Specimen Information

To be added

See above (Specimen/VLSpecimenExample)

Specimen Temperature

To be added

See above (SpecimenDefinition/SpecimenConservationExample)

Specimen Transportation

To be added

See above (Location/TransportRequestedLocationExample)
See above (Location/TransportCurrentLocationExample)

Laboratory Services

To be added

See above (Observation/ReasonForHIVTestingExample)
See above (ServiceRequest/HIVServiceRequestExample)
See above (ActivityDefinition/LabOrderTaskActivityExample)
See above (Task/HIVLabResultTaskExample)
See above (Device/TestingPlatformExample)
See above (Organization/RequestingOrganizationExample)
See above (Practitioner/RequestingPractitionerExample)
See above (Organization/PerformingOrganizationExample)
See above (Practitioner/PerformingPractitionerExample)

Result Information

To be added

See above (DiagnosticReport/HIVLabResultsDiagnosticReportExample)
See above (Transport/ResultDispatchedToRequestingFacilityExample)
See above (Observation/HIVTestResultExample)
See above (Observation/HIVTestResultViralLoadLogExample)
See above (Observation/HIVTestResultAbsoluteDecimalExample)
See above (Observation/RepeatHIVTestResultExample)
See above (Observation/SuspendTreatmentHIVTestResultExample)

Results Interpreter Details
To be added
See above (Practitioner/ResultsInterpreterExample)

ART Status

To be added

See above (Observation/ARTInitiatedExample)
See above (Observation/ARVRegimenChangeExample)
See above (Observation/ARTRegimenSwitchedOrSubstitutedExample)
See above (Observation/ARVAdherenceExample)
See above (CarePlan/ARVTreatmentRegimenChangedExample)
See above (CarePlan/ARVTreatmentInitiatedExample)

Prescribed ARV Medication

To be added

See above (MedicationRequest/ARVRegimenMedicationRequestRegimenChangedExample)
See above (MedicationRequest/ARVRegimenMedicationRequestARVExample)

Additional Document Content

2. Patient/HIVPatientExample (Patient/HIVPatientExample)

Jane Maria Smith (OFFICIAL) Female, DoB: 1990-12-12

3. Specimen/VLSpecimenExample (Specimen/VLSpecimenExample)

Generated Narrative: Specimen
Resource Specimen "VLSpecimenExample"
Profile: Viral Load Specimen
Sample reordered: false
identifier: App sample identifier: abc123, Remote sample identifier: def456, Sample identifier: ghi789, Universal Unique Identifier for the sample: 123456abc
type: Specimen Type (SNOMED CT#119361006 "Plasma specimen (specimen)")
subject: See above (Patient/HIVPatientExample)
receivedTime: 2022-07-28
Collections
- Collected[x]
* 2022-07-28
Processings
- Time[x]
* 2022-07-28
note: additional notes here (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

4. Organization/RequestingOrganizationExample (Organization/RequestingOrganizationExample)

Generated Narrative: Organization
Resource Organization "RequestingOrganizationExample"
Profile: Requesting Organization
identifier: Requesting Organization identifier: facility5
name: A facility name

5. Organization/PerformingOrganizationExample (Organization/PerformingOrganizationExample)

Generated Narrative: Organization
Resource Organization "PerformingOrganizationExample"
Profile: Performing Organization
Performing Organization Province: 4
Performing Organization District: 9
identifier: Performing Organization identifier: laboratory1
name: A Laboratory name
Contacts
- Address
* A province name

6. ServiceRequest/HIVServiceRequestExample (ServiceRequest/HIVServiceRequestExample)

Generated Narrative: ServiceRequest
Resource ServiceRequest "HIVServiceRequestExample"
Profile: HIV VL Service Request
identifier: HIV lab service request identifier: ORDER12345
status: COMPLETED
intent: ORDER
Codes
- Concept
* Test Type (LOINC#25836-8 "HIV 1 RNA [#/volume] (viral load) in Specimen by NAA with probe detection")
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
occurrence: 2012-01-05
requester: See above (Practitioner/RequestingPractitionerExample)
performer: See above (Practitioner/PerformingPractitionerExample)
Reasons
- Reference
* See above (Observation/ReasonForHIVTestingExample)
specimen: See above (Specimen/VLSpecimenExample)
note: additional notes here (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

7. Practitioner/RequestingPractitionerExample (Practitioner/RequestingPractitionerExample)

Generated Narrative: Practitioner
Resource Practitioner "RequestingPractitionerExample"
Profile: Practitioner
Clinician User Index: 2
name: James Smith
telecom: ph: 27537652509

8. Practitioner/PerformingPractitionerExample (Practitioner/PerformingPractitionerExample)

Generated Narrative: Practitioner
Resource Practitioner "PerformingPractitionerExample"
Profile: Practitioner
Clinician User Index: 6
name: Amy White
telecom: ph: 27537687534

9. Observation/ReasonForHIVTestingExample (Observation/ReasonForHIVTestingExample)

Generated Narrative: Observation
Resource Observation "ReasonForHIVTestingExample"
Profile: Reason for HIV testing Observation
status: FINAL
code: HIV Test (SNOMED CT#165813002 "Human immunodeficiency virus antibody test")
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
effective: 2022-11-30
performer: Practitioner/ObservationPerformingPractitionerExample " WHITE"
value: Reason for testing (SNOMED CT#2528003 "Viremia")
note: Some comments (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

10. Observation/PatientPregnantExample (Observation/PatientPregnantExample)

Generated Narrative: Observation
Resource Observation "PatientPregnantExample"
Profile: Patient Pregnancy Status Observation
status: FINAL
code: Pregnancy status (SNOMED CT#250421003)
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
effective: 2022-11-30
performer: Practitioner/ObservationPerformingPractitionerExample " WHITE"
value: Pregnancy test result (SNOMED CT#250423000 "Pregnancy test positive")
note: additional notes here (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

11. Observation/HIVPatientIsNewExample (Observation/HIVPatientIsNewExample)

Generated Narrative: Observation
Resource Observation "HIVPatientIsNewExample"
Profile: HIV Patient Is New Observation
status: FINAL
code: New Patient Indication (SNOMED CT#769681006)
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
effective: 2022-11-30
performer: Practitioner/ObservationPerformingPractitionerExample " WHITE"
value: true
note: additional notes here (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

12. Observation/BreastfeedingExample (Observation/BreastfeedingExample)

Generated Narrative: Observation
Resource Observation "BreastfeedingExample"
Profile: Breastfeeding Patient Observation
status: FINAL
code: Breastfeeding (SNOMED CT#413712001)
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
effective: 2022-11-30
performer: Practitioner/ObservationPerformingPractitionerExample " WHITE"
value: true
note: additional notes here (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

13. CarePlan/ARVTreatmentRegimenChangedExample (CarePlan/ARVTreatmentRegimenChangedExample)

Generated Narrative: CarePlan
Resource CarePlan "ARVTreatmentRegimenChangedExample"
Profile: ARV Treatment CarePlan
identifier: Unique ART number: UAN000123
status: ACTIVE
intent: ORDER
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
period: 2022-12-01 --> 2022-12-01
Activities
- PlannedActivityReference
* See above (MedicationRequest/ARVRegimenMedicationRequestRegimenChangedExample)
note: Some comments (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

14. CarePlan/ARVTreatmentInitiatedExample (CarePlan/ARVTreatmentInitiatedExample)

Generated Narrative: CarePlan
Resource CarePlan "ARVTreatmentInitiatedExample"
Profile: ARV Treatment CarePlan
identifier: Unique ART number: UAN000123
status: ACTIVE
intent: ORDER
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
period: 2022-12-01 --> 2022-12-01
Activities
- PlannedActivityReference
* See above (MedicationRequest/ARVRegimenMedicationRequestARVExample)
note: Some comments (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

15. MedicationRequest/ARVRegimenMedicationRequestRegimenChangedExample (MedicationRequest/ARVRegimenMedicationRequestRegimenChangedExample)

Generated Narrative: MedicationRequest
Resource MedicationRequest "ARVRegimenMedicationRequestRegimenChangedExample"
Profile: ARV Regimen Medication Request
status: COMPLETED
intent: ORDER
Medications
- Concept
* ARV regimen (SNOMED CT#427314002 "Antiviral therapy")
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
Reasons
- Reference
* See above (Observation/ARTRegimenSwitchedOrSubstitutedExample)

16. MedicationRequest/ARVRegimenMedicationRequestARVExample (MedicationRequest/ARVRegimenMedicationRequestARVExample)

Generated Narrative: MedicationRequest
Resource MedicationRequest "ARVRegimenMedicationRequestARVExample"
Profile: ARV Regimen Medication Request
status: COMPLETED
intent: ORDER
Medications
- Concept
* ARV regimen (SNOMED CT#427314002 "Antiviral therapy")
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
Reasons
- Reference
* See above (Observation/ARTInitiatedExample)

17. Encounter/TargetFacilityEncounterExample (Encounter/TargetFacilityEncounterExample)

Not done yet

18. Observation/HIVTestResultExample (Observation/HIVTestResultExample)

Generated Narrative: Observation
Resource Observation "HIVTestResultExample"
Profile: HIV VL Lab Result Observation
Test Result Entered Manually: false
status: FINAL
code: Viral Load Result (SNOMED CT#398579006 "Human immunodeficiency virus-1 nucleic acid assay")
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
effective: 2022-11-30
performer: Organization/HIVOrganizationExample "HIV Test Services Health Facility"
value: 1001
interpretation: Viral Load Suppression Status (SNOMED CT#19032002 "Uncontrolled")
note: Viral load not suppressed (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

19. SpecimenDefinition/SpecimenConservationExample (SpecimenDefinition/SpecimenConservationExample)

Generated Narrative: SpecimenDefinition
Resource SpecimenDefinition "SpecimenConservationExample"
Profile: Specimen Conservation
status: ACTIVE
typeTested
type: 119361006 (SNOMED CT#119361006)
preference: PREFERRED
handling
temperatureRange: 5-10
MaxDurations
- Value
* 20
instruction: Comments regarding the specimen conservation.

20. Task/HIVLabResultTaskExample (Task/HIVLabResultTaskExample)

Generated Narrative: Task
Resource Task "HIVLabResultTaskExample"
Profile: HIV VL Lab Order Task
Result Status Index: 4
identifier: Lab order number: ORDER12345
instantiatesCanonical: ActivityDefinition[http://openhie.org/fhir/rwanda-hiv/ActivityDefinition/LabOrderTaskActivityExample|0.1.0]
basedOn:
See above (ServiceRequest/HIVServiceRequestExample)
See above (Transport/SampleDispatchedToLabExample)
See above (Transport/ResultDispatchedToRequestingFacilityExample)
status: COMPLETED
intent: ORIGINALORDER
for: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
executionPeriod: ?? --> 2022-07-30
lastModified: 2022-07-30
note: additional notes here (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)
Outputs
- Type Value[x]
* Viral Load Result (SNOMED CT#398579006 "Human immunodeficiency virus-1 nucleic acid assay") See above (DiagnosticReport/HIVLabResultsDiagnosticReportExample)

21. ActivityDefinition/LabOrderTaskActivityExample (ActivityDefinition/LabOrderTaskActivityExample)

Generated Narrative: ActivityDefinition
Resource ActivityDefinition "LabOrderTaskActivityExample"
Profile: HIV Lab Order Activity Definition
HIV Viral Load Result Revised By: 2
status: ACTIVE
date: 2023-01-01
approvalDate: 2023-01-01
lastReviewDate: 2023-01-01
editor: Sarah May:
reviewer: Mark Jones:
endorser: Tobias Menley:
specimenRequirement: http://openhie.org/fhir/rwanda-hiv/SpecimenDefinition/SpecimenConservationExample

22. Transport/SampleDispatchedToLabExample (Transport/SampleDispatchedToLabExample)

Generated Narrative: Transport
Resource Transport "SampleDispatchedToLabExample"
Profile: Sample Dispatched
status: INPROGRESS
intent: ORDER
completionTime: 2022-07-28
authoredOn: 2022-07-28
note: additional notes here (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)
requestedLocation: See above (Location/TransportRequestedLocationExample)
currentLocation: See above (Location/TransportCurrentLocationExample)

23. Transport/ResultDispatchedToRequestingFacilityExample (Transport/ResultDispatchedToRequestingFacilityExample)

Generated Narrative: Transport
Resource Transport "ResultDispatchedToRequestingFacilityExample"
Profile: Result Dispatched
status: INPROGRESS
intent: ORDER
authoredOn: 2022-07-28
note: additional notes here (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)
requestedLocation: See above (Location/TransportRequestedLocationExample)
currentLocation: See above (Location/TransportCurrentLocationExample)

24. Location/TransportRequestedLocationExample (Location/TransportRequestedLocationExample)

Generated Narrative: Location
Resource Location "TransportRequestedLocationExample"
Profile: Transport Location
status: ACTIVE
name: Requested location name

25. Location/TransportCurrentLocationExample (Location/TransportCurrentLocationExample)

Generated Narrative: Location
Resource Location "TransportCurrentLocationExample"
Profile: Transport Location
status: ACTIVE
name: Current location name

26. DiagnosticReport/HIVLabResultsDiagnosticReportExample (DiagnosticReport/HIVLabResultsDiagnosticReportExample)

Test Type
Subject Jane Maria Smith (OFFICIAL) female, DoB: 1990-12-12
Report Details
Code Value Flags Note When For
Viral Load Result 1001 Viral Load Suppression Status Viral load not suppressed (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM) 2022-11-30
Some conclusion text

27. Practitioner/ResultsInterpreterExample (Practitioner/ResultsInterpreterExample)

Generated Narrative: Practitioner
Resource Practitioner "ResultsInterpreterExample"
Profile: Practitioner
Clinician User Index: 11
name: Jhon Smith
telecom: ph: 27539887534

28. Consent/ReceiveSMSMessagesExample (Consent/ReceiveSMSMessagesExample)

Generated Narrative: Consent
Resource Consent "ReceiveSMSMessagesExample"
Profile: Receive SMS Messages Consent
status: ACTIVE
category: Patient consent for SMS messages (LOINC#89057-4 "Permission to receive text messages")
subject: See above (Patient/HIVPatientExample)
decision: PERMIT

29. Observation/ARVAdherenceExample (Observation/ARVAdherenceExample)

Generated Narrative: Observation
Resource Observation "ARVAdherenceExample"
Profile: Adherence to ARV Treatment Observation
status: FINAL
code: Treatment compliance (SNOMED CT#386091000)
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
effective: 2022-11-30
performer: Practitioner/ObservationPerformingPractitionerExample " WHITE"
value: ARV adherence (LOINC#LA6763-2 "Good = 95% adherence")
note: additional notes here (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

30. Observation/RepeatHIVTestResultExample (Observation/RepeatHIVTestResultExample)

Generated Narrative: Observation
Resource Observation "RepeatHIVTestResultExample"
Profile: Repeat HIV VL Lab Result Observation
status: FINAL
code: Viral Load Result (SNOMED CT#398579006 "Human immunodeficiency virus-1 nucleic acid assay")
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
effective: 2022-11-30
performer: Organization/HIVOrganizationExample "HIV Test Services Health Facility"
value: 1001
note: Viral load not suppressed (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

31. Observation/SuspendTreatmentHIVTestResultExample (Observation/SuspendTreatmentHIVTestResultExample)

Generated Narrative: Observation
Resource Observation "SuspendTreatmentHIVTestResultExample"
Profile: Suspended Treatment HIV VL Lab Result Observation
status: FINAL
code: Viral Load Result (SNOMED CT#398579006 "Human immunodeficiency virus-1 nucleic acid assay")
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
effective: 2022-11-30
performer: Organization/HIVOrganizationExample "HIV Test Services Health Facility"
value: 1001
note: Viral load not suppressed (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

32. Device/TestingPlatformExample (Device/TestingPlatformExample)

Generated Narrative: Device
Resource Device "TestingPlatformExample"
Profile: Testing Platform
manufacturer: My testing platform
note: Some comments (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

33. Observation/HIVTestResultViralLoadLogExample (Observation/HIVTestResultViralLoadLogExample)

Generated Narrative: Observation
Resource Observation "HIVTestResultViralLoadLogExample"
Profile: Viral Load Log Observation
status: FINAL
code: Viral Load Result (SNOMED CT#398579006 "Human immunodeficiency virus-1 nucleic acid assay")
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
effective: 2022-11-30
performer: Organization/HIVOrganizationExample "HIV Test Services Health Facility"
value: 2.55
note: Some comments (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)
derivedFrom: See above (Observation/HIVTestResultExample)

34. Observation/HIVTestResultAbsoluteDecimalExample (Observation/HIVTestResultAbsoluteDecimalExample)

Generated Narrative: Observation
Resource Observation "HIVTestResultAbsoluteDecimalExample"
Profile: Viral Load Result Absolute Decimal Observation
status: FINAL
code: Viral Load Result (SNOMED CT#398579006 "Human immunodeficiency virus-1 nucleic acid assay")
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
effective: 2022-11-30
performer: Organization/HIVOrganizationExample "HIV Test Services Health Facility"
value: 2.55
note: Some comments (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)
derivedFrom: See above (Observation/HIVTestResultExample)

35. Organization/FundingOrganizationExample (Organization/FundingOrganizationExample)

Generated Narrative: Organization
Resource Organization "FundingOrganizationExample"
Profile: Funding Organization
Funding Organization: 1
identifier: Funding Organization identifier: funder1
name: A funding organization name

36. Organization/ImplementingPartnerOrganizationExample (Organization/ImplementingPartnerOrganizationExample)

Generated Narrative: Organization
Resource Organization "ImplementingPartnerOrganizationExample"
Profile: Implementing Partner Organization
Implementing Partner Organization: 14
identifier: Implementing Partner Organization identifier: implementing-partner-org1
name: An implementing partner organization name

37. Observation/ARTInitiatedExample (Observation/ARTInitiatedExample)

Generated Narrative: Observation
Resource Observation "ARTInitiatedExample"
Profile: ART Initiated Observation
status: FINAL
code: ART initiated (LOINC#47241-5 "Date determined medically eligible and ready to start HIV treatment")
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
effective: 2022-11-30
performer: Practitioner/ObservationPerformingPractitionerExample " WHITE"
note: Some comments (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)

38. Observation/ARVRegimenChangeExample (Observation/ARVRegimenChangeExample)

Generated Narrative: Observation
Resource Observation "ARVRegimenChangeExample"
Profile: ARV Regimen Change Observation
status: FINAL
code: ARV Regimen Change (SNOMED CT#182838006 "Change of medication")
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
effective: 2022-11-30
performer: Practitioner/ObservationPerformingPractitionerExample " WHITE"
value: Regimen change reason (SNOMED CT#271737000 "Anemia")
note: Some comments (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)
derivedFrom: See above (Observation/ARTRegimenSwitchedOrSubstitutedExample)

39. Observation/ARTRegimenSwitchedOrSubstitutedExample (Observation/ARTRegimenSwitchedOrSubstitutedExample)

Generated Narrative: Observation
Resource Observation "ARTRegimenSwitchedOrSubstitutedExample"
Profile: ART Regimen Switched Or Substituted Observation
status: FINAL
code: ARV Regimen Change (SNOMED CT#182838006 "Change of medication")
subject: See above (Patient/HIVPatientExample)
encounter: See above (Encounter/TargetFacilityEncounterExample)
effective: 2022-11-30
performer: Practitioner/ObservationPerformingPractitionerExample " WHITE"
value: true
note: Some comments (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)