Electronic Case Reporting (eCR)
3.0.0-ballot - STU 3 - Ballot United States of America flag

Electronic Case Reporting (eCR), published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot 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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

eCR CapabilityStatement

This resource defines the expected capabilities for both client and server participating in eCR exchange

eRSD Client CapabilityStatement

This section describes the expected capabilities of a client consuming eRSD resources including the Reportable Conditions Trigger Codes (RCTC).

Conformance requirements for an eRSD Client

The eRSD Client SHALL:

  • Support fetching the eRSD Bundle using the supported RESTful interactions.
  • Support processing PlanDefinition and ValueSet resources that are included in the Bundle.

The eRSD Client MAY:

  • Support fetching and reading a Person resource.
  • Support fetching and reading Subscription resources associated with a Person.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

Library Packaging

Packages the contents referenced by an asset-collection library such as a quality program release or version manifest.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Electronic Initial Case Report Composition

This Composition profile represents an electronic initial case report (eICR). It is based on and further constrains the US Public Health Composition.

RR Composition

This Composition profile represents the Reportability Response that is created in response to an electronic Initial Case Report Composition.

RR Document Bundle

This Bundle profile represents an RR Document Bundle. It contains an RR Composition.

RR DocumentReference

This profile represents external resources such as a text guidance, link to access forms for additional reporting needs, additional testing and/or laboratory testing needs, treatment and/or prevention resources, Public Health Agency contact information and general additional resources.

RR Relevant Reportable Condition Observation

This profile represents a relevant reportable condition.

RR Reportability Information Observation

This profile represents reportability information based on the PHA in which is located the patient's home, the provider facility, or both locations.

RR Summary

This profile contains a detailed textual description of the reportable condition(s), including actions the provider needs to take, any supplemental information that may be required, and where the initial case report was sent.

Responsible Agency Organization

This Organization profile represents the Responsible Agency which is a PHA to which reporting is legally required.

Routing Entity Organization

This Organization profile represents the Routing Entity which is a PHA or other organization identified by the PHA (such as an HIE) to which the eICR and/or the Reportability Response will be provided immediately following the creation of the Reportability Response.

Rules Authoring Agency Organization

This Organization profile represents the Rules Authoring Agency which is the originator of the rules that are being executed in decision support to determine reportability.

eCR MessageHeader

This MessageHeader profile represents metadata to support the eCR messaging paradigm.

eICR Country of Nationality

This Observation profile represents the patient's country of nationality.

eICR Country of Residence

This Observation profile represents the patient's country of usual residence.

eICR Document Bundle

This Bundle profile represents an eCR Document Bundle. It contains an eICR Composition.

eICR Encounter

This Encounter profile represents the encounter related to the event. It is based on the US Public Health Encounter profile.

eICR Procedure

This Procedure profile defines constraints on the US Core Procedure profile for the eICR use case.

eICR Processing Status Observation

This Observation profile represents the eICR processing status.

eICR Processing Status Reason Observation

This Observation profile represents, if the incoming eICR was not successfully processed for a determination of reportability, the reason it was not processed.

eICR ServiceRequest

This ServiceRequest profile represents eICR laboratory orders and other diagnostics for the eICR event.

eICR Vaccine Credential Patient Assertion

This Observation profile represents whether or not the patient has asserted that they have verifiable vaccine credentials.

eRSD PlanDefinition

This PlanDefinition profile defines the logic and rules around determining: whether or not a condition is reportable to public health, which jurisdiction(s) is/are responsible, which jurisdiction(s) need to be notified, and if the condition is reportable, gives timing information, next steps and condition information to the clinician. The rules for determining reportability described by an eRSD specification involve the use of triggering codes to determine potentially reportable events, and optionally locally evaluated rules for determining suspected reportable events. The final determination of reportability is made by the Public Health Agency or Agencies appropriate for the event, and may be performed by a combination of decisions occurring at various points during the processing of an eICR, as explained in the Reportability Response profile.

eRSD Supplemental Library

Defines the asset-collection library containing the eRSD supplemental assets.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

RR External Resource Extension

This Extension profile represents an external resource (DocumentReference) pertaining to the condition such as a text guidance, link to access forms for additional reporting needs, additional testing and/or laboratory testing needs, treatment and/or prevention resources, Public Health Agency contact information and general additional resources.

Reportability Response Priority Extension

This Extension profile represents the priority given to the whole composition or one or more external resources.

eICR Initiation Type Extension

This Extension profile represents that the eICR, was either manually or alternately initiated by the provider.

eICR Processing Status Extension

This Extension profile represents the eICR processing status.

eICR Receipt Time Extension

This Extension profile represents the date and time of eICR receipt

eICR Trigger Code Flag Extension

This Extension profile represents a flag which, if it is present, indicates that the target reference represents a triggering event and caused the eCR to be generated.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Example Chlamydia Lab Obs Test Name Triggers for Public Health Reporting

This example set of values contains laboratory observations test names that represent that the patient may have the potentially reportable condition of Chlamydia regardless of the clinical presentation of the condition

Example Diagnosis Problem Triggers for Public Health Reporting

This example set of values contains diagnoses or problems that represent that the patient may have a potentially reportable condition regardless of the clinical presentation of the condition

Example Lab Obs Test Name Triggers for Public Health Reporting

This example set of values contains laboratory observations test names that represent that the patient may have a potentially reportable condition regardless of the clinical presentation of the condition

Example Lab Order Test Triggers for Public Health Reporting

This example set of values contains laboratory test names for orders that represent that the patient may have a potentially reportable condition regardless of the clinical presentation of the condition

Example Medications Triggers for Public Health Reporting

This example set of values contains CVX, RXNORM,and SNOMED medication codes that may represent that the patient may have a potentially reportable condition. These pertain to medications administered and medications prescribed, where the medication, coded in CVX,RXNORM,SNOMED, may be indicative of a reportable condition.

Example Organism Substance Triggers for Public Health Reporting

This example set of values contains organism and substance names that represent that the patient may have a potentially reportable condition regardless of the clinical presentation of the condition

Example Procedure Triggers for Public Health Reporting

This example set of values contains procedure names for orders that represent that the patient may have a received a procedure or that a procedure has been requested.

Example Suspected Disorder Triggers for Public Health Reporting

This example set of values contains suspected diagnoses or problems that represent that the patient may have a potentially reportable condition. For example, these may be diagnoses recorded in an EHR problem list and diagnosis codes used for billing for the encounter.

US Public Health Computable ValueSet Example

ACME Codes for Cholesterol: Plasma only

US Public Health Message Significance Category

The impact of the content of a message.

US Public Health Message Types ValueSet

The US Public Health Message Types Value Set is a 'starter set' of codes for uniquely identifying messages in MessageHeader instances contained within a reporting bundle.

US Public Health PlanDefinition Action

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

US Public Health Pregnancy Status

This value set contains codes representing pregnancy statuses.

US Public Health Supplemental Valueset Example

This valueset is a simplified duplicate of the eRSD Endpoint Connection Type valueset created for the purposes of demonstraing, by example, the US Public Health Supplemental ValueSet profile.

US Public Health TriggerDefinition NamedEvent

The US Public Health TriggerDefinition NamedEvent Value Set is a 'starter set' of codes for identifying named events uniquely in TriggerDefinition instances contained within a PlanDefinition.

US Public Health ValueSet Chlamydia Example

This example set of values contains laboratory observations test names that represent Chlamydia tests

US Public Health ValueSet Priority

This value set contains codes representing release priority for ValueSets.

eCR MessageHeader Event Value Set

This value set contains codes that identify the event an eCR message represents.

eRSD Endpoint Connection Type Codes

Set of endpoint connection types

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

MessageHeader Event Code System

This code system contains codes that identify the event a message represents.

US Public Health Message Types CodeSystem

The US Public Health Message Types CodeSystem is a 'starter set' of codes supported for identifying types of messages being exchanged.

US Public Health PlanDefinition Action Codes

The US Public Health PlanDefinition Actions CodeSystem is a 'starter set' of codes supported for identifying actions in PlanDefinition.

US Public Health TriggerDefinition NamedEvents

The US Public Health TriggerDefinition NamedEvents CodeSystem is a 'starter set' of codes supported for identifying named events to subscribe to in clinical workflows.

US Public Health Usage Context

This code system contains codes that identify the use context of a ValueSet or Library.

US Public Health Usage Context Type

This code system contains codes that identify the use context type of a ValueSet or Library.

eRSD Endpoint Connection Type

This code system contains codes that identify the HL7 FHIR File type.

eRSD JurisdictionTypes

This code system describes the possible types of jurisdictions that require public health reporting.

eRSD Jurisdictions Example

This code system describes jurisdictions that require public health reporting.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Country of Nationality Observation Example: Eve Everywoman

Example of Country of Nationality Observation

Country of Residence Observation Example: Eve Everywoman

Example of Country of Residence Observation

Device Example: ECMO

Example of Device Profile (ECMO)

Disability Status Example: Eve Everywoman

Example of Disability Status Profile (Eve Everywoman)

Endpoint Example: endpoint-ecr-salem-medical-center

Example of Endpoint resource (Salem Medical Center endpoint)

Endpoint Example: endpoint-ecr-ymca

Example of Endpoint resource (YMCA endpoint)

Immunization Example: immunization-ecr-pneumo

Example of US Core Immunization profile

Last Menstrual Period Example: observation-last-menstrual-period-eve-everywoman

Example of Last Menstrual Period (Eve Everywoman)

Location Example: City Football Stadium

Example of Location resource (City Football Stadium)

MedicationAdministration Example: Eve Everywoman, azithromycin

Example of MedicationAdministration resource (Eve Everywoman, azithromycin)

MedicationAdministration Example: Eve Everywoman, naloxone response

Example of MedicationAdministration resource with Therapeutic Medication Response extension (Eve Everywoman: naloxone response)

ODH Employment Status Example: observation-odh-employment-status-ecr-eve-everywoman

Example of ODH Employment Status profile (Eve Everywoman)

ODH Past or Present Job Example: observation-odh-past-or-present-job-eve-everywoman

Example of ODH Past or Present Job profile (Eve Everywoman)

ODH Usual Work Example: observation-odh-usual-work-eve-everywoman

Example of ODH Usual Work profile (Eve Everywoman)

Observation RR Summary example

Example of RR Summary profile.

RR Document Bundle Example: One Condition, One PHA

Example RR Document Bundle: One Condition, One PHA

RR DocumentReference example: Additional reporting needs

Example of RR DocumentReference profile: Additional reporting needs

RR DocumentReference example: Zika follow-up

Example of RR DocumentReference profile: Zika follow-up

RR DocumentReference example: Zika info

Example of RR DocumentReference profile: Zika info

RR Relevant Reportable Condition Observation Example

Example of RR Relevant Reportable Condition Observation profile

RR Reportability Information Observation Example

Example of RR Reportability Information Observation profile

RR Responsible Agency Organization Example: Health Authority West Responsible Agency

Example of RR Responsible Agency Organization profile (Health Authority West Responsible Agency)

RR Routing Entity Organization Example: Health Authority West Routing Entity

Example of RR Routing Entity Organization Example profile (Health Authority West Routing Entity)

RR Rules Authoring Agency Organization Example: Health Authority West Rules Authoring Agency

Example of RR Rules Authoring Agency profile (Health Authority West Rules Authoring Agency)

RR eICR Processing Status Example: observation-rr-eicr-processing-status

Example of RR eCIR Processing Status Observation profile

RR eICR Processing Status Reason Example: observation-rr-eicr-processing-status-reason

Example of RR eICR Processing Status Reason Observation profile

Reportability Response - One Condition/One PHA with eICR Validation Output example

Example of Reportability Response Composition - One Condition/One PHA with eICR Validation Output

Reportability Response Composition - One Condition/One PHA example

Example of Reportability Response Composition - One Condition/One PHA

Reportable Condition Trigger Codes (RCTC) Example Library

This release includes code updates for the existing conditions and adds codes for Parkinson’s disease and 13 enteric conditions. Medication codes have also been added to this version.

Rule Filters Example Library

An example library with logic for determining whether or not an event or situation is reportable.

Travel History Observation Example: observation-travel-history-eve-everywoman-1999

Example of Travel History Observation profile (Eve Everywoman)

Travel History Observation Example: observation-travel-history-eve-everywoman-201610

Example of Travel History Observation profile (Eve Everywoman - October 2016)

Travel History Observation Example: observation-travel-history-eve-everywoman-201801

Example of Travel History Observation profile (Eve Everywoman - January 2018)

US Core Practitioner Example: Henry Seven

Example of US Core Practitioner (Henry Seven)

US Core Results Example: observation-us-ph-lab-result-eve-everywoman-pertussis

Example of US Public Health Lab Result profile (Eve Everywoman: Pertussis)

US Core Vital Sign Observation example

An example of the US Core Vital Sign Observation profile.

US PH Encounter Example: encounter-eicr-eve-everywoman-completed-inpatient

Example of US Public Health Encounter profile (Eve Everywoman: completed inpatient)

US PH Encounter Example: encounter-eicr-eve-everywoman-current-inpatient

Example of US Public Health Encounter profile (Eve Everywoman: current inpatient)

US PH Encounter Example: encounter-eicr-eve-everywoman-external-encounter

Example of US Public Health Encounter profile (Eve Everywoman, external encounter)

US PH Encounter Example: encounter-eicr-eve-everywoman-external-historical

Example of US Public Health Encounter profile (Eve Everywoman: external historical)

US PH Encounter Example: encounter-eicr-eve-everywoman-outpatient

Example of US Public Health Encounter profile (Eve Everywoman: outpatient)

US PH Location Example: Clinic Bldg A, Salem Medical Center

Example of US Public Health profile (Salem Medical Center)

US PH Organization Example: Acme Labs

Example of US Public Health Organization profile (Acme Labs)

US PH Organization Example: Health Authority West

Example of US Public Health Organization profile (Health Authority West)

US PH Organization Example: Salem Medical Center

Example of US Public Health Organization profile (Salem Medical Center)

US PH Organization Example: YMCA

Example of US Public Health Organization profile

US PH Patient Example: Eve Everywoman

Example of US Public Health Patient profile (Eve Everywoman)

US PH PractitionerRole Example: Henry Seven

Example of US Public Health PractitionerRole profile (Henry Seven)

US Public Health Characteristics of Home Environment Example: Eve Everywoman

Example of Characteristics of Home Environment profile (Eve Everywoman)

US Public Health Emergency Outbreak Information Example: Eve Everywoman

Example of Emergency Outbreak Information profile (Eve Everywoman)

US Public Health Exposure Contact Information Example: Football Game

Example of US Public Health Exposure Contact Information (Football Game)

US Public Health Lab Result Observation Example: observation-us-ph-lab-result-eve-everywoman-lymphocytes

Example of US Public Health Lab Result profile (Eve Everywoman, lymphocytes)

US Public Health PlanDefinition Example

Example of US Public Health PlanDefinition profile

US Public Health Postpartum Status Example: observation-postpartum-status-eve-everywoman

Example of US Public Health Postpartum Status profile (Eve Everywoman)

US Public Health Pregnancy Outcome Observation Example: Eve Everywoman

Example of US Public Health Pregnancy Outcome Observation profile (Eve Everywoman)

US Public Health Pregnancy Status Observation Example: Eve Everywoman

Example of US Public Health Pregnancy Status Observation profile (Eve Everywoman)

US Public Health Reporting Bundle Example: bundle-ecr-message-zika

Example of eCR Message Bundle profile (Eve Everywoman, Zika)

US Public Health Specification Library Example

Example of the US Public Health Specification Library

US Public Health Supplemental Library Example

Example of the US Public Health Supplemental Library

US Public Health Supplemental ValueSet Library Example

An example of the US Public Health Supplemental ValueSet Library

US Public Health Transportation Example: Eve Everywoman

Example of US Public Health Transportation Example (Eve Everywoman)

US Public Health ValueSet Library Example

Example of US Public Health ValueSet Library profile

US Public Health ValueSet Library Expansion Parameters Example

An example of the US Public Health ValueSet Library

documentreference-rr-one-cond-one-pha
eCR Device Example: device-ecr-software-ymca

Example of Device resource (YMCA software)

eCR MessageHeader Example: Requested eICR

Example of eCR MessageHeader profile (Requested eICR)

eICR Composition Example: Initial Public Health Case Report - Eve Everywoman, Pertussis and Zika

Example of eICR Composition profile (Eve Everywoman, Pertussis and Zika)

eICR Composition Example: Initial Public Health Case Report - Eve Everywoman, Zika

Example of eICR Composition profile (Eve Everywoman, Zika)

eICR Composition Example: Initial Public Health Case Report - Eve Everywoman, Zika, Manual Initiation

Example of eICR Composition profile (Eve Everywoman, Zika, Manual Initiation)

eICR Condition example: Eve Everywoman - diabetes

Example of eICR Condition profile (Eve Everywoman: diabetes)

eICR Condition example: Eve Everywoman - pertussis

Example of eICR Condition profile (Eve Everywoman: pertussis)

eICR Condition example: Eve Everywoman - zika

Example of eICR Condition profile (Eve Everywoman: zika)

eICR Condition example: Eve Everywoman- common cold

Example of eICR Condition profile (Eve Everywoman: common cold)

eICR Document Bundle Example: bundle-eicr-document-zika

Example of eICR Document Bundle profile (Eve Everywoman, Zika)

eICR Procedure Example: ECMO

Example of eICR Procedure (ECMO)

eICR ServiceRequest Example

Example of eICR ServiceRequest profile

eICR ServiceRequest Example: Eve Everywoman - Zika

Example of eICR ServiceRequest profile (Eve Everywoman - zika

eICR Vaccine Credential Patient Assertion Observation Example: Eve Everywoman

Example of eICR Vaccine Credential Patient Assertion Observation

eRSD PlanDefinition Instance Example

An example eRSD PlanDefinition

eRSD PlanDefinition Instance NamedEvent Example

This PlanDefinition is a simplified duplicate of the eRSD PlanDefinition Instance created for the purposes of demonstrating by example the usage of the US Public Health Named Event extension.

eRSD PlanDefinition Instance Simple Example

An example ersd PlanDefinition

eRSD PlanDefinition Instance Simple Example

An example eRSD PlanDefinition

eRSD Specification Library Example

Description of library

eRSD Supplemental Library Example

Description of library

subscription-dxtc

Example of Subscription resource (dxtc)

subscription-lotc

Example of Subscription resource (lotc)

subscription-ostc

Example of Subscription resource (ostc)

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

eRSD Specification Bundle Example

An example eRSD Specification Bundle

eRSD Supplemental Bundle Example

An example eRSD Supplemental Bundle

expansion-parameters-ecr

References US SNOMED CT version.