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

HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm). This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

Table of Contents

..0 Table of Contents
...1 Home Page
...2 The Specification
...3 Transaction Profiles
....3.1 Electronic Initial Case Report (eICR) Transaction and Profiles
....3.2 Reportability Response (RR) Transaction and Profiles
....3.3 Electronic Reporting and Surveillance Distribution (eRSD) Transaction and Profiles
.....3.3.1 Subscription Service
....3.4 Transport Options
...4 Implementation Guidance
....4.1 Design Considerations
....4.2 eICR Data Elements
....4.3 Reportability Response Narrative Guidance
....4.4 eRSD Jurisdictions CodeSystem Query
....4.5 eRSD Jurisdictions CodeSystem Description
....4.6 eRSD PlanDefinition DataRequirement FHIR Queries
....4.7 Rule Filter Generation
...5 Relationship to Other Standards
...6 Terminology
...7 Acknowledgements
...8 Downloads
...9 Acronyms and Abbreviations
...10 Artifacts Summary
....10.1 eICR Composition
....10.2 eICR Country of Nationality Observation
....10.3 eICR Country of Residence Observation
....10.4 eICR Document Bundle
....10.5 eICR Encounter
....10.6 eICR Procedure
....10.7 eICR ServiceRequest
....10.8 eICR Vaccine Credential Patient Assertion Observation
....10.9 RR Composition
....10.10 RR Document Bundle
....10.11 RR DocumentReference
....10.12 RR eICR Processing Status Extension
....10.13 RR eICR Processing Status Observation
....10.14 RR eICR Processing Status Reason Observation
....10.15 RR Relevant Reportable Condition Observation
....10.16 RR Reportability Information Observation
....10.17 RR Responsible Agency Organization
....10.18 RR Routing Entity Organization
....10.19 RR Rules Authoring Agency Organization
....10.20 RR Summary
....10.21 eRSD PlanDefinition
....10.22 eRSD Supplemental Library
....10.23 Rule Filters Example Library
....10.24 Reportable Condition Trigger Codes (RCTC) Example Library
....10.25 eRSD PlanDefinition Instance Example
....10.26 eRSD PlanDefinition Instance Simple Example
....10.27 US Public Health Characteristics of Home Environment
....10.28 US Public Health Condition
....10.29 US Public Health Disability Status
....10.30 US Public Health Emergency Outbreak Information
....10.31 US Public Health Encounter
....10.32 US Public Health Endpoint
....10.33 US Public Health Exposure Contact Information
....10.34 US Public Health Location
....10.35 US Public Health Organization
....10.36 US Public Health Patient
....10.37 US Public Health Postpartum Status
....10.38 US Public Health Practitioner Role
....10.39 US Public Health Pregnancy Outcome Observation
....10.40 US Public Health Pregnancy Status Observation
....10.41 US Public Health Transportation Details
....10.42 US Public Health Travel History
....10.43 US Public Health MedicationAdministration
....10.44 US Public Health Laboratory Result Observation Profile
....10.45 US Public Health Alternative Expression Extension
....10.46 US Public Health CodeSystem
....10.47 US Public Health Composition
....10.48 US Public Health Computable Library
....10.49 US Public Health Computable ValueSet
....10.50 US Public Health Content Bundle
....10.51 US Public Health Document Bundle
....10.52 US Public Health Executable Library
....10.53 US Public Health Executable ValueSet
....10.54 US Public Health MessageHeader
....10.55 US Public Health PlanDefinition
....10.56 US Public Health Reporting Bundle
....10.57 US Public Health Specification Library
....10.58 US Public Health Supplemental Library
....10.59 US Public Health Supplemental Value Set
....10.60 US Public Health Supplemental Valueset Library
....10.61 US Public Health Triggering Value Set
....10.62 US Public Health Triggering Valueset Library
....10.63 US Public Health Value Set
....10.64 US Public Health Valueset Library
....10.65 eCR MessageHeader
....10.66 US Public Health Address Extension
....10.67 US Public Health CodeSystem Property Binding Extension
....10.68 US Public Health Data Encrypted Extension
....10.69 US Public Health Date Determined Extension
....10.70 US Public Health Date Recorded Extension
....10.71 US Public Health Determination of Reportability Extension
....10.72 US Public Health Determination of Reportability Reason Extension
....10.73 US Public Health Determination of Reportability Rule Extension
....10.74 US Public Health Expansion Parameters Extension
....10.75 US Public Health Information Recipient Extension
....10.76 US Public Health Initiation Reason Extension
....10.77 US Public Health Message Processing Category Extension
....10.78 US Public Health Named Event Type Extension
....10.79 US Public Health Receiver Address Extension
....10.80 US Public Health Related Data Extension
....10.81 US Public Health Tribal Affiliation Extension
....10.82 US Public Health Usage Warning Extension
....10.83 US Public Health FHIR Query Pattern Extension
....10.84 US Public Health Gender Identity Extension
....10.85 eICR Initiation Type Extension
....10.86 eICR Trigger Code Flag Extension
....10.87 RR eICR Receipt Time Extension
....10.88 RR External Resource Extension
....10.89 RR Priority Extension
....10.90 US Public Health Therapeutic Medication Response Extension
....10.91 Country of Nationality Observation Example: Eve Everywoman
....10.92 Country of Residence Observation Example: Eve Everywoman
....10.93 Device Example: ECMO
....10.94 Disability Status Example: Eve Everywoman
....10.95 eICR Composition Example: Initial Public Health Case Report - Eve Everywoman, Pertussis and Zika
....10.96 eICR Composition Example: Initial Public Health Case Report - Eve Everywoman, Zika
....10.97 eICR Composition Example: Initial Public Health Case Report - Eve Everywoman, Zika, Manual Initiation
....10.98 eICR Condition example: Eve Everywoman - diabetes
....10.99 eICR Condition example: Eve Everywoman - pertussis
....10.100 eICR Condition example: Eve Everywoman - zika
....10.101 eICR Condition example: Eve Everywoman- common cold
....10.102 eICR Document Bundle Example: bundle-eicr-document-zika
....10.103 eICR Procedure Example: ECMO
....10.104 eICR ServiceRequest Example
....10.105 eICR ServiceRequest Example: Eve Everywoman - Zika
....10.106 eICR Vaccine Credential Patient Assertion Observation Example: Eve Everywoman
....10.107 Immunization Example: immunization-ecr-pneumo
....10.108 Last Menstrual Period Example: observation-last-menstrual-period-eve-everywoman
....10.109 Location Example: City Football Stadium
....10.110 MedicationAdministration Example: Eve Everywoman, azithromycin
....10.111 MedicationAdministration Example: Eve Everywoman, naloxone response
....10.112 ODH Past or Present Job Example: observation-odh-past-or-present-job-eve-everywoman
....10.113 ODH Usual Work Example: observation-odh-usual-work-eve-everywoman
....10.114 Travel History Observation Example: observation-travel-history-eve-everywoman-1999
....10.115 Travel History Observation Example: observation-travel-history-eve-everywoman-201610
....10.116 Travel History Observation Example: observation-travel-history-eve-everywoman-201801
....10.117 US Core Practitioner Example: Henry Seven
....10.118 US Core Vital Sign Observation example
....10.119 US Public Health Reporting Bundle Example: bundle-ecr-message-zika
....10.120 ODH Employment Status Example: observation-odh-employment-status-ecr-eve-everywoman
....10.121 Observation RR Summary example
....10.122 Reportability Response - One Condition/One PHA with eICR Validation Output example
....10.123 Reportability Response Composition - One Condition/One PHA example
....10.124 RR Document Bundle Example: One Condition, One PHA
....10.125 RR DocumentReference example: Zika follow-up
....10.126 RR DocumentReference example: Zika info
....10.127 RR DocumentReference example: Additional reporting needs
....10.128 RR eICR Processing Status Example: observation-rr-eicr-processing-status
....10.129 RR eICR Processing Status Reason Example: observation-rr-eicr-processing-status-reason
....10.130 RR Relevant Reportable Condition Observation Example
....10.131 RR Reportability Information Observation Example
....10.132 RR Responsible Agency Organization Example: Health Authority West Responsible Agency
....10.133 RR Routing Entity Organization Example: Health Authority West Routing Entity
....10.134 RR Rules Authoring Agency Organization Example: Health Authority West Rules Authoring Agency
....10.135 Library Packaging
....10.136 eRSD Specification Bundle Example
....10.137 eRSD Supplemental Bundle Example
....10.138 eRSD PlanDefinition Instance NamedEvent Example
....10.139 eRSD Supplemental Library Example
....10.140 eRSD Specification Library Example
....10.141 subscription-dxtc
....10.142 subscription-lotc
....10.143 subscription-ostc
....10.144 eCR Device Example: device-ecr-software-ymca
....10.145 eCR MessageHeader Example: Requested eICR
....10.146 Endpoint Example: endpoint-ecr-salem-medical-center
....10.147 Endpoint Example: endpoint-ecr-ymca
....10.148 US Public Health Characteristics of Home Environment Example: Eve Everywoman
....10.149 US Public Health PlanDefinition Example
....10.150 US Public Health Lab Result Observation Example: observation-us-ph-lab-result-eve-everywoman-lymphocytes
....10.151 US Core Results Example: observation-us-ph-lab-result-eve-everywoman-pertussis
....10.152 US PH Encounter Example: encounter-eicr-eve-everywoman-completed-inpatient
....10.153 US PH Encounter Example: encounter-eicr-eve-everywoman-current-inpatient
....10.154 US PH Encounter Example: encounter-eicr-eve-everywoman-external-encounter
....10.155 US PH Encounter Example: encounter-eicr-eve-everywoman-external-historical
....10.156 US PH Encounter Example: encounter-eicr-eve-everywoman-outpatient
....10.157 US PH Location Example: Clinic Bldg A, Salem Medical Center
....10.158 US PH Organization Example: Acme Labs
....10.159 US PH Organization Example: Health Authority West
....10.160 US PH Organization Example: Salem Medical Center
....10.161 US PH Organization Example: YMCA
....10.162 US PH Patient Example: Eve Everywoman
....10.163 US PH PractitionerRole Example: Henry Seven
....10.164 US Public Health Emergency Outbreak Information Example: Eve Everywoman
....10.165 US Public Health Exposure Contact Information Example: Football Game
....10.166 US Public Health Postpartum Status Example: observation-postpartum-status-eve-everywoman
....10.167 US Public Health Pregnancy Outcome Observation Example: Eve Everywoman
....10.168 US Public Health Pregnancy Status Observation Example: Eve Everywoman
....10.169 US Public Health Specification Library Example
....10.170 US Public Health Supplemental Library Example
....10.171 US Public Health Supplemental ValueSet Library Example
....10.172 US Public Health Transportation Example: Eve Everywoman
....10.173 US Public Health ValueSet Library Example
....10.174 US Public Health ValueSet Library Expansion Parameters Example
.....10.174.1 Parameters
....10.175 US Public Health Message Types CodeSystem
....10.176 US Public Health PlanDefinition Action Codes
....10.177 US Public Health TriggerDefinition Named Events
....10.178 US Public Health Usage Context
....10.179 US Public Health Usage Context Type
....10.180 US Public Health Message Significance Category
....10.181 US Public Health Message Types ValueSet
....10.182 US Public Health PlanDefinition Action
....10.183 US Public Health ValueSet Priority
....10.184 US Public Health Pregnancy Status
....10.185 US Public Health TriggerDefinition NamedEvent
....10.186 eRSD Endpoint Connection Type
....10.187 eRSD JurisdictionTypes
....10.188 MessageHeader Event Code System
....10.189 eCR MessageHeader Event
....10.190 Chlamydia Example
....10.191 eRSD Endpoint Connection Type Codes
....10.192 Extended Pregnancy Status Value Set
....10.193 eRSD Jurisdictions Example
....10.194 Example Procedure Triggers for Public Health Reporting
....10.195 Example ValueSet: Diagnosis Problem Triggers for Public Health Reporting
....10.196 Example ValueSet: Lab Observation Test Name Triggers for Public Health Reporting
....10.197 Example ValueSet: Lab Order Test Triggers for Public Health Reporting
....10.198 Example ValueSet: Medications Triggers for Public Health Reporting
....10.199 Example ValueSet: Suspected Disorder Triggers for Public Health Reporting
....10.200 Example ValueSet: Organism Substance Triggers for Public Health Reporting
....10.201 US Public Health Supplemental Valueset Example
....10.202 US Public Health Computable Valueset Example
....10.203 US Public Health Valueset Example
....10.204 eCR CapabilityStatement
....10.205 eRSD Client CapabilityStatement
....10.206 expansion-parameters-ecr