Da Vinci Unsolicited Notifications Implementation Guide CI Build

Da Vinci Unsolicited Notifications, published by HL7 International - Infrastructure and Messaging Work Group. This is not an authorized publication; it is the continuous build for version 0.2.1). This version is based on the current content of https://github.com/HL7/davinci-alerts/ and changes regularly. See the Directory of published versions

StructureDefinition-discharge-notification-messageheader

The Da Vinci Discharge Notification MessageHeader Profile builds on the Da Vinci Notifications MessageHeader Profile and sets minimum expectations for the FHIR MessageHeader resource to record the necessary context for Da Vinci discharge notification messaging scenario. The event code is “notification-discharge” and the focus of the event is the US Core Encounter Profile.

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 MessageHeader must have:

  1. An event code of “notification-discharge”
  2. An event focus reference(s) to US Core Encounter Profile(s) which will be bundled in the message.

Examples

The following examples of this profile are freestanding resource instances. Note that these are technically invalid since the profile is defined to references other resources within the same Da Vinci Notification Message Bundle. A complete list of examples including bundle examples can be found on the Examples page.

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/discharge-notification-messageheader

Published on Tue Nov 12 08:00:00 UTC 2019 as active by the Health eData Inc.

This profile builds on NotificationsMessageHeader


MessageHeader

Summary of the Mandatory Requirements

  1. A Coding in MessageHeader.eventCoding
  2. One or more Focus References in MessageHeader.focus
    • which must have at least one or more Focus Reference values in MessageHeader.focus
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*NotificationsMessageHeader
... eventCoding S1..1CodingRequired Pattern: At least the following
.... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-alerts/CodeSystem/notification-event
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: notification-discharge
.... display1..1stringRepresentation defined by the system
Fixed Value: Notification Discharge
... focus S1..*(Slice Definition)Slice: Unordered, Open by profile:$this
.... focus:discharge-notification S1..*Reference(US Core Encounter Profile) {b}

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader I0..*NotificationsMessageHeaderA resource that describes a message that is exchanged between systems
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... event[x] ΣI1..1(Slice Definition)Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example)
.... event[x]:eventCoding SΣI1..1CodingCode for the event this message represents or link to event definition
Binding: Da Vinci Notification Event ValueSet (extensible)
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-alerts/CodeSystem/notification-event
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: notification-discharge
..... display1..1stringRepresentation defined by the system
Fixed Value: Notification Discharge
..... userSelected0..1booleanIf this coding was chosen directly by the user
... destination SΣI0..1BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name ΣI0..1stringName of system
.... target ΣI0..1Reference(Device)Particular delivery destination within the destination
.... endpoint SΣI1..1urlActual destination address or id
.... receiver ΣI0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender SΣI0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Real world sender of the message
... enterer ΣI0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author SΣI0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) {b}The source of the decision
... source SΣI1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name ΣI0..1stringName of system
.... software ΣI0..1stringName of software running the system
.... version ΣI0..1stringVersion of software running
.... contact ΣI0..1ContactPointHuman contact for problems
.... endpoint ΣI1..1urlActual message source address or id
... responsible SΣI0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Final responsibility for event
... reason ΣI0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example)
... focus SΣI1..*(Slice Definition)The actual content of the message
Slice: Unordered, Open by profile:$this
.... focus:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
..... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
..... display ΣI0..1stringText alternative for the resource
.... focus:discharge-notification SΣI1..*Reference(US Core Encounter Profile) {b}The actual content of the message
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
..... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
..... display ΣI0..1stringText alternative for the resource
... definition ΣI0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

MessageHeader

Summary of the Mandatory Requirements

  1. A Coding in MessageHeader.eventCoding
  2. One or more Focus References in MessageHeader.focus
    • which must have at least one or more Focus Reference values in MessageHeader.focus

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*NotificationsMessageHeader
... eventCoding S1..1CodingRequired Pattern: At least the following
.... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-alerts/CodeSystem/notification-event
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: notification-discharge
.... display1..1stringRepresentation defined by the system
Fixed Value: Notification Discharge
... focus S1..*(Slice Definition)Slice: Unordered, Open by profile:$this
.... focus:discharge-notification S1..*Reference(US Core Encounter Profile) {b}

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader I0..*NotificationsMessageHeaderA resource that describes a message that is exchanged between systems
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... event[x] ΣI1..1(Slice Definition)Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example)
.... event[x]:eventCoding SΣI1..1CodingCode for the event this message represents or link to event definition
Binding: Da Vinci Notification Event ValueSet (extensible)
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-alerts/CodeSystem/notification-event
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: notification-discharge
..... display1..1stringRepresentation defined by the system
Fixed Value: Notification Discharge
..... userSelected0..1booleanIf this coding was chosen directly by the user
... destination SΣI0..1BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name ΣI0..1stringName of system
.... target ΣI0..1Reference(Device)Particular delivery destination within the destination
.... endpoint SΣI1..1urlActual destination address or id
.... receiver ΣI0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender SΣI0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Real world sender of the message
... enterer ΣI0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author SΣI0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) {b}The source of the decision
... source SΣI1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name ΣI0..1stringName of system
.... software ΣI0..1stringName of software running the system
.... version ΣI0..1stringVersion of software running
.... contact ΣI0..1ContactPointHuman contact for problems
.... endpoint ΣI1..1urlActual message source address or id
... responsible SΣI0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Final responsibility for event
... reason ΣI0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example)
... focus SΣI1..*(Slice Definition)The actual content of the message
Slice: Unordered, Open by profile:$this
.... focus:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
..... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
..... display ΣI0..1stringText alternative for the resource
.... focus:discharge-notification SΣI1..*Reference(US Core Encounter Profile) {b}The actual content of the message
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
..... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
..... display ΣI0..1stringText alternative for the resource
... definition ΣI0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format


See the Conformance requirements for a complete list of supported RESTful interactions for this IG.