electronic Case Reporting (eCR) Implementation Guide: STU2 Ballot

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

SD.24 StructureDefinition-rr-communication

eCR Profile: rr-communication

Scope and Usage

This Reportability Response Communication will be created in response to an electronic Initial Case Report Composition and the sharing of the Reportability Response with clinical care will serve several functions, including to:

  • Communicate the reportability status, for the responsible PHA(s)of each condition included in the electronic Initial Case Report (eICR)
  • Identify who (a PHA or an intermediary) prepared the Reportability Response
  • Indicate whether the eICR has been sent to one or more PHA(s)
  • Identify which PHA(s) has/have been sent the eICR
  • Provide contact information for the responsible PHA(s)
  • Provide suggested or required clinical follow-up activities from the responsible PHA(s), including any additional reporting needs or infection control activities
  • Provide access to clinical support resources suggested by the responsible PHA(s) for identified reportable conditions
  • Confirm eICR receipt and processing

A Reportability Response will also, when requested, be shared with the responsible PHAs (when they have not constructed it) for their internal use, so they understand what has been shared with clinical care and, and to monitor/audit decision support algorithm effectivesness and implementation. When a condition is considered reportable to more than one PHA, the Reportability Response can be helpful in communicating reporting that has been done to other PHAs.

The Reportability Response Communication is also structured to allow:

  • 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

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.

Examples

SD.24.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

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

Published on Tue Aug 21 15:50:01 AEST 2018 as a draft by .

This profile builds on Communication

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication S0..*Reportability Response Communication
... text SI1..1Narrativenar-1: Text narrative SHOULD conform to requirements laid out on the Narrative Guidance tab
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... extension-rr-priority S0..1CodeableConceptReportability Response Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-priority
Binding: Reportability Priority (eCR) (extensible)
... identifier S1..1IdentifierExample General': {"system":"http://acme.org/identifiers","value":"RR12346"}
... category S1..1CodeableConceptRequired Pattern: {"coding":[{"system":"http://loinc.org","code":"88085-6","display":"Reportability Response Report Public Health"}]}
... subject S1..1Reference(eCR Patient)Patient
Example General': {"reference":"Patient/ecr-patient-eve-everywoman","display":"Eve Everywoman"}
... recipient S1..*Reference(Organization | Practitioner | PractitionerRole)Example General': {"reference":"PractitionerRole/ecr-practitionerrole-henry-seven","display":"Henry Seven, MD"}
... topic S1..1Reference(Resource)Reportability Response Subject
.... reference 0..0
.... identifier 0..0
.... display S1..1stringReportability Response Subject text
Example General': Public Health Reporting Communication: one or more conditions are reportable, or may be reportable to public health.
... context S0..1Reference(eICR Encounter)eICR Encounter
... sent 1..1dateTime
... sender S1..1Reference(Organization | Practitioner)Author
... payload BackboneElementSlice: Unordered, Open by value:id
... payload S0..1BackboneElementReportability Response Summary
.... id S1..1stringFixed Value: reportability-response-summary
.... contentString 1..1stringReportability Response Summary text
Example General': Your organization electronically submitted an initial case report to determine if reporting to public health is needed for a patient. "Zika virus disease (disorder)" is reportable to "State Department of Health". An initial case report was sent to "State Department of Health". Additional information may be required for this report.
... payload S0..*BackboneElementRelevant Reportable Condition
.... id S1..1stringFixed Value: relevant-reportable-condition
.... contentReference 1..1Reference(Relevant Reportable Condition PlanDefinition)
... payload S1..*BackboneElementElectronic Initial Case Report Information
.... id S1..1stringFixed Value: eicr-information
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... extension-rr-eicr-processing-status S1..1(Complex)eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-processing-status
..... id S1..1stringFixed Value: eicr-processing-status
..... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-processing-status"
.... extension-rr-manually-initiated-eicr S1..1booleanManually Initiated eICR
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-manually-initiated-eicr
..... id S1..1stringFixed Value: manually-initiated-eicr
..... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-manually-initiated-eicr"
.... extension-rr-eicr-receipt-time S0..1dateTimeDate and time of eICR receipt
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-receipt-time
.... contentReference 1..1Reference(Electronic Initial Case Report Composition)Reference to eICR Composition
..... reference 0..1string
..... identifier S0..1IdentifiereICR Composition id
..... display S0..1stringeICR filename (or other identifying string)
Example General': eicr-composition-zika.xml

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication SI0..*Reportability Response Communication
... 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 SI1..1NarrativeText summary of the resource, for human interpretation
nar-1: Text narrative SHOULD conform to requirements laid out on the Narrative Guidance tab
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension-rr-priority SI0..1CodeableConceptReportability Response Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-priority
Binding: Reportability Priority (eCR) (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1IdentifierUnique identifier

Example General': {"system":"http://acme.org/identifiers","value":"RR12346"}
... definition Σ0..*Reference(PlanDefinition | ActivityDefinition)Instantiates protocol or definition
... basedOn Σ0..*Reference(Resource)Request fulfilled by this communication
... partOf Σ0..*Reference(Resource)Part of this action
... status ?!Σ1..1codepreparation | in-progress | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required)
... notDone ?!Σ0..1booleanCommunication did not occur
... notDoneReason ΣI0..1CodeableConceptWhy communication did not occur
Binding: CommunicationNotDoneReason (example)
... category S1..1CodeableConceptMessage category
Binding: CommunicationCategory (example)

Required Pattern: {"coding":[{"system":"http://loinc.org","code":"88085-6","display":"Reportability Response Report Public Health"}]}
... medium 0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example)
... subject SΣ1..1Reference(eCR Patient)Patient
Example General': {"reference":"Patient/ecr-patient-eve-everywoman","display":"Eve Everywoman"}
... recipient S1..*Reference(Organization | Practitioner | PractitionerRole)Message recipient

Example General': {"reference":"PractitionerRole/ecr-practitionerrole-henry-seven","display":"Henry Seven, MD"}
... topic S1..1Reference(Resource)Reportability Response Subject
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... display SΣ1..1stringReportability Response Subject text
Example General': Public Health Reporting Communication: one or more conditions are reportable, or may be reportable to public health.
... context SΣ0..1Reference(eICR Encounter)eICR Encounter
... sent 1..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... sender S1..1Reference(Organization | Practitioner)Author
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMED CT Clinical Findings (example)
... reasonReference Σ0..*Reference(Condition | Observation)Why was communication done?
... payload IBackboneElementMessage payload
Slice: Unordered, Open by value:id
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1string, Attachment, Reference(Resource)Message part content
... payload SI0..1BackboneElementReportability Response Summary
.... id S1..1stringxml:id (or equivalent in JSON)
Fixed Value: reportability-response-summary
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... contentString 1..1stringReportability Response Summary text
Example General': Your organization electronically submitted an initial case report to determine if reporting to public health is needed for a patient. "Zika virus disease (disorder)" is reportable to "State Department of Health". An initial case report was sent to "State Department of Health". Additional information may be required for this report.
... payload SI0..*BackboneElementRelevant Reportable Condition
.... id S1..1stringxml:id (or equivalent in JSON)
Fixed Value: relevant-reportable-condition
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... contentReference 1..1Reference(Relevant Reportable Condition PlanDefinition)Message part content
... payload SI1..*BackboneElementElectronic Initial Case Report Information
.... id S1..1stringxml:id (or equivalent in JSON)
Fixed Value: eicr-information
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-rr-eicr-processing-status SI1..1(Complex)eICR Processing Status
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-processing-status
..... id S1..1stringxml:id (or equivalent in JSON)
Fixed Value: eicr-processing-status
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension 1..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"eICRProcessingStatus"
...... valueReference 0..1Reference(eICR Processing Status)Value of extension
..... extension 0..*ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"eICRValidationOutput"
...... value[x] 1..1markdown, string, AttachmentValue of extension
..... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-processing-status"
.... extension-rr-manually-initiated-eicr SI1..1booleanManually Initiated eICR
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-manually-initiated-eicr
..... id S1..1stringxml:id (or equivalent in JSON)
Fixed Value: manually-initiated-eicr
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-manually-initiated-eicr"
..... valueBoolean 1..1booleanValue of extension
.... extension-rr-eicr-receipt-time SI0..1dateTimeExtension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-eicr-receipt-time
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... contentReference 1..1Reference(Electronic Initial Case Report Composition)Reference to eICR Composition
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier SΣ0..1IdentifiereICR Composition id
..... display SΣ0..1stringeICR filename (or other identifying string)
Example General': eicr-composition-zika.xml
... note 0..*AnnotationComments made about the communication

doco Documentation for this format

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