Da Vinci Unsolicited Notifications
1.1.0-preview - STU1 United States of America flag

Da Vinci Unsolicited Notifications, published by HL7 International / Infrastructure And Messaging. This guide is not an authorized publication; it is the continuous build for version 1.1.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-alerts/ and changes regularly. See the Directory of published versions

Resource Profile: Da Vinci Admit Notification MessageHeader Profile

Official URL: http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/admit-notification-messageheader Version: 1.1.0-preview
Standards status: Trial-use Maturity Level: 2 Computable Name: AdmitNotificationMessageHeader
Other Identifiers: OID:2.16.840.1.113883.4.642.40.47.42.1

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

The Da Vinci Admit 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 admit notification messaging scenario. The event code is "notification-admit" and the focus of the event is the Encounter.

Introduction

The Da Vinci Admit 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 admit notification messaging scenario. The event code is "notification-admit" and the focus of the event is the Encounter.

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-admit"
  2. An event focus reference to the Da Vinci Admit/Discharge/Transfer Notification Encounter Profile which will be bundled in the message

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.

Usage:

Formal Views of Profile Content

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

This structure is derived from NotificationsMessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* NotificationsMessageHeader A resource that describes a message that is exchanged between systems
... eventCoding S 1..1 Coding Code for the event this message represents or link to event definition
Binding: Da Vinci Notification Admit Event ValueSet (extensible)
... Slices for focus S 1..* Reference(Resource) {b} The actual content of the message
Slice: Unordered, Open by profile:$this.resolve()
.... focus:admit-notification S 1..* Reference(Da Vinci Admit/Discharge/Transfer Notification Encounter Profile) {b} The actual content of the message

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MessageHeader.eventCodingextensibleNotificationAdmitEventValueSet
http://hl7.org/fhir/us/davinci-alerts/ValueSet/notification-admit-event
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* NotificationsMessageHeader A resource that describes a message that is exchanged between systems
... id SΣ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] Σ 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventCoding SΣ 1..1 Coding Code for the event this message represents or link to event definition
Binding: Da Vinci Notification Admit Event ValueSet (extensible)
... destination SΣ 0..1 BackboneElement Message destination application(s)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint SΣ 1..1 url Actual destination address or id
... sender SΣ 0..1 Reference(HRex Practitioner Profile | HRex PractitionerRole Profile | HRex Organization Profile) {b} Real world sender of the message
.... Slices for extension Content/Rules for all slices
..... Device S 0..1 (Complex) Device as a sender
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] S 1..1 Reference(Device) {b} Value of extension
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
... author SΣ 0..1 Reference(HRex Practitioner Profile | HRex PractitionerRole Profile) {b} The source of the decision
.... Slices for extension Content/Rules for all slices
..... Device S 0..1 (Complex) Device as a author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] S 1..1 Reference(Device) {b} Value of extension
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
... source SΣ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual message source address or id
... responsible SΣ 0..1 Reference(HRex Practitioner Profile | HRex PractitionerRole Profile | HRex Organization Profile) {b} Final responsibility for event
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for focus SΣ 1..* Reference(Resource) {b} The actual content of the message
Slice: Unordered, Open by profile:$this.resolve()
.... focus:All Slices Content/Rules for all slices
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... focus:admit-notification SΣ 1..* Reference(Da Vinci Admit/Discharge/Transfer Notification Encounter Profile) {b} The actual content of the message
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventCodingextensibleNotificationAdmitEventValueSet
http://hl7.org/fhir/us/davinci-alerts/ValueSet/notification-admit-event
from this IG
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* NotificationsMessageHeader A resource that describes a message that is exchanged between systems
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] Σ 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventCoding SΣ 1..1 Coding Code for the event this message represents or link to event definition
Binding: Da Vinci Notification Admit Event ValueSet (extensible)
... destination SΣ 0..1 BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint SΣ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender SΣ 0..1 Reference(HRex Practitioner Profile | HRex PractitionerRole Profile | HRex Organization Profile) {b} Real world sender of the message
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Device S 0..1 (Complex) Device as a sender
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] S 1..1 Reference(Device) {b} Value of extension
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author SΣ 0..1 Reference(HRex Practitioner Profile | HRex PractitionerRole Profile) {b} The source of the decision
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Device S 0..1 (Complex) Device as a author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] S 1..1 Reference(Device) {b} Value of extension
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... source SΣ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint Σ 1..1 url Actual message source address or id
... responsible SΣ 0..1 Reference(HRex Practitioner Profile | HRex PractitionerRole Profile | HRex Organization Profile) {b} Final responsibility for event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... Slices for focus SΣ 1..* Reference(Resource) {b} The actual content of the message
Slice: Unordered, Open by profile:$this.resolve()
.... focus:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... focus:admit-notification SΣ 1..* Reference(Da Vinci Admit/Discharge/Transfer Notification Encounter Profile) {b} The actual content of the message
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventCodingextensibleNotificationAdmitEventValueSet
http://hl7.org/fhir/us/davinci-alerts/ValueSet/notification-admit-event
from this IG
MessageHeader.sender.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MessageHeader.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MessageHeader.responsible.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MessageHeader.reasonexampleExampleMessageReasonCodes
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard
MessageHeader.focus.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MessageHeader.focus:admit-notification.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from NotificationsMessageHeader

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MessageHeader.focus

Maturity: 2

Differential View

This structure is derived from NotificationsMessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* NotificationsMessageHeader A resource that describes a message that is exchanged between systems
... eventCoding S 1..1 Coding Code for the event this message represents or link to event definition
Binding: Da Vinci Notification Admit Event ValueSet (extensible)
... Slices for focus S 1..* Reference(Resource) {b} The actual content of the message
Slice: Unordered, Open by profile:$this.resolve()
.... focus:admit-notification S 1..* Reference(Da Vinci Admit/Discharge/Transfer Notification Encounter Profile) {b} The actual content of the message

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MessageHeader.eventCodingextensibleNotificationAdmitEventValueSet
http://hl7.org/fhir/us/davinci-alerts/ValueSet/notification-admit-event
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* NotificationsMessageHeader A resource that describes a message that is exchanged between systems
... id SΣ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] Σ 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventCoding SΣ 1..1 Coding Code for the event this message represents or link to event definition
Binding: Da Vinci Notification Admit Event ValueSet (extensible)
... destination SΣ 0..1 BackboneElement Message destination application(s)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint SΣ 1..1 url Actual destination address or id
... sender SΣ 0..1 Reference(HRex Practitioner Profile | HRex PractitionerRole Profile | HRex Organization Profile) {b} Real world sender of the message
.... Slices for extension Content/Rules for all slices
..... Device S 0..1 (Complex) Device as a sender
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] S 1..1 Reference(Device) {b} Value of extension
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
... author SΣ 0..1 Reference(HRex Practitioner Profile | HRex PractitionerRole Profile) {b} The source of the decision
.... Slices for extension Content/Rules for all slices
..... Device S 0..1 (Complex) Device as a author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] S 1..1 Reference(Device) {b} Value of extension
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
... source SΣ 1..1 BackboneElement Message source application
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual message source address or id
... responsible SΣ 0..1 Reference(HRex Practitioner Profile | HRex PractitionerRole Profile | HRex Organization Profile) {b} Final responsibility for event
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for focus SΣ 1..* Reference(Resource) {b} The actual content of the message
Slice: Unordered, Open by profile:$this.resolve()
.... focus:All Slices Content/Rules for all slices
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... focus:admit-notification SΣ 1..* Reference(Da Vinci Admit/Discharge/Transfer Notification Encounter Profile) {b} The actual content of the message
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventCodingextensibleNotificationAdmitEventValueSet
http://hl7.org/fhir/us/davinci-alerts/ValueSet/notification-admit-event
from this IG
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* NotificationsMessageHeader A resource that describes a message that is exchanged between systems
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] Σ 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventCoding SΣ 1..1 Coding Code for the event this message represents or link to event definition
Binding: Da Vinci Notification Admit Event ValueSet (extensible)
... destination SΣ 0..1 BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint SΣ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender SΣ 0..1 Reference(HRex Practitioner Profile | HRex PractitionerRole Profile | HRex Organization Profile) {b} Real world sender of the message
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Device S 0..1 (Complex) Device as a sender
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] S 1..1 Reference(Device) {b} Value of extension
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author SΣ 0..1 Reference(HRex Practitioner Profile | HRex PractitionerRole Profile) {b} The source of the decision
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Device S 0..1 (Complex) Device as a author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] S 1..1 Reference(Device) {b} Value of extension
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... source SΣ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint Σ 1..1 url Actual message source address or id
... responsible SΣ 0..1 Reference(HRex Practitioner Profile | HRex PractitionerRole Profile | HRex Organization Profile) {b} Final responsibility for event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... Slices for focus SΣ 1..* Reference(Resource) {b} The actual content of the message
Slice: Unordered, Open by profile:$this.resolve()
.... focus:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... focus:admit-notification SΣ 1..* Reference(Da Vinci Admit/Discharge/Transfer Notification Encounter Profile) {b} The actual content of the message
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventCodingextensibleNotificationAdmitEventValueSet
http://hl7.org/fhir/us/davinci-alerts/ValueSet/notification-admit-event
from this IG
MessageHeader.sender.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MessageHeader.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MessageHeader.responsible.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MessageHeader.reasonexampleExampleMessageReasonCodes
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard
MessageHeader.focus.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MessageHeader.focus:admit-notification.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from NotificationsMessageHeader

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MessageHeader.focus

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron