Health Care Surveys Content Implementation Guide
0.1.0 - STU 1 Ballot

This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) Healthcare Surveys Reporting Content IG (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

: HCS PlanDefinition Example - XML Representation

Raw xml | Download



<PlanDefinition xmlns="http://hl7.org/fhir">
  <id value="plandefinition-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>PlanDefinition 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 --&gt; (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 Signature</b>: </p><p><b style="color: maroon">Exception generating Narrative: type org.hl7.fhir.r5.model.Signature not handled - should not be here</b></p></div>
  </text>
  <extension
             url="http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-receiverAddress">
    <valueReference>
      <reference value="Endpoint/example-ph-endpoint"/>
    </valueReference>
  </extension>
  <extension
             url="http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-authorSignature">
    <valueSignature>
      <type>
        <system value="urn:iso-astm:E1762-95:2013"/>
        <code value="1.2.840.10065.1.12.1.5"/>
        <display value="Verification Signature"/>
      </type>
      <when value="2020-11-03T22:39:24.000+00:00"/>
      <who>
        <reference value="Organization/example-pha-org"/>
      </who>
      <targetFormat value="application/fhir+xml"/>
      <sigFormat value="application/signature+xml"/>
      <data value="L44u"/>
    </valueSignature>
  </extension>
  <url
       value="http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/plandefinition-example"/>
  <version value="0.1.0"/>
  <name value="PlanDefinitionExample"/>
  <title value="PlanDefinition 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="draft"/>
  <experimental value="true"/>
  <date value="2020-11-04T12:32:29.858-05:00"/>
  <publisher value="HL7 International - Public Health Work Group"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/Special/committees/pher"/>
    </telecom>
  </contact>
  <description
               value="This is the Health Care Survey Reporting Knowledge Artifact"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <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-close event"/>
    <textEquivalent
                    value="Start the reporting workflow in response to an encounter-close 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-close">
      <extension
                 url="http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType">
        <valueCodeableConcept>
          <coding>
            <system
                    value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-triggerdefinition-namedevents"/>
            <code value="encounter-close"/>
            <display value="Indicates the close of an encounter"/>
          </coding>
        </valueCodeableConcept>
      </extension>
      <type value="named-event"/>
      <name value="encounter-close"/>
    </trigger>
    <relatedAction>
      <actionId value="check-survey-participants"/>
      <relationship value="before-start"/>
      <offsetDuration>
        <value value="5"/>
        <system value="http://unitsofmeasure.org"/>
        <code value="min"/>
      </offsetDuration>
    </relatedAction>
  </action>
  <action id="check-survey-participants">
    <description
                 value="This action represents the check if Practitioner is registered to report on health care surveys."/>
    <textEquivalent value="Check Participant Registration"/>
    <code>
      <coding>
        <system
                value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
        <code value="check-participant-registration"/>
      </coding>
    </code>
    <condition>
      <kind value="applicability"/>
      <expression>
        <language value="text/fhirpath"/>
        <expression
                    value="closedEncounter.participant.individual.identifier.where(system = &#39;http://hl7.org/fhir/sid/us-npi).value.subsetOf(participantGroup.member.entity.identifier.where(system = &#39;http://hl7.org/fhir/sid/us-npi).value)&#39;"/>
      </expression>
    </condition>
    <input id="closedEncounter">
      <type value="Encounter"/>
      <profile
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"/>
    </input>
    <input id="participantGroup">
      <type value="Group"/>
      <profile
               value="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-survey-practitioner-group"/>
    </input>
    <relatedAction>
      <actionId value="report-to-nchs"/>
      <relationship value="before-start"/>
    </relatedAction>
  </action>
  <action id="report-to-nchs">
    <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="execute-reporting-workflow"/>
      </coding>
    </code>
    <action id="create-hcs-report">
      <description
                   value="This action represents the creation of the HCS Report."/>
      <textEquivalent value="Health Care Survey Report"/>
      <code>
        <coding>
          <system
                  value="http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions"/>
          <code value="create-report"/>
        </coding>
      </code>
      <input id="patient">
        <type value="Patient"/>
        <profile
                 value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/>
      </input>
      <input id="condition">
        <type value="Condition"/>
        <profile
                 value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"/>
      </input>
      <input id="encounter">
        <type value="Encounter"/>
        <profile
                 value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"/>
      </input>
      <input id="mr">
        <type value="MedicationRequest"/>
        <profile
                 value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"/>
      </input>
      <input id="vitals">
        <type value="Observation"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/vitalsigns"/>
      </input>
      <input id="labs">
        <type value="Observation"/>
        <profile
                 value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"/>
      </input>
      <output id="hcs-report">
        <type value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle"/>
      </output>
      <relatedAction>
        <actionId value="validate-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">
        <type value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle"/>
      </input>
      <output id="validated-hcs-report">
        <type value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle"/>
      </output>
      <relatedAction>
        <actionId value="submit-report"/>
        <relationship value="before-start"/>
      </relatedAction>
    </action>
    <action id="route-and-send-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">
        <type value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle"/>
      </input>
    </action>
  </action>
</PlanDefinition>