UKCore-Extension-SubscriptionParameters-Example

An example to illustrate identification and provision of API parameters in R4 Subscription.

Table View

Subscription.id[0]UKCore-Extension-SubscriptionParameters-Example
Subscription.text[0].status[0]additional
Subscription.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate identification and provision of API parameters in R4 Subscription.</div>
Subscription.extension[0].url[0]http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.content
Subscription.extension[0].value[0]id-only
Subscription.extension[1].extension[0].url[0]name
Subscription.extension[1].extension[0].value[0]Authorization
Subscription.extension[1].extension[1].url[0]value
Subscription.extension[1].extension[1].value[0]Bearer secret-token-abc-123
Subscription.extension[1].url[0]http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.parameter
Subscription.status[0]active
Subscription.end[0]2025-03-13T13:17:18+00:00
Subscription.reason[0]Subscription for a Change of GP event for patient
Subscription.criteria[0]Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|8449303649&generalPractitioner=https://fhir.hl7.org.uk/Id/gmp-number|G9999999
Subscription.channel[0].type[0]rest-hook
Subscription.channel[0].endpoint[0]https://app.nhs.uk/change-of-gp-handler
Subscription.channel[0].payload[0]application/fhir+json

Tree View

Subscription

XML View

<Subscription xmlns="http://hl7.org/fhir">
    <id value="UKCore-Extension-SubscriptionParameters-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <extension url="http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.content">
        <valueCode value="id-only" />
    </extension>
    <extension url="http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.parameter">
        <extension url="name">
            <valueString value="Authorization" />
        </extension>
        <extension url="value">
            <valueString value="Bearer secret-token-abc-123" />
        </extension>
    </extension>
    <status value="active" />
    <end value="2025-03-13T13:17:18Z" />
    <reason value="Subscription for a Change of GP event for patient" />
    <criteria value="Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|8449303649&amp;generalPractitioner=https://fhir.hl7.org.uk/Id/gmp-number|G9999999" />
    <channel>
        <type value="rest-hook" />
        <endpoint value="https://app.nhs.uk/change-of-gp-handler" />
        <payload value="application/fhir+json" />
    </channel>
</Subscription>

JSON View

{
    "resourceType": "Subscription",
    "id": "UKCore-Extension-SubscriptionParameters-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.content",
            "valueCode": "id-only"
        },
        {
            "extension":  [
                {
                    "url": "name",
                    "valueString": "Authorization"
                },
                {
                    "url": "value",
                    "valueString": "Bearer secret-token-abc-123"
                }
            ],
            "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.parameter"
        }
    ],
    "status": "active",
    "end": "03/13/2025 13:17:18",
    "reason": "Subscription for a Change of GP event for patient",
    "criteria": "Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|8449303649&generalPractitioner=https://fhir.hl7.org.uk/Id/gmp-number|G9999999",
    "channel": {
        "type": "rest-hook",
        "endpoint": "https://app.nhs.uk/change-of-gp-handler",
        "payload": "application/fhir+json"
    }
}