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-admit-notification-messageheader
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 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:
- An event code of “notification-admit”
- A reference to US Core Encounter Profile for the event focus 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/admit-notification-messageheader
Published on Tue Nov 12 08:00:00 UTC 2019 as active by the Health eData Inc.
This profile builds on NotificationsMessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageHeader | 0..* | NotificationsMessageHeader | ||
  eventCoding | S | 1..1 | Coding | Required Pattern: At least the following |
  system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-alerts/CodeSystem/notification-event | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: notification-admit | |
 display | 1..1 | string | Representation defined by the system Fixed Value: Notification admit | |
 focus | S | 1..* | (Slice Definition) | Slice: Unordered, Open by profile:$this |
   focus:admit-notification | S | 1..* | Reference(US Core Encounter Profile) {b} | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | I | 0..* | NotificationsMessageHeader | A resource that describes a message that is exchanged between systems |
 id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| event[x] | ΣI | 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ΣI | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: Da Vinci Notification Event ValueSet (extensible) Required Pattern: At least the following |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-alerts/CodeSystem/notification-event | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: notification-admit | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Notification admit | |
 userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| destination | SΣI | 0..1 | BackboneElement | Message destination application(s) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 0..1 | string | Name of system |
 target | ΣI | 0..1 | Reference(Device) | Particular delivery destination within the destination |
| endpoint | SΣI | 1..1 | url | Actual destination address or id |
| receiver | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data |
| sender | SΣI | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b} | Real world sender of the message |
| enterer | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry |
| author | SΣI | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) {b} | The source of the decision |
| source | SΣI | 1..1 | BackboneElement | Message source application |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 0..1 | string | Name of system |
| software | ΣI | 0..1 | string | Name of software running the system |
| version | ΣI | 0..1 | string | Version of software running |
| contact | ΣI | 0..1 | ContactPoint | Human contact for problems |
| endpoint | ΣI | 1..1 | url | Actual message source address or id |
| responsible | SΣI | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b} | Final responsibility for event |
| reason | ΣI | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example) |
| focus | SΣI | 1..* | (Slice Definition) | The actual content of the message Slice: Unordered, Open by profile:$this |
  focus:All Slices | Content/Rules for all slices | |||
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | SΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| focus:admit-notification | SΣI | 1..* | Reference(US Core Encounter Profile) {b} | The actual content of the message |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | SΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| definition | ΣI | 0..1 | canonical(MessageDefinition) | Link to the definition for this message |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | NotificationsMessageHeader | ||
| eventCoding | S | 1..1 | Coding | Required Pattern: At least the following |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-alerts/CodeSystem/notification-event | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: notification-admit | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Notification admit | |
| focus | S | 1..* | (Slice Definition) | Slice: Unordered, Open by profile:$this |
| focus:admit-notification | S | 1..* | Reference(US Core Encounter Profile) {b} | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | I | 0..* | NotificationsMessageHeader | A resource that describes a message that is exchanged between systems |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| event[x] | ΣI | 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ΣI | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: Da Vinci Notification Event ValueSet (extensible) Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-alerts/CodeSystem/notification-event | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: notification-admit | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Notification admit | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| destination | SΣI | 0..1 | BackboneElement | Message destination application(s) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 0..1 | string | Name of system |
| target | ΣI | 0..1 | Reference(Device) | Particular delivery destination within the destination |
| endpoint | SΣI | 1..1 | url | Actual destination address or id |
| receiver | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data |
| sender | SΣI | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b} | Real world sender of the message |
| enterer | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry |
| author | SΣI | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) {b} | The source of the decision |
| source | SΣI | 1..1 | BackboneElement | Message source application |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | ΣI | 0..1 | string | Name of system |
| software | ΣI | 0..1 | string | Name of software running the system |
| version | ΣI | 0..1 | string | Version of software running |
| contact | ΣI | 0..1 | ContactPoint | Human contact for problems |
| endpoint | ΣI | 1..1 | url | Actual message source address or id |
| responsible | SΣI | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b} | Final responsibility for event |
| reason | ΣI | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example) |
| focus | SΣI | 1..* | (Slice Definition) | The actual content of the message Slice: Unordered, Open by profile:$this |
| focus:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | SΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| focus:admit-notification | SΣI | 1..* | Reference(US Core Encounter Profile) {b} | The actual content of the message |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | SΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| definition | ΣI | 0..1 | canonical(MessageDefinition) | Link to the definition for this message |
| Documentation for this format | ||||
See the Conformance requirements for a complete list of supported RESTful interactions for this IG.
