Please note:
- This version of the UK Core is a development copy.
- This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
- This version is not yet reviewed for implementation. Other versions are available on the UK Core Version History Guide
- Please follow the guidance on the Contact Us page if you need any assistance.
- A summary of changes is available on the STU3 Sequence Change Log
Extension-UKCore-SubscriptionParameters-Example
An example to illustrate identification and provision of API parameters in R4 Subscription.
Table View
| Subscription.id[0] | Extension-UKCore-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 |
| id : Extension-UKCore-SubscriptionParameters-Example |
| text |
| status : additional |
| extension |
| url : http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.content |
| value : id-only |
| extension |
| url : http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.parameter |
| extension |
| url : name |
| value : Authorization |
| extension |
| url : value |
| value : Bearer secret-token-abc-123 |
| status : active |
| end : 2025-03-13T13:17:18Z |
| 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 |
XML View
--- We have skipped the narrative for better readability of the resource ---
</text>
</extension>
</extension>
</extension>
</extension>
<criteria value="Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|8449303649&generalPractitioner=https://fhir.hl7.org.uk/Id/gmp-number|G9999999" />
</channel>
</Subscription>
JSON View
{
--- We have skipped the narrative for better readability of the resource ---
},
{
},
{
{
},
{
}
]
}
],
"criteria": "Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|8449303649&generalPractitioner=https://fhir.hl7.org.uk/Id/gmp-number|G9999999",
}
}