Health Care Surveys Reporting
2.0.0 - STU 2
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
| Page standards status: Informative |
{
"resourceType" : "PlanDefinition",
"id" : "hcs-plandefinition-example",
"meta" : {
"profile" : [
🔗 "http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-plandefinition|2.0.0"
]
},
"text" : {
"status" : "extensions",
"div" : "<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.0/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>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension",
"valueReference" : {
🔗 "reference" : "Endpoint/endpoint-pha-example"
}
},
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension",
"valueUrl" : "http://example.org/jwks/123"
},
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension",
"valueCode" : "RSA384"
}
],
"url" : "https://build.fhir.org/ig/HL7/fhir-health-care-surveys-reporting-ig/PlanDefinition/hcs-plandefinition-example",
"identifier" : [
{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.40.59.34.1"
}
],
"version" : "2.0.0",
"name" : "PlanDefinitionNationalHealthCareSurveysExample",
"title" : "PlanDefinition National Health Care Surveys Example",
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
"code" : "workflow-definition",
"display" : "Workflow Definition"
}
]
},
"status" : "active",
"experimental" : true,
"date" : "2025-07-31T12:32:29.858-05:00",
"publisher" : "HL7 International / Public Health",
"contact" : [
{
"name" : "HL7 International / Public Health",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pher"
},
{
"system" : "email",
"value" : "ord@lists.HL7.org"
}
]
}
],
"description" : "An example National Health Care Surveys PlanDefinition",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"effectivePeriod" : {
"start" : "2025-12-01"
},
"library" : [
"http://example.org/fhir/Library/RuleFilters|1.0.0"
],
"action" : [
{
"id" : "start-workflow",
"description" : "Start the workflow action.",
"textEquivalent" : "Start the reporting workflow in response to an encounter-end event",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "initiate-reporting-workflow"
}
]
}
],
"trigger" : [
{
"type" : "named-event",
"name" : "encounter-end"
}
],
"relatedAction" : [
{
"actionId" : "check-reportability",
"relationship" : "before-start"
}
]
},
{
"id" : "check-reportability",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "execute-reporting-workflow"
}
]
}
],
"action" : [
{
"id" : "is-ambulatory-encounter-reportable",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "evaluate-condition"
}
]
}
]
},
{
"id" : "is-inpatient-encounter-reportable",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "evaluate-condition"
}
]
}
]
}
]
},
{
"id" : "create-hcs-report",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "create-report"
}
]
}
]
},
{
"id" : "validate-hcs-report"
},
{
"id" : "submit-hcs-report",
"textEquivalent" : "Route and send HCS Report"
}
]
}
IG © 2025+ HL7 International / Public Health. Package hl7.fhir.us.health-care-surveys-reporting#2.0.0 based on FHIR 4.0.1. Generated 2025-11-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change