You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP8/1.0.0-alpha.3.page.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,14 +11,20 @@ This is a pre-release of v1.0.0-alpha.3 - Referrals into a broker for Healthcare
| Patient Identifier Resource | Updates to Referral Payload Implementation Guidance for multiple elements to improve clarity.|<markstyle="background-color: Yellow">correction</mark>
15
+
| Scope and Requirements | Minor text changes and link to Hazard Log added|<markstyle="background-color: Yellow">correction</mark>
15
16
16
17
### Payload Change Log
17
18
18
19
19
20
| FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact |
| Patient.identifier.system | This SHOULD be populated with namespace for the Identifier. | This MUST be populated with namespace for the Identifier. | Update | Referral Response |Change | <markstyle="background-color: Yellow">correction</mark> |
23
+
| 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. | This MUST be populated with a human readable patient identifier. When used this MUST be populated with the NHS number when available. | Update | Referral Response |Change | <markstyle="background-color: Yellow">correction</mark> |
24
+
| 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 | This MUST be populated. Where used this MUST be populated with Structure Definition 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus' - FIXED VALUE | Update | Referral Response |Change | <markstyle="background-color: Yellow">correction</mark> |
25
+
| Patient.identifier.extension.valueCodeableConcept.coding.system | This SHOULD be populated. Where used this MUST be populated with CodeSystem - 'https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus' - FIXED VALUE | This MUST be populated with CodeSystem - 'https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus' - FIXED VALUE | Update | Referral Response |Change | <markstyle="background-color: Yellow">correction</mark> |
26
+
| Patient.identifier.extension.valueCodeableConcept.coding.code | This SHOULD be populated. Where used this MUST be 'number-present-and-verified' or 'number-present-but-not-traced', else no NHS number MUST be sent. No other statuses are permitted. | This MUST be populated. This MUST be 'number-present-and-verified' only. No other statuses are permitted. | Update | Referral Response |Change | <markstyle="background-color: Yellow">correction</mark> |
27
+
| Patient.identifier.extension.valueCodeableConcept.coding.display | This SHOULD be populated. Where used this MUST be populated with 'Number present and verified' or 'Number present but not traced'. No other statuses are permitted. |This MUST be populated. This MUST be populated with 'Number present and verified'. No other statuses are permitted. | Update | Referral Response |Change | <markstyle="background-color: Yellow">correction</mark> |
Copy file name to clipboardExpand all lines: guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -237,15 +237,15 @@ This payload is used to transmit all the necessary information that is required
237
237
| 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|
238
238
| Patient.meta.LastUpdate | 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 |
239
239
| Patient.identifier || MUST | 0..*||
240
-
| Patient.identifier.system | This SHOULD be populated with namespace for the Identifier | MUST | 1..1 |https://fhir.nhs.uk/Id/nhs-number|
241
-
| 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. | MUST | 1..1 | 3478526985 |
240
+
| Patient.identifier.system | This MUST be populated with namespace for the Identifier | MUST | 1..1 |https://fhir.nhs.uk/Id/nhs-number|
241
+
| Patient.identifier.value | This MUST be populated with a human readable patient identifier. This MUST be populated with the NHS number.| MUST | 1..1 | 3478526985 |
242
242
| Patient.identifier.extension | This extension is used to record the NHS number Verification status | MUST | 0..*||
243
-
| 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 | MUST | 1..1 |https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus|
243
+
| Patient.identifier.extension.url | This MUST be populated. This MUST be populated with Structure Definition 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus' - FIXED VALUE | MUST | 1..1 |https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus|
244
244
| Patient.identifier.extension.valueCodeableConcept || MUST | 0..1 ||
245
245
| Patient.identifier.extension.valueCodeableConcept.coding || MUST | 0..*||
246
-
| Patient.identifier.extension.valueCodeableConcept.coding.system | This SHOULD be populated. Where used this MUST be populated with CodeSystem - 'https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus' - FIXED VALUE | MUST | 0..1 |https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus|
247
-
| Patient.identifier.extension.valueCodeableConcept.coding.code | This SHOULD be populated. Where used this MUST be 'number-present-and-verified' else no NHS number MUST be sent. No other statuses are permitted. | MUST | 0..1 | number-present-and-verified |
248
-
| Patient.identifier.extension.valueCodeableConcept.coding.display | This SHOULD be populated. Where used this MUST be populated with 'Number present and verified'. No other statuses are permitted. | MUST | 0..1 | Number present and verified |
246
+
| Patient.identifier.extension.valueCodeableConcept.coding.system | This MUST be populated with CodeSystem - 'https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus' - FIXED VALUE | MUST | 0..1 |https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus|
247
+
| Patient.identifier.extension.valueCodeableConcept.coding.code | This MUST be populated. This MUST be 'number-present-and-verified' only. No other statuses are permitted. | MUST | 0..1 | number-present-and-verified |
248
+
| Patient.identifier.extension.valueCodeableConcept.coding.display | This MUST be populated. This MUST be populated with 'Number present and verified'. No other statuses are permitted. | MUST | 0..1 | Number present and verified |
249
249
| Patient.name || SHOULD | 0..*||
250
250
| Patient.name.use | Follow UK Core guidance for populating this element | SHOULD | 0..1 | official |
251
251
| Patient.name.text | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Mrs Julie Jones |
Copy file name to clipboardExpand all lines: guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md
+7-2Lines changed: 7 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,21 +42,26 @@ The payload and workflow have been designed to support these services. Other {{p
42
42
- BaRS currently supports the communication of consent for direct care only
43
43
- Certificates for Receiving messages to use nhs.uk domains only
44
44
- Receiving endpoints are to be internet facing
45
-
- Clincial Constraints exist - See Hazard Log
45
+
- Clincial Constraints exist - See [Hazard Log](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/onboarding-support-information#downloads)
46
46
- No element level 'updates' to requests are supported. A new request must be generated to change information in the referral request
47
47
- No digital support to remove or cancel a referral are offered (this would need to be achieved manually)
48
48
- The service discovery tool for establishing services for onward care must be the [e-RS Service Search API A010](https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir#post-/STU3/HealthcareService/$ers.searchHealthcareServicesForPatient)
49
49
50
50
### Requirements
51
51
52
+
Definitions used in these requirements:
53
+
- The referral Sender is the system/organisation making the referral request
54
+
- The referral Receiver is the system/organisation the referral is being sent to, in this specific case - the broker (e-RS)
55
+
- The end user is a person in an organisation using BaRS
56
+
52
57
**Service Discovery**
53
58
- Where more than one service is shortlisted, the maximum number of services allowed on a given shortlist is 20.
54
59
55
60
**Referral**
56
61
- The referral Receiver **must** accept the referral request regardless of whether the patient is known to the service provider
57
62
- The referral Receiver **must** only accept potential patients who **<ins>have</ins>** a national validated identifier e.g. NHS Number
58
63
- The national identifier **must** have a [verification status](https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-nhsnumberverificationstatus) of 'Number present and verified'.
59
-
- Any new or existing safeguarding concern, recorded as part of the assessment, **must** be included in the referral Sender's request
64
+
- Any new or existing safeguarding concern, recorded as part of the assessment, **must** be included in the referral request
60
65
- The referral Receiver **must** clearly identify any included safeguarding concern to the end user
61
66
- The referral Receiver **must** accurately represent information made by the Sender to the end user.
62
67
- The referral Sender **must** make available the human readable identifier for the referral, included in the HTTP synchronous response, to the end user
0 commit comments