Da Vinci Alerts Implementation Guide (Release 0.1.0 STU1 Ballot)

This page is part of the Da Vinci Unsolicited Notifications (v1.0.0: STU1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition-alerts-communication

The Da Vinci Alerts Communication Profile is a record of the alert communicated by the alert Sender as part of an alert Bundle. It provide the context of what the alert is about. This profile sets minimum expectations for the Communication resource to record the necessary context for the alert notifications. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the Communication resource.

Example Usage Scenarios:

The following are example usage scenarios for the Communication profile:

  • Included in the Alert notification bundle when a patient is admitted or discharged.

Mandatory and Must Support Data Elements

The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Communication must have:

  1. a status
  2. a category code of alert
  3. a patient
  4. a code representing the purpose of the alert
  5. the patient encounter
  6. who sent the alert

Note to Balloters: We are actively seeking input on whether a code representing the purpose of the alert is needed (‘Communication.topic’). This concept can be obtained from the associated Encounter resource. In FHIR, however, context conduction is not assumed and resources must form a complete representation by themselves. The question is whether a coded topic is simply redundant or is the Communication resource an incomplete record of a communication without it.

Each Communication must support:

  1. a business identifier
  2. an alert priority code
  3. coverage information
  4. who received the alert
  5. what supporting information was included in the notification in the form of free text or references to attachment(s) or resource(s) for the recipient.

Profile specific implementation guidance:

  • The [Alert Scenario] table lists the Resources that may be referenced in the Da Vinci Communication Profile payload element and included in the alert Bundle.

Examples

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

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

Published on Mon Jul 22 00:00:00 EDT 2019 as active by the Health eData Inc.

This profile builds on Communication

Communication

Summary of the Mandatory Requirements

  1. A code in Communication.status with a required binding to EventStatus
  2. One or more CodeableConcepts in Communication.category with an example binding to CommunicationCategory
    • which must have at least a CodeableConcept value in Communication.category with an example binding to CommunicationCategory
      • which must have a Coding value in Communication.category.coding
        • which must have a fixed Communication.category.coding.system = http://terminology.hl7.org/CodeSystem/communication-category
        • which must have a fixed Communication.category.coding.code = alert
  3. A Patient Reference in Communication.subject
  4. A CodeableConcept in Communication.topic with an extensible binding to Da Vinci Communication Topic ValueSet
  5. A Encounter Reference in Communication.encounter
  6. A Sender Reference in Communication.sender

Summary of the Must Support Requirements

  1. One or more Identifiers in Communication.identifier
  2. A code in Communication.priority with a required binding to Request priority
  3. One or more About References in Communication.about
  4. A About Reference in Communication.about
  5. A dateTime in Communication.sent
  6. One or more Recipient References in Communication.recipient
  7. One or more Payloads in Communication.payload
    • which must have a string, Attachment or Reference in Communication.payload.content[x]
NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*A record of information transmitted from a sender to a receiver
... 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: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(Resource)Request fulfilled by this communication
... partOf Σ0..*Reference(Resource)Part of this action
... inResponseTo 0..*Reference(Communication)Reply to
... status ?!SΣ1..1codepreparation | in-progress | not-done | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required)
... statusReason Σ0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example)
... category S(Slice Definition)Message category
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: CommunicationCategory (example)
.... alert S1..1CodeableConceptMessage category
Binding: CommunicationCategory (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/communication-category
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: alert
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... priority SΣ0..1codeMessage urgency
Binding: RequestPriority (required)
... medium 0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject SΣ1..1Reference(US Core Patient Profile)Focus of message
... topic S1..1CodeableConceptDescription of the purpose/content
Binding: Da Vinci Communication Topic ValueSet (extensible)
... about S(Slice Definition)Resources that pertain to this communication
Slice: Unordered, Open by type:$this
.... coverage S0..1Reference(HRex Coverage Profile)Resources that pertain to this communication
... encounter SΣ1..1Reference(US Core Encounter Profile)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... recipient S0..*Reference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core CareTeam Profile)Message recipient
... sender S1..1Reference(US Core Organization Profile | US Core PractitionerRole Profile)Message sender
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMEDCTClinicalFindings (example)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why was communication done?
... payload SI0..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] S1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(http://hl7.org/fhir/R4/resource.html)
... note 0..*AnnotationComments made about the communication

doco Documentation for this format

Communication

Summary of the Mandatory Requirements

  1. A code in Communication.status with a required binding to EventStatus
  2. One or more CodeableConcepts in Communication.category with an example binding to CommunicationCategory
    • which must have at least a CodeableConcept value in Communication.category with an example binding to CommunicationCategory
      • which must have a Coding value in Communication.category.coding
        • which must have a fixed Communication.category.coding.system = http://terminology.hl7.org/CodeSystem/communication-category
        • which must have a fixed Communication.category.coding.code = alert
  3. A Patient Reference in Communication.subject
  4. A CodeableConcept in Communication.topic with an extensible binding to Da Vinci Communication Topic ValueSet
  5. A Encounter Reference in Communication.encounter
  6. A Sender Reference in Communication.sender

Summary of the Must Support Requirements

  1. One or more Identifiers in Communication.identifier
  2. A code in Communication.priority with a required binding to Request priority
  3. One or more About References in Communication.about
  4. A About Reference in Communication.about
  5. A dateTime in Communication.sent
  6. One or more Recipient References in Communication.recipient
  7. One or more Payloads in Communication.payload
    • which must have a string, Attachment or Reference in Communication.payload.content[x]

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication I0..*A record of information transmitted from a sender to a receiver
... 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: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(Resource)Request fulfilled by this communication
... partOf Σ0..*Reference(Resource)Part of this action
... inResponseTo 0..*Reference(Communication)Reply to
... status ?!SΣ1..1codepreparation | in-progress | not-done | suspended | aborted | completed | entered-in-error
Binding: EventStatus (required)
... statusReason Σ0..1CodeableConceptReason for current status
Binding: CommunicationNotDoneReason (example)
... category S(Slice Definition)Message category
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: CommunicationCategory (example)
.... alert S1..1CodeableConceptMessage category
Binding: CommunicationCategory (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/communication-category
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: alert
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... priority SΣ0..1codeMessage urgency
Binding: RequestPriority (required)
... medium 0..*CodeableConceptA channel of communication
Binding: v3 Code System ParticipationMode (example)
... subject SΣ1..1Reference(US Core Patient Profile)Focus of message
... topic S1..1CodeableConceptDescription of the purpose/content
Binding: Da Vinci Communication Topic ValueSet (extensible)
... about S(Slice Definition)Resources that pertain to this communication
Slice: Unordered, Open by type:$this
.... coverage S0..1Reference(HRex Coverage Profile)Resources that pertain to this communication
... encounter SΣ1..1Reference(US Core Encounter Profile)Encounter created as part of
... sent S0..1dateTimeWhen sent
... received 0..1dateTimeWhen received
... recipient S0..*Reference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core CareTeam Profile)Message recipient
... sender S1..1Reference(US Core Organization Profile | US Core PractitionerRole Profile)Message sender
... reasonCode Σ0..*CodeableConceptIndication for message
Binding: SNOMEDCTClinicalFindings (example)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why was communication done?
... payload SI0..*BackboneElementMessage payload
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... content[x] S1..1Message part content
..... contentStringstring
..... contentAttachmentAttachment
..... contentReferenceReference(http://hl7.org/fhir/R4/resource.html)
... note 0..*AnnotationComments made about the communication

doco Documentation for this format

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


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.