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 - TTL Representation

Active as of 2020-09-06

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

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