Acknowledgement Framework

This guidance is under active development by NHS England and content may be added or updated on a regular basis.

Extensions

messageheader-response-request

Important: The Acknowledgement Framework is currently a draft version. Please contact the Interoperability Standards Team if you are interested to discuss this solution for your use case.

Note: This is an HL7 International common extension.

Extension	I		Extension	Element id Extension Short description messageheader initiator requests a response 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. Comments 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A v2: MSH-16
id		0..1	string	There are no (further) constraints on this element Element id Extension.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..0	Extension	There are no (further) constraints on this element Element id Extension.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
url		1..1	uriFixed Value	Element id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value http://hl7.org/fhir/StructureDefinition/messageheader-response-request Mappings rim: N/A
value[x]		1..1	Binding	Element id Extension.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. messageheader-response-request (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
valueCode			code	Data type code

Extension	I		Extension	Element id Extension Short description messageheader initiator requests a response 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. Comments 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A v2: MSH-16
id		0..1	string	There are no (further) constraints on this element Element id Extension.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..0	Extension	There are no (further) constraints on this element Element id Extension.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
url		1..1	uriFixed Value	Element id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value http://hl7.org/fhir/StructureDefinition/messageheader-response-request Mappings rim: N/A
value[x]		1..1	Binding	Element id Extension.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. messageheader-response-request (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
valueCode			code	Data type code

Extension	I		Extension	Element id Extension Short description messageheader initiator requests a response 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. Comments 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A v2: MSH-16
id		0..1	string	There are no (further) constraints on this element Element id Extension.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..0	Extension	There are no (further) constraints on this element Element id Extension.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
url		1..1	uriFixed Value	Element id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value http://hl7.org/fhir/StructureDefinition/messageheader-response-request Mappings rim: N/A
value[x]		1..1	Binding	Element id Extension.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. messageheader-response-request (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
valueCode			code	Data type code

back to top