FHIR IG analytics| Package | hl7.fhir.uv.xver-r2.r5 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-ext-R2-Subscription.channel.json |
| FHIR Version | R5 |
| Source | http://hl7.org/fhir/uv/xver-r2.r5/0.1.0/StructureDefinition-ext-R2-Subscription.channel.html |
| URL | http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.channel |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-03-17T21:02:03.8104715+00:00 |
| Name | ExtensionSubscription_Channel |
| Title | DSTU2: The channel on which to report matches to the criteria (new) |
| Realm | uv |
| Authority | hl7 |
| Description | DSTU2: `Subscription.channel` (new:BackboneElement) |
| Purpose | This extension is part of the cross-version definitions generated to enable use of the element `Subscription.channel` as defined in FHIR DSTU2 in FHIR R5. The source element is defined as: `Subscription.channel` 1..1 `BackboneElement` Across FHIR versions, the element set has been mapped as: * DSTU2: `Subscription.channel` 1..1 `BackboneElement` * STU3: `Subscription.channel` 1..1 `BackboneElement` * R4: `Subscription.channel` 1..1 `BackboneElement` * R4B: `Subscription.channel` 1..1 `BackboneElement` Following are the generation technical comments: 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). |
| Type | Extension |
| Kind | complex-type |
| ConceptMap | ||
| hl7.fhir.uv.xver-r2.r5#0.1.0 | R2-Subscription-element-map-to-R5 | Cross-version mapping for FHIR DSTU2 Subscription to FHIR R5 Subscription |
No resources found
No extension usage examples found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition ext-R2-Subscription.channel
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 1..1 | Extension(5.0.0) | DSTU2: The channel on which to report matches to the criteria (new) | |
  Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:type | 1..1 | Extension | DSTU2: rest-hook | websocket | email | sms | message (new) | |
  url | 1..1 | uri | "type" | |
  value[x] | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. | |
| extension:endpoint | 0..1 | Extension | DSTU2: Where the channel points to (new) | |
| url | 1..1 | uri | "endpoint" | |
| value[x] | 0..1 | uri | Where the channel points to | |
| extension:payload | 1..1 | Extension | DSTU2: Mimetype to send, or blank for no payload (new) | |
| url | 1..1 | uri | "payload" | |
| value[x] | 1..1 | string | Mimetype to send, or blank for no payload | |
 extension:header | 0..1 | Extension | DSTU2: Usage depends on the channel type (new) | |
 url | 1..1 | uri | "header" | |
| value[x] | 0..1 | string | Usage depends on the channel type | |
| url | 1..1 | uri | "http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.channel" | |
 value[x] | 0..0 | Value of extension | ||
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "ext-R2-Subscription.channel",
"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-r2.r5"
},
{
"url": "version",
"valueString": "0.1.0"
},
{
"url": "uri",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r2.r5"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"extension": [
{
"url": "startFhirVersion",
"valueCode": "5.0"
},
{
"url": "endFhirVersion",
"valueCode": "5.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
},
{
"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-r2.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-r2.r5"
}
]
}
}
],
"url": "http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.channel",
"version": "0.1.0",
"name": "ExtensionSubscription_Channel",
"title": "DSTU2: The channel on which to report matches to the criteria (new)",
"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": "DSTU2: `Subscription.channel` (new:BackboneElement)",
"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 `Subscription.channel` as defined in FHIR DSTU2\r\nin FHIR R5.\r\n\r\nThe source element is defined as:\r\n`Subscription.channel` 1..1 `BackboneElement`\r\n\r\nAcross FHIR versions, the element set has been mapped as:\r\n* DSTU2: `Subscription.channel` 1..1 `BackboneElement`\n* STU3: `Subscription.channel` 1..1 `BackboneElement`\n* R4: `Subscription.channel` 1..1 `BackboneElement`\n* R4B: `Subscription.channel` 1..1 `BackboneElement`\r\n\r\nFollowing are the generation technical comments:\r\nElement `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).",
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Subscription"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension|5.0.0",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
}
],
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "DSTU2: The channel on which to report matches to the criteria (new)",
"definition": "DSTU2: `Subscription.channel` (new:BackboneElement)",
"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).",
"min": 1,
"max": "1",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|5.0.0"
}
],
"isModifier": false
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"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",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 2,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|5.0.0"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Extension.extension:type",
"path": "Extension.extension",
"sliceName": "type",
"short": "DSTU2: rest-hook | websocket | email | sms | message (new)",
"definition": "DSTU2: `Subscription.channel.type` (new:code)",
"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).",
"requirements": "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).",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|5.0.0"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Extension.extension:type.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:type.extension",
"path": "Extension.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. To make the use of extensions safe and managable, 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.",
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|5.0.0"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:type.url",
"path": "Extension.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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "type",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:type.value[x]",
"path": "Extension.extension.value[x]",
"short": "rest-hook | websocket | email | sms | message",
"definition": "The type of channel to send notifications on.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"ext-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"strength": "required",
"description": "The type of method used to execute a subscription.",
"valueSet": "http://hl7.org/fhir/ValueSet/subscription-channel-type|5.0.0"
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:endpoint",
"path": "Extension.extension",
"sliceName": "endpoint",
"short": "DSTU2: Where the channel points to (new)",
"definition": "DSTU2: `Subscription.channel.endpoint` (new:uri)",
"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 their may be more than one, clients should avoid using relative URIs).",
"requirements": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|5.0.0"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Extension.extension:endpoint.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:endpoint.extension",
"path": "Extension.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. To make the use of extensions safe and managable, 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.",
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|5.0.0"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:endpoint.url",
"path": "Extension.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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "endpoint",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:endpoint.value[x]",
"path": "Extension.extension.value[x]",
"short": "Where the channel points to",
"definition": "The uri that describes the actual end-point to send messages to.",
"comment": "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 their may be more than one, clients should avoid using relative URIs).",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"condition": [
"ext-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:payload",
"path": "Extension.extension",
"sliceName": "payload",
"short": "DSTU2: Mimetype to send, or blank for no payload (new)",
"definition": "DSTU2: `Subscription.channel.payload` (new:string)",
"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 consequences. The server is responsible for ensuring that the content is appropriately secured.",
"requirements": "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).",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|5.0.0"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Extension.extension:payload.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:payload.extension",
"path": "Extension.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. To make the use of extensions safe and managable, 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.",
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|5.0.0"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:payload.url",
"path": "Extension.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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "payload",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:payload.value[x]",
"path": "Extension.extension.value[x]",
"short": "Mimetype to send, or blank for no payload",
"definition": "The mime type to send the payload in - either application/xml+fhir, or application/json+fhir. If the mime type is blank, then there is no payload in the notification, just a notification.",
"comment": "Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ext-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:header",
"path": "Extension.extension",
"sliceName": "header",
"short": "DSTU2: Usage depends on the channel type (new)",
"definition": "DSTU2: `Subscription.channel.header` (new:string)",
"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. The can convey additional information to the recipient and/or meet security requirements.",
"requirements": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|5.0.0"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Extension.extension:header.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:header.extension",
"path": "Extension.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. To make the use of extensions safe and managable, 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.",
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|5.0.0"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension:header.url",
"path": "Extension.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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "header",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.extension:header.value[x]",
"path": "Extension.extension.value[x]",
"short": "Usage depends on the channel type",
"definition": "Additional headers / information to send as part of the notification.",
"comment": "Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ext-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
}
],
"isModifier": false,
"isSummary": false,
"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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.channel",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).",
"min": 0,
"max": "0",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "integer64"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "CodeableReference"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "RatioRange"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Availability"
},
{
"code": "ExtendedContactDetail"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}
],
"condition": [
"ext-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "DSTU2: The channel on which to report matches to the criteria (new)",
"definition": "DSTU2: `Subscription.channel` (new:BackboneElement)",
"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).",
"min": 1,
"max": "1",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 2,
"max": "*",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
}
},
{
"id": "Extension.extension:type",
"path": "Extension.extension",
"sliceName": "type",
"short": "DSTU2: rest-hook | websocket | email | sms | message (new)",
"definition": "DSTU2: `Subscription.channel.type` (new:code)",
"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).",
"requirements": "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).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
}
},
{
"id": "Extension.extension:type.url",
"path": "Extension.extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "type"
},
{
"id": "Extension.extension:type.value[x]",
"path": "Extension.extension.value[x]",
"short": "rest-hook | websocket | email | sms | message",
"definition": "The type of channel to send notifications on.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The type of method used to execute a subscription.",
"valueSet": "http://hl7.org/fhir/ValueSet/subscription-channel-type|5.0.0"
}
},
{
"id": "Extension.extension:endpoint",
"path": "Extension.extension",
"sliceName": "endpoint",
"short": "DSTU2: Where the channel points to (new)",
"definition": "DSTU2: `Subscription.channel.endpoint` (new:uri)",
"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 their may be more than one, clients should avoid using relative URIs).",
"requirements": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
}
},
{
"id": "Extension.extension:endpoint.url",
"path": "Extension.extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "endpoint"
},
{
"id": "Extension.extension:endpoint.value[x]",
"path": "Extension.extension.value[x]",
"short": "Where the channel points to",
"definition": "The uri that describes the actual end-point to send messages to.",
"comment": "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 their may be more than one, clients should avoid using relative URIs).",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
]
},
{
"id": "Extension.extension:payload",
"path": "Extension.extension",
"sliceName": "payload",
"short": "DSTU2: Mimetype to send, or blank for no payload (new)",
"definition": "DSTU2: `Subscription.channel.payload` (new:string)",
"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 consequences. The server is responsible for ensuring that the content is appropriately secured.",
"requirements": "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).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
}
},
{
"id": "Extension.extension:payload.url",
"path": "Extension.extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "payload"
},
{
"id": "Extension.extension:payload.value[x]",
"path": "Extension.extension.value[x]",
"short": "Mimetype to send, or blank for no payload",
"definition": "The mime type to send the payload in - either application/xml+fhir, or application/json+fhir. If the mime type is blank, then there is no payload in the notification, just a notification.",
"comment": "Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension.extension:header",
"path": "Extension.extension",
"sliceName": "header",
"short": "DSTU2: Usage depends on the channel type (new)",
"definition": "DSTU2: `Subscription.channel.header` (new:string)",
"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. The can convey additional information to the recipient and/or meet security requirements.",
"requirements": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
}
},
{
"id": "Extension.extension:header.url",
"path": "Extension.extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "header"
},
{
"id": "Extension.extension:header.value[x]",
"path": "Extension.extension.value[x]",
"short": "Usage depends on the channel type",
"definition": "Additional headers / information to send as part of the notification.",
"comment": "Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension.url",
"path": "Extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "http://hl7.org/fhir/1.0/StructureDefinition/extension-Subscription.channel"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"min": 0,
"max": "0",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
}
}
]
}
}