Da Vinci Unsolicited Notifications
1.0.0 - STU1 Release

This page is part of the Da Vinci Unsolicited Notifications (v1.0.0: STU1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: NotificationsMessageHeader

Defining URL:http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/notifications-messageheader
Version:1.0.0
Name:NotificationsMessageHeader
Title:Da Vinci Notifications MessageHeader Profile
Status:Active as of 2019-11-13T00:00:00-08:00
Definition:

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 references the focus of the use case event or request as well as other information related to the action typically transmitted in a Bundle resource in which the MessageHeader resource instance is the first resource in the Bundle.

Publisher:HL7 International - Infrastructure and Messaging Work Group
Copyright:

Used by permission of HL7 International - Infrastructure and Messaging Work Group, all rights reserved Creative Commons License

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/notifications-messageheader

Introduction

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 references the focus of the use case event or request as well as other information related to the action 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 logical id
  2. A code for the type of event
  3. The message source application
  4. 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
  • The reference attribute is required for MessageHeader.sender, MessageHeader.author, MessageHeader.responsible, and MessageHeader.focus so there is no question how to find the resource inside the bundle - the use of only an identifier attribute (in other words, a logical reference) is not permitted.

Examples

The following example of this profile is a freestanding resource instance which is technically invalid since the profile is defined to reference other resources within the same Da Vinci Notification Message Bundle. For examples of this profile within a bundle, see the message bundle examples which are listed on the Examples page.

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from MessageHeader

Summary

Mandatory: 4 elements (4 nested mandatory elements)
Must-Support: 13 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id S1..1stringLogical id of this artifact
... eventCoding S1..1CodingCode for the event this message represents or link to event definition
Binding: Da Vinci Notification Event ValueSet (extensible)
... destination S0..1BackboneElementMessage destination application(s)
.... endpoint S1..1urlActual destination address or id
... sender S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Real world sender of the message
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... author S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) {b}The source of the decision
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... source S1..1BackboneElementMessage source application
... responsible S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Final responsibility for event
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... response 0..0
... focus S1..*Reference(Resource) {b}The actual content of the message
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id SΣ1..1stringLogical 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
... event[x] Σ1..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Σ1..1CodingCode for the event this message represents or link to event definition
Binding: Da Vinci Notification Event ValueSet (extensible)
... destination SΣ0..1BackboneElementMessage destination application(s)
.... 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
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint SΣ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender SΣ0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Real world sender of the message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author SΣ0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) {b}The source of the decision
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... source SΣ1..1BackboneElementMessage source application
.... 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
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible SΣ0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Final responsibility for event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example)
... focus SΣ1..*Reference(Resource) {b}The actual content of the message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id Σ1..1stringLogical id of this artifact
... event[x]:eventCoding Σ1..1CodingCode for the event this message represents or link to event definition
Binding: Da Vinci Notification Event ValueSet (extensible)
... destination Σ0..1BackboneElementMessage destination application(s)
.... endpoint Σ1..1urlActual destination address or id
... sender Σ0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Real world sender of the message
.... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL
... author Σ0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) {b}The source of the decision
.... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL
... source Σ1..1BackboneElementMessage source application
... responsible Σ0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Final responsibility for event
.... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL
... focus Σ1..*Reference(Resource) {b}The actual content of the message
.... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL

doco Documentation for this format

This structure is derived from MessageHeader

Summary

Mandatory: 4 elements (4 nested mandatory elements)
Must-Support: 13 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id S1..1stringLogical id of this artifact
... eventCoding S1..1CodingCode for the event this message represents or link to event definition
Binding: Da Vinci Notification Event ValueSet (extensible)
... destination S0..1BackboneElementMessage destination application(s)
.... endpoint S1..1urlActual destination address or id
... sender S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Real world sender of the message
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... author S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) {b}The source of the decision
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... source S1..1BackboneElementMessage source application
... responsible S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Final responsibility for event
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL
... response 0..0
... focus S1..*Reference(Resource) {b}The actual content of the message
.... reference S1..1stringLiteral reference, Relative, internal or absolute URL

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id SΣ1..1stringLogical 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
... event[x] Σ1..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Σ1..1CodingCode for the event this message represents or link to event definition
Binding: Da Vinci Notification Event ValueSet (extensible)
... destination SΣ0..1BackboneElementMessage destination application(s)
.... 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
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint SΣ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender SΣ0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Real world sender of the message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author SΣ0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) {b}The source of the decision
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... source SΣ1..1BackboneElementMessage source application
.... 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
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible SΣ0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b}Final responsibility for event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example)
... focus SΣ1..*Reference(Resource) {b}The actual content of the message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
MessageHeader.languagepreferredCommonLanguages
Max Binding: AllLanguages
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventCodingextensibleNotificationEventValueSet
MessageHeader.sender.typeextensibleResourceType
MessageHeader.author.typeextensibleResourceType
MessageHeader.responsible.typeextensibleResourceType
MessageHeader.reasonexampleExampleMessageReasonCodes
MessageHeader.response.coderequiredResponseType
MessageHeader.focus.typeextensibleResourceType