Skip to content
Merged
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
@@ -1,5 +1,5 @@
- name: Index
filename: index.page
filename: index.page.md
- name: Introduction
filename: Introduction.page.md
- name: Initial Booking
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- name: Index
filename: Index.page
filename: Index.page.md
- name: Introduction
filename: Introduction.page.md
- name: Frameworks
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- name: Index
filename: Index.page
filename: Index.page.md
- name: Introduction
filename: Introduction.page.md
- name: All
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,4 @@ A DocumentReference can be updated by performing a DELETE request with the resou
<a href="https://raw.githubusercontent.com/NHSDigital/NHSDigital-FHIR-BookingAndReferrals/main/BaRS-Images/DocumentReference/BaRS_NRL_Write_Sequence-1.1.0.svg" target="_blank">
<img src="https://raw.githubusercontent.com/NHSDigital/NHSDigital-FHIR-BookingAndReferrals/main/BaRS-Images/DocumentReference/BaRS_NRL_Write_Sequence-1.1.0.svg" ></img></a>

.
Original file line number Diff line number Diff line change
Expand Up @@ -111,3 +111,5 @@ Once you have retrieved the resource, you can process it according to your requi
<a href="https://raw.githubusercontent.com/NHSDigital/NHSDigital-FHIR-BookingAndReferrals/main/BaRS-Images/DocumentReference/BaRS_NRL_Search_Sequence-1.1.0.svg" target="_blank">
<img src="https://raw.githubusercontent.com/NHSDigital/NHSDigital-FHIR-BookingAndReferrals/main/BaRS-Images/DocumentReference/BaRS_NRL_Search_Sequence-1.1.0.svg" ></img></a>

.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- name: Index
filename: index.page
filename: index.page.md
- name: Introduction
filename: Introduction.page.md
- name: DocumentReferences for Senders
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- name: Index
filename: Index.page
filename: Index.page.md
- name: Introduction
filename: Introduction.page.md
- name: Service Discovery
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ Describing Endpoints will be facilitated by the Organization, HealthcareService
* An Endpoint belongs to a HealthcareService.
* Multiple Endpoints of the same type are not permitted for a HealthcareService



<details>
<summary>> <b class="barslink">Organization</b></summary>
<p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,7 @@ The Interface for managing the 3 resources relating to an "endpoint" is detailed

This table describes the parameters currently defined for the Paths defined in the interface table above.


<table><thead>
<tr>
<th>API Path</th>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,5 @@ BaRS employs an endpoint catalogue to match Target Identifiers with a stored end

The BaRS endpoints will utilise not only service ids and a physical endpoint, but data describing the healthcare service, the provider of that service and the organization which manages and/or supplies the endpoint in question. This information will be stored using 3 FHIR resources which appropriately describe [Endpoints](http://hl7.org/fhir/R4/endpoint.html), [HealthcareServices](http://hl7.org/fhir/R4/healthcareservice.html) and [Organizations](http://hl7.org/fhir/R4/organization.html).

BaRS will expose an interface to manage this information for each of these resources. Each resource will have a corresponding endpoint on the Proxy to assist in managing these endpoints.
BaRS will expose an interface to manage this information for each of these resources. Each resource will have a corresponding endpoint on the Proxy to assist in managing these endpoints.

Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,5 @@ Here a Receiving system is creating a resource related to an endpoint.
Here a Receiving system is updating a resource related to an endpoint.

<a href="https://raw.githubusercontent.com/NHSDigital/NHSDigital-FHIR-BookingAndReferrals/main/BaRS-Images/SequenceDiagrams/EPC-Sequence-Receiver-Update-Abstract.svg" target="_blank"><img src="https://raw.githubusercontent.com/NHSDigital/NHSDigital-FHIR-BookingAndReferrals/main/BaRS-Images/SequenceDiagrams/EPC-Sequence-Receiver-Update-Abstract.svg" width="1200"></img></a>

.
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
topic: core-StandardPattern-Endpoints-1.2.2
---


.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- name: Index
filename: Index.page
filename: Index.page.md
- name: Introduction
filename: Introduction.md
- name: Interface
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Below is a simplified example of how how to handle the Transaction Integrity HTT
![BaRS FHIR API end-to-end process](https://raw.githubusercontent.com/NHSDigital/NHSDigital-FHIR-BookingAndReferrals/main/BaRS-Images/FailureScenarios/HTTP-Header-logic-1.0.0.svg)


| HTTP Status Code | HTTP Error Code | issue Code | Scenario |
| HTTP Status Code | HTTP Error Code | Issue Code | Scenario |
|------------------|-----------------|------------|-------------------------------------------------------------------|
| 400 | REC_BAD_REQUEST | invalid | The request headers are not valid. |
| 400 | REC_BAD_REQUEST | required | The request headers are not present. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This section defines the failure scenarios for GET /Appointment. There are two w
### Errors by parameter
**path id in GET /Appointment{id}**

| HTTP Status Code | HTTP Error Code | issue Code | Scenario | Source |
| HTTP Status Code | HTTP Error Code | Issue Code | Scenario | Source |
|------------------|------------------|------------|-----------------------------------------------------------------------------------------------|----------|
| 400 | SEND_BAD_REQUEST | required | The parameter value was not included in the request. | API |
| 400 | REC_BAD_REQUEST | required | The parameter value was not included in the request. | Receiver |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Message definition includes only one additional parameter and therefore there ar

**context**

| HTTP Status Code | HTTP Error Code | issue Code | Scenario | Source |
| HTTP Status Code | HTTP Error Code | Issue Code | Scenario | Source |
|------------------|------------------|------------|--------------------------------------------------|----------|
| 400 | SEND_BAD_REQUEST | required | no context parameter was given. | API |
| 400 | REC_BAD_REQUEST | required | no context parameter was given. | Receiver |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This section defines the failure scenarios for GET /ServiceRequest. As with GET
### Errors by parameter
**path id in GET /ServiceRequest{id}**

| HTTP Status Code | HTTP Error Code | issue Code | Scenario | Source |
| HTTP Status Code | HTTP Error Code | Issue Code | Scenario | Source |
|------------------|------------------|------------|-----------------------------------------------------------------------------------------------|----------|
| 400 | SEND_BAD_REQUEST | required | The parameter value was not included in the request. | API |
| 400 | REC_BAD_REQUEST | required | The parameter value was not included in the request. | Receiver |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Get /Slots has added complexity compared to previous endpoints in this section.
### Errors by parameter
**Schedule:actor:HealthcareService**

| HTTP Status Code | HTTP Error Code | issue Code | Scenario | Source |
| HTTP Status Code | HTTP Error Code | Issue Code | Scenario | Source |
|------------------|-------------------------------------|-------------------|-------------------------------------------------------------------------------------------------------------|------------------|
| 400 | SEND_BAD_REQUEST / REC_BAD_REQUEST? | required | The parameter value was not included in the request. (This parameter is not currently marked as required. ) | API and Receiver |
| 400 | REC_BAD_REQUEST | value / invariant | The parameter value was incorrect or wrong. | Receiver |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
This section will define errors that could be seen in any given step and shared from function to function without context. All interactions MUST follow these rules as such they may be listed in different sections.


| HTTP Status Code | HTTP Error Code | issue.Code | Scenario | Source |
| HTTP Status Code | HTTP Error Code | Issue.Code | Scenario | Source |
|------------------|-----------------------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|
| 400 | SEND_BAD_REQUEST | required | Content invalid against the specification or a profile. For example a required parameter or header is not provided. | API |
| 400 | REC_BAD_REQUEST | value | a header value or parameter is invalid. (these are defined in each specific scenario) | Receiver |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- name: Index
filename: Index.page
filename: Index.page.md
- name: Introduction
filename: Introduction.page.md
- name: Message Routing
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
- name:
filename: Failure-Scenarios-1.1.x
- name: Index
filename: Index.page
filename: Index.page.md
- name: Introduction
filename: Introduction.page.md
- name: Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- name: Index
filename: Index.page
filename: Index.page.md
- name: Introduction
filename: Introduction.page.md
- name: Requirements
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- name: Index
filename: Index.page
filename: Index.page.md
- name: Introduction
filename: Introduction.page.md
- name: Sender
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- name: index
filename: index.page
filename: index.page.md
- name: Introduction
filename: Introduction.page.md
- name: Standard Pattern For Composites
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- name: Index
filename: Index.page
filename: Index.page.md
- name: Introduction
filename: Introduction.page.md
- name: Initial Request
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- name: Index
filename: Index.page
filename: Index.page.md
- name:
filename: End-to-end-workflow
- name:
Expand Down
Loading