HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.0 - STU 2 US

This page is part of the electronic Case Reporting (eCR) (v2.1.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: US Public Health PlanDefinition Action Codes - XML Representation

Active as of 2020-09-06

Raw xml | Download



<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="us-ph-plandefinition-actions"/>
  <meta>
    <versionId value="2"/>
    <lastUpdated value="2021-08-13T04:50:49.806+00:00"/>
    <source value="#awJouuxGqRh7nPXm"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>This code system http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions defines the following codes:</p><table class="codes"><tr><td><b>Lvl</b></td><td style="white-space:nowrap"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td>1</td><td style="white-space:nowrap">initiate-reporting-workflow<a name="us-ph-plandefinition-actions-initiate-reporting-workflow"> </a></td><td>Initiate a reporting workflow</td><td>Request the initiation of a reporting workflow for a patient for a specific context (e.g., encounter).</td></tr><tr><td>1</td><td style="white-space:nowrap">execute-reporting-workflow<a name="us-ph-plandefinition-actions-execute-reporting-workflow"> </a></td><td>Execute a series of actions to accomplish reporting</td><td>This is top level action that uses other defined actions to accomplish reporting for a specific context (e.g., encounter).</td></tr><tr><td>2</td><td style="white-space:nowrap">  check-trigger-codes<a name="us-ph-plandefinition-actions-check-trigger-codes"> </a></td><td>Evaluate candidate patient's data against trigger codes to determine reportability</td><td>Evaluate candidate patient's data against trigger codes to determine reportability.</td></tr><tr><td>2</td><td style="white-space:nowrap">  evaluate-condition<a name="us-ph-plandefinition-actions-evaluate-condition"> </a></td><td>Evaluate condition to determine reportability</td><td>Evaluate condition to determine reportability.</td></tr><tr><td>2</td><td style="white-space:nowrap">  check-participant-registration<a name="us-ph-plandefinition-actions-check-participant-registration"> </a></td><td>Evaluate participants in encounter for reportability</td><td>Evaluate encounter participants such as patient, practitioner, organization on whether they have been selected for reportability.</td></tr><tr><td>2</td><td style="white-space:nowrap">  create-report<a name="us-ph-plandefinition-actions-create-report"> </a></td><td>Create a Report containing Patient's data for patients who passed the check-reportability test</td><td>Create a Report containing Patient's data for patients who passed the check-reportability test.</td></tr><tr><td>2</td><td style="white-space:nowrap">  validate-report<a name="us-ph-plandefinition-actions-validate-report"> </a></td><td>Validate Report against specified profiles and terminologies.</td><td>Validate Report against specified profiles and terminologies.</td></tr><tr><td>2</td><td style="white-space:nowrap">  submit-report<a name="us-ph-plandefinition-actions-submit-report"> </a></td><td>Submit the report to specified endpoint</td><td>Submit the report to specified endpoint.</td></tr><tr><td>2</td><td style="white-space:nowrap">  deidentify-report<a name="us-ph-plandefinition-actions-deidentify-report"> </a></td><td>Deidentify the report before submitting the report</td><td>Deidentify the report before submitting the report.</td></tr><tr><td>2</td><td style="white-space:nowrap">  anonymize-report<a name="us-ph-plandefinition-actions-anonymize-report"> </a></td><td>Anonymize the report before submitting the report</td><td>Anonymize the report before submitting the report.</td></tr><tr><td>2</td><td style="white-space:nowrap">  pseudonymize-report<a name="us-ph-plandefinition-actions-pseudonymize-report"> </a></td><td>Pseudonymize the report before submitting the report</td><td>Pseudonymize the report before submitting the report.</td></tr><tr><td>2</td><td style="white-space:nowrap">  encrypt-report<a name="us-ph-plandefinition-actions-encrypt-report"> </a></td><td>Encrypt the report before submitting the report</td><td>Encrypt the report before submitting the report.</td></tr><tr><td>2</td><td style="white-space:nowrap">  complete-reporting<a name="us-ph-plandefinition-actions-complete-reporting"> </a></td><td>Complete reporting for the patient</td><td>Complete the reporting for the patient, after which no further reports will be sent for a specific context (e.g., Encounter).</td></tr><tr><td>2</td><td style="white-space:nowrap">  extract-research-data<a name="us-ph-plandefinition-actions-extract-research-data"> </a></td><td>Extract data from an EHR for one or more patients.</td><td>Extract data from an EHR for one or more patients for research purposes.</td></tr><tr><td>2</td><td style="white-space:nowrap">  execute-research-query<a name="us-ph-plandefinition-actions-execute-research-query"> </a></td><td>Execute a research query on the data mart.</td><td>Execute a research query on the data mart based on the PlanDefinition and create a result to be submitted.</td></tr><tr><td>1</td><td style="white-space:nowrap">terminate-reporting-workflow<a name="us-ph-plandefinition-actions-terminate-reporting-workflow"> </a></td><td>Terminate a reporting workflow</td><td>Request the initiation of terminating a reporting workflow.</td></tr><tr><td>2</td><td style="white-space:nowrap">  cancel-report<a name="us-ph-plandefinition-actions-cancel-report"> </a></td><td>Cancel an already submitted report</td><td>Cancel an already submitted report.</td></tr><tr><td>1</td><td style="white-space:nowrap">report-chronic-disease-surveillance<a name="us-ph-plandefinition-actions-report-chronic-disease-surveillance"> </a></td><td>Report Chronic Disease Surveillance</td><td>This action represents the reporting of a Chronic Disease Surveillance report.</td></tr></table></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"/>
  <version value="2.1.0"/>
  <name value="USPublicHealthPlanDefinitionActions"/>
  <title value="US Public Health PlanDefinition Action Codes"/>
  <status value="active"/>
  <date value="2020-09-06"/>
  <publisher
             value="HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)"/>
  <contact>
    <name value="HL7 International - Public Health"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/pher"/>
    </telecom>
  </contact>
  <description
               value="The US Public Health PlanDefinition Actions CodeSystem is a 'starter set' of codes supported for identifying actions in PlanDefinition."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <caseSensitive value="true"/>
  <valueSet
            value="http://hl7.org/fhir/us/ecr/ValueSet/us-ph-plandefinition-action"/>
  <hierarchyMeaning value="is-a"/>
  <content value="complete"/>
  <count value="11"/>
  <concept>
    <code value="initiate-reporting-workflow"/>
    <display value="Initiate a reporting workflow"/>
    <definition
                value="Request the initiation of a reporting workflow for a patient for a specific context (e.g., encounter)."/>
  </concept>
  <concept>
    <code value="execute-reporting-workflow"/>
    <display value="Execute a series of actions to accomplish reporting"/>
    <definition
                value="This is top level action that uses other defined actions to accomplish reporting for a specific context (e.g., encounter)."/>
    <concept>
      <code value="check-trigger-codes"/>
      <display
               value="Evaluate candidate patient's data against trigger codes to determine reportability"/>
      <definition
                  value="Evaluate candidate patient's data against trigger codes to determine reportability."/>
    </concept>
    <concept>
      <code value="evaluate-condition"/>
      <display value="Evaluate condition to determine reportability"/>
      <definition value="Evaluate condition to determine reportability."/>
    </concept>
    <concept>
      <code value="check-participant-registration"/>
      <display value="Evaluate participants in encounter for reportability"/>
      <definition
                  value="Evaluate encounter participants such as patient, practitioner, organization on whether they have been selected for reportability."/>
    </concept>
    <concept>
      <code value="create-report"/>
      <display
               value="Create a Report containing Patient's data for patients who passed the check-reportability test"/>
      <definition
                  value="Create a Report containing Patient's data for patients who passed the check-reportability test."/>
    </concept>
    <concept>
      <code value="validate-report"/>
      <display
               value="Validate Report against specified profiles and terminologies."/>
      <definition
                  value="Validate Report against specified profiles and terminologies."/>
    </concept>
    <concept>
      <code value="submit-report"/>
      <display value="Submit the report to specified endpoint"/>
      <definition value="Submit the report to specified endpoint."/>
    </concept>
    <concept>
      <code value="deidentify-report"/>
      <display value="Deidentify the report before submitting the report"/>
      <definition value="Deidentify the report before submitting the report."/>
    </concept>
    <concept>
      <code value="anonymize-report"/>
      <display value="Anonymize the report before submitting the report"/>
      <definition value="Anonymize the report before submitting the report."/>
    </concept>
    <concept>
      <code value="pseudonymize-report"/>
      <display value="Pseudonymize the report before submitting the report"/>
      <definition value="Pseudonymize the report before submitting the report."/>
    </concept>
    <concept>
      <code value="encrypt-report"/>
      <display value="Encrypt the report before submitting the report"/>
      <definition value="Encrypt the report before submitting the report."/>
    </concept>
    <concept>
      <code value="complete-reporting"/>
      <display value="Complete reporting for the patient"/>
      <definition
                  value="Complete the reporting for the patient, after which no further reports will be sent for a specific context (e.g., Encounter)."/>
    </concept>
    <concept>
      <code value="extract-research-data"/>
      <display value="Extract data from an EHR for one or more patients."/>
      <definition
                  value="Extract data from an EHR for one or more patients for research purposes."/>
    </concept>
    <concept>
      <code value="execute-research-query"/>
      <display value="Execute a research query on the data mart."/>
      <definition
                  value="Execute a research query on the data mart based on the PlanDefinition and create a result to be submitted."/>
    </concept>
  </concept>
  <concept>
    <code value="terminate-reporting-workflow"/>
    <display value="Terminate a reporting workflow"/>
    <definition
                value="Request the initiation of terminating a reporting workflow."/>
    <concept>
      <code value="cancel-report"/>
      <display value="Cancel an already submitted report"/>
      <definition value="Cancel an already submitted report."/>
    </concept>
  </concept>
  <concept>
    <code value="report-chronic-disease-surveillance"/>
    <display value="Report Chronic Disease Surveillance"/>
    <definition
                value="This action represents the reporting of a Chronic Disease Surveillance report."/>
  </concept>
</CodeSystem>