Open Health Hub FHIR Implementation Guide
0.1.0 - v0.1.0

Open Health Hub FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : OHH Retrieve CarePlan - XML Representation

Raw xml | Download

    <CarePlan xmlns="http://hl7.org/fhir">
      <id value="4"/>
      <meta>
        <lastUpdated value="2025-09-15T13:45:00+00:00"/>
        <profile
                 value="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-retrieve-care-plan"/>
      </meta>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CarePlan 4</b></p><a name="4"> </a><a name="hc4"> </a><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">Last updated: 2025-09-15 13:45:00+0000</p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-ohh-retrieve-care-plan.html">OHH Retrieve Care Plan Profile</a></p></div><p><b>Custom Invite Image</b>: image/png: base64+image</p><p><b>Custom Invite Text</b>: custom invite text</p><p><b>Program Link</b>: https://invitation.openhealthhub.com/pin/a1b2c3d4/user/fc3303e6-0c62-4c89-942e-150c4d89da4a</p><p><b>Program PIN</b>: a1b2c3d4</p><p><b>Form Filler Program Timeline</b>: https://formfiller.openhealthhub.com/user/fc3303e6-0c62-4c89-942e-150c4d89da4a/program/5a9ecc36-ae46-484b-9eb4-8812d242ffaf-4/module?signature=7ZaLnHY3eYCJaChCskRX2YHQpv%2BQLC4aSeYuYyEumo8%3D</p><p><b>instantiatesCanonical</b>: <code>https://api.openhealthhub.com/OpenHealthhub/fhir/4/PlanDefinition/a7b4be95-7fd1-480c-9f62-0100adfde3db|2</code></p><p><b>status</b>: Active</p><p><b>intent</b>: Plan</p><p><b>title</b>: Test Program</p><p><b>subject</b>: <a href="#hc4/patient">John Doe (no stated gender), DoB: 1982-01-01 ( Patient external identifier)</a></p><p><b>period</b>: 2024-10-23 00:00:00+0000 --&gt; 2025-09-13 12:30:00+0000</p><p><b>created</b>: 2025-09-13 12:30:00+0000</p><p><b>author</b>: <a href="#hc4/2d61c3c5-c0ce-4cee-ad0a-9e83289a5b61">Practitioner S. Caregiver</a></p><p><b>careTeam</b>: </p><ul><li><a href="CareTeam-4.html">CareTeam: category = Care Providers</a></li><li><a href="CareTeam-4-caregivers.html">CareTeam: category = Caregivers</a></li></ul><blockquote><p><b>activity</b></p><blockquote><p><b>detail</b></p><blockquote><p><b>id</b></p>589aa301-e69c-4bfa-9a44-7fd5d7b0c5d9</blockquote><p><b>Form Filler Program Task URL</b>: https://formfiller.openhealthhub.com/user/fc3303e6-0c62-4c89-942e-150c4d89da4a/program/5a9ecc36-ae46-484b-9eb4-8812d242ffaf-4/module/db117ee7-8059-450e-b425-f16e474eccd3?signature=7ZaLnHY3eYCJaChCskRX2YHQpv%2BQLC4aSeYuYyEumo8%3D</p><p><b>Task UUID</b>: db117ee7-8059-450e-b425-f16e474eccd3</p><p><b>instantiatesCanonical</b>: <a href="Questionnaire-57953eb8-2455-4f96-a9dd-c86f31f28c9c.html">OHH Questionnaire for Caregiver</a></p><p><b>code</b>: <span title="Codes:{https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/questionnaire-types questionnaire}">Questionnaire</span></p><p><b>status</b>: In Progress</p><p><b>scheduled</b>: 2024-09-12 14:16:00+0000 --&gt; 2025-10-12 10:15:00+0000</p><p><b>performer</b>: <a href="#hc4/patient">patient</a></p><p><b>description</b>: Task 1</p></blockquote></blockquote><blockquote><p><b>activity</b></p><p><b>outcomeReference</b>: <a href="QuestionnaireResponse-f443939b-439e-4fa9-a243-de27d1544b69.html">Response to Questionnaire '-&gt;Example Open Health Hub Questionnaire' about '-&gt;John Doe (no stated gender), DoB: 1982-01-01 ( Patient external identifier)'</a></p><blockquote><p><b>detail</b></p><blockquote><p><b>id</b></p>5dab8f24-ab30-41b9-8c24-7b48befbfca3</blockquote><p><b>Form Filler Program Task URL</b>: https://formfiller.openhealthhub.com/user/7f719d80-d843-4230-bca9-804b7cf95bad/program/5a9ecc36-ae46-484b-9eb4-8812d242ffaf-4/module/a54b5c56-98d9-4731-bbe1-b4e37baf51ec?signature=2g%2BFLS7A6t3Q8Q5TJqOo6GxSNfP0KiXjcXdYlonrjN0%3D</p><p><b>Task UUID</b>: a54b5c56-98d9-4731-bbe1-b4e37baf51ec</p><p><b>instantiatesCanonical</b>: <a href="Questionnaire-57953eb8-2455-4f96-a9dd-c86f31f28c9c.html">OHH Questionnaire for Caregiver</a></p><p><b>code</b>: <span title="Codes:{https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/questionnaire-types questionnaire}">Questionnaire</span></p><p><b>status</b>: Completed</p><p><b>scheduled</b>: 2025-03-24 11:55:00+0000 --&gt; 2025-06-23 05:23:00+0000</p><p><b>performer</b>: <a href="Practitioner-7f719d80-d843-4230-bca9-804b7cf95bad.html">psychologist (James Careson)</a></p><p><b>description</b>: Caregiver Task</p></blockquote></blockquote><blockquote><p><b>activity</b></p><blockquote><p><b>detail</b></p><blockquote><p><b>id</b></p>ae604b09-7f40-48b9-8a62-fd4bd2b3df03</blockquote><p><b>Related Questionnaire</b>: <a href="Questionnaire-cf1aa9a1-051d-4c0d-bb63-71a95276a71c.html">Example Open Health Hub Questionnaire</a></p><p><b>code</b>: <span title="Codes:{https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/action-type PUSH_NOTIFICATION}">send notification to user</span></p><p><b>status</b>: Completed</p><p><b>scheduled</b>: 2025-03-24 11:55:00+0000 --&gt; 2025-06-23 05:23:00+0000</p><p><b>performer</b>: <a href="#hc4/patient">patient</a></p></blockquote></blockquote><hr/><blockquote><p class="res-header-id"><b>Generated Narrative: Patient #patient</b></p><a name="4/patient"> </a><a name="hc4/patient"> </a><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"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-ohh-patient.html">Ohh Patient Profile</a></p></div><p style="border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;">John Doe (no stated gender), DoB: 1982-01-01 ( Patient external identifier)</p><hr/><table class="grid"><tr><td style="background-color: #f3f5da" title="Other Ids (see the one above)">Other Ids:</td><td colspan="3"><ul><li><a href="http://terminology.hl7.org/7.0.0/NamingSystem-uri.html" title="As defined by RFC 3986 (http://www.ietf.org/rfc/rfc3986.txt)(with many schemes defined in many RFCs). For OIDs and UUIDs, use the URN form (urn:oid:(note: lowercase) and urn:uuid:). See http://www.ietf.org/rfc/rfc3001.txt and http://www.ietf.org/rfc/rfc4122.txt

    This oid is used as an identifier II.root to indicate the the extension is an absolute URI (technically, an IRI). Typically, this is used for OIDs and GUIDs. Note that when this OID is used with OIDs and GUIDs, the II.extension should start with urn:oid or urn:uuid:

    Note that this OID is created to aid with interconversion between CDA and FHIR - FHIR uses urn:ietf:rfc:3986 as equivalent to this OID. URIs as identifiers appear more commonly in FHIR.

    This OID may also be used in CD.codeSystem.">Uniform Resource Identifier (URI)</a>/urn:uuid:4c5c53a7-8c58-4aa5-b069-889643f3685a</li><li><code>urn:uuid:33206393-ef4c-4456-a926-93299c4dc17e</code>/12345 (use: official, )</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="Ways to contact the Patient">Contact Detail</td><td colspan="3"><a href="mailto:john.doe@example.com">john.doe@example.com</a></td></tr><tr><td style="background-color: #f3f5da" title="Extension for patient signature"><a href="StructureDefinition-patient-signature.html">Patient Signature Extension</a></td><td colspan="3">encrypted-signature-value</td></tr></table></blockquote><hr/><blockquote><p class="res-header-id"><b>Generated Narrative: Practitioner #2d61c3c5-c0ce-4cee-ad0a-9e83289a5b61</b></p><a name="4/2d61c3c5-c0ce-4cee-ad0a-9e83289a5b61"> </a><a name="hc4/2d61c3c5-c0ce-4cee-ad0a-9e83289a5b61"> </a><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"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-practitioner-with-key.html">Practitioner With Key Profile</a></p></div><p><b>Caregiver Signature</b>: luKmgJnoLzTr5ORUyPkrqfLofQV0c5cr5LXmOseMdPw</p><p><b>identifier</b>: <a href="http://terminology.hl7.org/7.0.0/NamingSystem-uri.html" title="As defined by RFC 3986 (http://www.ietf.org/rfc/rfc3986.txt)(with many schemes defined in many RFCs). For OIDs and UUIDs, use the URN form (urn:oid:(note: lowercase) and urn:uuid:). See http://www.ietf.org/rfc/rfc3001.txt and http://www.ietf.org/rfc/rfc4122.txt

    This oid is used as an identifier II.root to indicate the the extension is an absolute URI (technically, an IRI). Typically, this is used for OIDs and GUIDs. Note that when this OID is used with OIDs and GUIDs, the II.extension should start with urn:oid or urn:uuid:

    Note that this OID is created to aid with interconversion between CDA and FHIR - FHIR uses urn:ietf:rfc:3986 as equivalent to this OID. URIs as identifiers appear more commonly in FHIR.

    This OID may also be used in CD.codeSystem.">Uniform Resource Identifier (URI)</a>/urn:uuid:8b0d9ef8-c6e7-4812-9f9f-ec08e0504214 (use: secondary, )</p><p><b>name</b>: S. Caregiver</p><p><b>telecom</b>: <a href="mailto:caregiver@ohh.com">caregiver@ohh.com</a></p></blockquote></div>
      </text>
      <contained>
        <Patient>
          <id value="patient"/>
          <meta>
            <profile
                     value="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-patient"/>
          </meta>
          <extension
                     url="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature">
            <valueString value="encrypted-signature-value"/>
          </extension>
          <identifier>
            <system value="urn:ietf:rfc:3986"/>
            <value value="urn:uuid:4c5c53a7-8c58-4aa5-b069-889643f3685a"/>
          </identifier>
          <identifier>
            <use value="official"/>
            <system value="urn:uuid:33206393-ef4c-4456-a926-93299c4dc17e"/>
            <value value="12345"/>
          </identifier>
          <identifier>
            <type>
              <coding>
                <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
                <code value="PT"/>
              </coding>
            </type>
            <value value="54964"/>
          </identifier>
          <name>
            <text value="John Doe"/>
          </name>
          <telecom>
            <system value="email"/>
            <value value="john.doe@example.com"/>
          </telecom>
          <birthDate value="1982-01-01"/>
        </Patient>
      </contained>
      <contained>
        <Practitioner>
          <id value="2d61c3c5-c0ce-4cee-ad0a-9e83289a5b61"/>
          <meta>
            <profile
                     value="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/practitioner-with-key"/>
          </meta>
          <extension
                     url="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature">
            <valueString value="luKmgJnoLzTr5ORUyPkrqfLofQV0c5cr5LXmOseMdPw"/>
          </extension>
          <identifier>
            <use value="secondary"/>
            <system value="urn:ietf:rfc:3986"/>
            <value value="urn:uuid:8b0d9ef8-c6e7-4812-9f9f-ec08e0504214"/>
          </identifier>
          <name>
            <text value="S. Caregiver"/>
          </name>
          <telecom>
            <system value="email"/>
            <value value="caregiver@ohh.com"/>
          </telecom>
        </Practitioner>
      </contained>
      <extension
                 url="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/custom-invite-image">
        <valueAttachment>
          <contentType value="image/png"/>
          <data value="base64+image"/>
        </valueAttachment>
      </extension>
      <extension
                 url="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/custom-invite-text">
        <valueString value="custom invite text"/>
      </extension>
      <extension
                 url="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/program-link">
        <valueString
                     value="https://invitation.openhealthhub.com/pin/a1b2c3d4/user/fc3303e6-0c62-4c89-942e-150c4d89da4a"/>
      </extension>
      <extension
                 url="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/program-pin">
        <valueString value="a1b2c3d4"/>
      </extension>
      <extension
                 url="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/form-filler-program-timeline">
        <valueString
                     value="https://formfiller.openhealthhub.com/user/fc3303e6-0c62-4c89-942e-150c4d89da4a/program/5a9ecc36-ae46-484b-9eb4-8812d242ffaf-4/module?signature=7ZaLnHY3eYCJaChCskRX2YHQpv%2BQLC4aSeYuYyEumo8%3D"/>
      </extension>
      <instantiatesCanonical
                             value="https://api.openhealthhub.com/OpenHealthhub/fhir/4/PlanDefinition/a7b4be95-7fd1-480c-9f62-0100adfde3db|2"/>
      <status value="active"/>
      <intent value="plan"/>
      <title value="Test Program"/>
      <subject>
        <reference value="#patient"/>
      </subject>
      <period>
        <start value="2024-10-23T00:00:00+00:00"/>
        <end value="2025-09-13T12:30:00+00:00"/>
      </period>
      <created value="2025-09-13T12:30:00+00:00"/>
      <author>
        <reference value="#2d61c3c5-c0ce-4cee-ad0a-9e83289a5b61"/>
      </author>
      <careTeam>🔗
        <reference value="CareTeam/4"/>
      </careTeam>
      <careTeam>🔗
        <reference value="CareTeam/4-caregivers"/>
      </careTeam>
      <activity>
        <detail id="589aa301-e69c-4bfa-9a44-7fd5d7b0c5d9">
          <extension
                     url="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/form-filler-program-task">
            <valueString
                         value="https://formfiller.openhealthhub.com/user/fc3303e6-0c62-4c89-942e-150c4d89da4a/program/5a9ecc36-ae46-484b-9eb4-8812d242ffaf-4/module/db117ee7-8059-450e-b425-f16e474eccd3?signature=7ZaLnHY3eYCJaChCskRX2YHQpv%2BQLC4aSeYuYyEumo8%3D"/>
          </extension>
          <extension
                     url="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/task-uuid">
            <valueString value="db117ee7-8059-450e-b425-f16e474eccd3"/>
          </extension>
          <instantiatesCanonical
                                 value="https://api.openhealthhub.com/OpenHealthhub/fhir/4/Questionnaire/57953eb8-2455-4f96-a9dd-c86f31f28c9c"/>
          <code>
            <coding>
              <system
                      value="https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/questionnaire-types"/>
              <code value="questionnaire"/>
            </coding>
          </code>
          <status value="in-progress"/>
          <scheduledPeriod>
            <start value="2024-09-12T14:16:00+00:00"/>
            <end value="2025-10-12T10:15:00+00:00"/>
          </scheduledPeriod>
          <performer>
            <reference value="#patient"/>
            <display value="patient"/>
          </performer>
          <description value="Task 1"/>
        </detail>
      </activity>
      <activity>
        <outcomeReference>🔗
          <reference
                     value="QuestionnaireResponse/f443939b-439e-4fa9-a243-de27d1544b69"/>
        </outcomeReference>
        <detail id="5dab8f24-ab30-41b9-8c24-7b48befbfca3">
          <extension
                     url="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/form-filler-program-task">
            <valueString
                         value="https://formfiller.openhealthhub.com/user/7f719d80-d843-4230-bca9-804b7cf95bad/program/5a9ecc36-ae46-484b-9eb4-8812d242ffaf-4/module/a54b5c56-98d9-4731-bbe1-b4e37baf51ec?signature=2g%2BFLS7A6t3Q8Q5TJqOo6GxSNfP0KiXjcXdYlonrjN0%3D"/>
          </extension>
          <extension
                     url="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/task-uuid">
            <valueString value="a54b5c56-98d9-4731-bbe1-b4e37baf51ec"/>
          </extension>
          <instantiatesCanonical
                                 value="https://api.openhealthhub.com/OpenHealthhub/fhir/4/Questionnaire/57953eb8-2455-4f96-a9dd-c86f31f28c9c"/>
          <code>
            <coding>
              <system
                      value="https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/questionnaire-types"/>
              <code value="questionnaire"/>
            </coding>
          </code>
          <status value="completed"/>
          <scheduledPeriod>
            <start value="2025-03-24T11:55:00+00:00"/>
            <end value="2025-06-23T05:23:00+00:00"/>
          </scheduledPeriod>
          <performer>🔗
            <reference value="Practitioner/7f719d80-d843-4230-bca9-804b7cf95bad"/>
            <display value="psychologist (James Careson)"/>
          </performer>
          <description value="Caregiver Task"/>
        </detail>
      </activity>
      <activity>
        <detail id="ae604b09-7f40-48b9-8a62-fd4bd2b3df03">
          <extension
                     url="https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/related-questionnaire">
            <valueReference>🔗
              <reference
                         value="Questionnaire/cf1aa9a1-051d-4c0d-bb63-71a95276a71c"/>
            </valueReference>
          </extension>
          <code>
            <coding>
              <system
                      value="https://api.openhealthhub.com/OpenHealthhub/fhir/4/CodeSystem/action-type"/>
              <code value="PUSH_NOTIFICATION"/>
            </coding>
          </code>
          <status value="completed"/>
          <scheduledPeriod>
            <start value="2025-03-24T11:55:00+00:00"/>
            <end value="2025-06-23T05:23:00+00:00"/>
          </scheduledPeriod>
          <performer>
            <reference value="#patient"/>
            <display value="patient"/>
          </performer>
        </detail>
      </activity>
    </CarePlan>