HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1
0.1.0 - STU1
HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/openhie/Training-Solution-1 and changes regularly. See the Directory of published versions
<Bundle xmlns="http://hl7.org/fhir">
<id value="EMR"/>
<type value="transaction"/>
<entry>
<fullUrl value="http://hapi-fhir:8080/fhir/Patient/HIVPatientExample"/>
<resource>
<Patient>
<id value="HIVPatientExample"/>
<meta>
<profile
value="http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-patient"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Patient</b><a name="HIVPatientExample"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Patient "HIVPatientExample" </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-hiv-patient.html">Patient</a></p></div><p><b>Key HIV Population</b>: HIV key population <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://browser.ihtsdotools.org/">SNOMED CT</a>#417284009 "Current drug user")</span></p><p><b>identifier</b>: Patient folder number: ORG1-0765712, id: NID1234567</p><p><b>name</b>: Jane Maria Smith (OFFICIAL)</p><p><b>telecom</b>: <a href="tel:+27821234567">+27821234567</a>, <a href="mailto:someone@example.com">someone@example.com</a></p><p><b>gender</b>: female</p><p><b>birthDate</b>: 1990-12-12</p><p><b>address</b>: 99 Walmer Blvd Sunnydale Cape Town Western Province South Africa </p><p><b>maritalStatus</b>: Married <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-v3-MaritalStatus.html">MaritalStatus</a>#M)</span></p><h3>Contacts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Relationship</b></td><td><b>Name</b></td><td><b>Telecom</b></td></tr><tr><td style="display: none">*</td><td>Next-of-Kin <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-v2-0131.html">contactRole2</a>#N)</span></td><td>John Doe </td><td><a href="tel:+27829999999">+27829999999</a></td></tr></table><p><b>managingOrganization</b>: <a href="Organization-HIVOrganizationExample.html">Organization/HIVOrganizationExample</a> "HIV Test Services Health Facility"</p></div>
</text>
<extension
url="http://openhie.org/fhir/training-solution-1/StructureDefinition/key-population-status">
<valueCodeableConcept>
<coding>
<system value="http://snomed.info/sct"/>
<code value="417284009"/>
<display value="Current drug user"/>
</coding>
<text value="HIV key population"/>
</valueCodeableConcept>
</extension>
<identifier>
<type>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="MR"/>
<display value="Medical record number"/>
</coding>
<text value="Patient folder number"/>
</type>
<system
value="http://openhie.org/fhir/training-solution-1/identifier/mr"/>
<value value="ORG1-0765712"/>
</identifier>
<identifier>
<system
value="http://openhie.org/fhir/training-solution-1/identifier/nid"/>
<value value="NID1234567"/>
</identifier>
<name>
<use value="official"/>
<family value="Smith"/>
<given value="Jane"/>
<given value="Maria"/>
</name>
<telecom>
<system value="phone"/>
<value value="+27821234567"/>
</telecom>
<telecom>
<system value="email"/>
<value value="someone@example.com"/>
</telecom>
<gender value="female"/>
<birthDate value="1990-12-12"/>
<address>
<line value="99"/>
<line value="Walmer Blvd"/>
<line value="Sunnydale"/>
<city value="Cape Town"/>
<district value="City of Cape Town"/>
<state value="Western Province"/>
<country value="South Africa"/>
</address>
<maritalStatus>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/v3-MaritalStatus"/>
<code value="M"/>
</coding>
</maritalStatus>
<contact>
<relationship>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0131"/>
<code value="N"/>
</coding>
</relationship>
<name>
<family value="Doe"/>
<given value="John"/>
</name>
<telecom>
<system value="phone"/>
<value value="+27829999999"/>
</telecom>
</contact>
<managingOrganization>🔗
<reference value="Organization/HIVOrganizationExample"/>
</managingOrganization>
</Patient>
</resource>
<request>
<method value="PUT"/>
<url value="Patient/HIVPatientExample"/>
</request>
</entry>
<entry>
<fullUrl
value="http://hapi-fhir:8080/fhir/Encounter/TargetFacilityEncounterExample"/>
<resource>
<Encounter>
<id value="TargetFacilityEncounterExample"/>
<meta>
<profile
value="http://openhie.org/fhir/training-solution-1/StructureDefinition/target-facility-encounter"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Encounter</b><a name="TargetFacilityEncounterExample"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Encounter "TargetFacilityEncounterExample" </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-target-facility-encounter.html">Target Facility Encounter</a></p></div><p><b>status</b>: finished</p><p><b>class</b>: ambulatory (Details: http://terminology.hl7.org/CodeSystem/v3-ActCode code AMB = 'ambulatory', stated as 'null')</p><p><b>subject</b>: <a href="#Patient_HIVPatientExample">See above (Patient/HIVPatientExample)</a></p><p><b>episodeOfCare</b>: <a href="#EpisodeOfCare_HIVEpisodeOfCareExample">See above (EpisodeOfCare/HIVEpisodeOfCareExample)</a></p><p><b>period</b>: 2022-12-01 --> 2023-01-20</p><p><b>partOf</b>: <a href="#Encounter_TransferringFacilityEncounterExample">See above (Encounter/TransferringFacilityEncounterExample)</a></p></div>
</text>
<status value="finished"/>
<class>
<system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
<code value="AMB"/>
</class>
<subject>🔗
<reference value="Patient/HIVPatientExample"/>
</subject>
<episodeOfCare>🔗
<reference value="EpisodeOfCare/HIVEpisodeOfCareExample"/>
</episodeOfCare>
<period>
<start value="2022-12-01"/>
<end value="2023-01-20"/>
</period>
<partOf>🔗
<reference value="Encounter/TransferringFacilityEncounterExample"/>
</partOf>
</Encounter>
</resource>
<request>
<method value="PUT"/>
<url value="Encounter/TargetFacilityEncounterExample"/>
</request>
</entry>
<entry>
<fullUrl
value="http://hapi-fhir:8080/fhir/Encounter/TransferringFacilityEncounterExample"/>
<resource>
<Encounter>
<id value="TransferringFacilityEncounterExample"/>
<meta>
<profile
value="http://openhie.org/fhir/training-solution-1/StructureDefinition/transferring-facility-encounter"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Encounter</b><a name="TransferringFacilityEncounterExample"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Encounter "TransferringFacilityEncounterExample" </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-transferring-facility-encounter.html">Transferring Facility Encounter</a></p></div><p><b>status</b>: finished</p><p><b>class</b>: ambulatory (Details: http://terminology.hl7.org/CodeSystem/v3-ActCode code AMB = 'ambulatory', stated as 'null')</p><p><b>serviceProvider</b>: <a href="Organization-HIVOrganizationExample.html">Organization/HIVOrganizationExample</a> "HIV Test Services Health Facility"</p></div>
</text>
<status value="finished"/>
<class>
<system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/>
<code value="AMB"/>
</class>
<serviceProvider>🔗
<reference value="Organization/HIVOrganizationExample"/>
</serviceProvider>
</Encounter>
</resource>
<request>
<method value="PUT"/>
<url value="Encounter/TransferringFacilityEncounterExample"/>
</request>
</entry>
<entry>
<fullUrl
value="http://hapi-fhir:8080/fhir/Condition/HIVDiagnosisExample"/>
<resource>
<Condition>
<id value="HIVDiagnosisExample"/>
<meta>
<profile
value="http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-diagnosis"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Condition</b><a name="HIVDiagnosisExample"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Condition "HIVDiagnosisExample" </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-hiv-diagnosis.html">Diagnosis</a></p></div><p><b>identifier</b>: HIV positive testing identifier: abc123</p><p><b>clinicalStatus</b>: Active <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-condition-clinical.html">Condition Clinical Status Codes</a>#active)</span></p><p><b>code</b>: Diagnosis <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://browser.ihtsdotools.org/">SNOMED CT</a>#86406008 "Human immunodeficiency virus infection")</span></p><p><b>subject</b>: <a href="#Patient_HIVPatientExample">See above (Patient/HIVPatientExample)</a></p><p><b>encounter</b>: <a href="#Encounter_TargetFacilityEncounterExample">See above (Encounter/TargetFacilityEncounterExample)</a></p><p><b>recordedDate</b>: 2021-05-18</p><p><b>note</b>: Additional information regarding the HIV diagnosis (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)</p></div>
</text>
<identifier>
<type>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="PI"/>
<display value="Patient internal identifier"/>
</coding>
<text value="HIV positive testing identifier"/>
</type>
<system
value="http://openhie.org/fhir/training-solution-1/identifier/hiv-diagnosis"/>
<value value="abc123"/>
</identifier>
<clinicalStatus>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/condition-clinical"/>
<code value="active"/>
</coding>
</clinicalStatus>
<code>
<coding>
<system value="http://snomed.info/sct"/>
<code value="86406008"/>
<display value="Human immunodeficiency virus infection"/>
</coding>
<text value="Diagnosis"/>
</code>
<subject>🔗
<reference value="Patient/HIVPatientExample"/>
</subject>
<encounter>🔗
<reference value="Encounter/TargetFacilityEncounterExample"/>
</encounter>
<recordedDate value="2021-05-18"/>
<note>
<authorReference>🔗
<reference value="Organization/HIVOrganizationExample"/>
</authorReference>
<time value="2015-02-07T13:28:17-05:00"/>
<text value="Additional information regarding the HIV diagnosis"/>
</note>
</Condition>
</resource>
<request>
<method value="PUT"/>
<url value="Condition/HIVDiagnosisExample"/>
</request>
</entry>
<entry>
<fullUrl
value="http://hapi-fhir:8080/fhir/Observation/DateHIVTestDoneExample"/>
<resource>
<Observation>
<id value="DateHIVTestDoneExample"/>
<meta>
<profile
value="http://openhie.org/fhir/training-solution-1/StructureDefinition/date-hiv-test-done"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Observation</b><a name="DateHIVTestDoneExample"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Observation "DateHIVTestDoneExample" </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-date-hiv-test-done.html">Date HIV Test Done</a></p></div><p><b>status</b>: final</p><p><b>code</b>: Viral Load Examination <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://browser.ihtsdotools.org/">SNOMED CT</a>#315124004 "Human immunodeficiency virus viral load")</span></p><p><b>subject</b>: <a href="#Patient_HIVPatientExample">See above (Patient/HIVPatientExample)</a></p><p><b>encounter</b>: <a href="#Encounter_TargetFacilityEncounterExample">See above (Encounter/TargetFacilityEncounterExample)</a></p><p><b>effective</b>: 2022-12-10</p><p><b>performer</b>: <a href="Organization-HIVOrganizationExample.html">Organization/HIVOrganizationExample</a> "HIV Test Services Health Facility"</p><p><b>note</b>: Additional information regarding the HIV test (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)</p></div>
</text>
<status value="final"/>
<code>
<coding>
<system value="http://snomed.info/sct"/>
<code value="315124004"/>
<display value="Human immunodeficiency virus viral load"/>
</coding>
<text value="Viral Load Examination"/>
</code>
<subject>🔗
<reference value="Patient/HIVPatientExample"/>
</subject>
<encounter>🔗
<reference value="Encounter/TargetFacilityEncounterExample"/>
</encounter>
<effectiveDateTime value="2022-12-10"/>
<performer>🔗
<reference value="Organization/HIVOrganizationExample"/>
</performer>
<note>
<authorReference>🔗
<reference value="Organization/HIVOrganizationExample"/>
</authorReference>
<time value="2015-02-07T13:28:17-05:00"/>
<text value="Additional information regarding the HIV test"/>
</note>
</Observation>
</resource>
<request>
<method value="PUT"/>
<url value="Observation/DateHIVTestDoneExample"/>
</request>
</entry>
<entry>
<fullUrl
value="http://hapi-fhir:8080/fhir/EpisodeOfCare/HIVEpisodeOfCareExample"/>
<resource>
<EpisodeOfCare>
<id value="HIVEpisodeOfCareExample"/>
<meta>
<profile
value="http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-episode-of-care"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: EpisodeOfCare</b><a name="HIVEpisodeOfCareExample"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource EpisodeOfCare "HIVEpisodeOfCareExample" </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-hiv-episode-of-care.html">Patient Enrollment Type</a></p></div><p><b>identifier</b>: Enrollment identifier: abc123</p><p><b>status</b>: active</p><h3>Diagnoses</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Condition</b></td></tr><tr><td style="display: none">*</td><td><a href="#Condition_HIVDiagnosisExample">See above (Condition/HIVDiagnosisExample)</a></td></tr></table><p><b>patient</b>: <a href="#Patient_HIVPatientExample">See above (Patient/HIVPatientExample)</a></p><p><b>managingOrganization</b>: <a href="Organization-HIVOrganizationExample.html">Organization/HIVOrganizationExample</a> "HIV Test Services Health Facility"</p><p><b>period</b>: 2021-05-18 --> 2021-05-18</p></div>
</text>
<identifier>
<type>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="PI"/>
<display value="Patient internal identifier"/>
</coding>
<text value="Enrollment identifier"/>
</type>
<system
value="http://openhie.org/fhir/training-solution-1/identifier/enrollment-unique-id"/>
<value value="abc123"/>
</identifier>
<status value="active"/>
<diagnosis>
<condition>🔗
<reference value="Condition/HIVDiagnosisExample"/>
</condition>
</diagnosis>
<patient>🔗
<reference value="Patient/HIVPatientExample"/>
</patient>
<managingOrganization>🔗
<reference value="Organization/HIVOrganizationExample"/>
</managingOrganization>
<period>
<start value="2021-05-18"/>
<end value="2021-05-18"/>
</period>
</EpisodeOfCare>
</resource>
<request>
<method value="PUT"/>
<url value="EpisodeOfCare/HIVEpisodeOfCareExample"/>
</request>
</entry>
<entry>
<fullUrl
value="http://hapi-fhir:8080/fhir/CarePlan/ARVTreatmentRegimenSwitchedOrSubstitutedExample"/>
<resource>
<CarePlan>
<id value="ARVTreatmentRegimenSwitchedOrSubstitutedExample"/>
<meta>
<profile
value="http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-arv-treatment"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: CarePlan</b><a name="ARVTreatmentRegimenSwitchedOrSubstitutedExample"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource CarePlan "ARVTreatmentRegimenSwitchedOrSubstitutedExample" </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-hiv-arv-treatment.html">ARV Treatment</a></p></div><p><b>status</b>: active</p><p><b>intent</b>: plan</p><p><b>subject</b>: <a href="#Patient_HIVPatientExample">See above (Patient/HIVPatientExample)</a></p><p><b>encounter</b>: <a href="#Encounter_TargetFacilityEncounterExample">See above (Encounter/TargetFacilityEncounterExample)</a></p><p><b>period</b>: 2022-12-01 --> 2022-12-01</p><blockquote><p><b>activity</b></p><h3>Details</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Extension</b></td><td><b>Kind</b></td><td><b>Code</b></td><td><b>Status</b></td><td><b>Scheduled[x]</b></td><td><b>Product[x]</b></td></tr><tr><td style="display: none">*</td><td>, , </td><td>MedicationRequest</td><td>ARV medication request <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://loinc.org/">LOINC</a>#45260-7 "HIV ART medication")</span></td><td>in-progress</td><td>2023-01-01 --> 2023-01-01</td><td>ARV Regimen <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://browser.ihtsdotools.org/">SNOMED CT</a>#387005008 "Abacavir")</span></td></tr></table></blockquote><p><b>note</b>: Prescribed Abacavir (ABC) (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM), Additional informatiion regarding the regimen switch (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17 PM)</p></div>
</text>
<status value="active"/>
<intent value="plan"/>
<subject>🔗
<reference value="Patient/HIVPatientExample"/>
</subject>
<encounter>🔗
<reference value="Encounter/TargetFacilityEncounterExample"/>
</encounter>
<period>
<start value="2022-12-01"/>
<end value="2022-12-01"/>
</period>
<activity>
<detail>
<extension
url="http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-line">
<valueCodeableConcept>
<coding>
<system value="http://snomed.info/sct"/>
<code value="708255002"/>
<display value="First line treatment"/>
</coding>
<text value="ART therapeutic line"/>
</valueCodeableConcept>
</extension>
<extension
url="http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-switched-or-substituted">
<valueCodeableConcept>
<coding>
<system
value="http://openhie.org/fhir/training-solution-1/CodeSystem/cs-art-regimen-change-type"/>
<code value="Switched"/>
<display value="ARV Regimen Switched"/>
</coding>
<text value="ARV regimen change"/>
</valueCodeableConcept>
</extension>
<extension
url="http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-care-next-visit">
<valueDateTime value="2023-02-01"/>
</extension>
<kind value="MedicationRequest"/>
<code>
<coding>
<system value="http://loinc.org"/>
<code value="45260-7"/>
<display value="HIV ART medication"/>
</coding>
<text value="ARV medication request"/>
</code>
<status value="in-progress"/>
<scheduledPeriod>
<start value="2023-01-01"/>
<end value="2023-01-01"/>
</scheduledPeriod>
<productCodeableConcept>
<coding>
<system value="http://snomed.info/sct"/>
<code value="387005008"/>
<display value="Abacavir"/>
</coding>
<text value="ARV Regimen"/>
</productCodeableConcept>
</detail>
</activity>
<note>
<authorReference>🔗
<reference value="Organization/HIVOrganizationExample"/>
</authorReference>
<time value="2015-02-07T13:28:17-05:00"/>
<text value="Prescribed Abacavir (ABC)"/>
</note>
<note>
<authorReference>🔗
<reference value="Organization/HIVOrganizationExample"/>
</authorReference>
<time value="2015-02-07T13:28:17-05:00"/>
<text value="Additional informatiion regarding the regimen switch"/>
</note>
</CarePlan>
</resource>
<request>
<method value="PUT"/>
<url value="CarePlan/ARVTreatmentRegimenSwitchedOrSubstitutedExample"/>
</request>
</entry>
</Bundle>