R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension: messageheader-response-request

Infrastructure And Messaging Work Group

Maturity Level: 1

Informative

Use 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.

Context of Use: Use on element: MessageHeader

usage info: insert a list of places where this extension is used

Summary

Name	Flags	Card.	Type	Description & Constraints
extension		1..1	code	URL = 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: MessageHeader
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	1..1	Extension	URL = 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: MessageHeader
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/messageheader-response-request"
valueCode	0..1	code	Value of extension Binding: messageheader-response-request (required)
Documentation for this format

XML Template

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

<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

Name	Flags	Card.	Type	Description & Constraints
extension		1..1	code	URL = 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: MessageHeader
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	1..1	Extension	URL = 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: MessageHeader
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/messageheader-response-request"
valueCode	0..1	code	Value of extension Binding: messageheader-response-request (required)
Documentation for this format

XML Template

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

<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')]))