FHIR IG analytics| Package | hl7.fhir.uv.xver-r4.r3 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-ext-R4-MessageDefinition.responseRequired.json |
| FHIR Version | R3 |
| Source | http://hl7.org/fhir/uv/xver-r4.r3/0.1.0/StructureDefinition-ext-R4-MessageDefinition.responseRequired.html |
| URL | http://hl7.org/fhir/4.0/StructureDefinition/extension-MessageDefinition.responseRequired |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-03-17T21:02:03.8104715+00:00 |
| Name | ExtensionMessageDefinition_ResponseRequired |
| Title | R4: always | on-error | never | on-success additional types |
| Realm | uv |
| Authority | hl7 |
| Description | R4: `MessageDefinition.responseRequired` additional types (code) additional types from child elements (value) |
| Purpose | This extension is part of the cross-version definitions generated to enable use of the element `MessageDefinition.responseRequired` as defined in FHIR R4 in FHIR STU3. The source element is defined as: `MessageDefinition.responseRequired` 0..1 `code` Following are the generation technical comments: Element `MessageDefinition.responseRequired` is mapped to FHIR STU3 element `MessageDefinition.responseRequired` as `SourceIsBroaderThanTarget`. The mappings for `MessageDefinition.responseRequired` do not cover the following types: code. The mappings for `MessageDefinition.responseRequired` do not cover the following types based on type expansion: value. |
| Type | Extension |
| Kind | complex-type |
| ConceptMap | ||
| hl7.fhir.uv.xver-r4.r3#0.1.0 | R4-MessageDefinition-element-map-to-R3 | Cross-version mapping for FHIR R4 MessageDefinition to FHIR STU3 MessageDefinition |
No resources found
No extension usage examples found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition ext-R4-MessageDefinition.responseRequired
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..1 | Extension | R4: always | on-error | never | on-success additional types | |
 url | 1..1 | uri | "http://hl7.org/fhir/4.0/StructureDefinition/extension-MessageDefinition.responseRequired" | |
  value[x] | 0..1 | code | always | on-error | never | on-success Binding: messageheader-response-request (required): HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "ext-R4-MessageDefinition.responseRequired",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"extension": [
{
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r4.r3"
},
{
"url": "version",
"valueString": "0.1.0"
},
{
"url": "uri",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4.r3"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4.r3"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4.r3"
}
]
}
}
],
"url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-MessageDefinition.responseRequired",
"version": "0.1.0",
"name": "ExtensionMessageDefinition_ResponseRequired",
"title": "R4: always | on-error | never | on-success additional types",
"status": "active",
"experimental": false,
"date": "2026-03-17T21:02:03.8104715+00:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "R4: `MessageDefinition.responseRequired` additional types (code) additional types from child elements (value)",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"purpose": "This extension is part of the cross-version definitions generated to enable use of the\r\nelement `MessageDefinition.responseRequired` as defined in FHIR R4\r\nin FHIR STU3.\r\n\r\nThe source element is defined as:\r\n`MessageDefinition.responseRequired` 0..1 `code`\r\n\r\nFollowing are the generation technical comments:\r\nElement `MessageDefinition.responseRequired` is mapped to FHIR STU3 element `MessageDefinition.responseRequired` as `SourceIsBroaderThanTarget`.\nThe mappings for `MessageDefinition.responseRequired` do not cover the following types: code.\nThe mappings for `MessageDefinition.responseRequired` do not cover the following types based on type expansion: value.",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"contextType": "resource",
"context": [
"MessageDefinition.responseRequired"
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "R4: always | on-error | never | on-success additional types",
"definition": "R4: `MessageDefinition.responseRequired` additional types (code) additional types from child elements (value)",
"comment": "Element `MessageDefinition.responseRequired` is mapped to FHIR STU3 element `MessageDefinition.responseRequired` as `SourceIsBroaderThanTarget`.\nThe mappings for `MessageDefinition.responseRequired` do not cover the following types: code.\nThe mappings for `MessageDefinition.responseRequired` do not cover the following types based on type expansion: value.\nThis 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.",
"min": 0,
"max": "1",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.url",
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/4.0/StructureDefinition/extension-MessageDefinition.responseRequired",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "always | on-error | never | on-success",
"definition": "Declare at a message definition level whether a response is required or only upon error or success, or never.",
"comment": "This 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.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message.",
"valueSetUri": "http://hl7.org/fhir/ValueSet/messageheader-response-request|3.0.2"
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "R4: always | on-error | never | on-success additional types",
"definition": "R4: `MessageDefinition.responseRequired` additional types (code) additional types from child elements (value)",
"comment": "Element `MessageDefinition.responseRequired` is mapped to FHIR STU3 element `MessageDefinition.responseRequired` as `SourceIsBroaderThanTarget`.\nThe mappings for `MessageDefinition.responseRequired` do not cover the following types: code.\nThe mappings for `MessageDefinition.responseRequired` do not cover the following types based on type expansion: value.\nThis 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.",
"min": 0,
"max": "1",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "Extension.url",
"path": "Extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "http://hl7.org/fhir/4.0/StructureDefinition/extension-MessageDefinition.responseRequired"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "always | on-error | never | on-success",
"definition": "Declare at a message definition level whether a response is required or only upon error or success, or never.",
"comment": "This 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.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message.",
"valueSetUri": "http://hl7.org/fhir/ValueSet/messageheader-response-request|3.0.2"
}
}
]
}
}