diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md index c4692e34..51bbe268 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md @@ -1,28 +1,26 @@ -## Current Release 1.11.0 +## Current Release 1.11.1 Product Link | Version | Handle | Phase | State | Release Date | Stability | Change Log Link -----------------------|---------|---------|----------|-----------------|--------------|------------|----------------- -Implementation Guide | 1.11.0 | v1 | Live | Current Release | 26/03/2026 | Stable |{{pagelink:trn-General}} -[FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.38.0) | 1.38.0| v1 | Live | Current Release | 26/03/2026 | Stable | -{{pagelink:design-core-1.4.0, text:BaRS Core}} | 1.4.0 | v1 | Live | Current Release | 26/03/2026 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} -[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_4_0) | 1.4.0 | v1 | Live | Current Release | 26/03/2026 | Stable |{{pagelink:trn-api}} +Implementation Guide | 1.11.1 | v1 | Live | Current Release | 19/05/2026 | Stable |{{pagelink:trn-General}} +[FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.40.0) | 1.40.0| v1 | Live | Current Release | 19/05/2026 | Stable | +{{pagelink:design-core-1.4.1, text:BaRS Core}} | 1.4.1 | v1 | Live | Current Release | 19/05/2026 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}} +[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1) | 1.4.1 | v1 | Live | Current Release | 19/05/2026 | Stable |{{pagelink:trn-api}} {{pagelink: build-testing, text: TKW}} | 1.0.21 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-tkw}} {{pagelink:application1, text:BaRS-APP1}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} {{pagelink:application2, text:BaRS-APP2}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} {{pagelink:application3, text:BaRS-APP3}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app3,text:BaRS APP3 Change Log}} {{pagelink:application4, text:BaRS-APP4}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app4,text:BaRS APP4 Change Log}} {{pagelink:application5, text:BaRS-APP5}} | 1.2.0 | v1 | Live | Current Release | 26/03/2026 | Stable |{{pagelink:trn-app5,text:BaRS APP5 Change Log}} -{{pagelink:application6, text:BaRS-APP6}} | 1.0.0-beta.7 | beta | | Current Release | 26/03/2026 | Pre-Release |{{pagelink:trn-app6,text:BaRS APP6 Change Log}} +{{pagelink:application6, text:BaRS-APP6}} | 1.0.0-beta.8 | beta | | Current Release | 19/05/2026 | Pre-Release |{{pagelink:trn-app6,text:BaRS APP6 Change Log}} {{pagelink:application7, text:BaRS-APP7}} | 1.0.0-alpha.4 | alpha | | Current Release | 02/07/2025 | Pre-Release |{{pagelink:trn-app7,text:BaRS APP7 Change Log}} -{{pagelink:application8, text:BaRS-APP8}} | 1.0.0-alpha | alpha | | Current Release | 26/03/2026 | Pre-Release |{{pagelink:trn-app8,text:BaRS APP8 Change Log}} +{{pagelink:application8, text:BaRS-APP8}} | 1.0.0-alpha.2 | alpha | | Current Release | 19/05/2026 | Pre-Release |{{pagelink:trn-app8,text:BaRS APP8 Change Log}} ### Overview of the release -Release 1.11.0 of the BaRS Implementation Guide introduces BaRS Application 8 "Referrals to a broker for Healthcare Service selection" as an alpha release. BaRS Application 8 is designed to create interoperability for referrals between NHS England products. The next phase of content and navigation changes in the Implementation Guide are delivered. They are focussed on: the Home page, the Analysis section (formerly About BaRS) and relocation of content from this area. These changes are based on user feedback. - -Application 5 is updated with the withdrawal of use cases for GP to Blood Pressure Check Service and GP to Pharmacy Contraception (Oral Contraception). Also included in this release are minor changes to BaRS Application 6 and bug fixes and corrections throughout the guide. +TBC A clinical safety assessment of the scope of this release has determined that it has not significantly changed the clinical safety profile of the BaRS. No new hazards have been identified in this release. The latest version of the BaRS clinical safety case and hazard log can be downloaded from the BaRS FHIR API onboarding support information page . @@ -181,12 +179,16 @@ Table detailing active versions of the latest Applications in Production (or cur
This Section of the Implementation Guide is currently a preview, in an Alpha state and subject to change. Only Internal NHSE programmes are currently permitted to build against this release. If you are interested in building against this documentation, please, contact the BaRS Team
This section of the Implementation Guide is currently a preview, in an Alpha state and subject to change. There is currently only support for Appointment (booking) pointers.
++ +| Header | Requirement | Description | Value | +|------------------------|------------------------|--------------------------------------------------------------|----------------------------| +| use-context | Required by the sender | Allows BaRS to route the message to the appropriate endpoint | Formatted string | + +This header is for usage statistics for the BaRS Proxy for NHS England. It consists of a composite of 4 values from within the payload, in order. The sender MUST include this information. The receiver MUST ignore this header. The elements are: + +The elements for a ServiceRequest are: + +* ServiceRequest.category.coding.code (usecases-categories-bars) +* ServiceRequest.category.coding.code (message-category-servicerequest) +* MessageHeader.eventCoding.code (message-event-bars) +* MessageHeader.reason.coding.code (message-reason-bars) + +The elements for an Appointment are: + +* Appointment.serviceCategory.coding (usecases-categories-bars) +* Appointment.status +* MessageHeader.eventCoding.code (message-event-bars) +* MessageHeader.reason.coding.code (message-reason-bars) + +These MUST be present in the use-context header, separated by a pipe, in the defined order. + +### Referral + +``` +ServiceRequest.category.coding.code[usecases-categories-bars] | ServiceRequest.category.coding.code[message-category-servicerequest] | MessageHeader.eventCoding.code | MessageHeader.reason.coding.code +``` +Example: +``` +--header 'use-context: a4t2|validation|servicerequest-response|new' +``` + +### Booking + +``` + Appointment.serviceCategory.coding[usecases-categories-bars] | Appointment.status | MessageHeader.eventCoding.code | MessageHeader.reason.coding.code +``` +Example: +``` +--header 'use-context: a1t1|booked|booking-request|new' +``` + +This header is applicable to the following endpoints: + * POST /$process-message + * POST /Appointment + * PUT /Appointment/{id} + * PATCH /Appointment/{id} + * POST /ServiceRequest + * PUT /ServiceRequest/{id} + * PATCH /ServiceRequest/{id} + +
+
This resource will describe either the Organisation of the Provider or the Organisation of the Supplier managing an Endpoint
+ {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization, hybrid}} + + + +| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example | Immutable | +|----------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|----------------------------------------------------------------------|-----------| +| Organization | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | | | | | +| Organization.id | This MUST only be populated with an id generated by the Endpoint Catalogue in the synchronous HTTP response upon creation. Its necessity is applicable to all VERBS bar POST | MUST | 0.1 | 236bb75d-90ef-461f-b71e-fde7f899802c | Y | +| Organization.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | | | Y | +| Organization.meta.lastUpdated | This MUST be supplied by the client with the time the resource is requested to be created or updated. If it is before the timestamp on the resource on an update, the request will be rejected. This is not the case for a DELETE operation. | MUST | | 2021-11-26T15:00:00.8185338+00:00 | Y | +| Organization.meta.profile | This MUST be populated with the structure definition for the R4 Organization Resource | MUST | | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | Y | +| Organization.identifier[1] | | MUST | | | Y | +| Organization.identifier[0] | This MUST Contain the identifier for Organization ODS code | MUST | | | Y | +| Organization.identifier[0].system | This MUST be the ODS code system identifier https://fhir.nhs.uk/id/ods-organization-code | MUST | | https://fhir.nhs.uk/id/ods-organization-code | Y | +| Organization.identifier[0].value | The ODS code as a string. | MUST | | AA01 | Y | +| Organization.identifier[1] | this MUST contain the identifier for Product ID | MUST | | | Y | +| Organization.identifier[1].system | this MUST be the Product ID system Identifier for http://fhir.nhs.uk/Id/product-id | MUST | | http://fhir.nhs.uk/Id/product-id | Y | +| Organization.identifier[1].value | The hexadecimal Product ID as a string. | MUST | | AAA000 | Y | +| Organization.name | The name of the Organization | MUST | | "NHS Trust A" OR "Supplier A" | Y | +| Organization.partOf | If this Organization describes a child organisation, then the reference to the parent MUST be populated | SHOULD | | | N | +| Organization.partOf.reference | the reference to the parent organization. | SHOULD | | Organization/d5ffd0cd-ec7e-48a1-84f1-91f4c0eb8fc5 | N | +| Organization.type | Follow UK Core guidance for populating this element. | COULD | | | N | +| Organization.type.ValueCodeableConcept | Follow UK Core guidance for populating this element. | COULD | | | N | +| Organization.alias | Follow UK Core guidance for populating this element. | COULD | | | N | +| Organization.telecom | Follow UK Core guidance for populating this element. | COULD | | | N | +| Organization.address | Follow UK Core guidance for populating this element. | COULD | | | N | +| Organization.contact | Follow UK Core guidance for populating this element. | COULD | | | N | +| Organization.endpoint | Not currently used in this implementation. | COULD | | | N | + + + +
+
+ This Resource describes the healthcare service that the endpoint is serving.> HealthcareService
+
+
+ This resource describes the endpoint itself including data around how to interact with it > Endpoint
+
+
+## Entity Relationship Diagram
+
+
+
+## Examples
+
+### Endpoint
+```json
+{
+ "resourceType": "Organization",
+ "meta": {
+ "lastUpdated": "2021-10-11T15:23:30.8185338+00:00",
+ "profile": [
+ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
+ ]
+ },
+ "identifier": [
+ {
+ "system": "https://fhir.nhs.uk/id/ods-organization-code",
+ "value": "RYE"
+ },
+ {
+ "system": "http://fhir.nhs.uk/Id/product-id",
+ "value": "AAA000"
+ }
+ ],
+ "name": "NHS Trust A"
+}
+```
+
+### HealthcareService
+```json
+{
+ "resourceType": "HealthcareService",
+ "meta": {
+ "lastUpdated": "2021-11-26T15:00:00.8185338+00:00",
+ "profile": [
+ "http://hl7.org/fhir/StructureDefinition/HealthcareService",
+ "https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService"
+ ]
+ },
+ "identifier": [
+ {
+ "system": "http://fhir.nhs.uk/Id/dos-service-id",
+ "value": "111111111"
+ },
+ {
+ "system": "http://fhir.nhs.uk/Id/product-id",
+ "value": "AAA000"
+ }
+ ],
+ "active": true,
+ "providedBy": {
+ "reference": "Organization/d5ffd0cd-ec7e-48a1-84f1-91f4c0eb8fc5"
+ },
+ "name": "Emergency Department A",
+ "endpoint":{
+ "reference":"Endpoint/4e958d43-ad80-40c9-85ff-2be003d1ea86"
+ }
+}
+```
+
+### Endpoint
+```json
+{
+ "resourceType": "Endpoint",
+ "id": "0cb21027-a246-43e6-9c7a-35b17163eab1",
+ "meta": {
+ "lastUpdated": "2021-10-11T15:23:30+00:00",
+ "profile": [
+ "http://hl7.org/fhir/StructureDefinition/Endpoint"
+ ]
+ },
+ "identifier": [
+ {
+ "system": "http://fhir.nhs.uk/Id/product-id",
+ "value": "AAA000"
+ }
+ ],
+ "status": "active",
+ "name": "Service Endpoint Name",
+ "connectionType": [
+ {
+ "valueCodeableConcept": {
+ "coding": [
+ {
+ "system": "https://fhir.nhs.uk/CodeSystem/ConnectionTypes",
+ "code": "BARS",
+ "display": "Booking And Referrals Standard"
+ }
+ ],
+ "text": "Booking and Referrals"
+ }
+ }
+ ],
+ "managingOrganization": [
+ {
+ "reference": "3e96763f-7969-404f-afac-c415f47dff42"
+ }
+ ],
+ "address": "https://myService.nhs.uk/Base/Address",
+ "header": "public",
+ "Period": {
+ "Start": "2021-10-11T15:23:30+00:00",
+ "End": "2021-10-11T15:23:30+00:00"
+ }
+}
+```
\ No newline at end of file
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/EndpointCatalogue-StandardPattern/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/EndpointCatalogue-StandardPattern/Index.page.md
new file mode 100644
index 00000000..1ec44930
--- /dev/null
+++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/EndpointCatalogue-StandardPattern/Index.page.md
@@ -0,0 +1,6 @@
+---
+topic: core-StandardPattern-Endpoints-1.4.1
+---
+
+
+.
\ No newline at end of file
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/EndpointCatalogue-StandardPattern/Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/EndpointCatalogue-StandardPattern/Interface.page.md
new file mode 100644
index 00000000..84ab833a
--- /dev/null
+++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/EndpointCatalogue-StandardPattern/Interface.page.md
@@ -0,0 +1,329 @@
+---
+topic: core-StandardPattern-Endpoint-Interface-1.4.1
+---
+
+# Interface
+
+The Interface for managing the 3 resources relating to an "endpoint" is detailed below and is part of the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1) for Core 1.2.0 and above.
+
+## Request and Response
+
+
| Behaviour | +Initiator | +VERB | +API Path | +Parameters | +Payload | +Payload Definition | +Reactor | +Reactor Behaviour | +Happy Response | +Response Definition | +
|---|---|---|---|---|---|---|---|---|---|---|
| Get Capabilities | +Sender | +GET | +/metadata | +N/A | +N/A | +N/A | +Endpoint Catalogue | +Return a capability statement describing capabilities. | +200: CapabilityStatement | +https://www.hl7.org/fhir/capabilitystatement.html | +
| Get Endpoints | +Sender / Receiver / BaRS / Admin | +GET | +/Endpoint | +query: _has | +N/A | +N/A | +Endpoint Catalogue | +Return a searchset of Endpoints based on the properties of the parent given as a _has HealthcareService.Identifier or Id | +200: Search Bundle | +https://simplifier.net/guide/NHSBookingandReferrals/UKCore-Bundle searchset | +
| query: Endpoint.identifier | +N/A | +N/A | +Endpoint Catalogue | +Return a searchset of Endpoints based on the identifier of the Endpoint itself. this should only be one item. | +200: Search Bundle | +https://simplifier.net/guide/NHSBookingandReferrals/UKCore-Bundle searchset | +||||
| Get Endpoint | +Sender / Receiver / BaRS / Admin | +GET | +/Endpoint/{id} | +path: id | +N/A | +N/A | +Endpoint Catalogue | +Return specific Endpoint based on id given. | +200: Endpoint | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Endpoint | +
| Create Endpoint | +Receiver / Admin | +POST | +/Endpoint | +path: id | +Endpoint | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Endpoint | +Endpoint Catalogue | +Store a new Endpoint based on id given. | +201: Endpoint | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Endpoint | +
| Update Endpoint | +Receiver / Admin | +PUT | +/Endpoint/{id} | +path: id | +Endpoint | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Endpoint | +Endpoint Catalogue | +Update an existing endpoint based on id given. | +200: Endpoint | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Endpoint | +
| Delete Endpoint | +Receiver / Admin | +DELETE | +/Endpoint/{id} | +path: id | +N/A | +N/A | +Endpoint Catalogue | +Remove an existing endpoint based on id given | +200: OperationOutcome | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome | +
| Get Organisations | +Sender / Receiver / BaRS / Admin | +GET | +/Organisation? | +query: Organization.identifier | +N/A | +N/A | +Endpoint Catalogue | +Return a list of Organizations based on the identifier given | +200: Search Bundle | +https://simplifier.net/guide/NHSBookingandReferrals/UKCore-Bundle searchset | +
| Get Organisation | +Sender / Receiver / BaRS / Admin | +GET | +/Organisation/{id} | +path: id | +N/A | +N/A | +Endpoint Catalogue | +Return a specific Endpoint based on the id given. | +200: Organization | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | +
| Create Organisation | +Receiver / Admin | +POST | +/Organisation | +path: id | +Organization | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | +Endpoint Catalogue | +Store a new Organization based on the id given. | +201: Organization | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | +
| Update Organisation | +Receiver / Admin | +PUT | +/Organisation/{id} | +path: id | +Organization | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | +Endpoint Catalogue | +Update an existing Organization based on the id given. | +200: Organization | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | +
| Delete Organisation | +Receiver / Admin | +DELETE | +/Organisation/{id} | +path: id | +N/A | +N/A | +Endpoint Catalogue | +Remove an existing Organization based on the id given. | +200: OperationOutcome | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome | +
| Get HealthcareService | +Sender / Receiver / BaRS / Admin | +GET | +/HealthcareService | +query: HealthcareService.identifier | +N/A | +N/A | +Endpoint Catalogue | +Return a list of HealthcareServices based on the identifier given | +200: Search Bundle | +https://simplifier.net/guide/NHSBookingandReferrals/UKCore-Bundle searchset | +
| query: HealthcareService.providedBy | +N/A | +N/A | +Endpoint Catalogue | +Return a list of HealthcareServices based on the identifier given | +200: Search Bundle | +https://simplifier.net/guide/NHSBookingandReferrals/UKCore-Bundle searchset | +||||
| Get HealthcareService | +Sender / Receiver / BaRS / Admin | +GET | +/HealthcareService/{id} | +path: id | +N/A | +N/A | +Endpoint Catalogue | +Return a specific HealthcareServicesbased on the id given. | +200: HealthcareServices | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | +
| Create HealthcareService | +Receiver / Admin | +POST | +/HealthcareService | +path: id | +Organization | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | +Endpoint Catalogue | +Store a new HealthcareServicesbased on the id given. | +201: HealthcareServices | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | +
| Update HealthcareService | +Receiver / Admin | +PUT | +/HealthcareService/{id} | +path: id | +Organization | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | +Endpoint Catalogue | +Update an existing HealthcareServicesbased on the id given. | +200: HealthcareServices | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | +
| Delete HealthcareService | +Receiver / Admin | +DELETE | +/HealthcareService/{id} | +path: id | +N/A | +N/A | +Endpoint Catalogue | +Remove an existing HealthcareServicesbased on the id given. | +200: OperationOutcome | +https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome | +
| API Path | +Type | +Parameter | +Format | +Purpose | +
|---|---|---|---|---|
| /Endpoint? | +query | +_has | +_has:HealthcareService.Identifier=https://fhir.nhs.uk/Id/dos-service-id|1000099999 | +An identifier for the HealthcareService to which Endpoints belong. in this example an id or DoS id. | +
| _has:HealthcareService.Id=95852b93-d1ab-4c51-8e7d-c24cf9b257a9 | +||||
| /Endpoint? | +query | +Endpoint.identifier | +The identifier of the type of Endpoint. This would be used to say if you want a BaRS endpoint or otherwise. |
+ |
| /Endpoint/{} | +path | +id | +GUID/UUID - "c1ab3fba-6bae-4ba4-b257-5a87c44d4a91" | +The identifier of the endpoint. | +
| /HealthcareService/? | +query | +HealthcareService.identifier | +https://fhir.nhs.uk/Id/dos-service-id|1000099999 | +an identifier of the healthcareService, in this example, a DoS id. | +
| /HealthcareService/? | +query | +HealthcareService.providedBy | +https://fhir.nhs.uk/Id/ods-organization-code|A001 | +the owning organisations ODS code. | +
| /HealthcareService/{id} | +path | +id | +GUID/UUID - "c1ab3fba-6bae-4ba4-b257-5a87c44d4a91" | +specific resource id of an HealthcareService. | +
| /Organisation? | +query | +Organization.identifier | +"A001" | +An identifier for the organization. in this example an ODS code. | +
| "https://fhir.nhs.uk/id/ods-organization-code|A001" | +||||
| /Organisation/{id} | +path | +id | +GUID/UUID - "c1ab3fba-6bae-4ba4-b257-5a87c44d4a91" | +specific resource id of an organization. | +
+ +This version of core is strictly a preview of what is currently in development for 1.2.0 and should not be built against. + +
| Core Version | +Minimum Guide Version | +Minimum API Spec Version | +
|---|---|---|
| v1.2.0-alpha | +v1.8.0 | +v1.2.0 | +
+
| Core Version | +Minimum Guide Version | +Minimum API Spec Version | +
|---|---|---|
| v1.4.1 | +v1.11.1 | +v1.4.1 | +
+ +This version of core is strictly a preview of what is currently in development for 1.4.1 and should not be built against. + +
+ +
The Bundle resource is the container for the event message.
+ {{tree:https://fhir.nhs.uk/StructureDefinition/BARSBundleMessage, hybrid}} ++ + + +| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | +|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|------------------------------------------------------------------------------------------| +| Bundle | The Bundle resource is the container for the event message https://simplifier.net/nhsbookingandreferrals/barsbundlemessage | | 1..1 | | +| Bundle.id | This id is generated by the originating sender of the message, retained in subsequent messages.. | MUST | 1..1 | 79120f41-a431-4f08-bcc5-1e67006fcae0 | +| Bundle.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | | +| Bundle.meta.versionId | This MUST be populated with the version of the Application the bundle complies with. The Receiver will read this to know whether they are capable of processing. | MUST | 0..1 | 1.0.0-beta | +| Bundle.meta.profile | This MUST be populated with the structure definition for BaRSBundleMessage : 'https://fhir.nhs.uk/StructureDefinition/BARSBundleMessage' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/StructureDefinition/BARSBundleMessage | +| Bundle.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under meta section which must be the same timestamp for each resource when created from new, but must be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | +| Bundle.type | This must be populated with 'message' - FIXED VALUE | MUST | 1..1 | message | +| Bundle.timestamp | the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | +| Bundle.entry(s) | Follow BaRS profile guidance for populating this element | MUST | 1..* | | +| Bundle.entry.fullUrl | unique identifier for the resource entry. Transient id relative to the bundle | MUST | 0..1 | urn:uuid:1cbdfb97-5859-48a4-8301-d54eab818d68 | +| Bundle.entry.resourceType | Resources detailed in the message definition. | MUST | 0..1 | MessageHeader,Patient, Encounter | + + + +
+
+
+ A resource that describes the BaRS message being exchanged between two systems.
+
+
+
+
+
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|------------------------------------------------------------------------------------------|
+| MessageHeader | A resource that describes the BaRS message being exchanged between two systems https://simplifier.net/nhsbookingandreferrals/barsmessageheaderservicerequestrequest | | 1..1 | |
+| MessageHeader.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | |
+| MessageHeader.meta.profile | This MUST be populated with the structure definition for BaRSMessageHeader-servicerequest-request. | MUST | 0..1 | https://fhir.nhs.uk/StructureDefinition/BARSMEssageHeader-servicerequest-request |
+| MessageHeader.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under the meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates to resources, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| MessageHeader.extension | This MUST be populated with details of the Clinical Decision Support System used | MUST | 0..* | |
+| MessageHeader.extension.url | This MUST be populated with 'https://fhir.nhs.uk/StructureDefinition/CDSSExtension' - FIXED VALUE | MUST | 1..1 | https://fhir.nhs.uk/StructureDefinition/CDSSExtension |
+| MessageHeader.extension.extension | | MUST | 0..* | |
+| MessageHeader.extension.extension.url | This MUST be populated with the pre-defined Clinical Decision Support System software URL - FIXED VALUE | MUST | 1..1 | requesterCDSSSoftware |
+| MessageHeader.extension.extension.valueString | This MUST be populated with the Clinical Decision Support System software name e.g. Pathways | MUST | 0..1 | Pathways |
+| MessageHeader.extension.extension | | MUST | 0..* | |
+| MessageHeader.extension.extension.url | This MUST be populated with the pre-defined Clinical Decision Support System software Version URL - FIXED VALUE | MUST | 1..1 | requesterCDSSVersion |
+| MessageHeader.extension.extension.valueString | This MUST be populated with the Clinical Decision Support System software Version name e.g. 30.2.0 | MUST | 0..1 | 30.2.0 |
+| MessageHeader.eventcoding | | MUST | 1..1 | |
+| MessageHeader.eventcoding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/message-events-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-events-bars |
+| MessageHeader.eventcoding.code | The status MUST be populated with 'servicerequest-request'. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-events-bars' - FIXED VALUE | MUST | 0..1 | servicerequest-request |
+| MessageHeader.destination | | MUST | 0..1 | |
+| MessageHeader.destination.receiver | | MUST | 0..1 | |
+| MessageHeader.destination.receiver.reference | This MUST be populated with the full URL to the Receiving Organisation resource. | MUST | 0..1 | urn:uuid:10397afd-479c-42ea-9d5d-e4024481e0f8 |
+| MessageHeader.destination.endpoint | This MUST be populated with the system and Service ID separated by a pipe. for example https://fhir.nhs.uk/id/dos-service-id\|11111111, this is to ensure the receiver knows the intended destination. | MUST | 1..1 | https://fhir.nhs.uk/id/dos-service-id\|1122334455 |
+| MessageHeader.sender | | MUST | 0..1 | |
+| MessageHeader.sender.reference | This MUST be populated. Follow BaRS profile guidance for populating this element | MUST | 0..1 | urn:uuid:07939a0c-2854-46ff-9282-ad906bc93679 |
+| MessageHeader.source | | MUST | 1..1 | |
+| MessageHeader.source.name | This MUST be populated with the sending system supplier name | MUST | 0..1 | NHS Trust |
+| MessageHeader.source.software | This SHOULD be populated with the sending software application name | SHOULD | 0..1 | Supplier Software |
+| MessageHeader.source.version | This SHOULD be populated with the sending software version | SHOULD | 0..1 | V1.0.0 |
+| MessageHeader.source.contact | | SHOULD | 0..1 | |
+| MessageHeader.source.contact.system | This SHOULD be populated with the Contact Type - phone \| fax \| email \| pager \| url \| sms \| other | SHOULD | 0..1 | phone |
+| MessageHeader.source.contact.value | This SHOULD be populated with the Contact Type value | SHOULD | 0..1 | +44 (0123) 123 4567 |
+| MessageHeader.source.endpoint | This MUST be populated with the system and Service ID separated by a pipe. for example https://fhir.nhs.uk/id/dos-service-id\|11111111, this is to ensure the receiver knows where any response messages SHOULD be addressed. | MUST | 1..1 | https://fhir.nhs.uk/id/dos-service-id\|5566778899 |
+| MessageHeader.reason | | MUST | 0..1 | |
+| MessageHeader.reason.coding | | MUST | 0..1 | |
+| MessageHeader.reason.coding.system | This MUST be populated with 'https://fhir.nhs.uk/CodeSystem/message-reason-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-reason-bars |
+| MessageHeader.reason.coding.code | This MUST be populated with "delete" for an cancellation. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-events-bars' | MUST | 0..1 | delete |
+| MessageHeader.reason.coding.display | This MUST be populated with 'Delete' when cancelling a Service Request. | SHOULD | 0..1 | Delete |
+| MessageHeader.focus | | MUST | 0..* | |
+| MessageHeader.focus.reference | This MUST be populated with a reference to the ServiceRequest | MUST | 0..1 | urn:uuid:236bb75d-90ef-461f-b71e-fde7f899802c |
+| MessageHeader.definition | This MUST be populated with the MessageDefinition the bundle is based on. This will be used for validation. Value - https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-cancelled | MUST | 0..1 | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-cancelled |
+
+
+
+> Message Header
+
+
+
+
+ A resource to carry a request for a service to be performed, in this case a Validation. This Resource is the focus of the Validation Request interaction.
+
+
+
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|------------------------------------------------------------------------------------------|
+| ServiceRequest | A resource to carry a request for a service to be performed, in this case a Validation. This Resource is the focus of the Validation Request interaction https://simplifier.net/nhsbookingandreferrals/barsservicerequest-request-validation | | 1..1 | |
+| ServiceRequest.id | MUST only be generated by the Receiver as the id for the resource in the synchronous HTTP response. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c |
+| ServiceRequest.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | |
+| ServiceRequest.meta.profile | https://fhir.nhs.uk/StructureDefinition/BARSServiceRequest-request-validation | MUST | 0..1 | https://fhir.nhs.uk/StructureDefinition/BARSServiceRequest-request-validation |
+| ServiceRequest.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under meta section which must be the same timestamp for each resource when created from new, but must be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| ServiceRequest.basedOn | | MUST | 0..* | |
+| ServiceRequest.basedOnreference | This MUST be populated with a reference to the CarePlan resource | MUST | 0..1 | urn:uuid:236bb75d-90ef-461f-b71e-fde7f899802c |
+| ServiceRequest.status | Only use the following 2 values, as appropriate: revoked is used when a SR is legitimately cancelled, entered-in-error is used when sent to the by mistake and needs to be removed. | MUST | 1..1 | entered-in-error |
+| ServiceRequest.intent | This MUST be populated with 'plan' - Fixed Value | MUST | 1..1 | plan |
+| ServiceRequest.category | | MUST | 0..1 | |
+| ServiceRequest.category.coding | | MUST | 0..* | |
+| ServiceRequest.category.coding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/message-category-servicerequest' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-category-servicerequest |
+| ServiceRequest.category.coding.code | This MUST be populated with code value appropriate for the Application employed. | MUST | 0..1 | validation |
+| ServiceRequest.category.coding.display | This MUST be populated with display value appropriate for the Application employed. | MUST | 0..1 | For Validation |
+| ServiceRequest.subject | Follow BaRS profile guidance for populating this element | MUST | 1..1 | |
+| ServiceRequest.subjectreference | This MUST be populated with a Reference to the Patient resource | MUST | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
+| ServiceRequest.encounter | | MUST | 0..1 | |
+| ServiceRequest.encounter.reference | This MUST be populated with a Reference to the Encounter | MUST | 0..1 | urn:uuid:8c63d621-4d86-4f57-8699-e8e22d49935d |
+| ServiceRequest.occurrencePeriod | Validation Breach time | MUST | 0..1 | |
+| ServiceRequest.occurrencePeriod.start | The start of the period must be ‘now’. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| ServiceRequest.occurrencePeriod.end | The time by which the validation must be complete (validation breach time) | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| ServiceRequest.reasonCode | This will ONLY be populated in a cancellation message with the reason for cancellation | SHOULD | 0..* | |
+| ServiceRequest.reasonCode.text | This SHOULD be populated. This will ONLY be populated in a cancellation message with the reason for cancellation and SHOULD only be used in conjunction with a corresponding status - revoked or entered-in-error | SHOULD | 0..1 | Revoked as patient has been dealt with. |
+
+
+> Service Request
+
+
+ This resource is used to communicate details about the patient who is the subject of the referral.
+
+
+
+
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|------------------------------------------------------------------------------------------|
+| Patient | This resource is used to communicate details about the patient who is the subject of the referral.> Patient
+
It also includes contact information for third parties when required.
It also includes contact information for third parties when required.
https://simplifier.net/hl7fhirukcorer4/ukcore-patient | | 1..1 | |
+| Patient.id | If this value was included in the synchronous response to the original request, it MUST be populated in subsequent requests. | MUST | 0..1 | 9589fb37-87a2-48d8-968f-b371429208a8 |
+| Patient.meta | https://simplifier.net/hl7fhirukcorer4/ukcore-patient | MUST | 1..1 | |
+| Patient.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient |
+| Patient.meta.LastUpdated | All resources MUST include 'lastUpdated' value, under meta section which must be the same timestamp for each resource when created from new, but must be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| Patient.identifier | This is a human readable patient identifier. This MUST be populated with the NHS number when available. Additionally a Local Patient Identifier Should be populated where available. If no NHS number is available this Should be populated with the Local patient identifier. | SHOULD | 0..* | |
+| Patient.identifier.system | https://simplifier.net/hl7-fhir--uk-core-r4-stu1-sequence/ukcore-nhsnumberverificationstatus | SHOULD | 1..1 | https://fhir.nhs.uk/Id/nhs-number |
+| Patient.identifier.value | This SHOULD be populated with a human readable patient identifier. When used this MUST be populated with the NHS number when available.If no NHS number is available this SHOULD be populated with the Local patient identifier. | SHOULD | 1..1 | 3478526985 |
+| Patient.identifier.extension | This extension is used to record the NHS number Verification status | SHOULD | 0..* | |
+| Patient.identifier.extension.url | This SHOULD be populated. Where used this MUST be populated with Structure Definition 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus' - FIXED VALUE | SHOULD | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus |
+| Patient.identifier.extension.valueCodeableConcept | | SHOULD | 0..1 | |
+| Patient.identifier.extension.valueCodeableConcept.coding | | SHOULD | 0..1 | |
+| Patient.identifier.extension.valueCodeableConcept.coding.system | https://simplifier.net/hl7fhirukcorer4/extensionukcorenhsnumberverificationstatus | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus |
+| Patient.identifier.extension.valueCodeableConcept.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | number-present-and-verified |
+| Patient.identifier.extension.valueCodeableConcept.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Number present and verified |
+| Patient.name | | SHOULD | 0..* | |
+| Patient.name.use | Follow UK Core guidance for populating this element | SHOULD | 0..1 | official |
+| Patient.name.text | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Mrs Julie Jones |
+| Patient.name.family | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Jones |
+| Patient.name.given | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Julie |
+| Patient.name.prefix | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Mrs |
+| Patient.gender | Follow UK Core guidance for populating this element | SHOULD | 0..1 | female |
+| Patient.birthDate | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 1959-05-04 |
+| Patient.address | Follow UK Core guidance for populating this element | SHOULD | 0..* | |
+| Patient.address.use | Follow UK Core guidance for populating this element | SHOULD | 0..1 | home |
+| Patient.address.type | Follow UK Core guidance for populating this element | SHOULD | 0..1 | both |
+| Patient.address.text | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 22 Brightside Crescent, Overtown, West Yorkshire, LS10 4YU |
+| Patient.address.line | Follow UK Core guidance for populating this element | SHOULD | 0..* | 22 Brightside Crescent |
+| Patient.address.city | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Overtown |
+| Patient.address.district | Follow UK Core guidance for populating this element | SHOULD | 0..1 | West Yorkshire |
+| Patient.address.postalCode | Follow UK Core guidance for populating this element | SHOULD | 0..1 | LS10 4YU |
+| Patient.contact | This should be used to record telecom information for the patient and/or the patient's representative for the encounter | MUST | 0..* | |
+| Patient.contact.extension | | MUST | 0..* | |
+| Patient.contact.extension.url | This MUST be populated with Structure Definition 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank' - FIXED VALUE | MUST | 0..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference |
+| Patient.contact.extension.urlvaluePositiveInt | This MUST be populated with the rank of the whole contact and MUST be populated with the value '1' for the primary person to contact for referral. There MUST be at least one contact for the referral. | MUST | 0..1 | 1 |
+| Patient.contact.relationship | | MUST | 0..* | |
+| Patient.contact.relationship.coding | | MUST | 0..* | |
+| Patient.contact.relationship.coding.system | This MUST be populated with the CodeSystem from the ValueSet 'https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-personrelationshiptype'.
Where the contact details relate to the patient this relationship MUST be populated with the value 'self'.
Where the contact details relate to a patient's representative this SHOULD be populated with their relationship to the patient.
If the relationship is not known this SHOULD be populated with the value 'Unknown' | MUST | 0..1 | http://terminology.hl7.org/CodeSystem/v2-0131 |
+| Patient.contact.relationship.coding.code | This MUST be populated with Code of CodeSystem value. See ValueSet 'https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-personrelationshiptype'. | MUST | 0..1 | EP |
+| Patient.contact.relationship.coding.display | This MUST be populated with Display of CodeSystem value. See ValueSet 'https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-personrelationshiptype'. | MUST | 0..1 | EP |
+| Patient.contact.name | | SHOULD | 0..1 | |
+| Patient.contact.name.family | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | Grayson |
+| Patient.contact.name.given | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | Jack |
+| Patient.contact.telecom | | MUST | 0..* | |
+| Patient.contact.telecom.system | This MUST be populated for the rank 1 contact. There MUST be at least one contact phone number for the referral | MUST | 0..1 | phone |
+| Patient.contact.telecom.value | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | 0789 1234567 |
+| Patient.contact.gender | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | male |
+| Patient.Communication | | SHOULD | 0..* | |
+| Patient.Communication.Language | | MUST | 1..1 | |
+| Patient.Communication.Language.coding | | MUST | 1..1 | |
+| Patient.Communication.Language.coding.code | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | en |
+| Patient.Communication.Language.coding.system | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage |
+| Patient.Communication.Language.coding.display | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | English |
+| Patient.Communication.Language.preferred | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | TRUE |
+| Patient.extension | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..* | |
+| Patient.extension.url | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory |
+| Patient.extension.url.valueCodeableConcept | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | |
+| Patient.extension.url.valueCodeableConcept.coding | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | |
+| Patient.extension.url.valueCodeableConcept.coding.system | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategory |
+| Patient.extension.url.valueCodeableConcept.coding.code | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | A |
+| Patient.extension.url.valueCodeableConcept.coding.display | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | British, Mixed British |
+| Patient.generalPractitioner | This SHOULD be populated with a reference to the GP Surgery ONLY rather than a specific practitioner | SHOULD | 0..* | |
+| Patient.generalPractitioner.reference | This SHOULD be populated. Where populated this MUST reference to an Organisation resource | SHOULD | 0..1 | urn:uuid:b83d13e2-8c2e-422c-88ac-63b8e86a4411 |
+
+
+
+
+
+ This resource is used to communicate details about the sender and receiver organisations.
+
+
+
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|------------------------------------------------------------------------------------------|
+| Organization | This resource is used to communicate details about the sender organisations. > Organization
+
https://simplifier.net/hl7fhirukcorer4/ukcore-organization | | 2..* | |
+| Organization.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 5d897313-c62d-4e7e-92b7-b2199804fed3 |
+| Organization.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
+| Organization.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization |
+| Organization.meta.lastUpdated | This MUST be populated. All resources MUST include 'lastUpdated' value, under meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| Organization.identifier | This MUST be populated with an organisation identifier e.g. ODS code | MUST | 0..* | |
+| Organization.identifier.system | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | https://fhir.nhs.uk/id/ods-organization-code |
+| Organization.identifier.value | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | ABD01 |
+| Organization.name | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | Organisation name |
+
+
+
+
+
+
+### Entity Relationship Diagram - Cancellation Referral Request
+
+
+
+The below diagram details the Cancellation Referral Request
+
+
+
+
+
+ +
The Bundle resource is the container for the event message.
+ {{tree:https://fhir.nhs.uk/StructureDefinition/BARSBundleMessage, hybrid}} ++ + + +| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | +|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|------------------------------------------------------------------------------------------| +| Bundle | The Bundle resource is the container for the event message https://simplifier.net/nhsbookingandreferrals/barsbundlemessage | | 1..1 | | +| Bundle.id | This id is generated by the originating sender of the message, retained in subsequent messages.. | MUST | 1..1 | 79120f41-a431-4f08-bcc5-1e67006fcae0 | +| Bundle.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | | +| Bundle.meta.versionId | This MUST be populated with the version of the Application the bundle complies with. The Receiver will read this to know whether they are capable of processing. | MUST | 0..1 | 1.0.0-beta | +| Bundle.meta.profile | This MUST be populated with the structure definition for BaRSBundleMessage : 'https://fhir.nhs.uk/StructureDefinition/BARSBundleMessage' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/StructureDefinition/BARSBundleMessage | +| Bundle.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under meta section which must be the same timestamp for each resource when created from new, but must be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | +| Bundle.type | This must be populated with 'message' - FIXED VALUE | MUST | 1..1 | message | +| Bundle.timestamp | the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | +| Bundle.entry(s) | Follow BaRS profile guidance for populating this element | MUST | 1..* | | +| Bundle.entry.fullUrl | unique identifier for the resource entry. Transient id relative to the bundle | MUST | 0..1 | urn:uuid:1cbdfb97-5859-48a4-8301-d54eab818d68 | +| Bundle.entry.resourceType | Resources detailed in the message definition. | MUST | 0..1 | MessageHeader,Patient, Encounter | + +
+
+
+ A resource that describes the BaRS message being exchanged between two systems.
+
+
+
+
+
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|------------------------------------------------------------------------------------------|
+| MessageHeader | A resource that describes the BaRS message being exchanged between two systems https://simplifier.net/nhsbookingandreferrals/barsmessageheaderservicerequestrequest | | 1..1 | |
+| MessageHeader.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | |
+| MessageHeader.meta.profile | This MUST be populated with the structure definition for BARSMessageHeader-booking-request | MUST | 0..1 | https://fhir.nhs.uk/StructureDefinition/BARSMessageHeader-booking-request |
+| MessageHeader.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under the meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates to resources, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| MessageHeader.eventcoding | | MUST | 1..1 | |
+| MessageHeader.eventcoding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/message-events-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-events-bars |
+| MessageHeader.eventcoding.code | The status MUST be populated with 'booking-request'. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-events-bars' - FIXED VALUE | MUST | 0..1 | booking-request |
+| MessageHeader.destination | | MUST | 0..1 | |
+| MessageHeader.destination.receiver | | MUST | 0..1 | |
+| MessageHeader.destination.receiver.reference | This MUST be populated with the full URL to the Receiving Organisation resource. | MUST | 0..1 | urn:uuid:10397afd-479c-42ea-9d5d-e4024481e0f8 |
+| MessageHeader.destination.endpoint | This MUST be populated with the system and Service ID separated by a pipe. for example https://fhir.nhs.uk/id/dos-service-id\|11111111, this is to ensure the receiver knows the intended destination. | MUST | 1..1 | https://fhir.nhs.uk/id/dos-service-id\|1122334455 |
+| MessageHeader.sender | | MUST | 0..1 | |
+| MessageHeader.sender.reference | This MUST be populated. Follow BaRS profile guidance for populating this element | MUST | 0..1 | urn:uuid:07939a0c-2854-46ff-9282-ad906bc93679 |
+| MessageHeader.source | | MUST | 1..1 | |
+| MessageHeader.source.name | This MUST be populated with the sending system supplier name | MUST | 0..1 | NHS Trust |
+| MessageHeader.source.software | This SHOULD be populated with the sending software application name | SHOULD | 0..1 | Supplier Software |
+| MessageHeader.source.version | This SHOULD be populated with the sending software version | SHOULD | 0..1 | V1.0.0 |
+| MessageHeader.source.contact | | SHOULD | 0..1 | |
+| MessageHeader.source.contact.system | This SHOULD be populated with the Contact Type - phone \| fax \| email \| pager \| url \| sms \| other | SHOULD | 0..1 | phone |
+| MessageHeader.source.contact.value | This SHOULD be populated with the Contact Type value | SHOULD | 0..1 | +44 (0123) 123 4567 |
+| MessageHeader.source.endpoint | This MUST be populated with the system and Service ID separated by a pipe. for example https://fhir.nhs.uk/id/dos-service-id\|11111111, this is to ensure the receiver knows where any response messages SHOULD be addressed. | MUST | 1..1 | https://fhir.nhs.uk/id/dos-service-id\|5566778899 |
+| MessageHeader.reason | | MUST | 0..1 | |
+| MessageHeader.reason.coding | | MUST | 0..1 | |
+| MessageHeader.reason.coding.system | This MUST be populated with 'https://fhir.nhs.uk/CodeSystem/message-reason-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-reason-bars |
+| MessageHeader.reason.coding.code | This MUST be populated with "delete" for an cancellation. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-events-bars' | MUST | 0..1 | delete |
+| MessageHeader.reason.coding.display | This MUST be populated with 'Delete' when cancelling a Booking. | SHOULD | 0..1 | Delete |
+| MessageHeader.focus | | MUST | 0..* | |
+| MessageHeader.focus.reference | This MUST be populated with a reference to the ServiceRequest | MUST | 0..1 | urn:uuid:236bb75d-90ef-461f-b71e-fde7f899802c |
+| MessageHeader.definition | This MUST be populated with the MessageDefinition the bundle is based on. This will be used for validation. Value - hhttps://fhir.nhs.uk/MessageDefinition/bars-message-booking-request-cancelled | MUST | 0..1 | https://fhir.nhs.uk/MessageDefinition/bars-message-booking-request-cancelled |
+
+
+> Message Header
+
+
+
+
+ This resource will be used to communicate information about an Appointment and is the focus of the Booking interation.
+
+
+
+
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|------------------------------------------------------------------------------------------|
+| Appointment | https://simplifier.net/hl7fhirukcorer4/ukcore-appointment > Appointment
+
+
+
+
This resource will be used to communicate information about an appointment. | | 1..1 | |
+| Appointment.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 3713c8fc-dbcf-4f90-bacf-89d99e434e9b |
+| Appointment.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
+| Appointment.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment |
+| Appointment.meta.lastupdated | This MUST be populated. All resources MUST include 'lastUpdated' value, under meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| Appointment.status | This MUST be populated with 'cancelled' | MUST | 1..1 | cancelled |
+| Appointment.description | This SHOULD be populated. It is the human readable description of the booking | SHOULD | 0..1 | Reason for calling |
+| Appointment.start | This MUST be populated with the Start time of the booking | MUST | 0..1 | 2021-10-12T12:30:00+00:00 |
+| Appointment.end | This MUST be populated with the End time of the booking | MUST | 0..1 | 2021-10-12T12:30:00+00:00 |
+| Appointment.slot | | MUST | 0..* | |
+| Appointment.slot.reference | This MUST be populated with the local logical bundle reference to the Slot resource | MUST | 0..1 | urn:uuid:c3f6145e-1a26-4345-b3f2-dccbcba62049 |
+| Appointment.created | This MUST only be populated with the date/time the booking was generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 2021-10-11T15:01:30+00:00" |
+| Appointment.basedOn | This MAY be populated. When the Service Request is made before the booking in the workflow this MUST be populated. | MAY | 0..* | |
+| Appointment.basedOn.reference | This MAY be populated. This is MUST be the relative reference to the Service Request when referral is made before booking in the workflow | MAY | 0..1 | ServiceRequest/236bb75d-90ef-461f-b71e-fde7f899802c |
+| Appointment.participant | | MUST | 1..1 | |
+| Appointment.participant.actor | This MUST be populated with reference to the patient | MUST | 0..1 | |
+| Appointment.participant.actor.reference | This MUST be populated with the local logical bundle reference to the Patient resource | MUST | 0..1 | urn:uuid:3a62607b-df65-4932-940c-14262787f62d |
+| Appointment.participant.actor.status | This MUST be populated with 'accepted' - FIXED VALUE | MUST | 1..1 | accepted |
+
+ This resource is used to communicate details about the patient who is the subject of the referral.
+
+
+
+
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|------------------------------------------------------------------------------------------|
+| Patient | This resource is used to communicate details about the patient who is the subject of the referral.> Patient
+
It also includes contact information for third parties when required.
It also includes contact information for third parties when required.
https://simplifier.net/hl7fhirukcorer4/ukcore-patient | | 1..1 | |
+| Patient.id | If this value was included in the synchronous response to the original request, it MUST be populated in subsequent requests. | MUST | 0..1 | 9589fb37-87a2-48d8-968f-b371429208a8 |
+| Patient.meta | https://simplifier.net/hl7fhirukcorer4/ukcore-patient | MUST | 1..1 | |
+| Patient.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient |
+| Patient.meta.LastUpdated | All resources MUST include 'lastUpdated' value, under meta section which must be the same timestamp for each resource when created from new, but must be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| Patient.identifier | This is a human readable patient identifier. This MUST be populated with the NHS number when available. Additionally a Local Patient Identifier Should be populated where available. If no NHS number is available this Should be populated with the Local patient identifier. | SHOULD | 0..* | |
+| Patient.identifier.system | https://simplifier.net/hl7-fhir--uk-core-r4-stu1-sequence/ukcore-nhsnumberverificationstatus | SHOULD | 1..1 | https://fhir.nhs.uk/Id/nhs-number |
+| Patient.identifier.value | This SHOULD be populated with a human readable patient identifier. When used this MUST be populated with the NHS number when available.If no NHS number is available this SHOULD be populated with the Local patient identifier. | SHOULD | 1..1 | 3478526985 |
+| Patient.identifier.extension | This extension is used to record the NHS number Verification status | SHOULD | 0..* | |
+| Patient.identifier.extension.url | This SHOULD be populated. Where used this MUST be populated with Structure Definition 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus' - FIXED VALUE | SHOULD | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus |
+| Patient.identifier.extension.valueCodeableConcept | | SHOULD | 0..1 | |
+| Patient.identifier.extension.valueCodeableConcept.coding | | SHOULD | 0..1 | |
+| Patient.identifier.extension.valueCodeableConcept.coding.system | https://simplifier.net/hl7fhirukcorer4/extensionukcorenhsnumberverificationstatus | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus |
+| Patient.identifier.extension.valueCodeableConcept.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | number-present-and-verified |
+| Patient.identifier.extension.valueCodeableConcept.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Number present and verified |
+| Patient.name | | SHOULD | 0..* | |
+| Patient.name.use | Follow UK Core guidance for populating this element | SHOULD | 0..1 | official |
+| Patient.name.text | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Mrs Julie Jones |
+| Patient.name.family | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Jones |
+| Patient.name.given | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Julie |
+| Patient.name.prefix | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Mrs |
+| Patient.gender | Follow UK Core guidance for populating this element | SHOULD | 0..1 | female |
+| Patient.birthDate | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 1959-05-04 |
+| Patient.address | Follow UK Core guidance for populating this element | SHOULD | 0..* | |
+| Patient.address.use | Follow UK Core guidance for populating this element | SHOULD | 0..1 | home |
+| Patient.address.type | Follow UK Core guidance for populating this element | SHOULD | 0..1 | both |
+| Patient.address.text | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 22 Brightside Crescent, Overtown, West Yorkshire, LS10 4YU |
+| Patient.address.line | Follow UK Core guidance for populating this element | SHOULD | 0..* | 22 Brightside Crescent |
+| Patient.address.city | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Overtown |
+| Patient.address.district | Follow UK Core guidance for populating this element | SHOULD | 0..1 | West Yorkshire |
+| Patient.address.postalCode | Follow UK Core guidance for populating this element | SHOULD | 0..1 | LS10 4YU |
+| Patient.contact | This should be used to record telecom information for the patient and/or the patient's representative for the encounter | MUST | 0..* | |
+| Patient.contact.extension | | MUST | 0..* | |
+| Patient.contact.extension.url | This MUST be populated with Structure Definition 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank' - FIXED VALUE | MUST | 0..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference |
+| Patient.contact.extension.urlvaluePositiveInt | This MUST be populated with the rank of the whole contact and MUST be populated with the value '1' for the primary person to contact for referral. There MUST be at least one contact for the referral. | MUST | 0..1 | 1 |
+| Patient.contact.relationship | | MUST | 0..* | |
+| Patient.contact.relationship.coding | | MUST | 0..* | |
+| Patient.contact.relationship.coding.system | This MUST be populated with the CodeSystem from the ValueSet 'https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-personrelationshiptype'.
Where the contact details relate to the patient this relationship MUST be populated with the value 'self'.
Where the contact details relate to a patient's representative this SHOULD be populated with their relationship to the patient.
If the relationship is not known this SHOULD be populated with the value 'Unknown' | MUST | 0..1 | http://terminology.hl7.org/CodeSystem/v2-0131 |
+| Patient.contact.relationship.coding.code | This MUST be populated with Code of CodeSystem value. See ValueSet 'https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-personrelationshiptype'. | MUST | 0..1 | EP |
+| Patient.contact.relationship.coding.display | This MUST be populated with Display of CodeSystem value. See ValueSet 'https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-personrelationshiptype'. | MUST | 0..1 | EP |
+| Patient.contact.name | | SHOULD | 0..1 | |
+| Patient.contact.name.family | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | Grayson |
+| Patient.contact.name.given | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | Jack |
+| Patient.contact.telecom | | MUST | 0..* | |
+| Patient.contact.telecom.system | This MUST be populated for the rank 1 contact. There MUST be at least one contact phone number for the referral | MUST | 0..1 | phone |
+| Patient.contact.telecom.value | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | 0789 1234567 |
+| Patient.contact.gender | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | male |
+| Patient.Communication | | SHOULD | 0..* | |
+| Patient.Communication.Language | | MUST | 1..1 | |
+| Patient.Communication.Language.coding | | MUST | 1..1 | |
+| Patient.Communication.Language.coding.code | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | en |
+| Patient.Communication.Language.coding.system | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage |
+| Patient.Communication.Language.coding.display | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | English |
+| Patient.Communication.Language.preferred | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | TRUE |
+| Patient.extension | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..* | |
+| Patient.extension.url | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory |
+| Patient.extension.url.valueCodeableConcept | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | |
+| Patient.extension.url.valueCodeableConcept.coding | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | |
+| Patient.extension.url.valueCodeableConcept.coding.system | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategory |
+| Patient.extension.url.valueCodeableConcept.coding.code | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | A |
+| Patient.extension.url.valueCodeableConcept.coding.display | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | British, Mixed British |
+| Patient.generalPractitioner | This SHOULD be populated with a reference to the GP Surgery ONLY rather than a specific practitioner | SHOULD | 0..* | |
+| Patient.generalPractitioner.reference | This SHOULD be populated. Where populated this MUST reference to an Organisation resource | SHOULD | 0..1 | urn:uuid:b83d13e2-8c2e-422c-88ac-63b8e86a4411 |
+
+
+
+
+ This resource is used to communicate details about the sender and receiver organisations.
+
+
+
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|------------------------------------------------------------------------------------------|
+| Organization | This resource is used to communicate details about the sender organisations. > Organization
+
https://simplifier.net/hl7fhirukcorer4/ukcore-organization | | 2..* | |
+| Organization.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 5d897313-c62d-4e7e-92b7-b2199804fed3 |
+| Organization.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
+| Organization.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization |
+| Organization.meta.lastUpdated | This MUST be populated. All resources MUST include 'lastUpdated' value, under meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| Organization.identifier | This MUST be populated with an organisation identifier e.g. ODS code | MUST | 0..* | |
+| Organization.identifier.system | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | https://fhir.nhs.uk/id/ods-organization-code |
+| Organization.identifier.value | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | ABD01 |
+| Organization.name | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | Organisation name |
+
+
+
+
+
+## Entity Relationship Diagram - Cancellation Booking Request
+
+
+
+The below diagram details the Cancellation Booking Request
+
+
+
+
+
+
+The below diagram details the options for obtaining the booking (Appointment) or referral/validation (ServiceRequest) resource, prior to update (including cancellation). The Sender must know the (resource).status and (resource).id values, as minimum, to build a valid update request. +
+