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

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

ValueSet: US Public Health PlanDefinition Action

Official URL: http://hl7.org/fhir/us/ecr/ValueSet/us-ph-plandefinition-action Version: 2.1.1
Active as of 2020-09-06 Computable Name: USPublicHealthPlanDefinitionAction

The US Public Health PlanDefinition Action Value Set is a ‘starter set’ of codes for uniquely identifying actions in PlanDefinition instances.

References

Logical Definition (CLD)

 

Expansion

Expansion based on codesystem US Public Health PlanDefinition Action Codes v2.1.1 (CodeSystem)

This value set contains 18 concepts

LevelCodeSystemDisplayDefinition
1  initiate-reporting-workflowhttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsInitiate a reporting workflow

Request the initiation of a reporting workflow for a patient for a specific context (e.g., encounter).

1  execute-reporting-workflowhttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsExecute a series of actions to accomplish reporting

This is top level action that uses other defined actions to accomplish reporting for a specific context (e.g., encounter).

2    check-trigger-codeshttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsEvaluate candidate patient's data against trigger codes to determine reportability

Evaluate candidate patient's data against trigger codes to determine reportability.

2    evaluate-conditionhttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsEvaluate condition to determine reportability

Evaluate condition to determine reportability.

2    check-participant-registrationhttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsEvaluate participants in encounter for reportability

Evaluate encounter participants such as patient, practitioner, organization on whether they have been selected for reportability.

2    create-reporthttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsCreate a Report containing Patient's data for patients who passed the check-reportability test

Create a Report containing Patient's data for patients who passed the check-reportability test.

2    validate-reporthttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsValidate Report against specified profiles and terminologies.

Validate Report against specified profiles and terminologies.

2    submit-reporthttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsSubmit the report to specified endpoint

Submit the report to specified endpoint.

2    deidentify-reporthttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsDeidentify the report before submitting the report

Deidentify the report before submitting the report.

2    anonymize-reporthttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsAnonymize the report before submitting the report

Anonymize the report before submitting the report.

2    pseudonymize-reporthttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsPseudonymize the report before submitting the report

Pseudonymize the report before submitting the report.

2    encrypt-reporthttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsEncrypt the report before submitting the report

Encrypt the report before submitting the report.

2    complete-reportinghttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsComplete reporting for the patient

Complete the reporting for the patient, after which no further reports will be sent for a specific context (e.g., Encounter).

2    extract-research-datahttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsExtract data from an EHR for one or more patients.

Extract data from an EHR for one or more patients for research purposes.

2    execute-research-queryhttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsExecute a research query on the data mart.

Execute a research query on the data mart based on the PlanDefinition and create a result to be submitted.

1  terminate-reporting-workflowhttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsTerminate a reporting workflow

Request the initiation of terminating a reporting workflow.

2    cancel-reporthttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsCancel an already submitted report

Cancel an already submitted report.

1  report-chronic-disease-surveillancehttp://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actionsReport Chronic Disease Surveillance

This action represents the reporting of a Chronic Disease Surveillance report.

Explanation of the columns that may appear on this page:

Level A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies
System The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code The code (used as the code in the resource instance)
Display The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application
Definition An explanation of the meaning of the concept
Comments Additional notes about how to use the code