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

# - ontology header ------------------------------------------------------------

 a owl:Ontology;
  owl:imports fhir:fhir.ttl.