Health Care Surveys Content Implementation Guide (IG)
1.0.0 - STU1 Release 1
Health Care Surveys Content Implementation Guide (IG)
1.0.0 - STU1 Release 1
This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) Healthcare Surveys Reporting Content IG (v1.0.0: STU1 Release 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
<Bundle xmlns="http://hl7.org/fhir">
<id value="healthcare-survey-specification-bundle-example"/>
<meta>
<versionId value="1"/>
<lastUpdated value="2020-11-29T02:03:28.045+00:00"/>
<profile
value="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-specification-bundle"/>
</meta>
<type value="collection"/>
<timestamp value="2020-11-20T11:15:33-10:00"/>
<entry>
<fullUrl value="PlanDefinition/plandefinition-healthcare-survey-example"/>
<resource>
<PlanDefinition>
<id value="plandefinition-healthcare-survey-example"/>
<meta>
<versionId value="1"/>
<lastUpdated value="2020-11-29T02:03:28.045+00:00"/>
<profile
value="http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-plandefinition"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><p><b>Receiver Endpoint Address</b>: <a>Generated Summary: id: example-nchs-endpoint; status: active; <span title="{http://terminology.hl7.org/CodeSystem/endpoint-connection-type hl7-fhir-rest}">HL7 FHIR</span>; name: PHAReceiver; endpointmanager@example.pha.org; period: 2020-11-20 --> (ongoing); <span title="Codes: {http://hl7.org/fhir/resource-types Bundle}">Bundle</span>; payloadMimeType: application/fhir+xml, payloadMimeType: application/fhir+json; address: http://example.pha.org/fhir</a></p><p><b>Author </b></p></div>
</text>
<url
value="http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/plandefinition-healthcare-survey-example"/>
<version value="1.0"/>
<name value="PlanDefinitionHealthcareSurveyExample"/>
<title value="PlanDefinition Health Care Survey Reporting 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="2023-06-01T12:32:29.858-05:00"/>
<publisher value="HL7 Public Health Work Group"/>
<description
value="This is the Health Care Survey Reporting Knowledge Artifact"/>
<effectivePeriod>
<start value="2021-11-01"/>
</effectivePeriod>
<relatedArtifact>
<type value="depends-on"/>
<label value="Health Care Survey Registered Participants"/>
<resource
value="http://nchs/fhir/r4/Group/healthcare-survey-participants"/>
</relatedArtifact>
<action id="start-workflow">
<description
value="This action represents the start of the reporting workflow in response to the encounter-end event"/>
<textEquivalent
value="Start the reporting workflow in response to an encounter-end event"/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
<code value="initiate-reporting-workflow"/>
</coding>
</code>
<trigger id="encounter-end">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype">
<valueCodeableConcept>
<coding>
<system
value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-triggerdefinition-namedevents"/>
<code value="encounter-end"/>
<display value="Indicates the end of an encounter"/>
</coding>
</valueCodeableConcept>
</extension>
<type value="named-event"/>
<name value="encounter-end"/>
</trigger>
<relatedAction>
<actionId value="check-reportability"/>
<relationship value="before-start"/>
<offsetDuration>
<value value="72"/>
<system value="http://unitsofmeasure.org"/>
<code value="h"/>
</offsetDuration>
</relatedAction>
</action>
<action id="check-reportability">
<description
value="This action represents the start of the check for reportable conditions in response to the encounter-end event. This is an example of executing a reporting workflow with other actions."/>
<textEquivalent value="Check Reportability"/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
<code value="execute-reporting-workflow"/>
</coding>
</code>
<action id="is-ambulatory-encounter-reportable">
<description
value="This action represents the check for reportability of ambulatory encounters based on survey participation."/>
<textEquivalent
value="Check Participation of Provider to report on the encounter"/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
<code value="evaluate-condition"/>
</coding>
</code>
<condition>
<kind value="applicability"/>
<expression>
<language value="text/fhirpath"/>
<expression
value="%closedEncounter.participant.individual.identifier.where(system = 'http://hl7.org/fhir/sid/us-npi).value.subsetOf(participantGroup.member.entity.identifier.where(system = 'http://hl7.org/fhir/sid/us-npi).value)'"/>
</expression>
</condition>
<input id="closedEncounter">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString value="Encounter/{{context.patientId}}"/>
</extension>
<type value="Encounter"/>
</input>
<input id="participantGroup">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString value="Group/{{context.nchsGroupId}}"/>
</extension>
<type value="Group"/>
</input>
<relatedAction>
<actionId value="create-hcs-report"/>
<relationship value="before-start"/>
</relatedAction>
</action>
<action id="is-inpatient-encounter-reportable">
<description
value="This action represents the check for reportability of inpatient encounters based on survey requirements."/>
<textEquivalent
value="Check criteria to report on the encounter"/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
<code value="evaluate-condition"/>
</coding>
</code>
<condition>
<kind value="applicability"/>
<expression>
<language value="text/fhirpath"/>
<expression value="%closedEncounter.exists()"/>
</expression>
</condition>
<input id="inpatientEncounter">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString value="Encounter/{{context.patientId}}"/>
</extension>
<type value="Encounter"/>
</input>
<relatedAction>
<actionId value="create-hcs-report"/>
<relationship value="before-start"/>
</relatedAction>
</action>
</action>
<action id="create-hcs-report">
<description
value="This action represents the creation, validation and submission of the health care survey report."/>
<textEquivalent value="Create Report and send to NCHS."/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
<code value="create-report"/>
</coding>
</code>
<input id="patient">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString value="Patient/{{context.patientId}}"/>
</extension>
<type value="Patient"/>
</input>
<input id="conditions">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="Condition?patient=Patient/{{context.patientId}}&clinical-status=http://terminology.hl7.org/CodeSystem/condition-clinical|active"/>
</extension>
<type value="Condition"/>
</input>
<input id="allergies">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="AllergyIntolerance?patient=Patient/{{context.patientId}}"/>
</extension>
<type value="AllergyIntolerance"/>
</input>
<input id="careteam">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="CareTeam?patient=Patient/{{context.patientId}}"/>
</extension>
<type value="CareTeam"/>
</input>
<input id="careplan">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="CarePlan?patient=Patient/{{context.patientId}}"/>
</extension>
<type value="CarePlan"/>
</input>
<input id="goals">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="Goal?patient=Patient/{{context.patientId}}"/>
</extension>
<type value="Goal"/>
</input>
<input id="encounter">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString value="Encounter/{{context.encounterId}}"/>
</extension>
<type value="Encounter"/>
</input>
<input id="medRequests">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="MedicationRequest?patient=Patient/{{context.patientId}}&intent=order"/>
</extension>
<type value="MedicationRequest"/>
</input>
<input id="medStatements">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="MedicationStatement?patient=Patient/{{context.patientId}}"/>
</extension>
<type value="MedicationStatement"/>
</input>
<input id="medAdms">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="MedicationAdministration?patient=Patient/{{context.patientId}}"/>
</extension>
<type value="MedicationAdministration"/>
</input>
<input id="vitals">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="Observation?patient=Patient/{{context.patientId}}&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs"/>
</extension>
<type value="Observation"/>
</input>
<input id="socialHistory">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="Observation?patient=Patient/{{context.patientId}}&category=http://terminology.hl7.org/CodeSystem/observation-category|social-history"/>
</extension>
<type value="Observation"/>
</input>
<input id="diagnosticOrders">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="DiagnosticReport?patient=Patient/{{context.patientId}}"/>
</extension>
<type value="DiagnosticReport"/>
</input>
<input id="serviceRequests">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="ServiceRequest?patient=Patient/{{context.patientId}}"/>
</extension>
<type value="ServiceRequest"/>
</input>
<input id="procedures">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="Procedure?patient=Patient/{{context.patientId}}"/>
</extension>
<type value="Procedure"/>
</input>
<input id="implantableDevices">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="Device?patient=Patient/{{context.patientId}}"/>
</extension>
<type value="Device"/>
</input>
<input id="labs">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension">
<valueString
value="Observation?patient=Patient/{{context.patientId}}&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory"/>
</extension>
<type value="Observation"/>
</input>
<output id="hcs-report">
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-reporting-bundle"/>
</output>
<relatedAction>
<actionId value="validate-hcs-report"/>
<relationship value="before-start"/>
</relatedAction>
</action>
<action id="validate-hcs-report">
<description
value="This action represents the validation of the HCS Report"/>
<textEquivalent value="Validate Report"/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
<code value="validate-report"/>
</coding>
</code>
<input id="created-hcs-report">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-relateddata-extension">
<valueString value="hcs-report"/>
</extension>
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-reporting-bundle"/>
</input>
<output id="validated-hcs-report">
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-reporting-bundle"/>
</output>
<relatedAction>
<actionId value="submit-hcs-report"/>
<relationship value="before-start"/>
</relatedAction>
</action>
<action id="submit-hcs-report">
<description
value="This action represents the routing and sending of the HCS Report"/>
<textEquivalent value="Route and send HCS Report"/>
<code>
<coding>
<system
value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
<code value="submit-report"/>
</coding>
</code>
<input id="valid-hcs-report">
<extension
url="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-relateddata-extension">
<valueString value="validated-hcs-report"/>
</extension>
<type value="Bundle"/>
<profile
value="http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-reporting-bundle"/>
</input>
</action>
</PlanDefinition>
</resource>
</entry>
</Bundle>
IG © 2021+ HL7 International - Public Health Work Group. Package hl7.fhir.us.health-care-surveys-reporting#1.0.0 based on FHIR 4.0.1. Generated 2023-08-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change