electronic Case Reporting (eCR) Implementation Guide Release For Comment Ballot Version

This page is part of the electronic Case Reporting (eCR) (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

SD.23 StructureDefinition-rr-communication

source file: source/pages/_includes/rr-communication-intro.md

ECR Profile: Reportability Response Communication Profile

Scope and Usage

The Reportability Response Communication profile establishes then core elements, extensions, vocabularies and value sets for recording the receipt and processing of an electronic Initial Case Report (eICR) CDA document or FHIR resource. This information includes information about the reportable condition along with resources and details on where to get more information about the condition, its treatment, and reporting requirements. In the most common scenario, the Reportability Response will communicate, for one or more PHAs, which condition(s) is/are reportable, provide information about what clinical next step activities may need to occur, and other relevant resources.

The Reportability Response allows for:

  • Notification, alerting, routing and queueing in work or message management systems for healthcare personnel
  • Dynamic and static URIs for supplemental data collection and the provision of information resources

  • If the eICR was successfully processed, then there SHOULD be:

    • A Topic Subject Line
    • A Topic Summary
    • A way to identify the eICR either as a direct reference or through a business identifier
    • References to related artifacts to assist the providers in understanding the investigating conditions.

  • If the eICR CDA document was not processed and has errors, then there SHOULD be:

    • A way to identify the eICR either as a direct reference or through a business identifier
    • An eICR processing error reasons

Additional Profile specific implementation guidance:

The Mappings tab above provides the mappings from the RR Data Elements to this profile as well to the HL7 CDA® R2 Implementation Guide: Reportability Response, Release 1 STU Release 1.0 - US Realm.

Figure 1 is a graph of a generic scenario using the RR Communication Profile resource to show the linkages and relationships to the other FHIR core resources. ( created using ClinFHIR Scenario Builder)

file:///assets/images/rr-comm-graph.png

Figure 1: Reportability Response Communication Graph.
rr-comm-graph.png

Examples

SD.23.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://fhir.hl7.org/us/ecr/StructureDefinition/rr-communication

Published on Sun Jun 11 00:00:00 AEST 2017 as a draft by PHER.

This profile builds on Communication

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication S0..*Reportabllity Response Profile
... identifier S0..*Identifier
... definition S0..*Reference(Reportability Response PlanDefinition Profile)
... status S1..1codeeICR Processing Status
Binding: EventStatus (required)
... category SCodeableConceptSlice: Unordered, Open by value:coding.code
... category S1..1CodeableConceptPriority Code
Binding: Reportability Priority (required)
... subject S0..1Reference(US Core Patient Profile)
... recipient S0..*Reference(eCR Organization Profile)EICR recipients and Intermediaries
.... extension-location-relevance S0..1codeLocation Relevance
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-location-relevance
Binding: LocationRelevance (required)
... topic S0..*​Reference(Any)Reportability Response summary
.... extension-topic-subject S0..1CodeableConceptSubject line
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-subject
.... extension-topic-summary S0..1markdownSummary
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-summary
.... extension-topic-dor S0..*codeDetermination of Reportability
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-dor
Binding: Determination of Reportability (required)
.... extension-topic-dor-reason S0..1CodeableConceptDetermination of Reportability Reason
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-dor-reason
Binding: Determination of Reportability Reason Codes (required)
.... extension-topic-dor-rule S0..1stringDetermination of Reportability Rule
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-dor-rule
... context S0..1Reference(eICR Encounter Profile)eICR encompassing encounter ID
... received 0..1dateTime
... sender S0..1Reference(Device), Reference(eCR Organization Profile), Reference(US Core Practitioner Profile)
.... extension-practitioner-role S0..1Reference(US Core PractitionerRole Profile)PractitionerRole reference
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-practitioner-role
... reasonCode S0..*CodeableConceptReportable Condition
Binding: Reportable Condition Trigger Codes (RCTC) (example)
... payload S0..*BackboneElement
.... contentReference 1..1Reference(DocumentReference), Reference(Binary)
..... reference S0..1stringReference to eICR CDA Document
..... identifier S0..1IdentifiereICR CDA Document ID*
..... display S0..1stringFilename of eICR
.... extension-manual-init S0..1booleanManually Initiated eICR
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-manual-init
.... extension-manual-init-reason S0..1stringInitial Case Report Manual Initiation Reason*
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-manual-init-reason
... note S0..*Annotation
... extension-status-reason S0..1Reference(eICR Operation Outcome)eICR processing status reason
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-status-reason

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication SI0..*Reportabllity Response Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension-status-reason SI0..1Reference(eICR Operation Outcome)eICR processing status reason
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-status-reason
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier
... definition SΣ0..*Reference(Reportability Response PlanDefinition Profile)Instantiates protocol or definition
... basedOn Σ0..*Reference(Resource)Request fulfilled by this communication
... partOf Σ0..*Reference(Resource)Part of this action
... status ?!SΣ1..1codeeICR Processing Status
Binding: EventStatus (required)
... notDone ?!Σ0..1booleanCommunication did not occur
... notDoneReason ΣI0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example)
... category SCodeableConceptMessage category
Slice: Unordered, Open by value:coding.code
Binding: CommunicationCategory (example)
... category S1..1CodeableConceptPriority Code
Binding: Reportability Priority (required)
... medium 0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject SΣ0..1Reference(US Core Patient Profile)Focus of message
... recipient S0..*Reference(eCR Organization Profile)EICR recipients and Intermediaries
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension-location-relevance S0..1codeLocation Relevance
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-location-relevance
Binding: LocationRelevance (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://fhir.hl7.org/us/ecr/StructureDefinition/extension-location-relevance"
..... valueCode 0..1codeValue of extension
Binding: LocationRelevance (required)
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... topic S0..*​Reference(Any)Reportability Response summary
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension-topic-subject S0..1CodeableConceptSubject line
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-subject
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-subject"
..... valueCodeableConcept 0..1CodeableConceptValue of extension
.... extension-topic-summary S0..1markdownSummary
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-summary
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-summary"
..... valueMarkdown 0..1markdownValue of extension
.... extension-topic-dor S0..*codeDetermination of Reportability
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-dor
Binding: Determination of Reportability (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-dor"
..... valueCode 0..1codeValue of extension
Binding: Determination of Reportability (required)
.... extension-topic-dor-reason S0..1CodeableConceptDetermination of Reportability Reason
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-dor-reason
Binding: Determination of Reportability Reason Codes (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-dor-reason"
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Determination of Reportability Reason Codes (required)
.... extension-topic-dor-rule S0..1stringDetermination of Reportability Rule
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-dor-rule
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://fhir.hl7.org/us/ecr/StructureDefinition/extension-topic-dor-rule"
..... valueString 0..1stringValue of extension
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... context SΣ0..1Reference(eICR Encounter Profile)eICR encompassing encounter ID
... sent 0..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... sender S0..1Reference(Device), Reference(eCR Organization Profile), Reference(US Core Practitioner Profile)Message sender
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension-practitioner-role S0..1Reference(US Core PractitionerRole Profile)Extension
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-practitioner-role
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://fhir.hl7.org/us/ecr/StructureDefinition/extension-practitioner-role"
..... valueReference 0..1Reference(US Core PractitionerRole Profile)Value of extension
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... reasonCode SΣ0..*CodeableConceptReportable Condition
Binding: Reportable Condition Trigger Codes (RCTC) (example)
... reasonReference Σ0..*Reference(Condition), Reference(Observation)Why was communication done?
... payload SI0..*BackboneElementMessage payload
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension-manual-init SI0..1booleanManually Initiated eICR
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-manual-init
.... extension-manual-init-reason SI0..1stringInitial Case Report Manual Initiation Reason*
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-manual-init-reason
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1Reference(DocumentReference), Reference(Binary)Message part content
..... id 0..1stringxml:id (or equivalent in JSON)
..... reference SΣI0..1stringReference to eICR CDA Document
..... identifier SΣ0..1IdentifiereICR CDA Document ID*
..... display SΣ0..1stringFilename of eICR
... note S0..*AnnotationComments made about the communication

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

SD.23.2 Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

...todo...