Da Vinci Unsolicited Notifications Implementation Guide (Release 0.2.0 STU1 Ballot)

This page is part of the Da Vinci Unsolicited Notifications (v0.2.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition-notifications-messageheader

The Da Vinci Notifications MessageHeader Profile sets minimum expectations for the FHIR MessageHeader resource to record the necessary context for Da Vinci notification messaging using FHIR resources. It reference(s) the focus of the use case event or request as well as other information related to the action are typically transmitted in a Bundle resource in which the MessageHeader resource instance is the first resource in the Bundle.

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. A code for the type of event
  2. the message source application
  3. A reference to the event’s focus resource(s) which will be bundled in the message.

Each MessageHeader must support:

  1. A destination
  2. A reference to the sender which will be bundled in the message.
  3. A reference to author which will be bundled in the message.
  4. A reference to responsible party which will be bundled in the message.

Additional Profile specific implementation guidance:

The destination.endpoint and source.endpoint can be in any form of url the server understands (usually, https: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point

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/notifications-messageheader

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

This profile builds on MessageHeader

MessageHeader

Summary of the Mandatory Requirements

  1. A Coding in MessageHeader.eventCoding with an extensible binding to Da Vinci Notification Event ValueSet
  2. A Source in MessageHeader.source
  3. One or more Focus References in MessageHeader.focus
    • which must have a string value in MessageHeader.focus.reference

Summary of the Must Support Requirements

  1. A Destination in MessageHeader.destination
  2. A Sender Reference in MessageHeader.sender
  3. An Author Reference in MessageHeader.author
  4. A Responsible Reference in MessageHeader.responsible

Summary of the Unsupported Elements

  1. MessageHeader.response
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader I0..*MessageHeaderA 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)
... 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..*Reference(Resource) {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 with an extensible binding to Da Vinci Notification Event ValueSet
  2. A Source in MessageHeader.source
  3. One or more Focus References in MessageHeader.focus
    • which must have a string value in MessageHeader.focus.reference

Summary of the Must Support Requirements

  1. A Destination in MessageHeader.destination
  2. A Sender Reference in MessageHeader.sender
  3. An Author Reference in MessageHeader.author
  4. A Responsible Reference in MessageHeader.responsible

Summary of the Unsupported Elements

  1. MessageHeader.response

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader I0..*MessageHeaderA 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)
... 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..*Reference(Resource) {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.