capabilitystatement-ecr
type: CapabilityStatement
node role: treeRoot
id:
  v: capabilitystatement-ecr
language:
  v: en
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: CapabilityStatement capabilitystatement-ecr Capability Statement eCR Implementation Guide Version: 3.0.0-ballot FHIR Version: 4.0.1 Supported Formats: application/xml, application/json Published on: 2025-12-01 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 Type Profile R S U C D Searches _include _revinclude Operations Composition Supported Profiles eICR Composition RR Composition y y y y Organization Supported Profiles US Public Health Organization RR Responsible Agency Organization RRRules Authoring Agency Organization RRRouting Entity Organization y y y y Encounter http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-encounter y y y y Location http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-location y y y y Observation Supported Profiles US Public Health Travel History eICR Processing Status Reason Observa…
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
    l: structuredefinition-wg
  value: Code
    v: pher
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
    l: structuredefinition-fmm
  value: Integer
    v: 3
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
        l: structuredefinition-conformance-derivedFrom
      value: Canonical
        v: http://hl7.org/fhir/us/ecr/ImplementationGuide/hl7.fhir.us.ecr
        l: hl7.fhir.us.ecr
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: trial-use
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
        l: structuredefinition-conformance-derivedFrom
      value: Canonical
        v: http://hl7.org/fhir/us/ecr/ImplementationGuide/hl7.fhir.us.ecr
        l: hl7.fhir.us.ecr
url:
  v: http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ecr
  l: capabilitystatement-ecr
version:
  v: 3.0.0-ballot
name:
  v: CapabilityStatement_eCR
title:
  v: Capability Statement eCR
status:
  v: active
experimental:
  v: false
date:
  v: 2025-12-01
publisher:
  v: HL7 International / Public Health
contact:
  name:
    v: HL7 International / Public Health
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/pher
  telecom:
    system:
      v: email
description:
  v: This resource defines the expected capabilities for both client and server participating in eCR exchange.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: US
kind:
  v: requirements
fhir version:
  v: 4.0.1
format:
  v: application/xml
format:
  v: application/json
implementation guide:
  v: http://hl7.org/fhir/us/ecr/ImplementationGuide/hl7.fhir.us.ecr
  l: hl7.fhir.us.ecr
rest:
  mode:
    v: server
  documentation:
    v: This section describes the expected capabilities for the server participating in eCR exchange.
  resource:
    type:
      v: Composition
    supported profile:
      v: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-composition
      l: eicr-composition
    supported profile:
      v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-composition
      l: rr-composition
    interaction:
      code:
        v: create
      documentation:
        v: Allows creation of Composition instances
    interaction:
      code:
        v: read
      documentation:
        v: Allows retrieval of a specific Composition instance
    interaction:
      code:
        v: update
      documentation:
        v: Allows update of Composition instances
    interaction:
      code:
        v: delete
      documentation:
        v: Allows deletion of Composition instances
  resource:
    type:
      v: Organization
    supported profile:
      v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-organization
      l: us-ph-organization
    supported profile:
      v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-responsible-agency-organization
      l: rr-responsible-agency-organization
    supported profile:
      v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-rules-authoring-agency-organization
      l: rr-rules-authoring-agency-organization
    supported profile:
      v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-routing-entity-organization
      l: rr-routing-entity-organization
    interaction:
      code:
        v: create
      documentation:
        v: Allows creation of Organization instances
    interaction:
      code:
        v: read
      documentation:
        v: Allows retrieval of a specific Organization instance
    interaction:
      code:
        v: update
      documentation:
        v: Allows update of Organization instances
    interaction:
      code:
        v: delete
      documentation:
        v: Allows deletion of Organization instances
  resource:
    type:
      v: Encounter
    profile:
      v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-encounter
      l: us-ph-encounter
    interaction:
      code:
        v: create
      documentation:
        v: Allows creation of Encounter instances
    interaction:
      code:
        v: read
      documentation:
        v: Allows retrieval of a specific Encounter instance
    interaction:
      code:
        v: update
      documentation:
        v: Allows update of Encounter instances
    interaction:
      code:
        v: delete
      documentation:
        v: Allows deletion of Encounter instances
  resource:
    type:
      v: Location
    profile:
      v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-location
      l: us-ph-location
    interaction:
      code:
        v: create
      documentation:
        v: Allows creation of Location instances
    interaction:
      code:
        v: read
      documentation:
        v: Allows retrieval of a specific Location instance

code:
  v: update
documentation:
  v: Allows update of Location instances

code:
  v: delete
documentation:
  v: Allows deletion of Location instances

type:
  v: Observation
supported profile:
  v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-travel-history
  l: us-ph-travel-history
supported profile:
  v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-reason-observation
  l: rr-eicr-processing-status-reason-observation
supported profile:
  v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-observation
  l: rr-eicr-processing-status-observation
supported profile:
  v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-pregnancy-outcome-observation
  l: us-ph-pregnancy-outcome-observation
supported profile:
  v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-pregnancy-status-observation
  l: us-ph-pregnancy-status-observation
supported profile:
  v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-is-postpartum
  l: us-ph-is-postpartum
supported profile:
  v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-relevant-reportable-condition-observation
  l: rr-relevant-reportable-condition-observation
supported profile:
  v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-summary-observation
  l: rr-summary-observation
supported profile:
  v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-reportability-information-observation
  l: rr-reportability-information-observation
interaction:
  code:
    v: create
  documentation:
    v: Allows creation of Observation instances
interaction:
  code:
    v: read
  documentation:
    v: Allows retrieval of a specific Observation instance
interaction:
  code:
    v: update
  documentation:
    v: Allows update of Observation instances
interaction:
  code:
    v: delete
  documentation:
    v: Allows deletion of Observation instances

type:
  v: Patient
profile:
  v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-patient
  l: us-ph-patient
interaction:
  code:
    v: create
  documentation:
    v: Allows creation of Patient instances
interaction:
  code:
    v: read
  documentation:
    v: Allows retrieval of a specific Patient instance
interaction:
  code:
    v: update
  documentation:
    v: Allows update of Patient instances
interaction:
  code:
    v: delete
  documentation:
    v: Allows deletion of Patient instances

type:
  v: PractitionerRole
profile:
  v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-practitionerrole
  l: us-ph-practitionerrole
interaction:
  code:
    v: create
  documentation:
    v: Allows creation of PractitionerRole instances
interaction:
  code:
    v: read
  documentation:
    v: Allows retrieval of a specific PractitionerRole instance
interaction:
  code:
    v: update
  documentation:
    v: Allows update of PractitionerRole instances
interaction:
  code:
    v: delete
  documentation:
    v: Allows deletion of PractitionerRole instances

type:
  v: ServiceRequest
profile:
  v: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-servicerequest
  l: eicr-servicerequest
interaction:
  code:
    v: create
  documentation:
    v: Allows creation of ServiceRequest instances
interaction:
  code:
    v: read
  documentation:
    v: Allows retrieval of a specific ServiceRequest instance
interaction:
  code:
    v: update
  documentation:
    v: Allows update of ServiceRequest instances
interaction:
  code:
    v: delete
  documentation:
    v: Allows deletion of ServiceRequest instances

type:
  v: Bundle
supported profile:
  v: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle
  l: eicr-document-bundle
supported profile:
  v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-document-bundle
  l: rr-document-bundle
supported profile:
  v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-reporting-bundle
  l: us-ph-reporting-bundle
interaction:
  code:
    v: create
  documentation:
    v: Allows creation of Bundle instances
interaction:
  code:
    v: read
  documentation:
    v: Allows retrieval of a specific Bundle instance
interaction:
  code:
    v: update
  documentation:
    v: Allows update of Bundle instances
interaction:
  code:
    v: delete
  documentation:
    v: Allows deletion of Bundle instances

type:
  v: MessageHeader
profile:
  v: http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheader
  l: ecr-messageheader
interaction:
  code:
    v: create
  documentation:
    v: Allows creation of MessageHeader instances
interaction:
  code:
    v: read
  documentation:
    v: Allows retrieval of a specific MessageHeader instance
interaction:
  code:
    v: update
  documentation:
    v: Allows update of MessageHeader instances
interaction:
  code:
    v: delete
  documentation:
    v: Allows deletion of MessageHeader instances

type:
  v: Practitioner
profile:
  v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|6.1.0
  l: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
interaction:
  code:
    v: create
  documentation:
    v: Allows creation of Practitioner instances
interaction:
  code:
    v: read
  documentation:
    v: Allows retrieval of a specific Practitioner instance
interaction:
  code:
    v: update
  documentation:
    v: Allows update of Practitioner instances
interaction:
  code:
    v: delete
  documentation:
    v: Allows deletion of Practitioner instances

mode:
  v: client
documentation:
  v: This section describes the expected capabilities for the client participating in eCR exchange.
resource:
  type:
    v: Composition
  supported profile:
    v: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-composition
    l: eicr-composition
  supported profile:
    v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-composition
    l: rr-composition
  interaction:
    code:
      v: create
    documentation:
      v: Allows creation of Composition instances
  interaction:
    code:
      v: read
    documentation:
      v: Allows retrieval of a specific Composition instance
  interaction:
    code:
      v: update
    documentation:
      v: Allows update of Composition instances
  interaction:
    code:
      v: delete
    documentation:
      v: Allows deletion of Composition instances
resource:
  type:
    v: Organization
  supported profile:
    v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-organization
    l: us-ph-organization
  supported profile:
    v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-responsible-agency-organization
    l: rr-responsible-agency-organization
  supported profile:
    v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-rules-authoring-agency-organization
    l: rr-rules-authoring-agency-organization
  supported profile:
    v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-routing-entity-organization
    l: rr-routing-entity-organization
  interaction:
    code:
      v: create
    documentation:
      v: Allows creation of Organization instances
  interaction:
    code:
      v: read
    documentation:
      v: Allows retrieval of a specific Organization instance
  interaction:
    code:
      v: update
    documentation:
      v: Allows update of Organization instances
  interaction:
    code:
      v: delete
    documentation:
      v: Allows deletion of Organization instances
resource:
  type:
    v: Encounter
  profile:
    v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-encounter
    l: us-ph-encounter
  interaction:
    code:
      v: create
    documentation:
      v: Allows creation of Encounter instances
  interaction:
    code:
      v: read
    documentation:
      v: Allows retrieval of a specific Encounter instance
  interaction:
    code:
      v: update
    documentation:
      v: Allows update of Encounter instances
  interaction:
    code:
      v: delete
    documentation:
      v: Allows deletion of Encounter instances
resource:
  type:
    v: Location
  profile:
    v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-location
    l: us-ph-location
  interaction:
    code:
      v: create
    documentation:
      v: Allows creation of Location instances
  interaction:
    code:
      v: read
    documentation:
      v: Allows retrieval of a specific Location instance
  interaction:
    code:
      v: update
    documentation:
      v: Allows update of Location instances
  interaction:
    code:
      v: delete
    documentation:
      v: Allows deletion of Location instances
resource:
  type:
    v: Observation
  supported profile:
    v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-travel-history
    l: us-ph-travel-history
  supported profile:
    v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-reason-observation
    l: rr-eicr-processing-status-reason-observation
  supported profile:
    v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-observation
    l: rr-eicr-processing-status-observation
  supported profile:
    v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-pregnancy-outcome-observation
    l: us-ph-pregnancy-outcome-observation
  supported profile:
    v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-pregnancy-status-observation
    l: us-ph-pregnancy-status-observation
  supported profile:
    v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-is-postpartum
    l: us-ph-is-postpartum
  supported profile:
    v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-relevant-reportable-condition-observation
    l: rr-relevant-reportable-condition-observation
  supported profile:
    v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-summary-observation
    l: rr-summary-observation
  supported profile:
    v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-reportability-information-observation
    l: rr-reportability-information-observation
  interaction:
    code:
      v: create
    documentation:
      v: Allows creation of Observation instances
  interaction:
    code:
      v: read
    documentation:
      v: Allows retrieval of a specific Observation instance
  interaction:
    code:
      v: update
    documentation:
      v: Allows update of Observation instances
  interaction:
    code:
      v: delete
    documentation:
      v: Allows deletion of Observation instances
resource:
  type:
    v: Patient
  profile:
    v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-patient
    l: us-ph-patient
  interaction:
    code:
      v: create
    documentation:
      v: Allows creation of Patient instances
  interaction:
    code:
      v: read
    documentation:
      v: Allows retrieval of a specific Patient instance
  interaction:
    code:
      v: update
    documentation:
      v: Allows update of Patient instances
  interaction:
    code:
      v: delete
    documentation:
      v: Allows deletion of Patient instances
resource:
  type:
    v: PractitionerRole
  profile:
    v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-practitionerrole
    l: us-ph-practitionerrole

code:
  v: create
documentation:
  v: Allows creation of PractitionerRole instances

code:
  v: read
documentation:
  v: Allows retrieval of a specific PractitionerRole instance

code:
  v: update
documentation:
  v: Allows update of PractitionerRole instances

code:
  v: delete
documentation:
  v: Allows deletion of PractitionerRole instances

type:
  v: ServiceRequest
profile:
  v: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-servicerequest
  l: eicr-servicerequest
interaction:
  code:
    v: create
  documentation:
    v: Allows creation of ServiceRequest instances
interaction:
  code:
    v: read
  documentation:
    v: Allows retrieval of a specific ServiceRequest instance
interaction:
  code:
    v: update
  documentation:
    v: Allows update of ServiceRequest instances
interaction:
  code:
    v: delete
  documentation:
    v: Allows deletion of ServiceRequest instances

type:
  v: Bundle
supported profile:
  v: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle
  l: eicr-document-bundle
supported profile:
  v: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-document-bundle
  l: rr-document-bundle
supported profile:
  v: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-reporting-bundle
  l: us-ph-reporting-bundle
interaction:
  code:
    v: create
  documentation:
    v: Allows creation of Bundle instances
interaction:
  code:
    v: read
  documentation:
    v: Allows retrieval of a specific Bundle instance
interaction:
  code:
    v: update
  documentation:
    v: Allows update of Bundle instances
interaction:
  code:
    v: delete
  documentation:
    v: Allows deletion of Bundle instances

type:
  v: MessageHeader
profile:
  v: http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheader
  l: ecr-messageheader
interaction:
  code:
    v: create
  documentation:
    v: Allows creation of MessageHeader instances
interaction:
  code:
    v: read
  documentation:
    v: Allows retrieval of a specific MessageHeader instance
interaction:
  code:
    v: update
  documentation:
    v: Allows update of MessageHeader instances
interaction:
  code:
    v: delete
  documentation:
    v: Allows deletion of MessageHeader instances

type:
  v: Practitioner
profile:
  v: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|6.1.0
  l: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
interaction:
  code:
    v: create
  documentation:
    v: Allows creation of Practitioner instances
interaction:
  code:
    v: read
  documentation:
    v: Allows retrieval of a specific Practitioner instance
interaction:
  code:
    v: update
  documentation:
    v: Allows update of Practitioner instances
interaction:
  code:
    v: delete
  documentation:
    v: Allows deletion of Practitioner instances