HL7 FHIR Implementation Guide: Rwanda HIV
0.1.0 - STU1
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
Bundle VLSMS-VL-Request-Transactional of type transaction
Entry 1 - fullUrl = Patient/HIVPatientExample
Request:
PUT Patient/HIVPatientExample
Resource Patient:
Jane Maria Smith (OFFICIAL) Female, DoB: 1990-12-12
Entry 2 - fullUrl = Specimen/VLSpecimenExample
Request:
PUT Specimen/VLSpecimenExample
Resource 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)
Entry 3 - fullUrl = Organization/RequestingOrganizationExample
Request:
PUT Organization/RequestingOrganizationExample
Resource Organization:
Generated Narrative: Organization
Resource Organization "RequestingOrganizationExample"
Profile: Requesting Organization
identifier: Requesting Organization identifier: facility5
name: A facility name
Entry 4 - fullUrl = Organization/PerformingOrganizationExample
Request:
PUT Organization/PerformingOrganizationExample
Resource Organization:
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
Entry 5 - fullUrl = ServiceRequest/HIVServiceRequestExample
Request:
PUT ServiceRequest/HIVServiceRequestExample
Resource ServiceRequest:
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)
Entry 6 - fullUrl = Practitioner/RequestingPractitionerExample
Request:
PUT Practitioner/RequestingPractitionerExample
Resource Practitioner:
Generated Narrative: Practitioner
Resource Practitioner "RequestingPractitionerExample"
Profile: Practitioner
Clinician User Index: 2
name: James Smith
telecom: ph: 27537652509
Entry 7 - fullUrl = Practitioner/PerformingPractitionerExample
Request:
PUT Practitioner/PerformingPractitionerExample
Resource Practitioner:
Generated Narrative: Practitioner
Resource Practitioner "PerformingPractitionerExample"
Profile: Practitioner
Clinician User Index: 6
name: Amy White
telecom: ph: 27537687534
Entry 8 - fullUrl = Observation/ReasonForHIVTestingExample
Request:
PUT Observation/ReasonForHIVTestingExample
Resource Observation:
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)
Entry 9 - fullUrl = Observation/PatientPregnantExample
Request:
PUT Observation/PatientPregnantExample
Resource Observation:
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)
Entry 10 - fullUrl = Observation/HIVPatientIsNewExample
Request:
PUT Observation/HIVPatientIsNewExample
Resource Observation:
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)
Entry 11 - fullUrl = Observation/BreastfeedingExample
Request:
PUT Observation/BreastfeedingExample
Resource Observation:
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)
Entry 12 - fullUrl = CarePlan/ARVTreatmentRegimenChangedExample
Request:
PUT CarePlan/ARVTreatmentRegimenChangedExample
Resource 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)
Entry 13 - fullUrl = CarePlan/ARVTreatmentInitiatedExample
Request:
PUT CarePlan/ARVTreatmentInitiatedExample
Resource 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)
Entry 14 - fullUrl = MedicationRequest/ARVRegimenMedicationRequestRegimenChangedExample
Request:
PUT MedicationRequest/ARVRegimenMedicationRequestRegimenChangedExample
Resource MedicationRequest:
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)
Entry 15 - fullUrl = MedicationRequest/ARVRegimenMedicationRequestARVExample
Request:
PUT MedicationRequest/ARVRegimenMedicationRequestARVExample
Resource MedicationRequest:
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)
Entry 16 - fullUrl = Encounter/TargetFacilityEncounterExample
Request:
PUT Encounter/TargetFacilityEncounterExample
Resource Encounter:
Not done yet
Entry 17 - fullUrl = Observation/HIVTestResultExample
Request:
PUT Observation/HIVTestResultExample
Resource Observation:
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)
Entry 18 - fullUrl = SpecimenDefinition/SpecimenConservationExample
Request:
PUT SpecimenDefinition/SpecimenConservationExample
Resource SpecimenDefinition:
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.
Entry 19 - fullUrl = Task/HIVLabResultTaskExample
Request:
PUT Task/HIVLabResultTaskExample
Resource 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)
Entry 20 - fullUrl = ActivityDefinition/LabOrderTaskActivityExample
Request:
PUT ActivityDefinition/LabOrderTaskActivityExample
Resource ActivityDefinition:
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
Entry 21 - fullUrl = Transport/SampleDispatchedToLabExample
Request:
PUT Transport/SampleDispatchedToLabExample
Resource Transport:
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)
Entry 22 - fullUrl = Transport/ResultDispatchedToRequestingFacilityExample
Request:
PUT Transport/ResultDispatchedToRequestingFacilityExample
Resource Transport:
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)
Entry 23 - fullUrl = Location/TransportRequestedLocationExample
Request:
PUT Location/TransportRequestedLocationExample
Resource Location:
Resource Location "TransportRequestedLocationExample"
Profile: Transport Location
status: ACTIVE
name: Requested location name
Entry 24 - fullUrl = Location/TransportCurrentLocationExample
Request:
PUT Location/TransportCurrentLocationExample
Resource Location:
Resource Location "TransportCurrentLocationExample"
Profile: Transport Location
status: ACTIVE
name: Current location name
Entry 25 - fullUrl = DiagnosticReport/HIVLabResultsDiagnosticReportExample
Request:
PUT DiagnosticReport/HIVLabResultsDiagnosticReportExample
Resource DiagnosticReport:
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
Entry 26 - fullUrl = Practitioner/ResultsInterpreterExample
Request:
PUT Practitioner/ResultsInterpreterExample
Resource Practitioner:
Generated Narrative: Practitioner
Resource Practitioner "ResultsInterpreterExample"
Profile: Practitioner
Clinician User Index: 11
name: Jhon Smith
telecom: ph: 27539887534
Entry 27 - fullUrl = Consent/ReceiveSMSMessagesExample
Request:
PUT Consent/ReceiveSMSMessagesExample
Resource 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
Entry 28 - fullUrl = Observation/ARVAdherenceExample
Request:
PUT Observation/ARVAdherenceExample
Resource Observation:
Generated Narrative: Observation
Resource Observation "ARVAdherenceExample"
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)
Entry 29 - fullUrl = Observation/RepeatHIVTestResultExample
Request:
PUT Observation/RepeatHIVTestResultExample
Resource Observation:
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)
Entry 30 - fullUrl = Observation/SuspendTreatmentHIVTestResultExample
Request:
PUT Observation/SuspendTreatmentHIVTestResultExample
Resource Observation:
Generated Narrative: Observation
Resource Observation "SuspendTreatmentHIVTestResultExample"
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)
Entry 31 - fullUrl = Device/TestingPlatformExample
Request:
PUT Device/TestingPlatformExample
Resource Device:
Resource Device "TestingPlatformExample"
Profile: Testing Platform
manufacturer: My testing platform
note: Some comments (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)
Entry 32 - fullUrl = Observation/HIVTestResultViralLoadLogExample
Request:
PUT Observation/HIVTestResultViralLoadLogExample
Resource Observation:
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)
Entry 33 - fullUrl = Observation/HIVTestResultAbsoluteDecimalExample
Request:
PUT Observation/HIVTestResultAbsoluteDecimalExample
Resource Observation:
Generated Narrative: Observation
Resource Observation "HIVTestResultAbsoluteDecimalExample"
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)
Entry 34 - fullUrl = Organization/FundingOrganizationExample
Request:
PUT Organization/FundingOrganizationExample
Resource Organization:
Generated Narrative: Organization
Resource Organization "FundingOrganizationExample"
Profile: Funding Organization
Funding Organization: 1
identifier: Funding Organization identifier: funder1
name: A funding organization name
Entry 35 - fullUrl = Organization/ImplementingPartnerOrganizationExample
Request:
PUT Organization/ImplementingPartnerOrganizationExample
Resource Organization:
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
Entry 36 - fullUrl = Observation/ARTInitiatedExample
Request:
PUT Observation/ARTInitiatedExample
Resource Observation:
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)
Entry 37 - fullUrl = Observation/ARVRegimenChangeExample
Request:
PUT Observation/ARVRegimenChangeExample
Resource Observation:
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)
Entry 38 - fullUrl = Observation/ARTRegimenSwitchedOrSubstitutedExample
Request:
PUT Observation/ARTRegimenSwitchedOrSubstitutedExample
Resource Observation:
Generated Narrative: Observation
Resource Observation "ARTRegimenSwitchedOrSubstitutedExample"
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)