Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ We recommend reading the following documentation as part of the discovery stage
* [BaRS FHIR API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0)

### Onboarding
{{pagelink:Home/Build/Testing-and-Environments/Onboarding.page.md, text:Onboarding}} with our platform is a self-service process. This step is required to make requests of the BaRS API and have requests forwarded to your endpoint, as a Receiver. This **must** occur on both Integration (INT) and Production environments. The {{pagelink:Home/Build/Testing-and-Environments/Onboarding.page.md, text: full step-by-step onboarding guide}} can be followed by any solution on either environment.
{{pagelink:Testing-and-Environments, text:Connecting to environments}} on our platform is a self-service process. This step is required to make requests of the BaRS API and have requests forwarded to your endpoint, as a Receiver. This **must** occur on both Integration (INT) and Production environments.

Full details of the security model adopted by the platform can be found under the [security](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication) section.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This page describes BaRS principles and prerequisites for suppliers. Elements of
3. Systems MUST support JSON formats for all API interactions
4. Systems SHOULD have a FHIR Server or FHIR functionality in place
5. Systems SHOULD implement RESTful behaviour patterns
6. System Suppliers MUST complete the {{pagelink:Home/Build/Testing-and-Environments/Onboarding.page.md, text:BaRS onboarding process}}
6. System Suppliers MUST complete the {{pagelink:Testing-and-Environments, text:BaRS connecting to environments process}}
7. Systems MUST support Service Discovery

<br>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<div class="bars-blg-expander">

<div class="bars-blg-expander-entry" id="v1.10.0">
### 1.10.0

## Implementation Guide Changes
Expand All @@ -10,7 +13,11 @@
| Assure |Provided clarity on the expectations and limitation of the assurance process.|
| Testing and environments |Onboarding renamed to Connecting to environments. Specific sections created for Connecting as a sender and Connecting as a receiver to make navigation easier and give step by step guidance.

<p>
</div>
</div>

<br>
<hr>

### Previous Releases

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### 1.11.0

## Implementation Guide Changes

| Change | Description |
|---------------------------------------|---------------------------------------------------------------------------------------------------------|
| Bug fixes and corrections |There have been several bug fixes and corrections in the guide, these includes typos, broken links or corrections.|

<br>
<hr>

### Previous Releases
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
- name: Index
filename: Index.page.md
- name: 1.11.0
filename: 1.11.0.page.md
- name: 1.10.0
filename: 1.10.0.page.md
- name: 1.9.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<div class="bars-blg-expander">
<div class="bars-blg-expander-entry" id="v1.0.0-beta.6">

## {{page-title}}
This is a minor "patch" with clarifications to limited areas of the Implementation Guidance and examples for v1.0.0-beta.6

Expand All @@ -11,20 +14,16 @@ This is a minor "patch" with clarifications to limited areas of the Implementati
|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------|
|
| FHIR BaRS CodeSystem values added for Location Types | Values for Helimed From and Helimed To added | <mark style="background-color: LightGreen">non-breaking</mark> |
| FHIR BaRS CodeSystem value added for Flag Categories | Value for Call Warning added | <mark style="background-color: LightGreen">non-breaking</mark> |
| Updated FHIR Questionnaire and QuestionnaireResponse guidance | Guidance updated to reflect Nature of Call published Questionnaire being removed for beta | <mark style="background-color: LightGreen">non-breaking</mark> |

### Payload Change Log


| FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact |
|------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------|
| QuestionnaireResponse.extension.valueCodeableConcept.text | This SHOULD be populated with the name of the questionnaire responses contained within. | This SHOULD be populated with the name of the questionnaire responses contained within. For the Nature-of-call response this MUST be set to 'Nature of Call (NOC)' | Update | Referral Request |Changes to use of QuestionnaireResponse for Nature-of-call | <mark style="background-color: LightGreen">non-breaking</mark> |
| QuestionnaireResponse.questionnaire | Example updated - https://fhir.nhs.uk/Questionnaire/NOC | Example updated - https://fhir.nhs.uk/Questionnaire/PTS | Update | Referral Request |Changes to use of QuestionnaireResponse for Nature-of-call | <mark style="background-color: LightGreen">non-breaking</mark> |
| QuestionnaireResponse.questionnaire | Necessity Updated - MUST | Necessity Updated - MAY | Update | Referral Request |Changes to use of QuestionnaireResponse for Nature-of-call | <mark style="background-color: LightGreen">non-breaking</mark> |

</div>
</div>

<br>
<hr>

### Previous Releases
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## {{page-title}}
This is a minor "patch" with clarifications to limited areas of the Implementation Guidance and examples for v1.0.0-beta.7

### Application Change Log


<br>


| Change | Description | Impact |
|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------|
|
| Implementation guidance updated | patient.id implementation guidance corrected | <mark style="background-color: Yellow">correction</mark> |


### Payload Change Log


| FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact |
|------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------|
| patient.id | This SHOULD be populated with the name of the questionnaire responses contained within. | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | Update | Referral Request |Bug fix | <mark style="background-color: Yellow">correction</mark> |
| patient.id | This SHOULD be populated with the name of the questionnaire responses contained within. | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | Update | Referral Response |Bug fix | <mark style="background-color: Yellow">correction</mark> |



<br>
<hr>

### Previous Releases
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
- name: Index
filename: Index.page.md
- name: 1.0.0-beta.7
filename: 1.0.0-beta.7.page.md
- name: 1.0.0-beta.6
filename: 1.0.0-beta.6.page.md
- name: 1.0.0-beta.5
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ This payload is used to transmit all the necessary information that is required
| 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.<br>It also includes contact information for third parties when required.<br><br>https://simplifier.net/hl7fhirukcorer4/ukcore-patient | | 1..1 | |
| Patient.id | It also includes contact information for third parties when required. | MUST | 0..1 | 9589fb37-87a2-48d8-968f-b371429208a8 |
| Patient.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | 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.LastUpdate | 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 |
Expand Down
Loading
Loading