Extension: MessageHeader Response Request

Infrastructure And Messaging Work Group

Maturity Level: 1

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/messageheader-response-request`				Version: 5.0.0-snapshot3
draft as of 2017-01-24				Computable Name: MsgResponseRequest
Flags: Non-Modifier				OID: 2.16.840.1.113883.4.642.5.1435

Context of Use: Use on Element ID MessageHeader

Definition

This extension enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never.

Comment:

The Message Definition data provides perhaps what would be acceptable response requests, but could not indicate for each instance what is appropriate. The initiator should be able to handle the response even if not expected.

Summary

Name	Flags	Card.	Type	Description & Constraints
MsgResponseRequest		0..1	code	URL = http://hl7.org/fhir/StructureDefinition/messageheader-response-request MsgResponseRequest: This extension enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never. Binding: messageheader-response-request (required): Message Header Response Request codes Use on Element ID MessageHeader
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/messageheader-response-request MsgResponseRequest: This extension enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never. Use on Element ID MessageHeader
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/messageheader-response-request"
value[x]	1..1	code	Value of extension Binding: messageheader-response-request (required): Message Header Response Request codes
Documentation for this format

XML Template

<!-- MsgResponseRequest -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/messageheader-response-request" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // MsgResponseRequest
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/messageheader-response-request", // R! 
    "valueCode" : "<code>" // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
MsgResponseRequest		0..1	code	URL = http://hl7.org/fhir/StructureDefinition/messageheader-response-request MsgResponseRequest: This extension enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never. Binding: messageheader-response-request (required): Message Header Response Request codes Use on Element ID MessageHeader
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/messageheader-response-request MsgResponseRequest: This extension enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never. Use on Element ID MessageHeader
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/messageheader-response-request"
value[x]	1..1	code	Value of extension Binding: messageheader-response-request (required): Message Header Response Request codes
Documentation for this format

XML Template

<!-- MsgResponseRequest -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/messageheader-response-request" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // MsgResponseRequest
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/messageheader-response-request", // R! 
    "valueCode" : "<code>" // I R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.