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

CapabilityStatement: eCR CapabilityStatement

Official URL: http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ecr Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: CapabilityStatement_eCR
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.13.1

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

Raw OpenAPI-Swagger Definition file | Download

Capability Statement eCR

  • Implementation Guide Version: 3.0.0-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: application/xml, application/json
  • Published on: 2019-06-25
  • Published by: HL7 International / Public Health

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

  • http://hl7.org/fhir/us/ecr/ImplementationGuide/hl7-fhir-us-ecr

FHIR RESTful Capabilities

REST Configuration: 1

Mode: server

This section describes the expected capabilities for the server participating in eCR exchange.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCDSearches_include_revincludeOperations
CompositionSupported Profiles
  Electronic Initial Case Report Compositionversion: 3.0.0-ballot)
  RR Compositionversion: 3.0.0-ballot)		yyyy
OrganizationSupported Profiles
  US Public Health Organizationversion: 2.0.0)
  Responsible Agency Organizationversion: 3.0.0-ballot)
  Rules Authoring Agency Organizationversion: 3.0.0-ballot)
  Routing Entity Organizationversion: 3.0.0-ballot)		yyyy
Encounterhttp://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-encounter|2.0.0yyyy
Locationhttp://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-location|2.0.0yyyy
ObservationSupported Profiles
  US Public Health Travel Historyversion: 2.0.0)
  eICR Processing Status Reason Observationversion: 3.0.0-ballot)
  eICR Processing Status Observationversion: 3.0.0-ballot)
  US Public Health Pregnancy Outcome Observationversion: 2.0.0)
  US Public Health Pregnancy Status Observationversion: 2.0.0)
  http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-postpartum-status
  RR Relevant Reportable Condition Observationversion: 3.0.0-ballot)
  RR Summaryversion: 3.0.0-ballot)
  RR Reportability Information Observationversion: 3.0.0-ballot)		yyyy
Patienthttp://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-patient|2.0.0yyyy
PractitionerRolehttp://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-practitionerrole|2.0.0yyyy
ServiceRequesthttp://hl7.org/fhir/us/ecr/StructureDefinition/eicr-servicerequest|3.0.0-ballotyyyy
BundleSupported Profiles
  eICR Document Bundleversion: 3.0.0-ballot)
  RR Document Bundleversion: 3.0.0-ballot)
  US Public Health Reporting Bundleversion: 2.0.0)		yyyy
MessageHeaderhttp://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheader|3.0.0-ballotyyyy
Practitionerhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|6.1.0yyyy
Resource Conformance: supported Composition
Core FHIR Resource
Composition
Reference Policy
Interaction summary
  • Supports
    create

    Allows creation of Composition instances

    read

    Allows retrieval of a specific Composition instance

    update

    Allows update of Composition instances

    delete

    Allows deletion of Composition instances

Supported Profiles

Electronic Initial Case Report Compositionversion: 3.0.0-ballot)
RR Compositionversion: 3.0.0-ballot)

Resource Conformance: supported Organization
Core FHIR Resource
Organization
Reference Policy
Interaction summary
  • Supports
    create

    Allows creation of Organization instances

    read

    Allows retrieval of a specific Organization instance

    update

    Allows update of Organization instances

    delete

    Allows deletion of Organization instances

Supported Profiles

US Public Health Organizationversion: 2.0.0)
Responsible Agency Organizationversion: 3.0.0-ballot)
Rules Authoring Agency Organizationversion: 3.0.0-ballot)
Routing Entity Organizationversion: 3.0.0-ballot)

Resource Conformance: supported Encounter
Base System Profile
US Public Health Encounterversion: 2.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of Encounter instances

    read

    Allows retrieval of a specific Encounter instance

    update

    Allows update of Encounter instances

    delete

    Allows deletion of Encounter instances

Resource Conformance: supported Location
Base System Profile
US Public Health Locationversion: 2.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of Location instances

    read

    Allows retrieval of a specific Location instance

    update

    Allows update of Location instances

    delete

    Allows deletion of Location instances

Resource Conformance: supported Observation
Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • Supports
    create

    Allows creation of Observation instances

    read

    Allows retrieval of a specific Observation instance

    update

    Allows update of Observation instances

    delete

    Allows deletion of Observation instances

Supported Profiles

US Public Health Travel Historyversion: 2.0.0)
eICR Processing Status Reason Observationversion: 3.0.0-ballot)
eICR Processing Status Observationversion: 3.0.0-ballot)
US Public Health Pregnancy Outcome Observationversion: 2.0.0)
US Public Health Pregnancy Status Observationversion: 2.0.0)
http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-postpartum-status
RR Relevant Reportable Condition Observationversion: 3.0.0-ballot)
RR Summaryversion: 3.0.0-ballot)
RR Reportability Information Observationversion: 3.0.0-ballot)

Resource Conformance: supported Patient
Base System Profile
US Public Health Patientversion: 2.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of Patient instances

    read

    Allows retrieval of a specific Patient instance

    update

    Allows update of Patient instances

    delete

    Allows deletion of Patient instances

Resource Conformance: supported PractitionerRole
Base System Profile
US Public Health PractitionerRoleversion: 2.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of PractitionerRole instances

    read

    Allows retrieval of a specific PractitionerRole instance

    update

    Allows update of PractitionerRole instances

    delete

    Allows deletion of PractitionerRole instances

Resource Conformance: supported ServiceRequest
Base System Profile
eICR ServiceRequestversion: 3.0.0-ballot)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of ServiceRequest instances

    read

    Allows retrieval of a specific ServiceRequest instance

    update

    Allows update of ServiceRequest instances

    delete

    Allows deletion of ServiceRequest instances

Resource Conformance: supported Bundle
Core FHIR Resource
Bundle
Reference Policy
Interaction summary
  • Supports
    create

    Allows creation of Bundle instances

    read

    Allows retrieval of a specific Bundle instance

    update

    Allows update of Bundle instances

    delete

    Allows deletion of Bundle instances

Supported Profiles

eICR Document Bundleversion: 3.0.0-ballot)
RR Document Bundleversion: 3.0.0-ballot)
US Public Health Reporting Bundleversion: 2.0.0)

Resource Conformance: supported MessageHeader
Base System Profile
eCR MessageHeaderversion: 3.0.0-ballot)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of MessageHeader instances

    read

    Allows retrieval of a specific MessageHeader instance

    update

    Allows update of MessageHeader instances

    delete

    Allows deletion of MessageHeader instances

Resource Conformance: supported Practitioner
Base System Profile
US Core Practitioner Profileversion: 6.1.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of Practitioner instances

    read

    Allows retrieval of a specific Practitioner instance

    update

    Allows update of Practitioner instances

    delete

    Allows deletion of Practitioner instances

REST Configuration: 2

Mode: client

This section describes the expected capabilities for the client participating in eCR exchange.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCDSearches_include_revincludeOperations
CompositionSupported Profiles
  Electronic Initial Case Report Compositionversion: 3.0.0-ballot)
  RR Compositionversion: 3.0.0-ballot)		yyyy
OrganizationSupported Profiles
  US Public Health Organizationversion: 2.0.0)
  Responsible Agency Organizationversion: 3.0.0-ballot)
  Rules Authoring Agency Organizationversion: 3.0.0-ballot)
  Routing Entity Organizationversion: 3.0.0-ballot)		yyyy
Encounterhttp://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-encounter|2.0.0yyyy
Locationhttp://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-location|2.0.0yyyy
ObservationSupported Profiles
  US Public Health Travel Historyversion: 2.0.0)
  eICR Processing Status Reason Observationversion: 3.0.0-ballot)
  eICR Processing Status Observationversion: 3.0.0-ballot)
  US Public Health Pregnancy Outcome Observationversion: 2.0.0)
  US Public Health Pregnancy Status Observationversion: 2.0.0)
  http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-postpartum-status
  RR Relevant Reportable Condition Observationversion: 3.0.0-ballot)
  RR Summaryversion: 3.0.0-ballot)
  RR Reportability Information Observationversion: 3.0.0-ballot)		yyyy
Patienthttp://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-patient|2.0.0yyyy
PractitionerRolehttp://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-practitionerrole|2.0.0yyyy
ServiceRequesthttp://hl7.org/fhir/us/ecr/StructureDefinition/eicr-servicerequest|3.0.0-ballotyyyy
BundleSupported Profiles
  eICR Document Bundleversion: 3.0.0-ballot)
  RR Document Bundleversion: 3.0.0-ballot)
  US Public Health Reporting Bundleversion: 2.0.0)		yyyy
MessageHeaderhttp://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheader|3.0.0-ballotyyyy
Practitionerhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|6.1.0yyyy
Resource Conformance: supported Composition
Core FHIR Resource
Composition
Reference Policy
Interaction summary
  • Supports
    create

    Allows creation of Composition instances

    read

    Allows retrieval of a specific Composition instance

    update

    Allows update of Composition instances

    delete

    Allows deletion of Composition instances

Supported Profiles

Electronic Initial Case Report Compositionversion: 3.0.0-ballot)
RR Compositionversion: 3.0.0-ballot)

Resource Conformance: supported Organization
Core FHIR Resource
Organization
Reference Policy
Interaction summary
  • Supports
    create

    Allows creation of Organization instances

    read

    Allows retrieval of a specific Organization instance

    update

    Allows update of Organization instances

    delete

    Allows deletion of Organization instances

Supported Profiles

US Public Health Organizationversion: 2.0.0)
Responsible Agency Organizationversion: 3.0.0-ballot)
Rules Authoring Agency Organizationversion: 3.0.0-ballot)
Routing Entity Organizationversion: 3.0.0-ballot)

Resource Conformance: supported Encounter
Base System Profile
US Public Health Encounterversion: 2.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of Encounter instances

    read

    Allows retrieval of a specific Encounter instance

    update

    Allows update of Encounter instances

    delete

    Allows deletion of Encounter instances

Resource Conformance: supported Location
Base System Profile
US Public Health Locationversion: 2.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of Location instances

    read

    Allows retrieval of a specific Location instance

    update

    Allows update of Location instances

    delete

    Allows deletion of Location instances

Resource Conformance: supported Observation
Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • Supports
    create

    Allows creation of Observation instances

    read

    Allows retrieval of a specific Observation instance

    update

    Allows update of Observation instances

    delete

    Allows deletion of Observation instances

Supported Profiles

US Public Health Travel Historyversion: 2.0.0)
eICR Processing Status Reason Observationversion: 3.0.0-ballot)
eICR Processing Status Observationversion: 3.0.0-ballot)
US Public Health Pregnancy Outcome Observationversion: 2.0.0)
US Public Health Pregnancy Status Observationversion: 2.0.0)
http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-postpartum-status
RR Relevant Reportable Condition Observationversion: 3.0.0-ballot)
RR Summaryversion: 3.0.0-ballot)
RR Reportability Information Observationversion: 3.0.0-ballot)

Resource Conformance: supported Patient
Base System Profile
US Public Health Patientversion: 2.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of Patient instances

    read

    Allows retrieval of a specific Patient instance

    update

    Allows update of Patient instances

    delete

    Allows deletion of Patient instances

Resource Conformance: supported PractitionerRole
Base System Profile
US Public Health PractitionerRoleversion: 2.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of PractitionerRole instances

    read

    Allows retrieval of a specific PractitionerRole instance

    update

    Allows update of PractitionerRole instances

    delete

    Allows deletion of PractitionerRole instances

Resource Conformance: supported ServiceRequest
Base System Profile
eICR ServiceRequestversion: 3.0.0-ballot)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of ServiceRequest instances

    read

    Allows retrieval of a specific ServiceRequest instance

    update

    Allows update of ServiceRequest instances

    delete

    Allows deletion of ServiceRequest instances

Resource Conformance: supported Bundle
Core FHIR Resource
Bundle
Reference Policy
Interaction summary
  • Supports
    create

    Allows creation of Bundle instances

    read

    Allows retrieval of a specific Bundle instance

    update

    Allows update of Bundle instances

    delete

    Allows deletion of Bundle instances

Supported Profiles

eICR Document Bundleversion: 3.0.0-ballot)
RR Document Bundleversion: 3.0.0-ballot)
US Public Health Reporting Bundleversion: 2.0.0)

Resource Conformance: supported MessageHeader
Base System Profile
eCR MessageHeaderversion: 3.0.0-ballot)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of MessageHeader instances

    read

    Allows retrieval of a specific MessageHeader instance

    update

    Allows update of MessageHeader instances

    delete

    Allows deletion of MessageHeader instances

Resource Conformance: supported Practitioner
Base System Profile
US Core Practitioner Profileversion: 6.1.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    create

    Allows creation of Practitioner instances

    read

    Allows retrieval of a specific Practitioner instance

    update

    Allows update of Practitioner instances

    delete

    Allows deletion of Practitioner instances