Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU see ballot notes ). 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 Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/messageheader-response-request
Version: 5.0.0-ballot
Name: messageheader-response-request
Title: MessageHeader response request
Modifier: This extension is not a modifier extension
Status: draft
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.
Committee: Infrastructure And Messaging Work Group

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

Name Flags Card. Type Description & Constraints doco
. . messageheader-response-request 1..1 0..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 ): Message Header Response Request codes


Use on Element ID MessageHeader

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 1..1 0..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 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


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]"/><!-- I 1..1 Value of extension -->

</extension>

JSON Template 

{ // messageheader-response-request
  // 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 doco
. . messageheader-response-request 1..1 0..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 ): Message Header Response Request codes


Use on Element ID MessageHeader

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 1..1 0..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 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


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]"/><!-- I 1..1 Value of extension -->

</extension>

JSON Template 

{ // messageheader-response-request
  // 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 unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters @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')]) )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) )
  • ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div )

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.