HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
1.1.0 - STU 2 Ballot

This page is part of the electronic Case Reporting (eCR) (v1.1.0: STU 2 on FHIR R4 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

Artifacts Summary

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

US Public Health Profiles

US Public Health Emergency Outbreak Information

This profile represents information that is required during a public health emergency/outbreak. This information can be highly variable, so a generic structure has been chosen to represent it.

US Public Health Encounter

This Encounter profile represents the encounter related to the event.

US Public Health Exposure Information

This Observation profile represents potential patient exposure and contact information.

US Public Health Location

This Location profile represents the location/facility in which care was provided.

US Public Health Organization

This Organization profile represents an organization involved in public health.

US Public Health Patient

This Patient profile represents a US Public Health Patient.

US Public Health PlanDefinition

This profile describes the US Public Health PlanDefinition.

US Public Health Practitioner Role

This PractitionerRole profile represents the roles and organizations a practitioner involved in public health is associated with.

US Public Health Procedure

This Procedure profile defines constraints on the US Core Procedure profile for US Public Health use cases.

US Public Health Value Set

This profile describes the US Public Health value sets.

US Public Health Transportation Details

This Observation profile represents transportation details such as the type of transport (plane, train, ship, etc.) along with any associated information (e.g. name of cruise ship, flight number, airport, seat number, cabin number, etc.).

US Public Health Specification Bundle

This Bundle profile represents an US Public Health Specification Bundle.

Usage Warning

An extra warning about the correct use of the value set.

US Public Health Supplemental Bundle

This Bundle profile represents a US Public Health Supplemental Bundle.

US Public Health Computable ValueSet

Defines a computable value set as one that SHALL have an expression-based definition (i.e. a value set defined intensionally using expressions of the code systems involved) and MAY have an expansion included. The expression-based definition SHALL be represented in only one of three ways; using the compose element, using the expression extension, or using the rules-text extension to provide a step-by-step process for expanding the value set definition

US Public Health Computable Library

The computable library profile sets the minimum expectations for a computable CQL library.

US Public Health Executable Library

This profile sets the minimum expectations for an executable CQL library. Specifically, the profile requires that the library contain one of ELM XML or JSON content, the compiled representation of the CQL logic.

US Public Health Executable ValueSet

Defines an executable value set as one that SHALL have an expansion included, as well as a usage warning indicating the expansion is a point-in-time snapshot and must be maintained over time for production usage.

US Public Health Triggering Value Set

This profile describes the US Public Health Triggering value set.

US Public Health Triggering Valueset Library

Defines the library containing the US Public Health triggering value sets.

US Public Health Supplemental Value Set

This profile describes the US Public Health Supplemental value set.

US Public Health Supplemental Valueset Library

Defines the library containing the US Public Health supplemental value sets.

US Public Health Valueset Library

Defines the library containing US Public Health value sets.

US Public Health Exposure Contact Information Example: Football Game

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

US Public Health Alternative Expression Extension

This extension represents an US Public Health Alternative Expression

eICR Profiles

Characteristics of Home Environment

This Observation profile represents characteristics of the patient’s home environment.

Disability Status

This profile represents the Disability Element defined here: https://aspe.hhs.gov/basic-report/hhs-implementation-guidance-data-collection-standards-race-ethnicity-sex-primary-language-and-disability-status

eICR Composition

This Composition profile represents an electronic initial case report (eICR).

eICR Condition

This Condition profile represents the signs, symptoms, and diagnoses related to an eICR event.

eICR Document Bundle

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

eICR Initiation Reason Extension

This extension contains an explanation for the manual or alternate initiation of the eICR.

eICR ServiceRequest

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

Postpartum Status

This profile represents the postpartum status of a patient.

Pregnancy Outcome Observation

This profile represents a result of the pregnancy such as live birth, still birth, miscarriage, etc.

Pregnancy Status Observation

This profile represents current and/or prior pregnancy statuses and their date ranges, enabling investigators to determine if a patient was pregnant, possibly pregnant, not pregnant or whether the pregnancy status was unknown during a particular date range.

Travel History Observation

This Observation profile represents a patient’s travel history.

Location Example: City Football Stadium

Example of Location resource (City Football Stadium)

Reportability Response Profiles

RR Communication

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

RR Determination of Reportability Extension

This Extension profile represents the determination of reportability.

RR Determination of Reportability Reason Extension

This Extension profile represents the reason for the determination of reportability.

RR Determination of Reportability Rule Extension

This Extension profile represents a rule that led to the determination of reportability.

RR eICR Processing Status Extension

This Extension profile represents the eICR processing status.

RR eICR Processing Status Observation

This Observation profile represents the eICR processing status.

RR 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.

RR Relevant Reportable Condition Plandefinition

This PlanDefinition in the Reportability Response transaction represents reportability information for a condition-jurisdiction pair, based on the PHA in which is located the patient’s home, the provider facility or both locations.

RR Responsible Agency Organization

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

RR 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.

RR 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.

eRSD Profiles/Instances

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.

eRSD Specification Bundle

This Bundle profile represents an eRSD Specification Bundle. It contains the eRSD Specification.

eRSD Supplemental Bundle

This Bundle profile represents an eRSD Supplemental Bundle. It contains the eRSD Supplements.

FHIR Helpers Library

CQL FHIR Helpers Library

library-rctc

RCTC Library

eRSD PlanDefinition Instance: plandefinition-ersd-instance

Instance of eRSD PlanDefinition profile

Rule Filters

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

Transport Profiles

eCR Message Bundle

This Bundle profile represents an eICR Message Bundle.

eCR Message Header

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

eCR Task

This Task profile represents the state of completion of the eCR activity.

US Public Health Extensions

US Public Health Named Event Type

Indicates the types of named events to subscribe to from the EHR.

Extensions

Date Determined Extension

The date a status or observation was determined (date of determination).

Date Recorded Extension

The date a status or observation was recorded (recorded date).

eICR Initiation Type Extension

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

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.

Relates To Extension

This Extension profile represents relationships with other structures that already exist

RR eICR Receipt Time Extension

This Extension profile represents the date and time of eICR receipt

RR External Resource Type Extension

This Extension profile represents the type/category of one or more external resources.

RR Location Relevance Extension

This Extension profile represents a code indicating whether the responsible PHA is relevant because of the patient’s home address, the provider facility address, or both.

RR Priority Extension

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

RR Responsible Agency Organization Extension

This extension represents an RR Responsible Agency Organization

RR Routing Entity Organization Extension

This extension represents an RR Routing Entity Organization

RR Rules Authoring Agency Organization Extension

This extension represents an RR Rules Authoring Agency Organization

Therapeutic Medication Response Extension

This Extension profile represents represents a therapeutic response (as opposed to an undesired reaction) to the administration of a medication.

Travel History Address Extension

This Extension profile represents where the patient traveled to or visited as an address e.g.: country, state, city, street address (if applicable).

Tribal Affiliation Extension

This Extension profile represents an affiliated tribe name and whether or not the patient is an enrolled member

US Public Health Examples

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 Emergency Outbreak Information Example: Eve Everywoman

Example of Emergency Outbreak Information profile (Eve Everywoman)

US Public Health Procedure Example: ECMO

Example of US Public Health Procedure (ECMO)

US Public Health Transportation Example: Eve Everywoman

Example of US Public Health Transportation Example (Eve Everywoman)

PlanDefinition US Public Health Example

Example of US Public Health PlanDefinition profile

US Public Health ValueSet Library Example

Example of US Public Health ValueSet Library profile

USPublicHealthSpecificationBundleExample

An example of the US Public Health Specification Bundle

USPublicHealthSupplementalBundleExample

An example of the US Public Health Supplemental Bundle profile.

US Public Health Supplemental ValueSet Library Example

Description of library

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.

eICR Examples

Characteristics of Home Environment Example: Eve Everywoman

Example of Characteristics of Home Environment profile (Eve Everywoman)

eCR Message Bundle Example: bundle-ecr-message-zika

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

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-pertussis-zika

Example of eICR Document Bundle profile

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

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

eICR ServiceRequest Example

Example of eICR ServiceRequest profile

eICR ServiceRequest Example: Eve Everywoman - Zika

Example of eICR ServiceRequest profile (Eve Everywoman - zika

Immunication Example: immunization-ecr-pneumo

Example of US Core Immunization profile

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)

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

Example of Last Menstrual Period (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)

Postpartum Status Example: observation-postpartum-status-eve-everywoman

Example of Postpartum Status profile (Eve Everywoman)

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 Results Example: observation-us-core-results-eve-everywoman-lymphocytes

Example of US Core Results profile (Eve Everywoman, lymphocytes)

US Core Results Example: observation-us-core-results-eve-everywoman-pertussis

Example of US Core Results profile (Eve Everywoman: Pertussis)

Pregnancy Outcome Observation Example: Eve Everywoman

Example of Pregnancy Outcome Observation profile (Eve Everywoman)

Pregnancy Status Observation Example: Eve Everywoman

Example of Pregnancy Status Observation profile (Eve Everywoman)

US Core Practitioner Example: Henry Seven

Example of US Core Practitioner (Henry Seven)

Disability Status Example: Eve Everywoman

Example of Disability Status Profile (Eve Everywoman)

US Core Device Example: ECMO

Example of US Core Device Profile (ECMO)

Reportability Response Examples

RR Communication Collection Bundle Example: bundle-rr-collection-communication

Example of Reportability Response Communication collection bundle

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

RR Communication profile example: One condition, one PHA

Example of RR Communication profile (One condition, one PHA

RR Communication profile example: One condition, one PHA, with validation output

Example of RR Communication profile (One condition, one PHA, with validation output)

RR Relevant Reportable Condition PlanDefinition Example

Example of RR Relevant Reportable Condition PlanDefinition 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)

eRSD Examples

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 Supplemental Bundle example

This Bundle profile represents an eRSD Supplemental Bundle. It contains the eRSD Supplements.

eRSD Specification Bundle example

This Bundle profile represents an eRSD Specification Bundle. It contains the eRSD Specification.

Subscription Examples

subscription-dxtc

Example of Subscription resource (dxtc)

subscription-lotc

Example of Subscription resource (lotc)

subscription-ostc

Example of Subscription resource (ostc)

Transport Examples

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)

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)

eCR Task Example: task-ecr-ehr-requested-eicr

Example of eCR Task profile

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.

Terminology: Code Systems

Code System Task Business Status

This code system contains codes that describe the business status of a task.

eRSD Endpoint Connection Type

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

eRSD Jurisdictions Example

This code system describes jurisdictions that require public health reporting.

eRSD JurisdictionTypes

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

Executable Task Types Code System

This code system contains codes that describe the executable task types.

MessageHeader Event Code System

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

US Public Health TriggerDefinition Named Events

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 Type

This code system contains codes that identify the use context type of a valueset.

US Public Health Usage Context

This code system contains codes that identify the use context of a valueset.

Terminology: Value Sets

eCR MessageHeader Event

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

eRSD Endpoint Connection Type Codes

Set of endpoint connection types specified as being supported by APHL

Example ValueSet: 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 ValueSet: Immunizations Triggers for Public Health Reporting

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

Example ValueSet: Lab Observation 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 ValueSet: 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 ValueSet: 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 ValueSet: 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

Extended Pregnancy Status Value Set

Defines the status of pregnancy. Extended pregnancy status VSAC link

Pregnancy Status

This value set contains codes representing pregnancy statuses.

Value Set eCR Task BusinessStatus

This value set contains codes that describe the eCR task businessStatus.

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.

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: Example Instances

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

FHIR Model Definition

Model definition for the FHIR R4 (v4.0.1) Model

Other

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

expansion-parameters-ecr

References US SNOMED CT version.