FHIR IG analytics| Package | hl7.fhir.uv.xver-r4.r5 |
| Resource Type | ConceptMap |
| Id | ConceptMap-R4-Subscription-element-map-to-R5.json |
| FHIR Version | R5 |
| Source | http://hl7.org/fhir/uv/xver-r4.r5/0.1.0/ConceptMap-R4-Subscription-element-map-to-R5.html |
| URL | http://hl7.org/fhir/uv/xver/ConceptMap/R4-Subscription-element-map-to-R5 |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-03-17T16:04:37.9609996-05:00 |
| Name | R4SubscriptionElementMapToR5 |
| Title | Cross-version mapping for FHIR R4 Subscription to FHIR R5 Subscription |
| Realm | uv |
| Authority | hl7 |
| Description | This ConceptMap represents cross-version mappings for elements from a FHIR R4 Subscription to FHIR R5. |
No resources found
| StructureDefinition | ||
| hl7.fhir.uv.xver-r4.r5#0.1.0 | extension-Subscription.channel | R4: The channel on which to report matches to the criteria (new) |
| hl7.fhir.uv.xver-r4.r5#0.1.0 | extension-Subscription.criteria | R4: Rule for server push (new) |
| hl7.fhir.uv.xver-r4.r5#0.1.0 | extension-Subscription.error | R4: Latest error note (new) |
Note: links and images are rebased to the (stated) source
Generated Narrative: ConceptMap R4-Subscription-element-map-to-R5
Mapping from http://hl7.org/fhir/4.0 to http://hl7.org/fhir/5.0
Group 1 Mapping from http://hl7.org/fhir/StructureDefinition/Subscription|4.0.1 to Subscriptionversion: 5.0.0)
| Source Code | Relationship | Target Code | Comment |
| Subscription.meta (meta) | is equivalent to | Subscription.meta | Element `Subscription.meta` is mapped to FHIR R5 element `Subscription.meta` as `Equivalent`. |
| Subscription.implicitRules (implicitRules) | is equivalent to | Subscription.implicitRules | Element `Subscription.implicitRules` is mapped to FHIR R5 element `Subscription.implicitRules` as `Equivalent`. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
| Subscription.language (language) | is equivalent to | Subscription.language | Element `Subscription.language` is mapped to FHIR R5 element `Subscription.language` as `Equivalent`. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
| Subscription.text (text) | is equivalent to | Subscription.text | Element `Subscription.text` is mapped to FHIR R5 element `Subscription.text` as `Equivalent`. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Subscription.contained (contained) | is equivalent to | Subscription.contained | Element `Subscription.contained` is mapped to FHIR R5 element `Subscription.contained` as `Equivalent`. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
| Subscription.status (status) | is equivalent to | Subscription.status | Element `Subscription.status` is mapped to FHIR R5 element `Subscription.status` as `SourceIsNarrowerThanTarget`. The mappings for `Subscription.status` do not allow expression of the necessary codes, per the bindings on the source and target. A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
| Subscription.contact (contact) | is equivalent to | Subscription.contact | Element `Subscription.contact` is mapped to FHIR R5 element `Subscription.contact` as `Equivalent`. |
| Subscription.end (end) | is equivalent to | Subscription.end | Element `Subscription.end` is mapped to FHIR R5 element `Subscription.end` as `Equivalent`. The server is permitted to deviate from this time but should observe it. |
| Subscription.reason (reason) | is equivalent to | Subscription.reason | Element `Subscription.reason` is mapped to FHIR R5 element `Subscription.reason` as `Equivalent`. |
Group 2 Mapping from http://hl7.org/fhir/StructureDefinition/Subscription|4.0.1 to R4: Rule for server push (new)version: 0.1.0)
| Source Code | Relationship | Target Code | Comment |
| Subscription.criteria (criteria) | is equivalent to | Extension (R4: Rule for server push (new)) | Element `Subscription.criteria` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.criteria` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/". |
Group 3 Mapping from http://hl7.org/fhir/StructureDefinition/Subscription|4.0.1 to R4: Latest error note (new)version: 0.1.0)
| Source Code | Relationship | Target Code | Comment |
| Subscription.error (error) | is equivalent to | Extension (R4: Latest error note (new)) | Element `Subscription.error` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.error` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). |
Group 4 Mapping from http://hl7.org/fhir/StructureDefinition/Subscription|4.0.1 to R4: The channel on which to report matches to the criteria (new)version: 0.1.0)
| Source Code | Relationship | Target Code | Comment |
| Subscription.channel (channel) | is equivalent to | Extension (R4: The channel on which to report matches to the criteria (new)) | Element `Subscription.channel` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). |
| Subscription.channel.type (type) | is equivalent to | Extension.extension:type (R4: rest-hook | websocket | email | sms | message (new)) | Element `Subscription.channel.type` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.type` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.type` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). |
| Subscription.channel.endpoint (endpoint) | is equivalent to | Extension.extension:endpoint (R4: Where the channel points to (new)) | Element `Subscription.channel.endpoint` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.endpoint` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.endpoint` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs). |
| Subscription.channel.payload (payload) | is equivalent to | Extension.extension:payload (R4: MIME type to send, or omit for no payload (new)) | Element `Subscription.channel.payload` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.payload` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.payload` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured. |
| Subscription.channel.header (header) | is equivalent to | Extension.extension:header (R4: Usage depends on the channel type (new)) | Element `Subscription.channel.header` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension. Element `Subscription.channel.header` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`. Element `Subscription.channel.header` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions. |
{
"resourceType": "ConceptMap",
"id": "R4-Subscription-element-map-to-R5",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4.r5"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4.r5"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/xver/ConceptMap/R4-Subscription-element-map-to-R5",
"version": "0.1.0",
"name": "R4SubscriptionElementMapToR5",
"title": "Cross-version mapping for FHIR R4 Subscription to FHIR R5 Subscription",
"status": "active",
"experimental": false,
"date": "2026-03-17T16:04:37.9609996-05:00",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "This ConceptMap represents cross-version mappings for elements from a FHIR R4 Subscription to FHIR R5.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"sourceScopeCanonical": "http://hl7.org/fhir/4.0",
"targetScopeUri": "http://hl7.org/fhir/5.0",
"group": [
{
"source": "http://hl7.org/fhir/StructureDefinition/Subscription|4.0.1",
"target": "http://hl7.org/fhir/StructureDefinition/Subscription|5.0.0",
"element": [
{
"code": "Subscription.meta",
"display": "meta",
"target": [
{
"code": "Subscription.meta",
"display": "Subscription.meta",
"relationship": "equivalent",
"comment": "Element `Subscription.meta` is mapped to FHIR R5 element `Subscription.meta` as `Equivalent`."
}
]
},
{
"code": "Subscription.implicitRules",
"display": "implicitRules",
"target": [
{
"code": "Subscription.implicitRules",
"display": "Subscription.implicitRules",
"relationship": "equivalent",
"comment": "Element `Subscription.implicitRules` is mapped to FHIR R5 element `Subscription.implicitRules` as `Equivalent`.\nAsserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc."
}
]
},
{
"code": "Subscription.language",
"display": "language",
"target": [
{
"code": "Subscription.language",
"display": "Subscription.language",
"relationship": "equivalent",
"comment": "Element `Subscription.language` is mapped to FHIR R5 element `Subscription.language` as `Equivalent`.\nLanguage is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."
}
]
},
{
"code": "Subscription.text",
"display": "text",
"target": [
{
"code": "Subscription.text",
"display": "Subscription.text",
"relationship": "equivalent",
"comment": "Element `Subscription.text` is mapped to FHIR R5 element `Subscription.text` as `Equivalent`.\nContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later."
}
]
},
{
"code": "Subscription.contained",
"display": "contained",
"target": [
{
"code": "Subscription.contained",
"display": "Subscription.contained",
"relationship": "equivalent",
"comment": "Element `Subscription.contained` is mapped to FHIR R5 element `Subscription.contained` as `Equivalent`.\nThis should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels."
}
]
},
{
"code": "Subscription.status",
"display": "status",
"target": [
{
"code": "Subscription.status",
"display": "Subscription.status",
"relationship": "equivalent",
"comment": "Element `Subscription.status` is mapped to FHIR R5 element `Subscription.status` as `SourceIsNarrowerThanTarget`.\nThe mappings for `Subscription.status` do not allow expression of the necessary codes, per the bindings on the source and target.\nA client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid."
}
]
},
{
"code": "Subscription.contact",
"display": "contact",
"target": [
{
"code": "Subscription.contact",
"display": "Subscription.contact",
"relationship": "equivalent",
"comment": "Element `Subscription.contact` is mapped to FHIR R5 element `Subscription.contact` as `Equivalent`."
}
]
},
{
"code": "Subscription.end",
"display": "end",
"target": [
{
"code": "Subscription.end",
"display": "Subscription.end",
"relationship": "equivalent",
"comment": "Element `Subscription.end` is mapped to FHIR R5 element `Subscription.end` as `Equivalent`.\nThe server is permitted to deviate from this time but should observe it."
}
]
},
{
"code": "Subscription.reason",
"display": "reason",
"target": [
{
"code": "Subscription.reason",
"display": "Subscription.reason",
"relationship": "equivalent",
"comment": "Element `Subscription.reason` is mapped to FHIR R5 element `Subscription.reason` as `Equivalent`."
}
]
}
]
},
{
"source": "http://hl7.org/fhir/StructureDefinition/Subscription|4.0.1",
"target": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Subscription.criteria|0.1.0",
"element": [
{
"code": "Subscription.criteria",
"display": "criteria",
"target": [
{
"code": "Extension",
"relationship": "equivalent",
"comment": "Element `Subscription.criteria` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`.\nElement `Subscription.criteria` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).\nThe rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading \"/\"."
}
]
}
]
},
{
"source": "http://hl7.org/fhir/StructureDefinition/Subscription|4.0.1",
"target": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Subscription.error|0.1.0",
"element": [
{
"code": "Subscription.error",
"display": "error",
"target": [
{
"code": "Extension",
"relationship": "equivalent",
"comment": "Element `Subscription.error` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`.\nElement `Subscription.error` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element)."
}
]
}
]
},
{
"source": "http://hl7.org/fhir/StructureDefinition/Subscription|4.0.1",
"target": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Subscription.channel|0.1.0",
"element": [
{
"code": "Subscription.channel",
"display": "channel",
"target": [
{
"code": "Extension",
"relationship": "equivalent",
"comment": "Element `Subscription.channel` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`.\nElement `Subscription.channel` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element)."
}
]
},
{
"code": "Subscription.channel.type",
"display": "type",
"target": [
{
"code": "Extension.extension:type",
"relationship": "equivalent",
"comment": "Element `Subscription.channel.type` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension.\nElement `Subscription.channel.type` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`.\nElement `Subscription.channel.type` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element)."
}
]
},
{
"code": "Subscription.channel.endpoint",
"display": "endpoint",
"target": [
{
"code": "Extension.extension:endpoint",
"relationship": "equivalent",
"comment": "Element `Subscription.channel.endpoint` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension.\nElement `Subscription.channel.endpoint` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`.\nElement `Subscription.channel.endpoint` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).\nFor rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs)."
}
]
},
{
"code": "Subscription.channel.payload",
"display": "payload",
"target": [
{
"code": "Extension.extension:payload",
"relationship": "equivalent",
"comment": "Element `Subscription.channel.payload` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension.\nElement `Subscription.channel.payload` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`.\nElement `Subscription.channel.payload` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).\nSending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured."
}
]
},
{
"code": "Subscription.channel.header",
"display": "header",
"target": [
{
"code": "Extension.extension:header",
"relationship": "equivalent",
"comment": "Element `Subscription.channel.header` is part of an existing definition because parent element `Subscription.channel` requires a cross-version extension.\nElement `Subscription.channel.header` has a context of Subscription based on following the parent source element upwards and mapping to `Subscription`.\nElement `Subscription.channel.header` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).\nExactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions."
}
]
}
]
}
]
}