Health Care Surveys Reporting
2.0.0 - STU 2

Health Care Surveys Reporting, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-health-care-surveys-reporting-ig/ and changes regularly. See the Directory of published versions

## : National Health Care Surveys PlanDefinition

Page standards status: Informative

Raw xml | Download

    <PlanDefinition xmlns="http://hl7.org/fhir">
      <id value="hcs-plandefinition-example"/>
      <meta>
        <profile
                 value="http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-plandefinition"/>
      </meta>
      <language value="en"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml">
    <div>
        <table class="grid dict">

            <tr>
                <th scope="row"><b>Id: </b></th>
                <td style="padding-left: 4px;">hcs-plandefinition-example</td>
            </tr>

            <tr>
                <th scope="row"><b>Url: </b></th>
                <td style="padding-left: 4px;"><a href="PlanDefinition-hcs-plandefinition-example.html">PlanDefinition National Health Care Surveys Example</a></td>
            </tr>

            <tr>
                <th scope="row"><b>Version: </b></th>
                <td style="padding-left: 4px;">2.0.0</td>
            </tr>

            <tr>
                <th scope="row">
                    <b>

                    </b>
                </th>
                <td style="padding-left: 4px;">

                    <p style="margin-bottom: 5px;">
                        <span>urn:oid:2.16.840.1.113883.4.642.40.59.34.1</span>
                    </p>

                </td>
            </tr>

            <tr>
                <th scope="row"><b>Title: </b></th>
                <td style="padding-left: 4px;">PlanDefinition National Health Care Surveys Example</td>
            </tr>

            <tr>
                <th scope="row"><b>Experimental: </b></th>
                <td style="padding-left: 4px;">true</td>
            </tr>

            <tr>
                <th scope="row"><b>Type: </b></th>
                <td style="padding-left: 4px;">

                            <p style="margin-bottom: 5px;">
                                <b>system: </b> <span><a href="http://terminology.hl7.org/7.0.1/CodeSystem-plan-definition-type.html">http://terminology.hl7.org/CodeSystem/plan-definition-type</a></span>
                            </p>

                            <p style="margin-bottom: 5px;">
                                <b>code: </b> <span>workflow-definition</span>
                            </p>

                            <p style="margin-bottom: 5px;">
                                <b>display: </b> <span>Workflow Definition</span>
                            </p>

                </td>
            </tr>

            <tr>
                <th scope="row"><b>Date: </b></th>
                <td style="padding-left: 4px;">2025-07-31 12:32:29-0500</td>
            </tr>

            <tr>
                <th scope="row"><b>Publisher: </b></th>
                <td style="padding-left: 4px;">HL7 International / Public Health</td>
            </tr>

            <tr>
                <th scope="row"><b>Description: </b></th>
                <td style="padding-left: 4px;"><div><p>An example National Health Care Surveys PlanDefinition</p>
    </div></td>
            </tr>

            <tr>
                <th scope="row"><b>Jurisdiction: </b></th>
                <td style="padding-left: 4px;">US</td>
            </tr>

            <tr>
                <th scope="row"><b>Effective Period: </b></th>
                <td style="padding-left: 4px;">2025-12-01..</td>
            </tr>

            <tr>
                <th scope="row"><b>Libraries: </b></th>
                <td style="padding-left: 4px;">
                    <table class="grid-dict">

                        <tr>
                            <td><code>http://example.org/fhir/Library/RuleFilters|1.0.0</code></td>
                        </tr>

                    </table>
                </td>
            </tr>

            <tr>
                <th scope="row"><b>Actions: </b></th>
                <td style="padding-left: 4px;">
                    <table class="grid-dict">

                        <tr>
                            <td>

                                Start the reporting workflow in response to an encounter-end event

                                <br/>

                                <b>When:</b>

                                <i>Named Event:</i> encounter-end
                                <br/>

                            </td>
                        </tr>

                        <tr>
                            <td>

                                <b> :</b>

                                <br/>

                                <b>Then:</b>
                                <table class="grid-dict">

                                    <tr>
                                        <td>

                                            <b> :</b>

                                            <br/>

                                        </td>
                                    </tr>

                                    <tr>
                                        <td>

                                            <b> :</b>

                                            <br/>

                                        </td>
                                    </tr>

                                </table>

                            </td>
                        </tr>

                        <tr>
                            <td>

                                <b> :</b>

                                <br/>

                            </td>
                        </tr>

                        <tr>
                            <td>

                                <b> :</b>

                                <br/>

                            </td>
                        </tr>

                        <tr>
                            <td>

                                Route and send HCS Report

                                <br/>

                            </td>
                        </tr>

                    </table>
                </td>
            </tr>

        </table>
    </div>
    </div>
      </text>
      <extension
                 url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension">
        <valueReference>🔗
          <reference value="Endpoint/endpoint-pha-example"/>
        </valueReference>
      </extension>
      <extension
                 url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension">
        <valueUrl value="http://example.org/jwks/123"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension">
        <valueCode value="RSA384"/>
      </extension>
      <url
           value="https://build.fhir.org/ig/HL7/fhir-health-care-surveys-reporting-ig/PlanDefinition/hcs-plandefinition-example"/>
      <identifier>
        <system value="urn:ietf:rfc:3986"/>
        <value value="urn:oid:2.16.840.1.113883.4.642.40.59.34.1"/>
      </identifier>
      <version value="2.0.0"/>
      <name value="PlanDefinitionNationalHealthCareSurveysExample"/>
      <title value="PlanDefinition National Health Care Surveys Example"/>
      <type>
        <coding>
          <system
                  value="http://terminology.hl7.org/CodeSystem/plan-definition-type"/>
          <code value="workflow-definition"/>
          <display value="Workflow Definition"/>
        </coding>
      </type>
      <status value="active"/>
      <experimental value="true"/>
      <date value="2025-07-31T12:32:29.858-05:00"/>
      <publisher value="HL7 International / Public Health"/>
      <contact>
        <name value="HL7 International / Public Health"/>
        <telecom>
          <system value="url"/>
          <value value="http://www.hl7.org/Special/committees/pher"/>
        </telecom>
        <telecom>
          <system value="email"/>
          <value value="ord@lists.HL7.org"/>
        </telecom>
      </contact>
      <description
                   value="An example National Health Care Surveys PlanDefinition"/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="US"/>
        </coding>
      </jurisdiction>
      <effectivePeriod>
        <start value="2025-12-01"/>
      </effectivePeriod>
      <library value="http://example.org/fhir/Library/RuleFilters|1.0.0"/>
      <action id="start-workflow">
        <description value="Start the workflow action."/>
        <textEquivalent
                        value="Start the reporting workflow in response to an encounter-end event"/>
        <code>
          <coding>
            <system
                    value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
            <code value="initiate-reporting-workflow"/>
          </coding>
        </code>
        <trigger>
          <type value="named-event"/>
          <name value="encounter-end"/>
        </trigger>
        <relatedAction>
          <actionId value="check-reportability"/>
          <relationship value="before-start"/>
        </relatedAction>
      </action>
      <action id="check-reportability">
        <code>
          <coding>
            <system
                    value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
            <code value="execute-reporting-workflow"/>
          </coding>
        </code>
        <action id="is-ambulatory-encounter-reportable">
          <code>
            <coding>
              <system
                      value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
              <code value="evaluate-condition"/>
            </coding>
          </code>
        </action>
        <action id="is-inpatient-encounter-reportable">
          <code>
            <coding>
              <system
                      value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
              <code value="evaluate-condition"/>
            </coding>
          </code>
        </action>
      </action>
      <action id="create-hcs-report">
        <code>
          <coding>
            <system
                    value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
            <code value="create-report"/>
          </coding>
        </code>
      </action>
      <action id="validate-hcs-report"/>
      <action id="submit-hcs-report">
        <textEquivalent value="Route and send HCS Report"/>
      </action>
    </PlanDefinition>