HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.0 - STU 2
US
HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.0 - STU 2
US
This page is part of the electronic Case Reporting (eCR) (v2.1.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Active as of 2019-06-25 |
{
"resourceType" : "CapabilityStatement",
"id" : "capabilitystatement-ecr",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>CapabilityStatement_eCR</h2><div><p>This resource defines the expected capabilities for both client and server participating in eCR exchange.</p>\n</div><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td><div><p>This section describes the expected capabilities for the server participating in eCR exchange.</p>\n</div></td></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title=\"GET a resource (read interaction)\">Read</b></th><th><b title=\"GET all set of resources of the type (search interaction)\">Search</b></th><th><b title=\"PUT a new resource version (update interaction)\">Update</b></th><th><b title=\"POST a new resource (create interaction)\">Create</b></th><th><b title=\"DELETE a resource (delete interaction)\">Delete</b></th></tr><tr><td>Composition</td><td>Supported profiles:<br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-composition\">http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-composition</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-composition\">http://hl7.org/fhir/us/ecr/StructureDefinition/rr-composition</a></td><td>y</td><td></td><td>y</td><td>y</td><td>y</td></tr><tr><td>Organization</td><td>Supported profiles:<br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-organization\">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-organization</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-responsible-agency-organization\">http://hl7.org/fhir/us/ecr/StructureDefinition/rr-responsible-agency-organization</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-rules-authoring-agency-organization\">http://hl7.org/fhir/us/ecr/StructureDefinition/rr-rules-authoring-agency-organization</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-routing-entity-organization\">http://hl7.org/fhir/us/ecr/StructureDefinition/rr-routing-entity-organization</a></td><td>y</td><td></td><td>y</td><td>y</td><td>y</td></tr><tr><td>Encounter</td><td><a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-encounter\">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-encounter</a></td><td>y</td><td></td><td>y</td><td>y</td><td>y</td></tr><tr><td>Location</td><td><a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-location\">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-location</a></td><td>y</td><td></td><td>y</td><td>y</td><td>y</td></tr><tr><td>Observation</td><td>Supported profiles:<br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-travel-history\">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-travel-history</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-reason-observation\">http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-reason-observation</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-observation\">http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-observation</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-pregnancy-outcome-observation\">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-pregnancy-outcome-observation</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-pregnancy-status-observation\">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-pregnancy-status-observation</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-postpartum-status\">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-postpartum-status</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-relevant-reportable-condition-observation\">http://hl7.org/fhir/us/ecr/StructureDefinition/rr-relevant-reportable-condition-observation</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-summary\">http://hl7.org/fhir/us/ecr/StructureDefinition/rr-summary</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-reportability-information-observation\">http://hl7.org/fhir/us/ecr/StructureDefinition/rr-reportability-information-observation</a></td><td>y</td><td></td><td>y</td><td>y</td><td>y</td></tr><tr><td>Patient</td><td><a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-patient\">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-patient</a></td><td>y</td><td></td><td>y</td><td>y</td><td>y</td></tr><tr><td>PractitionerRole</td><td><a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-practitionerrole\">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-practitionerrole</a></td><td>y</td><td></td><td>y</td><td>y</td><td>y</td></tr><tr><td>ServiceRequest</td><td><a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-servicerequest\">http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-servicerequest</a></td><td>y</td><td></td><td>y</td><td>y</td><td>y</td></tr><tr><td>Bundle</td><td>Supported profiles:<br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle\">http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-document-bundle\">http://hl7.org/fhir/us/ecr/StructureDefinition/rr-document-bundle</a><br/> <a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-reporting-bundle\">http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-reporting-bundle</a></td><td>y</td><td></td><td>y</td><td>y</td><td>y</td></tr><tr><td>MessageHeader</td><td><a href=\"http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheader\">http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheader</a></td><td>y</td><td></td><td>y</td><td>y</td><td>y</td></tr><tr><td>Practitioner</td><td><a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner\">http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner</a></td><td>y</td><td></td><td>y</td><td>y</td><td>y</td></tr></table></div>"
},
"url" : "http://hl7.org/fhir/us/ecr/CapabilityStatement/capabilitystatement-ecr",
"version" : "2.1.0",
"name" : "CapabilityStatement_eCR",
"title" : "Capability Statement eCR",
"status" : "active",
"experimental" : false,
"date" : "2019-06-25",
"publisher" : "HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)",
"contact" : [
{
"name" : "HL7 International - Public Health",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pher"
}
]
}
],
"description" : "This resource defines the expected capabilities for both client and server participating in eCR exchange.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
],
"text" : "United States of America"
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"application/xml",
"application/json"
],
"implementationGuide" : [
"http://hl7.org/fhir/us/ecr/ImplementationGuide/hl7-fhir-us-ecr"
],
"rest" : [
{
"mode" : "server",
"documentation" : "This section describes the expected capabilities for the server participating in eCR exchange.",
"resource" : [
{
"type" : "Composition",
"supportedProfile" : [
"http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-composition",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-composition"
],
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Composition instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Composition instance"
},
{
"code" : "update",
"documentation" : "Allows update of Composition instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Composition instances"
}
]
},
{
"type" : "Organization",
"supportedProfile" : [
"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-organization",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-responsible-agency-organization",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-rules-authoring-agency-organization",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-routing-entity-organization"
],
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Organization instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Organization instance"
},
{
"code" : "update",
"documentation" : "Allows update of Organization instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Organization instances"
}
]
},
{
"type" : "Encounter",
"profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-encounter",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Encounter instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Encounter instance"
},
{
"code" : "update",
"documentation" : "Allows update of Encounter instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Encounter instances"
}
]
},
{
"type" : "Location",
"profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-location",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Location instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Location instance"
},
{
"code" : "update",
"documentation" : "Allows update of Location instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Location instances"
}
]
},
{
"type" : "Observation",
"supportedProfile" : [
"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-travel-history",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-reason-observation",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-observation",
"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-pregnancy-outcome-observation",
"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-pregnancy-status-observation",
"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-postpartum-status",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-relevant-reportable-condition-observation",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-summary",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-reportability-information-observation"
],
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Observation instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Observation instance"
},
{
"code" : "update",
"documentation" : "Allows update of Observation instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Observation instances"
}
]
},
{
"type" : "Patient",
"profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-patient",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Patient instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Patient instance"
},
{
"code" : "update",
"documentation" : "Allows update of Patient instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Patient instances"
}
]
},
{
"type" : "PractitionerRole",
"profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-practitionerrole",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of PractitionerRole instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific PractitionerRole instance"
},
{
"code" : "update",
"documentation" : "Allows update of PractitionerRole instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of PractitionerRole instances"
}
]
},
{
"type" : "ServiceRequest",
"profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-servicerequest",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of ServiceRequest instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific ServiceRequest instance"
},
{
"code" : "update",
"documentation" : "Allows update of ServiceRequest instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of ServiceRequest instances"
}
]
},
{
"type" : "Bundle",
"supportedProfile" : [
"http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-document-bundle",
"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-reporting-bundle"
],
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Bundle instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Bundle instance"
},
{
"code" : "update",
"documentation" : "Allows update of Bundle instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Bundle instances"
}
]
},
{
"type" : "MessageHeader",
"profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheader",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of MessageHeader instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific MessageHeader instance"
},
{
"code" : "update",
"documentation" : "Allows update of MessageHeader instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of MessageHeader instances"
}
]
},
{
"type" : "Practitioner",
"profile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Practitioner instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Practitioner instance"
},
{
"code" : "update",
"documentation" : "Allows update of Practitioner instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Practitioner instances"
}
]
}
]
},
{
"mode" : "client",
"documentation" : "This section describes the expected capabilities for the client participating in eCR exchange.",
"resource" : [
{
"type" : "Composition",
"supportedProfile" : [
"http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-composition",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-composition"
],
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Composition instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Composition instance"
},
{
"code" : "update",
"documentation" : "Allows update of Composition instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Composition instances"
}
]
},
{
"type" : "Organization",
"supportedProfile" : [
"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-organization",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-responsible-agency-organization",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-rules-authoring-agency-organization",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-routing-entity-organization"
],
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Organization instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Organization instance"
},
{
"code" : "update",
"documentation" : "Allows update of Organization instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Organization instances"
}
]
},
{
"type" : "Encounter",
"profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-encounter",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Encounter instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Encounter instance"
},
{
"code" : "update",
"documentation" : "Allows update of Encounter instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Encounter instances"
}
]
},
{
"type" : "Location",
"profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-location",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Location instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Location instance"
},
{
"code" : "update",
"documentation" : "Allows update of Location instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Location instances"
}
]
},
{
"type" : "Observation",
"supportedProfile" : [
"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-travel-history",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-reason-observation",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-eicr-processing-status-observation",
"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-pregnancy-outcome-observation",
"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-pregnancy-status-observation",
"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-postpartum-status",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-relevant-reportable-condition-observation",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-summary",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-reportability-information-observation"
],
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Observation instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Observation instance"
},
{
"code" : "update",
"documentation" : "Allows update of Observation instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Observation instances"
}
]
},
{
"type" : "Patient",
"profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-patient",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Patient instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Patient instance"
},
{
"code" : "update",
"documentation" : "Allows update of Patient instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Patient instances"
}
]
},
{
"type" : "PractitionerRole",
"profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-practitionerrole",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of PractitionerRole instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific PractitionerRole instance"
},
{
"code" : "update",
"documentation" : "Allows update of PractitionerRole instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of PractitionerRole instances"
}
]
},
{
"type" : "ServiceRequest",
"profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-servicerequest",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of ServiceRequest instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific ServiceRequest instance"
},
{
"code" : "update",
"documentation" : "Allows update of ServiceRequest instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of ServiceRequest instances"
}
]
},
{
"type" : "Bundle",
"supportedProfile" : [
"http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle",
"http://hl7.org/fhir/us/ecr/StructureDefinition/rr-document-bundle",
"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-reporting-bundle"
],
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Bundle instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Bundle instance"
},
{
"code" : "update",
"documentation" : "Allows update of Bundle instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Bundle instances"
}
]
},
{
"type" : "MessageHeader",
"profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheader",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of MessageHeader instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific MessageHeader instance"
},
{
"code" : "update",
"documentation" : "Allows update of MessageHeader instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of MessageHeader instances"
}
]
},
{
"type" : "Practitioner",
"profile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner",
"interaction" : [
{
"code" : "create",
"documentation" : "Allows creation of Practitioner instances"
},
{
"code" : "read",
"documentation" : "Allows retrieval of a specific Practitioner instance"
},
{
"code" : "update",
"documentation" : "Allows update of Practitioner instances"
},
{
"code" : "delete",
"documentation" : "Allows deletion of Practitioner instances"
}
]
}
]
}
]
}
IG © 2020+ HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm). Package hl7.fhir.us.ecr#2.1.0 based on FHIR 4.0.1. Generated 2022-08-31
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change