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
Defining URL: | http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/admit-notification-messageheader |
Version: | 1.0.0 |
Name: | AdmitNotificationMessageHeader |
Title: | Da Vinci Admit Notification MessageHeader Profile |
Status: | Active as of 2019-11-12T00:00:00-08:00 |
Definition: | 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. |
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/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 Encounter.
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:
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.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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:
This structure is derived from NotificationsMessageHeader
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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) |
focus | S | 1..* | (Slice Definition) | The actual content of the message Slice: Unordered, Open by profile:$this.resolve() |
focus:admit-notification | S | 1..* | Reference(Da Vinci Admit/Transfer/Discharge Notification Encounter Profile) {b} | The actual content of the message |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | NotificationsMessageHeader | A resource that describes a message that is exchanged between systems | |
id | SΣ | 1..1 | string | 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) Max Binding: AllLanguages | |
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 |
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..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(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b} | Real world sender 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ΣI | 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) |
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(US Core Practitioner Profile | US Core PractitionerRole Profile) {b} | The source of the decision |
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ΣI | 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) |
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(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core 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ΣI | 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) |
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) |
focus | SΣ | 1..* | (Slice Definition) | 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ΣI | 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) |
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/Transfer/Discharge 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ΣI | 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) |
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 |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | NotificationsMessageHeader | A resource that describes a message that is exchanged between systems | |
id | Σ | 1..1 | string | Logical id of this artifact |
event[x]:eventCoding | Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: Da Vinci Notification Admit Event ValueSet (extensible) |
destination | Σ | 0..1 | BackboneElement | Message destination application(s) |
endpoint | Σ | 1..1 | url | Actual destination address or id |
sender | Σ | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b} | Real world sender of the message |
reference | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
author | Σ | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) {b} | The source of the decision |
reference | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
source | Σ | 1..1 | BackboneElement | Message source application |
responsible | Σ | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b} | Final responsibility for event |
reference | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
focus | Σ | 1..* | (Slice Definition) | The actual content of the message Slice: Unordered, Open by profile:$this.resolve() |
focus:All Slices | Content/Rules for all slices | |||
reference | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
focus:admit-notification | Σ | 1..* | Reference(Da Vinci Admit/Transfer/Discharge Notification Encounter Profile) {b} | The actual content of the message |
reference | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
Documentation for this format |
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:
Differential View
This structure is derived from NotificationsMessageHeader
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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) |
focus | S | 1..* | (Slice Definition) | The actual content of the message Slice: Unordered, Open by profile:$this.resolve() |
focus:admit-notification | S | 1..* | Reference(Da Vinci Admit/Transfer/Discharge Notification Encounter Profile) {b} | The actual content of the message |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | NotificationsMessageHeader | A resource that describes a message that is exchanged between systems | |
id | SΣ | 1..1 | string | 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) Max Binding: AllLanguages | |
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 |
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..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(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) {b} | Real world sender 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ΣI | 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) |
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(US Core Practitioner Profile | US Core PractitionerRole Profile) {b} | The source of the decision |
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ΣI | 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) |
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(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core 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ΣI | 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) |
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) |
focus | SΣ | 1..* | (Slice Definition) | 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ΣI | 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) |
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/Transfer/Discharge 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ΣI | 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) |
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 |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
MessageHeader.language | preferred | CommonLanguages Max Binding: AllLanguages |
MessageHeader.event[x] | example | MessageEvent |
MessageHeader.event[x]:eventCoding | extensible | NotificationAdmitEventValueSet |
MessageHeader.sender.type | extensible | ResourceType |
MessageHeader.author.type | extensible | ResourceType |
MessageHeader.responsible.type | extensible | ResourceType |
MessageHeader.reason | example | ExampleMessageReasonCodes |
MessageHeader.response.code | required | ResponseType |
MessageHeader.focus.type | extensible | ResourceType |
MessageHeader.focus:admit-notification.type | extensible | ResourceType |