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

HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

: US Public Health TriggerDefinition Named Events - XML Representation

Active as of 2020-09-06

Raw xml | Download



<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="us-ph-triggerdefinition-namedevents"/>
  <meta>
    <versionId value="8"/>
    <lastUpdated value="2021-08-04T15:52:33.158+00:00"/>
    <source value="#3Te0anOrvocKgcow"/>
    <profile
             value="http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-codesystem"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>This case-sensitive code system <code>http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-triggerdefinition-namedevents</code> defines the following codes in a Is-A heirarchy:</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">encounter-change<a name="us-ph-triggerdefinition-namedevents-encounter-change"> </a></td><td>Indicates a change in the patient's encounter records</td><td>Indicates a change in the patient's encounter records which includes starting an encounter, closing an encounter, modifying data elements of an encounter. Encounter change events would be triggered by monitoring the Encounter resource.</td></tr><tr><td>2</td><td style="white-space:nowrap">  encounter-start<a name="us-ph-triggerdefinition-namedevents-encounter-start"> </a></td><td>Indicates the start of an encounter</td><td>Indicates the start of an encounter, where in encounter.period.low is populated with the start time.</td></tr><tr><td>2</td><td style="white-space:nowrap">  encounter-close<a name="us-ph-triggerdefinition-namedevents-encounter-close"> </a></td><td>Indicates the close of an encounter</td><td>Indicates the closure of an encounter, where in encounter.period.high is populated with the end time.</td></tr><tr><td>2</td><td style="white-space:nowrap">  encounter-modified<a name="us-ph-triggerdefinition-namedevents-encounter-modified"> </a></td><td>Indicates modifications to data elements of an encounter</td><td>Indicates changes to encounter codes, times, reason codes, diagnosis, discharge dispositions, locations etc.</td></tr><tr><td>1</td><td style="white-space:nowrap">diagnosis-change<a name="us-ph-triggerdefinition-namedevents-diagnosis-change"> </a></td><td>Indicates a change in the patient's diagnosis</td><td>Indicates a change in the patient's diagnosis and it includes new diagnosis or modifications to existing diagnosis. Diagnosis change events would be triggered by monitoring the Condition resource.</td></tr><tr><td>2</td><td style="white-space:nowrap">  new-diagnosis<a name="us-ph-triggerdefinition-namedevents-new-diagnosis"> </a></td><td>New Diagnosis added</td><td>Indicates that a new diagnosis has been added to the patient's chart in the EHR</td></tr><tr><td>2</td><td style="white-space:nowrap">  modified-diagnosis<a name="us-ph-triggerdefinition-namedevents-modified-diagnosis"> </a></td><td>Existing Diagnosis record has been modified</td><td>Indicates that an existing diagnosis record in the patient's chart has been modified. Sometimes this is equivalent to removing an existing diagnosis record (which may have been entered in error) and adding a new diagnosis record.</td></tr><tr><td>1</td><td style="white-space:nowrap">medication-change<a name="us-ph-triggerdefinition-namedevents-medication-change"> </a></td><td>Indicates a change in the patient's medications</td><td>Indicates a change in the patient's medications and it includes changes to Administered medications or Requested medications or Dispensed medications. Medication change events would be triggered by monitoring the MedicationRequest, MedicationDispense, MedicationStatement and MedicationAdministration resources.</td></tr><tr><td>2</td><td style="white-space:nowrap">  new-medication<a name="us-ph-triggerdefinition-namedevents-new-medication"> </a></td><td>New Medication added</td><td>Indicates that a new MedicationRequest or MedicationDispense or MedicationAdministered or MedicationStatement has been added to the patient's chart in the EHR</td></tr><tr><td>2</td><td style="white-space:nowrap">  modified-medication<a name="us-ph-triggerdefinition-namedevents-modified-medication"> </a></td><td>Existing Medication record has been modified</td><td>Indicates that an existing medication record in the patient's chart has been modified. Sometimes this is equivalent to removing an existing medication record (which may have been entered in error) and adding a new medication record.</td></tr><tr><td>1</td><td style="white-space:nowrap">labresult-change<a name="us-ph-triggerdefinition-namedevents-labresult-change"> </a></td><td>Indicates a change in the patient's labresults</td><td>Indicates a change in the patient's lab results and it includes new lab results or modifications to existing lab results. Changes to lab results could be because of change in the lab result values, lab test names, times or other data elements of the Observation resource where the category is laboratory. LabResult events would be triggered by monitoring the Observation resource with an Observation.category=laboratory.</td></tr><tr><td>2</td><td style="white-space:nowrap">  new-labresult<a name="us-ph-triggerdefinition-namedevents-new-labresult"> </a></td><td>New Lab Result added</td><td>Indicates that a new Lab Result has been added to the patient's chart in the EHR</td></tr><tr><td>2</td><td style="white-space:nowrap">  modified-labresult<a name="us-ph-triggerdefinition-namedevents-modified-labresult"> </a></td><td>Existing Lab Result record has been modified</td><td>Indicates that an existing lab result record in the patient's chart has been modified. Sometimes this is equivalent to removing an existing lab result record (which may have been entered in error) and adding a new lab result record. Changes to lab results could be because of change in the lab result values, lab test names, times or other data elements of the Observation resource where the category is laboratory.</td></tr><tr><td>1</td><td style="white-space:nowrap">order-change<a name="us-ph-triggerdefinition-namedevents-order-change"> </a></td><td>Indicates a change in the patient's orders</td><td>Indicates a change in the patient's orders and it includes new or modified ServiceRequests. Order change events would be triggered by monitoring the ServiceRequest resource.</td></tr><tr><td>2</td><td style="white-space:nowrap">  new-order<a name="us-ph-triggerdefinition-namedevents-new-order"> </a></td><td>New Order added</td><td>Indicates that a new ServiceRequest has been added to the patient's chart in the EHR</td></tr><tr><td>2</td><td style="white-space:nowrap">  modified-order<a name="us-ph-triggerdefinition-namedevents-modified-order"> </a></td><td>Existing Order record has been modified</td><td>Indicates that an existing ServiceRequest record in the patient's chart has been modified. Sometimes this is equivalent to removing an existing ServiceRequest record (which may have been entered in error) and adding a new ServiceRequest record.</td></tr><tr><td>1</td><td style="white-space:nowrap">procedure-change<a name="us-ph-triggerdefinition-namedevents-procedure-change"> </a></td><td>Indicates a change in the patient's procedures</td><td>Indicates a change in the patient's procedures and it includes new procedures or modifications to existing procedures. Procedure events would be triggered by monitoring the Procedure resource.</td></tr><tr><td>2</td><td style="white-space:nowrap">  new-procedure<a name="us-ph-triggerdefinition-namedevents-new-procedure"> </a></td><td>New Procedure added</td><td>Indicates that a new procedure has been added to the patient's chart in the EHR</td></tr><tr><td>2</td><td style="white-space:nowrap">  modified-procedure<a name="us-ph-triggerdefinition-namedevents-modified-procedure"> </a></td><td>Existing Procedure record has been modified</td><td>Indicates that an existing procedure record in the patient's chart has been modified. Sometimes this is equivalent to removing an existing procedure record (which may have been entered in error) and adding a new procedure record.</td></tr><tr><td>1</td><td style="white-space:nowrap">immunization-change<a name="us-ph-triggerdefinition-namedevents-immunization-change"> </a></td><td>Indicates a change in the patient's immunizations</td><td>Indicates a change in the patient's immunization and it includes new immunizations or modifications to existing immunization records. Immunization change events would be triggered by monitoring the Immunization resource.</td></tr><tr><td>2</td><td style="white-space:nowrap">  new-immunization<a name="us-ph-triggerdefinition-namedevents-new-immunization"> </a></td><td>New Immunization added</td><td>Indicates that a new immunization has been added to the patient's chart in the EHR</td></tr><tr><td>2</td><td style="white-space:nowrap">  modified-immunization<a name="us-ph-triggerdefinition-namedevents-modified-immunization"> </a></td><td>Existing immunization record has been modified</td><td>Indicates that an existing immunization record in the patient's chart has been modified. Sometimes this is equivalent to removing an existing immunization record (which may have been entered in error) and adding a new immunization record.</td></tr><tr><td>1</td><td style="white-space:nowrap">demographic-change<a name="us-ph-triggerdefinition-namedevents-demographic-change"> </a></td><td>Indicates change in patient demographics</td><td>Indicates that the Patient demographic attributes such as Date of Birth, Race, Ethnicity, Deceased date, Address, Telecom, Names have changed. Demographic change events would be triggered by monitoring the Patient resource.</td></tr><tr><td>1</td><td style="white-space:nowrap">received-public-health-report<a name="us-ph-triggerdefinition-namedevents-received-public-health-report"> </a></td><td>Indicates receipt of a public health report</td><td>Indicates that a public health report was submitted and received by a specific system. This event could trigger downstream processing and hence is designated as a named event.</td></tr><tr><td>1</td><td style="white-space:nowrap">received-public-health-response<a name="us-ph-triggerdefinition-namedevents-received-public-health-response"> </a></td><td>Indicates receipt of a public health response for a submitted public health report</td><td>Indicates that a public health response was received by a specific system for an already submitted public health report. This event could trigger downstream processing and hence is designated as a named event.</td></tr><tr><td>1</td><td style="white-space:nowrap">manual-notification<a name="us-ph-triggerdefinition-namedevents-manual-notification"> </a></td><td>A Practitioner or their representatives notify the application about change in patient data</td><td>In some cases where automated notifications are not supported, a practitioner or their representative can initiate the public health report processing by notifying the application about change in a patient's data.</td></tr><tr><td>1</td><td style="white-space:nowrap">timer-event<a name="us-ph-triggerdefinition-namedevents-timer-event"> </a></td><td>A Timer is setup to kick off processing.</td><td>Indicates a timer based approach to start processing.</td></tr><tr><td>2</td><td style="white-space:nowrap">  periodic-timer<a name="us-ph-triggerdefinition-namedevents-periodic-timer"> </a></td><td>Setup Periodic Timer</td><td>Indicates that processing must be performed periodically based on a specified duration.</td></tr><tr><td>2</td><td style="white-space:nowrap">  absolute-timer<a name="us-ph-triggerdefinition-namedevents-absolute-timer"> </a></td><td>Setup Absolute Timer</td><td>Indicates that processing must be performed at a specific time.</td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="pher"/>
  </extension>
  <url
       value="http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-triggerdefinition-namedevents"/>
  <version value="2.1.1"/>
  <name value="USPublicHealthTriggerDefinitionNamedEvents"/>
  <title value="US Public Health TriggerDefinition NamedEvents"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2020-09-06"/>
  <publisher value="HL7 International / Public Health"/>
  <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 TriggerDefinition NamedEvents CodeSystem is a 'starter set' of codes supported for identifying named events to subscribe to in clinical workflows."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
    <text value="United States of America"/>
  </jurisdiction>
  <caseSensitive value="true"/>
  <valueSet
            value="http://hl7.org/fhir/us/ecr/ValueSet/us-ph-triggerdefinition-namedevent"/>
  <hierarchyMeaning value="is-a"/>
  <content value="complete"/>
  <count value="29"/>
  <concept>
    <code value="encounter-change"/>
    <display value="Indicates a change in the patient's encounter records"/>
    <definition
                value="Indicates a change in the patient's encounter records which includes starting an encounter, closing an encounter, modifying data elements of an encounter. Encounter change events would be triggered by monitoring the Encounter resource."/>
    <concept>
      <code value="encounter-start"/>
      <display value="Indicates the start of an encounter"/>
      <definition
                  value="Indicates the start of an encounter, where in encounter.period.low is populated with the start time."/>
    </concept>
    <concept>
      <code value="encounter-close"/>
      <display value="Indicates the close of an encounter"/>
      <definition
                  value="Indicates the closure of an encounter, where in encounter.period.high is populated with the end time."/>
    </concept>
    <concept>
      <code value="encounter-modified"/>
      <display
               value="Indicates modifications to data elements of an encounter"/>
      <definition
                  value="Indicates changes to encounter codes, times, reason codes, diagnosis, discharge dispositions, locations etc."/>
    </concept>
  </concept>
  <concept>
    <code value="diagnosis-change"/>
    <display value="Indicates a change in the patient's diagnosis"/>
    <definition
                value="Indicates a change in the patient's diagnosis and it includes new diagnosis or modifications to existing diagnosis. Diagnosis change events would be triggered by monitoring the Condition resource."/>
    <concept>
      <code value="new-diagnosis"/>
      <display value="New Diagnosis added"/>
      <definition
                  value="Indicates that a new diagnosis has been added to the patient's chart in the EHR"/>
    </concept>
    <concept>
      <code value="modified-diagnosis"/>
      <display value="Existing Diagnosis record has been modified"/>
      <definition
                  value="Indicates that an existing diagnosis record in the patient's chart has been modified. Sometimes this is equivalent to removing an existing diagnosis record (which may have been entered in error) and adding a new diagnosis record."/>
    </concept>
  </concept>
  <concept>
    <code value="medication-change"/>
    <display value="Indicates a change in the patient's medications"/>
    <definition
                value="Indicates a change in the patient's medications and it includes changes to Administered medications or Requested medications or Dispensed medications. Medication change events would be triggered by monitoring the MedicationRequest, MedicationDispense, MedicationStatement and MedicationAdministration resources."/>
    <concept>
      <code value="new-medication"/>
      <display value="New Medication added"/>
      <definition
                  value="Indicates that a new MedicationRequest or MedicationDispense or MedicationAdministered or MedicationStatement has been added to the patient's chart in the EHR"/>
    </concept>
    <concept>
      <code value="modified-medication"/>
      <display value="Existing Medication record has been modified"/>
      <definition
                  value="Indicates that an existing medication record in the patient's chart has been modified. Sometimes this is equivalent to removing an existing medication record (which may have been entered in error) and adding a new medication record."/>
    </concept>
  </concept>
  <concept>
    <code value="labresult-change"/>
    <display value="Indicates a change in the patient's labresults"/>
    <definition
                value="Indicates a change in the patient's lab results and it includes new lab results or modifications to existing lab results. Changes to lab results could be because of change in the lab result values, lab test names, times or other data elements of the Observation resource where the category is laboratory. LabResult events would be triggered by monitoring the Observation resource with an Observation.category=laboratory."/>
    <concept>
      <code value="new-labresult"/>
      <display value="New Lab Result added"/>
      <definition
                  value="Indicates that a new Lab Result has been added to the patient's chart in the EHR"/>
    </concept>
    <concept>
      <code value="modified-labresult"/>
      <display value="Existing Lab Result record has been modified"/>
      <definition
                  value="Indicates that an existing lab result record in the patient's chart has been modified. Sometimes this is equivalent to removing an existing lab result record (which may have been entered in error) and adding a new lab result record. Changes to lab results could be because of change in the lab result values, lab test names, times or other data elements of the Observation resource where the category is laboratory."/>
    </concept>
  </concept>
  <concept>
    <code value="order-change"/>
    <display value="Indicates a change in the patient's orders"/>
    <definition
                value="Indicates a change in the patient's orders and it includes new or modified ServiceRequests. Order change events would be triggered by monitoring the ServiceRequest resource."/>
    <concept>
      <code value="new-order"/>
      <display value="New Order added"/>
      <definition
                  value="Indicates that a new ServiceRequest has been added to the patient's chart in the EHR"/>
    </concept>
    <concept>
      <code value="modified-order"/>
      <display value="Existing Order record has been modified"/>
      <definition
                  value="Indicates that an existing ServiceRequest record in the patient's chart has been modified. Sometimes this is equivalent to removing an existing ServiceRequest record (which may have been entered in error) and adding a new ServiceRequest record."/>
    </concept>
  </concept>
  <concept>
    <code value="procedure-change"/>
    <display value="Indicates a change in the patient's procedures"/>
    <definition
                value="Indicates a change in the patient's procedures and it includes new procedures or modifications to existing procedures. Procedure events would be triggered by monitoring the Procedure resource."/>
    <concept>
      <code value="new-procedure"/>
      <display value="New Procedure added"/>
      <definition
                  value="Indicates that a new procedure has been added to the patient's chart in the EHR"/>
    </concept>
    <concept>
      <code value="modified-procedure"/>
      <display value="Existing Procedure record has been modified"/>
      <definition
                  value="Indicates that an existing procedure record in the patient's chart has been modified. Sometimes this is equivalent to removing an existing procedure record (which may have been entered in error) and adding a new procedure record."/>
    </concept>
  </concept>
  <concept>
    <code value="immunization-change"/>
    <display value="Indicates a change in the patient's immunizations"/>
    <definition
                value="Indicates a change in the patient's immunization and it includes new immunizations or modifications to existing immunization records. Immunization change events would be triggered by monitoring the Immunization resource."/>
    <concept>
      <code value="new-immunization"/>
      <display value="New Immunization added"/>
      <definition
                  value="Indicates that a new immunization has been added to the patient's chart in the EHR"/>
    </concept>
    <concept>
      <code value="modified-immunization"/>
      <display value="Existing immunization record has been modified"/>
      <definition
                  value="Indicates that an existing immunization record in the patient's chart has been modified. Sometimes this is equivalent to removing an existing immunization record (which may have been entered in error) and adding a new immunization record."/>
    </concept>
  </concept>
  <concept>
    <code value="demographic-change"/>
    <display value="Indicates change in patient demographics"/>
    <definition
                value="Indicates that the Patient demographic attributes such as Date of Birth, Race, Ethnicity, Deceased date, Address, Telecom, Names have changed. Demographic change events would be triggered by monitoring the Patient resource."/>
  </concept>
  <concept>
    <code value="received-public-health-report"/>
    <display value="Indicates receipt of a public health report"/>
    <definition
                value="Indicates that a public health report was submitted and received by a specific system. This event could trigger downstream processing and hence is designated as a named event."/>
  </concept>
  <concept>
    <code value="received-public-health-response"/>
    <display
             value="Indicates receipt of a public health response for a submitted public health report"/>
    <definition
                value="Indicates that a public health response was received by a specific system for an already submitted public health report. This event could trigger downstream processing and hence is designated as a named event."/>
  </concept>
  <concept>
    <code value="manual-notification"/>
    <display
             value="A Practitioner or their representatives notify the application about change in patient data"/>
    <definition
                value="In some cases where automated notifications are not supported, a practitioner or their representative can initiate the public health report processing by notifying the application about change in a patient's data."/>
  </concept>
  <concept>
    <code value="timer-event"/>
    <display value="A Timer is setup to kick off processing."/>
    <definition
                value="Indicates a timer based approach to start processing."/>
    <concept>
      <code value="periodic-timer"/>
      <display value="Setup Periodic Timer"/>
      <definition
                  value="Indicates that processing must be performed periodically based on a specified duration."/>
    </concept>
    <concept>
      <code value="absolute-timer"/>
      <display value="Setup Absolute Timer"/>
      <definition
                  value="Indicates that processing must be performed at a specific time."/>
    </concept>
  </concept>
</CodeSystem>