HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2 United States of America flag

This page is part of the electronic Case Reporting (eCR) (v2.1.2: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

: US Public Health PlanDefinition Action Codes - JSON Representation

Active as of 2020-09-06

Raw json | Download

{
  "resourceType" : "CodeSystem",
  "id" : "us-ph-plandefinition-actions",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem us-ph-plandefinition-actions</b></p><a name=\"us-ph-plandefinition-actions\"> </a><a name=\"hcus-ph-plandefinition-actions\"> </a><a name=\"us-ph-plandefinition-actions-en-US\"> </a><p>This case-sensitive code system <code>http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions</code> defines the following codes in a Is-A hierarchy:</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\">\u00a0\u00a0check-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\">\u00a0\u00a0evaluate-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\">\u00a0\u00a0check-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\">\u00a0\u00a0create-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\">\u00a0\u00a0validate-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\">\u00a0\u00a0submit-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\">\u00a0\u00a0deidentify-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\">\u00a0\u00a0anonymize-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\">\u00a0\u00a0pseudonymize-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\">\u00a0\u00a0encrypt-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\">\u00a0\u00a0complete-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\">\u00a0\u00a0extract-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\">\u00a0\u00a0execute-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\">\u00a0\u00a0cancel-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>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "pher"
    }
  ],
  "url" : "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.4.642.40.46.16.6"
    }
  ],
  "version" : "2.1.2",
  "name" : "USPublicHealthPlanDefinitionActions",
  "title" : "US Public Health PlanDefinition Action Codes",
  "status" : "active",
  "experimental" : false,
  "date" : "2020-09-06",
  "publisher" : "HL7 International / Public Health",
  "contact" : [
    {
      "name" : "HL7 International / Public Health",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/pher"
        }
      ]
    }
  ],
  "description" : "The US Public Health PlanDefinition Actions CodeSystem is a 'starter set' of codes supported for identifying actions in PlanDefinition.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/us/ecr/ValueSet/us-ph-plandefinition-action",
  "hierarchyMeaning" : "is-a",
  "content" : "complete",
  "count" : 18,
  "concept" : [
    {
      "code" : "initiate-reporting-workflow",
      "display" : "Initiate a reporting workflow",
      "definition" : "Request the initiation of a reporting workflow for a patient for a specific context (e.g., encounter)."
    },
    {
      "code" : "execute-reporting-workflow",
      "display" : "Execute a series of actions to accomplish reporting",
      "definition" : "This is top level action that uses other defined actions to accomplish reporting for a specific context (e.g., encounter).",
      "concept" : [
        {
          "code" : "check-trigger-codes",
          "display" : "Evaluate candidate patient's data against trigger codes to determine reportability",
          "definition" : "Evaluate candidate patient's data against trigger codes to determine reportability."
        },
        {
          "code" : "evaluate-condition",
          "display" : "Evaluate condition to determine reportability",
          "definition" : "Evaluate condition to determine reportability."
        },
        {
          "code" : "check-participant-registration",
          "display" : "Evaluate participants in encounter for reportability",
          "definition" : "Evaluate encounter participants such as patient, practitioner, organization on whether they have been selected for reportability."
        },
        {
          "code" : "create-report",
          "display" : "Create a Report containing Patient's data for patients who passed the check-reportability test",
          "definition" : "Create a Report containing Patient's data for patients who passed the check-reportability test."
        },
        {
          "code" : "validate-report",
          "display" : "Validate Report against specified profiles and terminologies.",
          "definition" : "Validate Report against specified profiles and terminologies."
        },
        {
          "code" : "submit-report",
          "display" : "Submit the report to specified endpoint",
          "definition" : "Submit the report to specified endpoint."
        },
        {
          "code" : "deidentify-report",
          "display" : "Deidentify the report before submitting the report",
          "definition" : "Deidentify the report before submitting the report."
        },
        {
          "code" : "anonymize-report",
          "display" : "Anonymize the report before submitting the report",
          "definition" : "Anonymize the report before submitting the report."
        },
        {
          "code" : "pseudonymize-report",
          "display" : "Pseudonymize the report before submitting the report",
          "definition" : "Pseudonymize the report before submitting the report."
        },
        {
          "code" : "encrypt-report",
          "display" : "Encrypt the report before submitting the report",
          "definition" : "Encrypt the report before submitting the report."
        },
        {
          "code" : "complete-reporting",
          "display" : "Complete reporting for the patient",
          "definition" : "Complete the reporting for the patient, after which no further reports will be sent for a specific context (e.g., Encounter)."
        },
        {
          "code" : "extract-research-data",
          "display" : "Extract data from an EHR for one or more patients.",
          "definition" : "Extract data from an EHR for one or more patients for research purposes."
        },
        {
          "code" : "execute-research-query",
          "display" : "Execute a research query on the data mart.",
          "definition" : "Execute a research query on the data mart based on the PlanDefinition and create a result to be submitted."
        }
      ]
    },
    {
      "code" : "terminate-reporting-workflow",
      "display" : "Terminate a reporting workflow",
      "definition" : "Request the initiation of terminating a reporting workflow.",
      "concept" : [
        {
          "code" : "cancel-report",
          "display" : "Cancel an already submitted report",
          "definition" : "Cancel an already submitted report."
        }
      ]
    },
    {
      "code" : "report-chronic-disease-surveillance",
      "display" : "Report Chronic Disease Surveillance",
      "definition" : "This action represents the reporting of a Chronic Disease Surveillance report."
    }
  ]
}