2.47 2.15 Resource MessageHeader - Content

Name	Flags	Card.	Type	Description & Constraints      Filter: Bindings Constraints Obligations
MessageHeader	Σ TU N		DomainResource	A resource that describes a message that is exchanged between systems Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
event[x]	Σ	1..1		The real world event that triggered this message represents or link to event definition messsage Binding: MessageEvent ( Example )
eventCoding			Coding
eventUri			uri
eventCanonical			canonical ( EventDefinition | SubscriptionTopic )
destination	Σ	0..*	BackboneElement	Message destination application(s)
name endpoint[x]	Σ	0..1		Actual destination address or Endpoint resource Name of system
target endpointUrl			Σ url	0..1
endpointReference			Reference ( Device Endpoint )	Particular delivery destination within the destination
endpoint name	Σ	0..1	url string	Name of system Actual destination address or id
receiver	Σ	0..1	Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | Organization RelatedPerson )	Intended "real-world" recipient for the data
sender source	Σ	1..1	Reference ( Practitioner | PractitionerRole | Organization BackboneElement )	Message source application Real world sender of the message
enterer endpoint[x]	Σ	0..1	Reference ( Practitioner | PractitionerRole )	Actual source of the data entry address or Endpoint resource
author Σ endpointUrl	0..1		Reference ( Practitioner | PractitionerRole url )	The source of the decision
source endpointReference		1..1	BackboneElement Reference ( Endpoint )	Message source application
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 sender	Σ	0..1	Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | Organization )	Real world sender of the message Final responsibility for event
reason	Σ	0..1	CodeableConcept	Cause of event Binding: Example Message Reason Codes ( Example )
response	Σ	0..1	BackboneElement	If this is a reply to prior message
identifier	Σ	1..1	id Identifier	Bundle.identifier of original message
code	Σ	1..1	code	ok | transient-error | fatal-error ResponseType Binding: Response Type ( Required )
details	Σ	0..1	Reference ( OperationOutcome )	Specific list of hints/warnings/errors
focus	Σ	0..*	Reference ( Any )	The actual content of the message
definition	Σ	0..1	canonical ( MessageDefinition )	Link to the definition for this message
Documentation for this format

See the Extensions for this resource

<MessageHeader xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</event[x]>

 <event[x]><!-- 1..1 Coding|uri|canonical(EventDefinition|SubscriptionTopic) The real world event that triggered this messsage --></event[x]>

 <destination>  <!-- 0..* Message destination application(s) -->
  <endpoint[x]><!-- 0..1 url|Reference(Endpoint) Actual destination address or Endpoint resource --></endpoint[x]>

  <name value="[string]"/><!-- 0..1 Name of system -->
  <</target>
  <
  <</receiver>

  <receiver><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) Intended "real-world" recipient for the data --></receiver>
 </destination>
 <</sender>
 <</enterer>
 <</author>

 <source>  <!-- 1..1 Message source application -->
  <endpoint[x]><!-- 0..1 url|Reference(Endpoint) Actual source address or Endpoint resource --></endpoint[x]>

  <name value="[string]"/><!-- 0..1 Name of system -->
  <software value="[string]"/><!-- 0..1 Name of software running the system -->
  <version value="[string]"/><!-- 0..1 Version of software running -->
  <contact><!-- 0..1 ContactPoint Human contact for problems --></contact>
  <

  <sender><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole) Real world sender of the message --></sender>
 </source>
 <</responsible>

 <reason><!-- 0..1 CodeableConcept Cause of event --></reason>
 <response>  <!-- 0..1 If this is a reply to prior message -->
  <

  <identifier><!-- 1..1 Identifier Bundle.identifier of original message --></identifier>

  <code value="[code]"/><!-- 1..1 ok | transient-error | fatal-error -->
  <details><!-- 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors --></details>
 </response>
 <</focus>

 <focus><!-- 0..* Reference(Any) The actual content of the message --></focus>

 <definition><!-- 0..1 canonical(MessageDefinition) Link to the definition for this message --></definition>
</MessageHeader>

{
  "resourceType" : "MessageHeader",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  
  " },
  ">",

  // event[x]: The real world event that triggered this messsage. One of these 3:
  "eventCoding" : { Coding },
  "eventUri" : "<uri>",
  "eventCanonical" : "<canonical(EventDefinition|SubscriptionTopic)>",

  "destination" : [{ // Message destination application(s)
    // endpoint[x]: Actual destination address or Endpoint resource. One of these 2:
    "endpointUrl" : "<url>",
    "endpointReference" : { Reference(Endpoint) },

    "name" : "<string>", // Name of system
    "
    "
    "

    "receiver" : { Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) } // Intended "real-world" recipient for the data
  }],
  "
  "
  "

  "source" : { // R!  Message source application
    // endpoint[x]: Actual source address or Endpoint resource. One of these 2:
    "endpointUrl" : "<url>",
    "endpointReference" : { Reference(Endpoint) },

    "name" : "<string>", // Name of system
    "software" : "<string>", // Name of software running the system
    "version" : "<string>", // Version of software running
    "contact" : { ContactPoint }, // Human contact for problems
    "

    "sender" : { Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole) } // Real world sender of the message
  },
  "

  "reason" : { CodeableConcept }, // Cause of event
  "response" : { // If this is a reply to prior message
    "

    "identifier" : { Identifier }, // R!  Bundle.identifier of original message

    "code" : "<code>", // R!  ok | transient-error | fatal-error
    "details" : { Reference(OperationOutcome) } // Specific list of hints/warnings/errors
  },
  "
  "

  "focus" : [{ Reference(Any) }], // The actual content of the message
  "definition" : "<canonical(MessageDefinition)>" // Link to the definition for this message

}

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:MessageHeader;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 
  # . One of these 2
    fhir: ]
    fhir: ]
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
  ];
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
  ];
  fhir:
  fhir:

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  # event[x] : 1..1 The real world event that triggered this messsage. One of these 3
    fhir:event [  a fhir:Coding ; Coding ]
    fhir:event [  a fhir:Uri ; uri ]
    fhir:event [  a fhir:Canonical ; canonical(EventDefinition|SubscriptionTopic) ]
  fhir:destination ( [ # 0..* Message destination application(s)
    # endpoint[x] : 0..1 Actual destination address or Endpoint resource. One of these 2
      fhir:endpoint [  a fhir:Url ; url ]
      fhir:endpoint [  a fhir:Reference ; Reference(Endpoint) ]
    fhir:name [ string ] ; # 0..1 Name of system
    fhir:receiver [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Intended "real-world" recipient for the data
  ] ... ) ;
  fhir:source [ # 1..1 Message source application
    # endpoint[x] : 0..1 Actual source address or Endpoint resource. One of these 2
      fhir:endpoint [  a fhir:Url ; url ]
      fhir:endpoint [  a fhir:Reference ; Reference(Endpoint) ]
    fhir:name [ string ] ; # 0..1 Name of system
    fhir:software [ string ] ; # 0..1 Name of software running the system
    fhir:version [ string ] ; # 0..1 Version of software running
    fhir:contact [ ContactPoint ] ; # 0..1 Human contact for problems
    fhir:sender [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole) ] ; # 0..1 Real world sender of the message
  ] ;
  fhir:reason [ CodeableConcept ] ; # 0..1 Cause of event
  fhir:response [ # 0..1 If this is a reply to prior message
    fhir:identifier [ Identifier ] ; # 1..1 Bundle.identifier of original message
    fhir:code [ code ] ; # 1..1 ok | transient-error | fatal-error
    fhir:details [ Reference(OperationOutcome) ] ; # 0..1 Specific list of hints/warnings/errors
  ] ;
  fhir:focus  ( [ Reference(Any) ] ... ) ; # 0..* The actual content of the message
  fhir:definition [ canonical(MessageDefinition) ] ; # 0..1 Link to the definition for this message

]

Changes since R3 from R5 to R6

Changes from R4 and R4B to R6

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). ) for R4B as XML or JSON .

Name	Flags	Card.	Type	Description & Constraints      Filter: Bindings Constraints Obligations
MessageHeader	Σ TU N		DomainResource	A resource that describes a message that is exchanged between systems Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
event[x]	Σ	1..1		The real world event that triggered this message represents or link to event definition messsage Binding: MessageEvent ( Example )
eventCoding			Coding
eventUri			uri
eventCanonical			canonical ( EventDefinition | SubscriptionTopic )
destination	Σ	0..*	BackboneElement	Message destination application(s)
name endpoint[x]	Σ	0..1		Actual destination address or Endpoint resource Name of system
target endpointUrl			Σ url	0..1
endpointReference			Reference ( Device Endpoint )	Particular delivery destination within the destination
endpoint name	Σ	0..1	url string	Name of system Actual destination address or id
receiver	Σ	0..1	Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | Organization RelatedPerson )	Intended "real-world" recipient for the data
sender source	Σ	1..1	Reference ( Practitioner | PractitionerRole | Organization BackboneElement )	Message source application Real world sender of the message
enterer endpoint[x]	Σ	0..1	Reference ( Practitioner | PractitionerRole )	Actual source of the data entry address or Endpoint resource
author Σ endpointUrl	0..1		Reference ( Practitioner | PractitionerRole url )	The source of the decision
source endpointReference		1..1	BackboneElement Reference ( Endpoint )	Message source application
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 sender	Σ	0..1	Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | Organization )	Real world sender of the message Final responsibility for event
reason	Σ	0..1	CodeableConcept	Cause of event Binding: Example Message Reason Codes ( Example )
response	Σ	0..1	BackboneElement	If this is a reply to prior message
identifier	Σ	1..1	id Identifier	Bundle.identifier of original message
code	Σ	1..1	code	ok | transient-error | fatal-error ResponseType Binding: Response Type ( Required )
details	Σ	0..1	Reference ( OperationOutcome )	Specific list of hints/warnings/errors
focus	Σ	0..*	Reference ( Any )	The actual content of the message
definition	Σ	0..1	canonical ( MessageDefinition )	Link to the definition for this message
Documentation for this format

See the Extensions for this resource

<MessageHeader xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</event[x]>

 <event[x]><!-- 1..1 Coding|uri|canonical(EventDefinition|SubscriptionTopic) The real world event that triggered this messsage --></event[x]>

 <destination>  <!-- 0..* Message destination application(s) -->
  <endpoint[x]><!-- 0..1 url|Reference(Endpoint) Actual destination address or Endpoint resource --></endpoint[x]>

  <name value="[string]"/><!-- 0..1 Name of system -->
  <</target>
  <
  <</receiver>

  <receiver><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) Intended "real-world" recipient for the data --></receiver>
 </destination>
 <</sender>
 <</enterer>
 <</author>

 <source>  <!-- 1..1 Message source application -->
  <endpoint[x]><!-- 0..1 url|Reference(Endpoint) Actual source address or Endpoint resource --></endpoint[x]>

  <name value="[string]"/><!-- 0..1 Name of system -->
  <software value="[string]"/><!-- 0..1 Name of software running the system -->
  <version value="[string]"/><!-- 0..1 Version of software running -->
  <contact><!-- 0..1 ContactPoint Human contact for problems --></contact>
  <

  <sender><!-- 0..1 Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole) Real world sender of the message --></sender>
 </source>
 <</responsible>

 <reason><!-- 0..1 CodeableConcept Cause of event --></reason>
 <response>  <!-- 0..1 If this is a reply to prior message -->
  <

  <identifier><!-- 1..1 Identifier Bundle.identifier of original message --></identifier>

  <code value="[code]"/><!-- 1..1 ok | transient-error | fatal-error -->
  <details><!-- 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors --></details>
 </response>
 <</focus>

 <focus><!-- 0..* Reference(Any) The actual content of the message --></focus>

 <definition><!-- 0..1 canonical(MessageDefinition) Link to the definition for this message --></definition>
</MessageHeader>

{
  "resourceType" : "MessageHeader",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  
  " },
  ">",

  // event[x]: The real world event that triggered this messsage. One of these 3:
  "eventCoding" : { Coding },
  "eventUri" : "<uri>",
  "eventCanonical" : "<canonical(EventDefinition|SubscriptionTopic)>",

  "destination" : [{ // Message destination application(s)
    // endpoint[x]: Actual destination address or Endpoint resource. One of these 2:
    "endpointUrl" : "<url>",
    "endpointReference" : { Reference(Endpoint) },

    "name" : "<string>", // Name of system
    "
    "
    "

    "receiver" : { Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) } // Intended "real-world" recipient for the data
  }],
  "
  "
  "

  "source" : { // R!  Message source application
    // endpoint[x]: Actual source address or Endpoint resource. One of these 2:
    "endpointUrl" : "<url>",
    "endpointReference" : { Reference(Endpoint) },

    "name" : "<string>", // Name of system
    "software" : "<string>", // Name of software running the system
    "version" : "<string>", // Version of software running
    "contact" : { ContactPoint }, // Human contact for problems
    "

    "sender" : { Reference(Device|Organization|Patient|Practitioner|
    PractitionerRole) } // Real world sender of the message
  },
  "

  "reason" : { CodeableConcept }, // Cause of event
  "response" : { // If this is a reply to prior message
    "

    "identifier" : { Identifier }, // R!  Bundle.identifier of original message

    "code" : "<code>", // R!  ok | transient-error | fatal-error
    "details" : { Reference(OperationOutcome) } // Specific list of hints/warnings/errors
  },
  "
  "

  "focus" : [{ Reference(Any) }], // The actual content of the message
  "definition" : "<canonical(MessageDefinition)>" // Link to the definition for this message

}

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:MessageHeader;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 
  # . One of these 2
    fhir: ]
    fhir: ]
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
  ];
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
  ];
  fhir:
  fhir:

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  # event[x] : 1..1 The real world event that triggered this messsage. One of these 3
    fhir:event [  a fhir:Coding ; Coding ]
    fhir:event [  a fhir:Uri ; uri ]
    fhir:event [  a fhir:Canonical ; canonical(EventDefinition|SubscriptionTopic) ]
  fhir:destination ( [ # 0..* Message destination application(s)
    # endpoint[x] : 0..1 Actual destination address or Endpoint resource. One of these 2
      fhir:endpoint [  a fhir:Url ; url ]
      fhir:endpoint [  a fhir:Reference ; Reference(Endpoint) ]
    fhir:name [ string ] ; # 0..1 Name of system
    fhir:receiver [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Intended "real-world" recipient for the data
  ] ... ) ;
  fhir:source [ # 1..1 Message source application
    # endpoint[x] : 0..1 Actual source address or Endpoint resource. One of these 2
      fhir:endpoint [  a fhir:Url ; url ]
      fhir:endpoint [  a fhir:Reference ; Reference(Endpoint) ]
    fhir:name [ string ] ; # 0..1 Name of system
    fhir:software [ string ] ; # 0..1 Name of software running the system
    fhir:version [ string ] ; # 0..1 Version of software running
    fhir:contact [ ContactPoint ] ; # 0..1 Human contact for problems
    fhir:sender [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole) ] ; # 0..1 Real world sender of the message
  ] ;
  fhir:reason [ CodeableConcept ] ; # 0..1 Cause of event
  fhir:response [ # 0..1 If this is a reply to prior message
    fhir:identifier [ Identifier ] ; # 1..1 Bundle.identifier of original message
    fhir:code [ code ] ; # 1..1 ok | transient-error | fatal-error
    fhir:details [ Reference(OperationOutcome) ] ; # 0..1 Specific list of hints/warnings/errors
  ] ;
  fhir:focus  ( [ Reference(Any) ] ... ) ; # 0..* The actual content of the message
  fhir:definition [ canonical(MessageDefinition) ] ; # 0..1 Link to the definition for this message

]

Changes since Release 3 from R5 to R6

Changes from R4 and R4B to R6

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). ) for R4B as XML or JSON .