Current Build

Extension: messageheader-response-request

Infrastructure And Messaging Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/messageheader-response-request

Status: draft. Extension maintained by: Health Level Seven, Inc. - InM Work Group

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.

Context of Use: Use on Element ID MessageHeader

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. messageheader-response-request1..1codeURL = http://hl7.org/fhir/StructureDefinition/messageheader-response-request
messageheader-response-request: 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)
Use on Element ID MessageHeader

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension1..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/messageheader-response-request
messageheader-response-request: 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..1uri"http://hl7.org/fhir/StructureDefinition/messageheader-response-request"
... valueCode 0..1codeValue of extension
Binding: messageheader-response-request (required)

doco Documentation for this format

XML Template

<!-- messageheader-response-request -->doco

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

JSON Template

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

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. messageheader-response-request1..1codeURL = http://hl7.org/fhir/StructureDefinition/messageheader-response-request
messageheader-response-request: 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)
Use on Element ID MessageHeader

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension1..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/messageheader-response-request
messageheader-response-request: 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..1uri"http://hl7.org/fhir/StructureDefinition/messageheader-response-request"
... valueCode 0..1codeValue of extension
Binding: messageheader-response-request (required)

doco Documentation for this format

XML Template

<!-- messageheader-response-request -->doco

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

JSON Template

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

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))