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 ttl | Download

    @prefix fhir: <http://hl7.org/fhir/> .
    @prefix owl: <http://www.w3.org/2002/07/owl#> .
    @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
    @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
    @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

    # - resource -------------------------------------------------------------------

     a fhir:PlanDefinition ;
      fhir:nodeRole fhir:treeRoot ;
      fhir:id [ fhir:v "hcs-plandefinition-example"] ; #
      fhir:meta [
        ( fhir:profile [
    fhir:v "http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-plandefinition"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-plandefinition>     ] )
      ] ; #
      fhir:language [ fhir:v "en"] ; #
      fhir:text [
    fhir:status [ fhir:v "extensions" ] ;
    fhir:div [ fhir:v "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n<div>\n    <table class=\"grid dict\">\n        \n        <tr>\n            <th scope=\"row\"><b>Id: </b></th>\n            <td style=\"padding-left: 4px;\">hcs-plandefinition-example</td>\n        </tr>\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Url: </b></th>\n            <td style=\"padding-left: 4px;\"><a href=\"PlanDefinition-hcs-plandefinition-example.html\">PlanDefinition National Health Care Surveys Example</a></td>\n        </tr>\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Version: </b></th>\n            <td style=\"padding-left: 4px;\">2.0.0</td>\n        </tr>\n        \n\n        \n        <tr>\n            <th scope=\"row\">\n                <b>\n                    \n                        \n                    \n                </b>\n            </th>\n            <td style=\"padding-left: 4px;\">\n                \n                <p style=\"margin-bottom: 5px;\">\n                    <span>urn:oid:2.16.840.1.113883.4.642.40.59.34.1</span>\n                </p>\n                \n            </td>\n        </tr>\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Title: </b></th>\n            <td style=\"padding-left: 4px;\">PlanDefinition National Health Care Surveys Example</td>\n        </tr>\n        \n\n        \n\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Experimental: </b></th>\n            <td style=\"padding-left: 4px;\">true</td>\n        </tr>\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Type: </b></th>\n            <td style=\"padding-left: 4px;\">\n                \n                    \n                        \n                        <p style=\"margin-bottom: 5px;\">\n                            <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>\n                        </p>\n                        \n                        \n                        <p style=\"margin-bottom: 5px;\">\n                            <b>code: </b> <span>workflow-definition</span>\n                        </p>\n                        \n                        \n                        <p style=\"margin-bottom: 5px;\">\n                            <b>display: </b> <span>Workflow Definition</span>\n                        </p>\n                        \n                    \n                \n                \n            </td>\n        </tr>\n        \n\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Date: </b></th>\n            <td style=\"padding-left: 4px;\">2025-07-31 12:32:29-0500</td>\n        </tr>\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Publisher: </b></th>\n            <td style=\"padding-left: 4px;\">HL7 International / Public Health</td>\n        </tr>\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Description: </b></th>\n            <td style=\"padding-left: 4px;\"><div><p>An example National Health Care Surveys PlanDefinition</p>\n</div></td>\n        </tr>\n        \n\n        \n\n        \n\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Jurisdiction: </b></th>\n            <td style=\"padding-left: 4px;\">US</td>\n        </tr>\n        \n\n        \n\n        \n\n        \n\n        \n\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Effective Period: </b></th>\n            <td style=\"padding-left: 4px;\">2025-12-01..</td>\n        </tr>\n        \n\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Libraries: </b></th>\n            <td style=\"padding-left: 4px;\">\n                <table class=\"grid-dict\">\n                    \n                    <tr>\n                        <td><code>http://example.org/fhir/Library/RuleFilters|1.0.0</code></td>\n                    </tr>\n                    \n                </table>\n            </td>\n        </tr>\n        \n\n        \n        <tr>\n            <th scope=\"row\"><b>Actions: </b></th>\n            <td style=\"padding-left: 4px;\">\n                <table class=\"grid-dict\">\n                    \n                    <tr>\n                        <td>\n                            \n                            Start the reporting workflow in response to an encounter-end event\n                            \n                            <br/>\n                            \n                            <b>When:</b>\n                            \n                            <i>Named Event:</i> encounter-end\n                            <br/>\n                            \n                            \n                            \n                            \n                            \n                            \n                        </td>\n                    </tr>\n                    \n                    <tr>\n                        <td>\n                            \n                            <b> :</b> \n                            \n                            <br/>\n                            \n                            \n                            \n                            <b>Then:</b>\n                            <table class=\"grid-dict\">\n                                \n                                <tr>\n                                    <td>\n                                        \n                                        <b> :</b>\n                                        \n                                        \n                                        <br/>\n                                        \n                                        \n                                        \n                                        \n                                        \n                                    </td>\n                                </tr>\n                                \n                                <tr>\n                                    <td>\n                                        \n                                        <b> :</b>\n                                        \n                                        \n                                        <br/>\n                                        \n                                        \n                                        \n                                        \n                                        \n                                    </td>\n                                </tr>\n                                \n                            </table>\n                            \n                        </td>\n                    </tr>\n                    \n                    <tr>\n                        <td>\n                            \n                            <b> :</b> \n                            \n                            <br/>\n                            \n                            \n                            \n                            \n                            \n                        </td>\n                    </tr>\n                    \n                    <tr>\n                        <td>\n                            \n                            <b> :</b> \n                            \n                            <br/>\n                            \n                            \n                            \n                            \n                            \n                        </td>\n                    </tr>\n                    \n                    <tr>\n                        <td>\n                            \n                            Route and send HCS Report\n                            \n                            <br/>\n                            \n                            \n                            \n                            \n                            \n                        </td>\n                    </tr>\n                    \n                </table>\n            </td>\n        </tr>\n        \n    </table>\n</div>\n</div>"^^rdf:XMLLiteral ]
      ] ; #
      fhir:extension ( [
    fhir:url [
    fhir:v "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension>     ] ;
    fhir:value [
    a fhir:Reference ;
    fhir:l fhir:Endpoint/endpoint-pha-example ;
    fhir:reference [ fhir:v "Endpoint/endpoint-pha-example" ]     ]
      ] [
    fhir:url [
    fhir:v "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension>     ] ;
    fhir:value [
    a fhir:Url ;
    fhir:v "http://example.org/jwks/123"^^xsd:anyURI ;
    fhir:l <http://example.org/jwks/123>     ]
      ] [
    fhir:url [
    fhir:v "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension>     ] ;
    fhir:value [
    a fhir:Code ;
    fhir:v "RSA384"     ]
      ] ) ; #
      fhir:url [
    fhir:v "https://build.fhir.org/ig/HL7/fhir-health-care-surveys-reporting-ig/PlanDefinition/hcs-plandefinition-example"^^xsd:anyURI ;
    fhir:l <https://build.fhir.org/ig/HL7/fhir-health-care-surveys-reporting-ig/PlanDefinition/hcs-plandefinition-example>
      ] ; #
      fhir:identifier ( [
    fhir:system [
    fhir:v "urn:ietf:rfc:3986"^^xsd:anyURI ;
    fhir:l <urn:ietf:rfc:3986>     ] ;
    fhir:value [ fhir:v "urn:oid:2.16.840.1.113883.4.642.40.59.34.1" ]
      ] ) ; #
      fhir:version [ fhir:v "2.0.0"] ; #
      fhir:name [ fhir:v "PlanDefinitionNationalHealthCareSurveysExample"] ; #
      fhir:title [ fhir:v "PlanDefinition National Health Care Surveys Example"] ; #
      fhir:type [
        ( fhir:coding [
    fhir:system [
    fhir:v "http://terminology.hl7.org/CodeSystem/plan-definition-type"^^xsd:anyURI ;
    fhir:l <http://terminology.hl7.org/CodeSystem/plan-definition-type>       ] ;
    fhir:code [ fhir:v "workflow-definition" ] ;
    fhir:display [ fhir:v "Workflow Definition" ]     ] )
      ] ; #
      fhir:status [ fhir:v "active"] ; #
      fhir:experimental [ fhir:v true] ; #
      fhir:date [ fhir:v "2025-07-31T12:32:29.858-05:00"^^xsd:dateTime] ; #
      fhir:publisher [ fhir:v "HL7 International / Public Health"] ; #
      fhir:contact ( [
    fhir:name [ fhir:v "HL7 International / Public Health" ] ;
        ( fhir:telecom [
    fhir:system [ fhir:v "url" ] ;
    fhir:value [ fhir:v "http://www.hl7.org/Special/committees/pher" ]     ] [
    fhir:system [ fhir:v "email" ] ;
    fhir:value [ fhir:v "ord@lists.HL7.org" ]     ] )
      ] ) ; #
      fhir:description [ fhir:v "An example National Health Care Surveys PlanDefinition"] ; #
      fhir:jurisdiction ( [
        ( fhir:coding [
    fhir:system [
    fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ;
    fhir:l <urn:iso:std:iso:3166>       ] ;
    fhir:code [ fhir:v "US" ]     ] )
      ] ) ; #
      fhir:effectivePeriod [
    fhir:start [ fhir:v "2025-12-01"^^xsd:date ]
      ] ; #
      fhir:library ( [
    fhir:v "http://example.org/fhir/Library/RuleFilters|1.0.0"^^xsd:anyURI ;
    fhir:l <http://example.org/fhir/Library/RuleFilters?version=1.0.0>
      ] ) ; #
      fhir:action ( [
    fhir:id [ fhir:v "start-workflow" ] ;
    fhir:description [ fhir:v "Start the workflow action." ] ;
    fhir:textEquivalent [ fhir:v "Start the reporting workflow in response to an encounter-end event" ] ;
        ( fhir:code [
          ( fhir:coding [
    fhir:system [
    fhir:v "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions>         ] ;
    fhir:code [ fhir:v "initiate-reporting-workflow" ]       ] )     ] ) ;
        ( fhir:trigger [
    fhir:type [ fhir:v "named-event" ] ;
    fhir:name [ fhir:v "encounter-end" ]     ] ) ;
        ( fhir:relatedAction [
    fhir:actionId [ fhir:v "check-reportability" ] ;
    fhir:relationship [ fhir:v "before-start" ]     ] )
      ] [
    fhir:id [ fhir:v "check-reportability" ] ;
        ( fhir:code [
          ( fhir:coding [
    fhir:system [
    fhir:v "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions>         ] ;
    fhir:code [ fhir:v "execute-reporting-workflow" ]       ] )     ] ) ;
        ( fhir:action [
    fhir:id [ fhir:v "is-ambulatory-encounter-reportable" ] ;
          ( fhir:code [
            ( fhir:coding [
    fhir:system [
    fhir:v "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions>           ] ;
    fhir:code [ fhir:v "evaluate-condition" ]         ] )       ] )     ] [
    fhir:id [ fhir:v "is-inpatient-encounter-reportable" ] ;
          ( fhir:code [
            ( fhir:coding [
    fhir:system [
    fhir:v "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions>           ] ;
    fhir:code [ fhir:v "evaluate-condition" ]         ] )       ] )     ] )
      ] [
    fhir:id [ fhir:v "create-hcs-report" ] ;
        ( fhir:code [
          ( fhir:coding [
    fhir:system [
    fhir:v "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions>         ] ;
    fhir:code [ fhir:v "create-report" ]       ] )     ] )
      ] [
    fhir:id [ fhir:v "validate-hcs-report" ]
      ] [
    fhir:id [ fhir:v "submit-hcs-report" ] ;
    fhir:textEquivalent [ fhir:v "Route and send HCS Report" ]
      ] ) . #