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

This page is part of the electronic Case Reporting (eCR) (v2.1.2: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

CapabilityStatement: eCR CapabilityStatement

Official URL: http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ecr Version: 2.1.2
Active as of 2019-06-25 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

Generated Narrative: CapabilityStatement capabilitystatement-ecr

Capability Statement eCR

  • Implementation Guide Version: 2.1.2
  • FHIR Version: 4.0.1
  • Supported Formats: application/xml, application/json
  • Supported Patch Formats:
  • 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.

Summary of System-wide Interactions

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 Composition
  RR Composition		yyyy
OrganizationSupported Profiles
  US Public Health Organization
  Responsible Agency Organization
  Rules Authoring Agency Organization
  Routing Entity Organization		yyyy
Encounterhttp://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-encounteryyyy
Locationhttp://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-locationyyyy
ObservationSupported Profiles
  US Public Health Travel History
  eICR Processing Status Reason Observation
  eICR Processing Status Observation
  US Public Health Pregnancy Outcome Observation
  US Public Health Pregnancy Status Observation
  US Public Health Postpartum Status
  RR Relevant Reportable Condition Observation
  RR Summary
  RR Reportability Information Observation		yyyy
Patienthttp://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-patientyyyy
PractitionerRolehttp://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-practitionerroleyyyy
ServiceRequesthttp://hl7.org/fhir/us/ecr/StructureDefinition/eicr-servicerequestyyyy
BundleSupported Profiles
  eICR Document Bundle
  RR Document Bundle
  US Public Health Reporting Bundle		yyyy
MessageHeaderhttp://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheaderyyyy
Practitionerhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioneryyyy
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 Composition
RR Composition

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 Organization
Responsible Agency Organization
Rules Authoring Agency Organization
Routing Entity Organization

Resource Conformance: supported Encounter
Base System Profile
US Public Health Encounter
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 Location
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 History
eICR Processing Status Reason Observation
eICR Processing Status Observation
US Public Health Pregnancy Outcome Observation
US Public Health Pregnancy Status Observation
US Public Health Postpartum Status
RR Relevant Reportable Condition Observation
RR Summary
RR Reportability Information Observation

Resource Conformance: supported Patient
Base System Profile
US Public Health Patient
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 PractitionerRole
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 ServiceRequest
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 Bundle
RR Document Bundle
US Public Health Reporting Bundle

Resource Conformance: supported MessageHeader
Base System Profile
eCR MessageHeader
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 Profile
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.

Summary of System-wide Interactions

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 Composition
  RR Composition		yyyy
OrganizationSupported Profiles
  US Public Health Organization
  Responsible Agency Organization
  Rules Authoring Agency Organization
  Routing Entity Organization		yyyy
Encounterhttp://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-encounteryyyy
Locationhttp://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-locationyyyy
ObservationSupported Profiles
  US Public Health Travel History
  eICR Processing Status Reason Observation
  eICR Processing Status Observation
  US Public Health Pregnancy Outcome Observation
  US Public Health Pregnancy Status Observation
  US Public Health Postpartum Status
  RR Relevant Reportable Condition Observation
  RR Summary
  RR Reportability Information Observation		yyyy
Patienthttp://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-patientyyyy
PractitionerRolehttp://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-practitionerroleyyyy
ServiceRequesthttp://hl7.org/fhir/us/ecr/StructureDefinition/eicr-servicerequestyyyy
BundleSupported Profiles
  eICR Document Bundle
  RR Document Bundle
  US Public Health Reporting Bundle		yyyy
MessageHeaderhttp://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheaderyyyy
Practitionerhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioneryyyy
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 Composition
RR Composition

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 Organization
Responsible Agency Organization
Rules Authoring Agency Organization
Routing Entity Organization

Resource Conformance: supported Encounter
Base System Profile
US Public Health Encounter
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 Location
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 History
eICR Processing Status Reason Observation
eICR Processing Status Observation
US Public Health Pregnancy Outcome Observation
US Public Health Pregnancy Status Observation
US Public Health Postpartum Status
RR Relevant Reportable Condition Observation
RR Summary
RR Reportability Information Observation

Resource Conformance: supported Patient
Base System Profile
US Public Health Patient
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 PractitionerRole
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 ServiceRequest
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 Bundle
RR Document Bundle
US Public Health Reporting Bundle

Resource Conformance: supported MessageHeader
Base System Profile
eCR MessageHeader
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 Profile
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