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
{
"resourceType" : "Bundle",
"id" : "EMR",
"type" : "transaction",
"entry" : [
{
"fullUrl" : "http://hapi-fhir:8080/fhir/Patient/HIVPatientExample",
"resource" : {
"resourceType" : "Patient",
"id" : "HIVPatientExample",
"meta" : {
"profile" : [
🔗 "http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-patient"
]
},
"text" : {
"status" : "extensions",
"div" : "<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:\u00a0ORG1-0765712, id:\u00a0NID1234567</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>"
},
"extension" : [
{
"url" : "http://openhie.org/fhir/training-solution-1/StructureDefinition/key-population-status",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "417284009",
"display" : "Current drug user"
}
],
"text" : "HIV key population"
}
}
],
"identifier" : [
{
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
"code" : "MR",
"display" : "Medical record number"
}
],
"text" : "Patient folder number"
},
"system" : "http://openhie.org/fhir/training-solution-1/identifier/mr",
"value" : "ORG1-0765712"
},
{
"system" : "http://openhie.org/fhir/training-solution-1/identifier/nid",
"value" : "NID1234567"
}
],
"name" : [
{
"use" : "official",
"family" : "Smith",
"given" : [
"Jane",
"Maria"
]
}
],
"telecom" : [
{
"system" : "phone",
"value" : "+27821234567"
},
{
"system" : "email",
"value" : "someone@example.com"
}
],
"gender" : "female",
"birthDate" : "1990-12-12",
"address" : [
{
"line" : [
"99",
"Walmer Blvd",
"Sunnydale"
],
"city" : "Cape Town",
"district" : "City of Cape Town",
"state" : "Western Province",
"country" : "South Africa"
}
],
"maritalStatus" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code" : "M"
}
]
},
"contact" : [
{
"relationship" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0131",
"code" : "N"
}
]
}
],
"name" : {
"family" : "Doe",
"given" : [
"John"
]
},
"telecom" : [
{
"system" : "phone",
"value" : "+27829999999"
}
]
}
],
"managingOrganization" : {
🔗 "reference" : "Organization/HIVOrganizationExample"
}
},
"request" : {
"method" : "PUT",
"url" : "Patient/HIVPatientExample"
}
},
{
"fullUrl" : "http://hapi-fhir:8080/fhir/Encounter/TargetFacilityEncounterExample",
"resource" : {
"resourceType" : "Encounter",
"id" : "TargetFacilityEncounterExample",
"meta" : {
"profile" : [
🔗 "http://openhie.org/fhir/training-solution-1/StructureDefinition/target-facility-encounter"
]
},
"text" : {
"status" : "generated",
"div" : "<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>"
},
"status" : "finished",
"class" : {
"system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code" : "AMB"
},
"subject" : {
🔗 "reference" : "Patient/HIVPatientExample"
},
"episodeOfCare" : [
{
🔗 "reference" : "EpisodeOfCare/HIVEpisodeOfCareExample"
}
],
"period" : {
"start" : "2022-12-01",
"end" : "2023-01-20"
},
"partOf" : {
🔗 "reference" : "Encounter/TransferringFacilityEncounterExample"
}
},
"request" : {
"method" : "PUT",
"url" : "Encounter/TargetFacilityEncounterExample"
}
},
{
"fullUrl" : "http://hapi-fhir:8080/fhir/Encounter/TransferringFacilityEncounterExample",
"resource" : {
"resourceType" : "Encounter",
"id" : "TransferringFacilityEncounterExample",
"meta" : {
"profile" : [
🔗 "http://openhie.org/fhir/training-solution-1/StructureDefinition/transferring-facility-encounter"
]
},
"text" : {
"status" : "generated",
"div" : "<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>"
},
"status" : "finished",
"class" : {
"system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code" : "AMB"
},
"serviceProvider" : {
🔗 "reference" : "Organization/HIVOrganizationExample"
}
},
"request" : {
"method" : "PUT",
"url" : "Encounter/TransferringFacilityEncounterExample"
}
},
{
"fullUrl" : "http://hapi-fhir:8080/fhir/Condition/HIVDiagnosisExample",
"resource" : {
"resourceType" : "Condition",
"id" : "HIVDiagnosisExample",
"meta" : {
"profile" : [
🔗 "http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-diagnosis"
]
},
"text" : {
"status" : "generated",
"div" : "<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:\u00a0abc123</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\u202fPM)</p></div>"
},
"identifier" : [
{
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
"code" : "PI",
"display" : "Patient internal identifier"
}
],
"text" : "HIV positive testing identifier"
},
"system" : "http://openhie.org/fhir/training-solution-1/identifier/hiv-diagnosis",
"value" : "abc123"
}
],
"clinicalStatus" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code" : "active"
}
]
},
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "86406008",
"display" : "Human immunodeficiency virus infection"
}
],
"text" : "Diagnosis"
},
"subject" : {
🔗 "reference" : "Patient/HIVPatientExample"
},
"encounter" : {
🔗 "reference" : "Encounter/TargetFacilityEncounterExample"
},
"recordedDate" : "2021-05-18",
"note" : [
{
"authorReference" : {
🔗 "reference" : "Organization/HIVOrganizationExample"
},
"time" : "2015-02-07T13:28:17-05:00",
"text" : "Additional information regarding the HIV diagnosis"
}
]
},
"request" : {
"method" : "PUT",
"url" : "Condition/HIVDiagnosisExample"
}
},
{
"fullUrl" : "http://hapi-fhir:8080/fhir/Observation/DateHIVTestDoneExample",
"resource" : {
"resourceType" : "Observation",
"id" : "DateHIVTestDoneExample",
"meta" : {
"profile" : [
🔗 "http://openhie.org/fhir/training-solution-1/StructureDefinition/date-hiv-test-done"
]
},
"text" : {
"status" : "generated",
"div" : "<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\u202fPM)</p></div>"
},
"status" : "final",
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "315124004",
"display" : "Human immunodeficiency virus viral load"
}
],
"text" : "Viral Load Examination"
},
"subject" : {
🔗 "reference" : "Patient/HIVPatientExample"
},
"encounter" : {
🔗 "reference" : "Encounter/TargetFacilityEncounterExample"
},
"effectiveDateTime" : "2022-12-10",
"performer" : [
{
🔗 "reference" : "Organization/HIVOrganizationExample"
}
],
"note" : [
{
"authorReference" : {
🔗 "reference" : "Organization/HIVOrganizationExample"
},
"time" : "2015-02-07T13:28:17-05:00",
"text" : "Additional information regarding the HIV test"
}
]
},
"request" : {
"method" : "PUT",
"url" : "Observation/DateHIVTestDoneExample"
}
},
{
"fullUrl" : "http://hapi-fhir:8080/fhir/EpisodeOfCare/HIVEpisodeOfCareExample",
"resource" : {
"resourceType" : "EpisodeOfCare",
"id" : "HIVEpisodeOfCareExample",
"meta" : {
"profile" : [
🔗 "http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-episode-of-care"
]
},
"text" : {
"status" : "generated",
"div" : "<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:\u00a0abc123</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>"
},
"identifier" : [
{
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
"code" : "PI",
"display" : "Patient internal identifier"
}
],
"text" : "Enrollment identifier"
},
"system" : "http://openhie.org/fhir/training-solution-1/identifier/enrollment-unique-id",
"value" : "abc123"
}
],
"status" : "active",
"diagnosis" : [
{
"condition" : {
🔗 "reference" : "Condition/HIVDiagnosisExample"
}
}
],
"patient" : {
🔗 "reference" : "Patient/HIVPatientExample"
},
"managingOrganization" : {
🔗 "reference" : "Organization/HIVOrganizationExample"
},
"period" : {
"start" : "2021-05-18",
"end" : "2021-05-18"
}
},
"request" : {
"method" : "PUT",
"url" : "EpisodeOfCare/HIVEpisodeOfCareExample"
}
},
{
"fullUrl" : "http://hapi-fhir:8080/fhir/CarePlan/ARVTreatmentRegimenSwitchedOrSubstitutedExample",
"resource" : {
"resourceType" : "CarePlan",
"id" : "ARVTreatmentRegimenSwitchedOrSubstitutedExample",
"meta" : {
"profile" : [
🔗 "http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-arv-treatment"
]
},
"text" : {
"status" : "generated",
"div" : "<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\u202fPM), Additional informatiion regarding the regimen switch (By Organization/HIVOrganizationExample @Feb 7, 2015, 6:28:17\u202fPM)</p></div>"
},
"status" : "active",
"intent" : "plan",
"subject" : {
🔗 "reference" : "Patient/HIVPatientExample"
},
"encounter" : {
🔗 "reference" : "Encounter/TargetFacilityEncounterExample"
},
"period" : {
"start" : "2022-12-01",
"end" : "2022-12-01"
},
"activity" : [
{
"detail" : {
"extension" : [
{
"url" : "http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-line",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "708255002",
"display" : "First line treatment"
}
],
"text" : "ART therapeutic line"
}
},
{
"url" : "http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-switched-or-substituted",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://openhie.org/fhir/training-solution-1/CodeSystem/cs-art-regimen-change-type",
"code" : "Switched",
"display" : "ARV Regimen Switched"
}
],
"text" : "ARV regimen change"
}
},
{
"url" : "http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-care-next-visit",
"valueDateTime" : "2023-02-01"
}
],
"kind" : "MedicationRequest",
"code" : {
"coding" : [
{
"system" : "http://loinc.org",
"code" : "45260-7",
"display" : "HIV ART medication"
}
],
"text" : "ARV medication request"
},
"status" : "in-progress",
"scheduledPeriod" : {
"start" : "2023-01-01",
"end" : "2023-01-01"
},
"productCodeableConcept" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "387005008",
"display" : "Abacavir"
}
],
"text" : "ARV Regimen"
}
}
}
],
"note" : [
{
"authorReference" : {
🔗 "reference" : "Organization/HIVOrganizationExample"
},
"time" : "2015-02-07T13:28:17-05:00",
"text" : "Prescribed Abacavir (ABC)"
},
{
"authorReference" : {
🔗 "reference" : "Organization/HIVOrganizationExample"
},
"time" : "2015-02-07T13:28:17-05:00",
"text" : "Additional informatiion regarding the regimen switch"
}
]
},
"request" : {
"method" : "PUT",
"url" : "CarePlan/ARVTreatmentRegimenSwitchedOrSubstitutedExample"
}
}
]
}