HIV Case-Based Surveillance, published by Jembi Health Systems. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/openhie/HIV-CBS and changes regularly. See the Directory of published versions
EMR Bundle
Introduction
This UML diagram has been modelled from the EMR message bundle specification.
UML
resourceType Bundle id EMR type transaction entry fullUrl Patient/HIVPatientExample resource request resourceType Patient id HIVPatientExample meta extension identifier active ☑ true name telecom gender female birthDate 1990-12-12 address maritalStatus contact managingOrganization profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/hiv-patient url http://openhie.org/fhir/hiv-cbs/StructureDefinition/key-population-status valueCodeableConcept coding system http://snomed.info/sct code 417284009 system http://openhie.org/fhir/hiv-cbs/identifier/mr value ORG1-0765712 system http://openhie.org/fhir/hiv-cbs/identifier/nid value NID1234567 use official family Smith given Jane Maria system phone value +27821234567 system email value someone@example.com city Cape Town district City of Cape Town state Western Province country South Africa coding system http://terminology.hl7.org/CodeSystem/v3-MaritalStatus code M relationship name telecom coding system http://terminology.hl7.org/CodeSystem/v2-0131 code N family Doe given John system phone value +27829999999 reference Organization/HIVOrganizationExample method PUT url Patient/HIVPatientExample fullUrl Encounter/TargetFacilityEncounterExample resource request resourceType Encounter id TargetFacilityEncounterExample meta extension status finished class subject episodeOfCare period serviceProvider partOf profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/target-facility-encounter url http://openhie.org/fhir/hiv-cbs/StructureDefinition/hiv-care-next-visit valueDateTime 2022-10-22 system http://terminology.hl7.org/CodeSystem/v3-ActCode code AMB reference Patient/HIVPatientExample reference EpisodeOfCare/HIVEpisodeOfCareExample start 2022-12-01 end 2023-01-20 reference Organization/HIVOrganizationExample reference Encounter/TransferringFacilityEncounterExample method PUT url Encounter/TargetFacilityEncounterExample fullUrl Encounter/TransferringFacilityEncounterExample resource request resourceType Encounter id TransferringFacilityEncounterExample meta status finished class period serviceProvider profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/transferring-facility-encounter system http://terminology.hl7.org/CodeSystem/v3-ActCode code AMB start 2022-12-01 end 2023-01-20 reference Organization/HIVOrganizationExample method PUT url Encounter/TransferringFacilityEncounterExample fullUrl Condition/HIVDiagnosisExample resource request resourceType Condition id HIVDiagnosisExample meta identifier clinicalStatus verificationStatus code subject encounter recordedDate 2021-05-18 note profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/hiv-diagnosis type system http://openhie.org/fhir/hiv-cbs/identifier/hiv-diagnosis value abc123 coding system http://terminology.hl7.org/CodeSystem/v2-0203 code PI coding system http://terminology.hl7.org/CodeSystem/condition-clinical code active coding system http://terminology.hl7.org/CodeSystem/condition-ver-status code confirmed coding system http://snomed.info/sct code 86406008 reference Patient/HIVPatientExample reference Encounter/TargetFacilityEncounterExample authorReference time 2015-02-07T13:28:17-05:00 text Additional information regarding the HIV diagnosis reference Organization/HIVOrganizationExample method PUT url Condition/HIVDiagnosisExample fullUrl Observation/DeathExample resource request resourceType Observation id DeathExample meta status final code subject encounter effectiveDateTime 2023-02-05 valueCodeableConcept note profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/death coding system http://snomed.info/sct code 419620001 reference Patient/HIVPatientExample reference Encounter/TargetFacilityEncounterExample coding system http://loinc.org code 80359-3 authorReference time 2015-02-07T13:28:17-05:00 text Details regarding death reference Organization/HIVOrganizationExample method PUT url Observation/DeathExample fullUrl Observation/DateHIVTestDoneExample resource request resourceType Observation id DateHIVTestDoneExample meta status final code subject encounter effectiveDateTime 2022-12-10 note profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/date-hiv-test-done coding system http://snomed.info/sct code 315124004 reference Patient/HIVPatientExample reference Encounter/TargetFacilityEncounterExample authorReference time 2015-02-07T13:28:17-05:00 text Additional information regarding the HIV test reference Organization/HIVOrganizationExample method PUT url Observation/DateHIVTestDoneExample fullUrl EpisodeOfCare/HIVEpisodeOfCareExample resource request resourceType EpisodeOfCare id HIVEpisodeOfCareExample meta identifier status active diagnosis patient managingOrganization period profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/hiv-episode-of-care type system http://openhie.org/fhir/hiv-cbs/identifier/enrollment-unique-id value abc123 coding system http://terminology.hl7.org/CodeSystem/v2-0203 code PI condition reference Condition/HIVDiagnosisExample reference Patient/HIVPatientExample reference Organization/HIVOrganizationExample start 2021-05-18 end 2021-05-18 method PUT url EpisodeOfCare/HIVEpisodeOfCareExample fullUrl Observation/HIVRecencyTestDoneExample resource request resourceType Observation id HIVRecencyTestDoneExample meta status final code subject encounter effectiveDateTime 2022-12-10 valueCodeableConcept note profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/hiv-recency-test-done coding system http://snomed.info/sct code 409788009 reference Patient/HIVPatientExample reference Encounter/TargetFacilityEncounterExample coding system http://snomed.info/sct code 373066001 authorReference time 2015-02-07T13:28:17-05:00 text Additional information regarding the HIV recency test reference Organization/HIVOrganizationExample method PUT url Observation/HIVRecencyTestDoneExample fullUrl Observation/HIVRecencyTestResultExample resource request resourceType Observation id HIVRecencyTestResultExample meta status final code subject encounter effectiveDateTime 2022-12-10 performer valueCodeableConcept interpretation note profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/hiv-recency-test-result coding system http://snomed.info/sct code 409788009 reference Patient/HIVPatientExample reference Encounter/TargetFacilityEncounterExample reference Organization/HIVOrganizationExample coding system http://snomed.info/sct code 118246004 coding system http://snomed.info/sct code 6493001 authorReference time 2015-02-07T13:28:17-05:00 text Additional information regarding the HIV recency test result reference Organization/HIVOrganizationExample method PUT url Observation/HIVRecencyTestResultExample fullUrl Observation/CD4PercentageExample resource request resourceType Observation id CD4PercentageExample meta status final code subject encounter effectiveDateTime 2022-12-10 performer valueQuantity note derivedFrom profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/hiv-cd4-percentage coding system http://snomed.info/sct code 313938009 reference Patient/HIVPatientExample reference Encounter/TargetFacilityEncounterExample reference Organization/HIVOrganizationExample value 45.23 authorReference time 2015-02-07T13:28:17-05:00 text Additional information regarding the CD4 Percentage reference Organization/HIVOrganizationExample reference Observation/CD4TestResultExample method PUT url Observation/CD4PercentageExample fullUrl Observation/CD4TestResultExample resource request resourceType Observation id CD4TestResultExample meta status final code subject encounter effectiveDateTime 2022-12-10 performer valueInteger 650 note profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/hiv-cd4-test coding system http://snomed.info/sct code 151271000119102 reference Patient/HIVPatientExample reference Encounter/TargetFacilityEncounterExample reference Organization/HIVOrganizationExample authorReference time 2015-02-07T13:28:17-05:00 text Additional information regarding the CD4 Count reference Organization/HIVOrganizationExample method PUT url Observation/CD4TestResultExample fullUrl CarePlan/ARVTreatmentRegimenSwitchedOrSubstitutedExample resource request resourceType CarePlan id ARVTreatmentRegimenSwitchedOrSubstitutedExample meta status active intent plan subject encounter period activity note profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/hiv-arv-treatment reference Patient/HIVPatientExample reference Encounter/TargetFacilityEncounterExample start 2022-12-01 end 2022-12-01 detail extension kind MedicationRequest code status in-progress scheduledPeriod productCodeableConcept url http://openhie.org/fhir/hiv-cbs/StructureDefinition/art-regimen-line valueCodeableConcept coding system http://snomed.info/sct code 708255002 url http://openhie.org/fhir/hiv-cbs/StructureDefinition/art-regimen-switched-or-substituted valueCodeableConcept coding system http://openhie.org/fhir/hiv-cbs/CodeSystem/cs-art-regimen-change-type code Switched coding system http://loinc.org code 45260-7 start 2023-01-01 end 2023-01-01 coding system http://snomed.info/sct code 387005008 authorReference time 2015-02-07T13:28:17-05:00 text Additional information regarding the switching of the ARV regimen with another ARV regimen. reference Organization/HIVOrganizationExample method PUT url CarePlan/ARVTreatmentRegimenSwitchedOrSubstitutedExample fullUrl MedicationRequest/HIVCareMedicationRequestExample resource request resourceType MedicationRequest id HIVCareMedicationRequestExample meta status active intent proposal medicationCodeableConcept subject encounter basedOn note dispenseRequest profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/hiv-med-req coding system http://snomed.info/sct code 878898002 reference Patient/HIVPatientExample reference Encounter/TargetFacilityEncounterExample reference CarePlan/ARVTreatmentRegimenSwitchedOrSubstitutedExample authorReference time 2015-02-07T13:28:17-05:00 text Additional information regarding the HIV Medication Request reference Organization/HIVOrganizationExample quantity value 30 method PUT url MedicationRequest/HIVCareMedicationRequestExample fullUrl ServiceRequest/TransferredOutServiceRequestExample resource request resourceType ServiceRequest id TransferredOutServiceRequestExample meta status completed intent order code subject encounter occurrenceDateTime 2012-01-05 requester performer note profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/transferred-out coding system http://loinc.org code LA20597-3 reference Patient/HIVPatientExample reference Encounter/TargetFacilityEncounterExample reference Practitioner/PractitionerExample reference Organization/HIVOrganizationPatientTransferredToExample authorReference time 2015-02-07T13:28:17-05:00 text additional notes about the transfer reference Organization/HIVOrganizationExample method PUT url ServiceRequest/TransferredOutServiceRequestExample fullUrl Organization/HIVOrganizationPatientTransferredToExample resource request resourceType Organization id HIVOrganizationPatientTransferredToExample meta identifier name HIV Test Services Health Facility address profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/hiv-organization-patient-transferred-to type system http://openhie.org/fhir/hiv-cbs/identifier/hiv-organization value facility1 coding system http://terminology.hl7.org/CodeSystem/v2-0203 code XX line city DISI city 1 district DISI district 1 state DISI state 1 postalCode DISI postal code country DISI country DISI line 1 DISI line 2 DISI line 3 method PUT url Organization/HIVOrganizationPatientTransferredToExample fullUrl Observation/HIVTestResultExample resource request resourceType Observation id HIVTestResultExample meta status final code subject encounter effectiveDateTime 2022-11-30 performer valueInteger 1001 interpretation note profile http://openhie.org/fhir/hiv-cbs/StructureDefinition/hiv-test-results coding system http://snomed.info/sct code 398579006 reference Patient/HIVPatientExample reference Encounter/TargetFacilityEncounterExample reference Organization/HIVOrganizationExample coding system http://snomed.info/sct code 19032002 authorReference time 2015-02-07T13:28:17-05:00 text Viral load not suppressed reference Organization/HIVOrganizationExample method PUT url Observation/HIVTestResultExample
EMR Bundle - UML Diagram