diff --git a/CodeSystem/usecases-categories-bars.xml b/CodeSystem/usecases-categories-bars.xml index 11fab27e..957071d3 100644 --- a/CodeSystem/usecases-categories-bars.xml +++ b/CodeSystem/usecases-categories-bars.xml @@ -60,6 +60,18 @@ + + + + + + + + + + + + @@ -76,6 +88,14 @@ + + + + + + + + @@ -92,6 +112,10 @@ + + + + diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.0.1.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.0.1.page.md index 857b594f..73051ea9 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.0.1.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.0.1.page.md @@ -9,10 +9,10 @@ | Change | Description | |--------------------------------------------------|----------------------------------------------------------------------------------------------------------| | Fixed issue with menu in Design/BaRS Core | The "Failure Scenarios" subsection had an erroneous entry in left-hand navigation. This has been removed | -| Updated release notes structure | This change was to accomodate historical releases by hiding them in an expander | +| Updated release notes structure | This change was to accommodate historical releases by hiding them in an expander | | Improved release notes navigation | a "back" button was added to each of the release note detail sections | | Updated FHIR assets section | Simplified approach with a link out to the full Simplifier project | -| TKW - Updated context description | Now includes detail of deployment on INT and rationale adopting this appraoch | +| TKW - Updated context description | Now includes detail of deployment on INT and rationale adopting this approach | | TKW - Corrected sentinel values | Some sentinel values for referencing UserTest DoS were out of date and did not return | | TKW - Updated Response scenarios | Added the sentinel values, under the Scenarios section, to elicit responses for interim and full Validation responses | | TKW - Added table of DoS Service Ids | Table of DoS Service Ids and how to obtain them to use as sentinel values for TKW Scenarios | @@ -20,7 +20,7 @@ | BARS-UEC-1 Application | Corrected how elements ServiceRequest.supportInfo and CarePlan.supportingInfo must be populated | | BARS-UEC-2 Application | Corrected how elements ServiceRequest.supportInfo and CarePlan.supportingInfo must be populated | | Fixed broken or incorrect links on "Home Page" | Some links were linking to the wrong page | -| Help and Support - fixed broken external links | Some external linkswere broken or still "boiler plate" links | +| Help and Support - fixed broken external links | Some external links were broken or still "boiler plate" links | | Updated Change Log naming | Change Log names have been changed to more in line with the rest of the change log names | | Updated wording on releases | Wording of guidance around support for new releases of Core was updated to provide more clarity | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.8.1.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.8.1.page.md index ab95eb27..e14968ab 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.8.1.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.8.1.page.md @@ -11,7 +11,7 @@ | Existing use case categories have been corrected where needed | existing use case categories have been corrected where required | | BaRS Core addition of use context header | HTTP header for auditing and logging has been added to assist with NHSE reporting. | | Bug fixes and corrections |There have been several bug fixes and corrections in the guide, these includes typos, broken links or corrections.| -| Improvements to the the Build Section | Several improvements to the Testing and Environments pages | +| Improvements to the Build Section | Several improvements to the Testing and Environments pages | | Application 6 TKW changes | Application 6 is now available in the TKW |

diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Versioning.guide.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Versioning.guide.md index ba4ff6f6..5b11d772 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Versioning.guide.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Versioning.guide.md @@ -8,7 +8,7 @@ The Booking and Referral Standard (BaRS) will follow [Semantic Versioning](https Full details can be found at the [Semantic Versioning](https://semver.org/) site, key points outlined below: #### Major version -The major version is incremented when an incompatible changes are made, i.e. a non backwards compatible change. +The major version is incremented when incompatible changes are made, i.e. a non backwards compatible change. #### Minor version The minor version increments when changes are made in a backwards compatible manner. @@ -39,14 +39,14 @@ Breaking change will always be considered before being implemented, the overhead ### **For the Core elements of BaRS (BaRS Core) suppliers will be expected to revise their solution to support a MAJOR release within six months from the version release date** -Note: Major releases of BaRS Core will be NO LESS than SIX MONTHS from the preceeding major release +Note: Major releases of BaRS Core will be NO LESS than SIX MONTHS from the preceding major release

{{render:versioning.png}}
-Compatibilty is verified dynamically during workflows through the 'version' element defined on the Capability Statement and Message Definitions. Senders and Receivers should operate on the highest version they are both compatible with and negoitate down, where possible. +Compatibility is verified dynamically during workflows through the 'version' element defined on the Capability Statement and Message Definitions. Senders and Receivers should operate on the highest version they are both compatible with and negotiate down, where possible. A Sender **must** check the returned 'version' in these resources before proceeding to make requests of a Receiver. For version 1.0.0 **only** versions within the major version v1.0.0 should be considered compatible (1.0.0 extensions excluded):- @@ -61,7 +61,7 @@ A Receiver **should** check the version a Sender is expecting interoperate on by ### Pre-release Labels -These labels will be taken from the GDS (Goverment Digital Services) development process stages, and will be one of: +These labels will be taken from the GDS (Government Digital Services) development process stages, and will be one of: * **Discovery**: a Feasibility study. A 'No code' development. Designed to find out what users are trying to achieve, any constraints, improvement opportunities @@ -69,11 +69,11 @@ These labels will be taken from the GDS (Goverment Digital Services) development * **Private Beta**: Working version and test with invited users. Handle real transactions and work at scale. ‘Invite only’ or regional. Must Pass assessment by business and technical SME’s -* **Public Beta**: All users can participate. Version unlikely to change substantially, but still needs further testing by a wider group of implementors before becoming live +* **Public Beta**: All users can participate. Version unlikely to change substantially, but still needs further testing by a wider group of implementers before becoming live * **Live**: The live phase is about supporting the service in a sustainable way, and continuing to iterate and make improvements -* **Retiring**: Implementors notified that the service is discontinued and not to be used for new developments +* **Retiring**: Implementers notified that the service is discontinued and not to be used for new developments
@@ -88,7 +88,7 @@ APIs should have the ability to route traffic based on the version header as sho -API Versioning between entities is fairly loose, only the major versioning differences would case a failure. with the exception of new endpoints which will be gated by minor versioning. The diagram below shows desired behavior in all versioning negotiations at the API. +API Versioning between entities is fairly loose, only the major versioning differences would case a failure. with the exception of new endpoints which will be gated by minor versioning. The diagram below shows desired behaviour in all versioning negotiations at the API. @@ -102,7 +102,7 @@ The CapabilityStatement, coupled with the Accept header can define what version ### MessageDefinition (step 3) -The serviceID will help dictate what MessageDefinitions are returned and ensure they are specifiic to the service being queried. The version of the MessageDefinitions returned would be linked to the version of the Use case. The use case is identified using the useContext element. +The serviceID will help dictate what MessageDefinitions are returned and ensure they are specific to the service being queried. The version of the MessageDefinitions returned would be linked to the version of the Use case. The use case is identified using the useContext element. For example, a service could service multiple applications covered by a single message definition, of varying versions. They would then choose the version of the message definition most appropriate for the use case. Knowing, from Service Discovery, that the Receiver accepts that type of referral and that it requires that version of the messageDefinition. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Booking-Request-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Booking-Request-Payload.page.md index c945ddf8..676f2f94 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Booking-Request-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Booking-Request-Payload.page.md @@ -24,7 +24,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Bundle | 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 | | 79120f41-a431-4f08-bcc5-1e67006fcae0 | @@ -51,7 +51,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.nhs.uk/StructureDefinition/BARSMessageHeader-booking-request, hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | MessageHeader | https://simplifier.net/nhsbookingandreferrals/barsmessageheaderbookingrequest-duplicate-2 | | 1..1 | | | MessageHeader.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | | @@ -170,7 +170,7 @@ This payload is used to support a booking workflow and contains all the required -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Patient | https://simplifier.net/hl7fhirukcorer4/ukcore-patient | | 1..1 | | | Patient.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | | 9589fb37-87a2-48d8-968f-b371429208a8 | @@ -245,7 +245,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization , hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | 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 | | 5d897313-c62d-4e7e-92b7-b2199804fed3 | @@ -268,7 +268,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Practitioner | https://simplifier.net/hl7fhirukcorer4/ukcore-practitioner | |0..* | | | Practitioner.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 1..1 | 51182cb1-b199-4222-85f5-16d5428f6358 | @@ -297,7 +297,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | PractitionerRole | https://simplifier.net/hl7fhirukcorer4/ukcore-practitionerrole | | 0..* | | | PractitionerRole.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 1..1 | 1801e180-e6a1-4753-8a55-ab2d1cff6549 | @@ -326,7 +326,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService , hybrid}} -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | HealthcareService | https://simplifier.net/hl7fhirukcorer4/ukcore-healthcareservice | | 1..1 | | | HealthcareService.id | This MUST be populated with the value retrieved for the resource via the GET /Sot request. | MUST | 1..1 | 1801e180-e6a1-4753-8a55-ab2d1cff6549 | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Booking-Request-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Booking-Request-Payload.page.md index 68d28e36..a587be97 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Booking-Request-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Booking-Request-Payload.page.md @@ -24,7 +24,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Bundle | 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 | | 79120f41-a431-4f08-bcc5-1e67006fcae0 | @@ -51,7 +51,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.nhs.uk/StructureDefinition/BARSMessageHeader-booking-request, hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | MessageHeader | https://simplifier.net/nhsbookingandreferrals/barsmessageheaderbookingrequest-duplicate-2 | | 1..1 | | | MessageHeader.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | | @@ -108,7 +108,7 @@ This payload is used to support a booking workflow and contains all the required -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Appointment | https://simplifier.net/hl7fhirukcorer4/ukcore-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 | | 3713c8fc-dbcf-4f90-bacf-89d99e434e9b | @@ -171,7 +171,7 @@ This payload is used to support a booking workflow and contains all the required -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Patient | https://simplifier.net/hl7fhirukcorer4/ukcore-patient | | 1..1 | | | Patient.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | | 9589fb37-87a2-48d8-968f-b371429208a8 | @@ -246,7 +246,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization , hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | 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 | | 5d897313-c62d-4e7e-92b7-b2199804fed3 | @@ -269,7 +269,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Practitioner | https://simplifier.net/hl7fhirukcorer4/ukcore-practitioner | |0..* | | | Practitioner.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 1..1 | 51182cb1-b199-4222-85f5-16d5428f6358 | @@ -298,7 +298,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | PractitionerRole | https://simplifier.net/hl7fhirukcorer4/ukcore-practitionerrole | | 0..* | | | PractitionerRole.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 1..1 | 1801e180-e6a1-4753-8a55-ab2d1cff6549 | @@ -327,7 +327,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService , hybrid}} -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | HealthcareService | https://simplifier.net/hl7fhirukcorer4/ukcore-healthcareservice | | 1..1 | | | HealthcareService.id | This MUST be populated with the value retrieved for the resource via the GET /Sot request. | MUST | 1..1 | 1801e180-e6a1-4753-8a55-ab2d1cff6549 | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/How-does-it-work.page.md index af695c9d..11da3c80 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/How-does-it-work.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/How-does-it-work.page.md @@ -16,7 +16,7 @@ This workflow details a referral into a CAS from a 999 Ambulance Service Trust ( - Prior to referral the 999 AST will undertake a triage of the patient to determine the acuity of the case. This will typically be undertaken by a call handler on the Computer Aided Dispatch system (CAD) using an approved Clinical Decision Support System (CDSS) such as NHS Pathways or AMPDS. For cases with a non-ambulance disposition (CAT5), local business rules will be applied to determine if the case meets the requirement for referral to a CAS for consultation. - For cases requiring a referral to CAS, a suitable CAS is identified based on the patient’s clinical need and location. Service discovery will use local directories or UEC DOS to ascertain the Service ID - The Service ID is used to query the BaRS endpoint catalogue to identify the receiving CAS system's endpoint details. This process is happening in the background that Senders and Receivers do not need to manage. -- The 999-AST will send the referral to the CAS via the BaRS Proxy, including the information required by a CAS Clinician to continue the patent's clinical care. This will also include the Journey ID created at the patient's first contact. +- The 999-AST will send the referral to the CAS via the BaRS Proxy, including the information required by a CAS Clinician to continue the patient's clinical care. This will also include the Journey ID created at the patient's first contact. - The CAS system will acknowledge the referral on receipt, after which the case may be closed by the 999 AST on the CAD. It should be noted that Duty of care is passed from the 999 AST with the referral and is considered accepted by the CAS on receipt of the acknowledgement. - Prior to the consultation the case will typically be posted to a queue for prioritisation, based on information in the referral. This may be based on the call back time, determined locally or nationally based on the triage outcome codes. E.g. Where cases have a Pathways disposition (Dx) these are prioritised in accordance with the criteria specified in the IUC CAS service specification which sets out call-back times by Dx code. - The CAS Clinician will contact the patient, or their representative, utilising information in the referral message, then undertakes a consultation which may include a triage. The consultation will be informed by the clinical information sent by the referring service. This will be recorded in the CAS system. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Payloads.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Payloads.page.md index bca71813..ed0dfe6c 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Payloads.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Payloads.page.md @@ -46,7 +46,7 @@ When a BARS Sender populates the Location resource: * what3words * They **should** populate the *Location.address* for all property based locations. -* They **should** populate *Location.address.line* which is a repeatable element, with the the order in which lines should appear in an address label +* They **should** populate *Location.address.line* which is a repeatable element, with the order in which lines should appear in an address label * They **should** populate *Location.name* when there is a property name * They **should** populate *Location.address.text* with a text representation of the full address (including the address name), with each line separated by a comma diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/How-does-it-work.page.md index fe46487f..82459aa9 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/How-does-it-work.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/How-does-it-work.page.md @@ -7,7 +7,7 @@ topic: APP4-HowDoesItWork This section describes how the primary operations used in this application work. -Application 4 supports complex workflows which include enabling the the Requester to: +Application 4 supports complex workflows which include enabling the Requester to: * Refer a patient for a specified activity to be carried out within a stated timescale (breach time) * Receive notification of if the referral has been rejected or accepted and is in progress (Interim Validation Response) * Retrieve the case by cancelling the referral @@ -38,7 +38,7 @@ This details a 999 Ambulance Service Trust (Requester) Referral into the followi - Prior to making a Validation Request, the Requester will undertake a triage of the patient to determine the acuity of the case. This will typically be undertaken by a call handler on the Computer Aided Dispatch (CAD) system, using an approved Clinical Decision Support System (CDSS) such as NHS Pathways or AMPDS. For cases with an ambulance disposition, local business rules will be applied to determine if the case meets the requirement for validation by a CAS clinician, Falls Community service Healthcare Professional (HCP). For cases requiring clinical validation in a CAS, this will usually be Ambulance Response Programme (ARP) priority C3 and C4 cases, but may include C2 segmentation cases, subject to local agreements between the 999 AST and the CAS. - A suitable Responder service is identified, based on the patient’s clinical need and location. Service discovery will use local directories or UEC DOS to ascertain the ServiceID - The Service ID is used to query the BaRS Endpoint Catalogue to identify the Receiver's endpoint details. -- The Requester will send the Validation Request to the Responder, which includes information required by an appropriate HCP to continue the patent's clinical care. This will also include the JourneyID created at the patient's first contact. +- The Requester will send the Validation Request to the Responder, which includes information required by an appropriate HCP to continue the patient's clinical care. This will also include the JourneyID created at the patient's first contact. - The Responder will acknowledge the Validation Request on receipt. - On receipt of the Acknowledgement (synchronous response), the Requester may move the case to a 'pending' stack. If the case exceeds the validation breach time before a validation response is received, a fail-safe process should be implemented to ensure that an ambulance is dispatched within the time frame determined by the original triage outcome. - If additional or changed information about the case is captured by the Requester subsequent to sending the Validation Request, but prior to receiving an Interim Validation Response or Validation Response, they may send a Validation Request Update to ensure that the Responder has the most up to date information. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Payloads-for-Responders.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Payloads-for-Responders.page.md index 17617880..425dfe64 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Payloads-for-Responders.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Payloads-for-Responders.page.md @@ -104,7 +104,7 @@ When a BARS Responder populates the Location resource: * what3words * They **should** populate the *Location.address* for all property based locations. -* They **should** populate *Location.address.line* which is a repeatable element, with the the order in which lines should appear in an address label +* They **should** populate *Location.address.line* which is a repeatable element, with the order in which lines should appear in an address label * They **should** populate *Location.address.name* when there is a property name * They **should** populate *Location.address.text* with a text representation of the full address (including the address name), with each line separated by a comma diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/How-does-it-work.page.md index f6fcac63..ce5599d6 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/How-does-it-work.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/How-does-it-work.page.md @@ -90,7 +90,7 @@ Note: The BaRS Referral may be used to support single patient Mutual aid request - The referral Receiver is identified based on nationally agreed polygons that set geographic boundaries of responsibility for each AST. Service discovery will use these polygons to ascertain the ServiceID of the referral Receiver. - The Service ID is used to query the BaRS Endpoint Catalogue to identify the referral Receiver's CAD system's endpoint details - The sender will check that the Receiver supports the intended Referral use case before sending. -- The referral Sender will send the BaRS Referral to the referral Receiver, which includes information required by the referral Receiver to continue the patent's clinical care. This will also include the JourneyID created at the patient's first contact. +- The referral Sender will send the BaRS Referral to the referral Receiver, which includes information required by the referral Receiver to continue the patient's clinical care. This will also include the JourneyID created at the patient's first contact. ### Create Case - The referral Receiver's CAD will create a new case (Encounter) on receipt of the BaRS Referral and populate it with the patient and clinical details provided in the referral diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md index 59ceddcc..cd58e2a8 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md @@ -61,7 +61,7 @@ This page provides guidance for implementing the Referral Standard (BaRS) specif The referral information data model is based on user research with NHS 111 service providers, 999 Ambulance Service Trusts, Clinical Assessment Services and clinical and administrative Emergency Department staff. We carried out this research in parallel with the [Professional Records Standards Body (PRSB)](https://theprsb.org/) who examined the wider brief of 'referrals from NHS 111 to any other care setting' -For the CAD to CAD use case, the data model was agreed by the CAD to CAD Reference Group following a period of user research involving site visits, Reference Group workshops and desk research. This was endorsed by the CAD to CAD Working Group and shared with the the following organisations: +For the CAD to CAD use case, the data model was agreed by the CAD to CAD Reference Group following a period of user research involving site visits, Reference Group workshops and desk research. This was endorsed by the CAD to CAD Working Group and shared with the following organisations: * National Ambulance Programme Board (NAPB) * National Ambulance Advisory Group (NAAG) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Booking-Request-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Booking-Request-Payload.page.md index ad57f787..f110c7ea 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Booking-Request-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Booking-Request-Payload.page.md @@ -24,7 +24,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Bundle | 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 | | 79120f41-a431-4f08-bcc5-1e67006fcae0 | @@ -51,7 +51,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.nhs.uk/StructureDefinition/BARSMessageHeader-booking-request, hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | MessageHeader | https://simplifier.net/nhsbookingandreferrals/barsmessageheaderbookingrequest-duplicate-2 | | 1..1 | | | MessageHeader.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | | @@ -108,7 +108,7 @@ This payload is used to support a booking workflow and contains all the required -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Appointment | https://simplifier.net/hl7fhirukcorer4/ukcore-appointment | | 1..1 | | | Appointment.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | | 3713c8fc-dbcf-4f90-bacf-89d99e434e9b | @@ -146,7 +146,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Slot , hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Slot | This resource will be used to communicate information about the slot. The Slot resource retrieved via the GET /Slot request and MUST be returned how it was received

https://simplifier.net/hl7fhirukcorer4/ukcoreslot | | 1..1 | | | Slot.id | Id returned as part of the GET /Slot response | Must | 1..1 | e267afc4-4310-4549-b66a-5bc4db08f09b | @@ -181,7 +181,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Schedule , hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Schedule | This resource will be used to communicate information about the schedule. The Schedule resource retrieved via the GET /Slot request and MUST be returned how it was received

https://simplifier.net/hl7fhirukcorer4/ukcoreschedule | | 1..1 | | | Schedule.id | Id returned as part of the GET /Slot response | Must | 1..1 | e267afc4-4310-4549-b66a-5bc4db08f09b | @@ -197,7 +197,7 @@ This payload is used to support a booking workflow and contains all the required | Schedule.serviceCategory.coding.code | This MUST be populated with the code of the 'service' | MUST | 0..1 | 17 | | Schedule.serviceCategory.coding.display | This MUST be populated with the display of the 'service' | MUST | 0..1 | General Practice | | Schedule.actor | UKCore | Must | 1..* | | -| Schedule.actor.referrence | This MUST be populated with the Healthcare Service, PractitionerRole, Practitioner in seperate actors. | Must | 0..1 | 6daaadd8-56e0-4d74-8350-1632331c5452 | +| Schedule.actor.referrence | This MUST be populated with the Healthcare Service, PractitionerRole, Practitioner in separate actors. | Must | 0..1 | 6daaadd8-56e0-4d74-8350-1632331c5452 | @@ -213,7 +213,7 @@ This payload is used to support a booking workflow and contains all the required -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Patient | https://simplifier.net/hl7fhirukcorer4/ukcore-patient | | 1..1 | | | Patient.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | | 9589fb37-87a2-48d8-968f-b371429208a8 | @@ -288,7 +288,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization , hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | 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 | | 5d897313-c62d-4e7e-92b7-b2199804fed3 | @@ -311,7 +311,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Practitioner | https://simplifier.net/hl7fhirukcorer4/ukcore-practitioner | |0..* | | | Practitioner.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 1..1 | 51182cb1-b199-4222-85f5-16d5428f6358 | @@ -340,7 +340,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | PractitionerRole | https://simplifier.net/hl7fhirukcorer4/ukcore-practitionerrole | | 0..* | | | PractitionerRole.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 1..1 | 1801e180-e6a1-4753-8a55-ab2d1cff6549 | @@ -369,7 +369,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService , hybrid}} -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | HealthcareService | https://simplifier.net/hl7fhirukcorer4/ukcore-healthcareservice | | 1..1 | | | HealthcareService.id | This MUST be populated with the value retrieved for the resource via the GET /Sot request. | MUST | 1..1 | 1801e180-e6a1-4753-8a55-ab2d1cff6549 | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-0-7/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-0-7/BaRS-FHIR-Usage/Bundle.page.md index f20df435..10119ec8 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-0-7/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-0-7/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.0.7 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/Appointment-StandardPattern/Introduction.page.md index be392d9a..a39676a3 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/Appointment-StandardPattern/Introduction.page.md @@ -12,7 +12,7 @@ topic: core-StandardPattern-appointment-Introduction-1.4.0 The [BaRS API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir) suite can be used where there is no specific use-case supported by the {{pagelink:Home/Applications/BaRS-Applications, text:Applications}} to fulfil generic Appointment workflows, referred to as Appointment Management Foundation. This section outlines the functionality supported, workflows involved and how these correspond with the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.0). -This includes using {{pagelink:core-StandardPattern-document-reference-1.4.0, text: Standard Pattern DocumentReference}} to write pointers for bookings to a central respository, commonly referred to as the Registry. +This includes using {{pagelink:core-StandardPattern-document-reference-1.4.0, text: Standard Pattern DocumentReference}} to write pointers for bookings to a central repository, commonly referred to as the Registry. The Appointment Management Foundation is based on {{pagelink:design-core-1.4.0, text:BaRS Core}} and an understanding of the central tenets is essential before beginning. This includes: - * {{pagelink:core-EndToEndWorkflow-1.4.0, text:End to end workflow }} - how Senders and Receivers, interacting through the central Proxy, negotiate compatibility and engage @@ -32,7 +32,7 @@ The ability to - ## Interface -The following table describes how the BaRS API accomodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.0#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.0#put-/Appointment/-id-) endpoint +The following table describes how the BaRS API accommodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.0#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.0#put-/Appointment/-id-) endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/BaRS-FHIR-Usage/Bundle.page.md index e33390d5..7e32c8fb 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-0/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.4.0 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/Appointment-StandardPattern/Introduction.page.md index 9d84d288..a8b7f52d 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/Appointment-StandardPattern/Introduction.page.md @@ -32,7 +32,7 @@ The ability to - ## Interface -The following table describes how the BaRS API accomodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) endpoint +The following table describes how the BaRS API accommodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1#put-/Appointment/-id-) endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/BaRS-FHIR-Usage/Bundle.page.md index c054d39d..bc2adc85 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.4.1 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.3/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.3/BaRS-FHIR-Usage/Bundle.page.md index 4e4619c9..92a8089a 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.3/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.3/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.0.3 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.4/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.4/BaRS-FHIR-Usage/Bundle.page.md index dcd04063..7198474c 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.4/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.4/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.0.4 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.5/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.5/BaRS-FHIR-Usage/Bundle.page.md index 682576b1..440ab4d6 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.5/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.5/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.0.5 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.6/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.6/BaRS-FHIR-Usage/Bundle.page.md index 6b16268c..d6406baa 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.6/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.6/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.0.6 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.3/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.3/Appointment-StandardPattern/Introduction.page.md index d5d1d4b5..5e43741d 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.3/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.3/Appointment-StandardPattern/Introduction.page.md @@ -19,7 +19,7 @@ There are 4 capabilities that are required surrounding appointments. This sectio ## interface -The following table describes how the BaRS API accomodates these 4 capabilities using the /Appointment endpoint and the /Appointment/[id] endpoint +The following table describes how the BaRS API accommodates these 4 capabilities using the /Appointment endpoint and the /Appointment/[id] endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.3/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.3/BaRS-FHIR-Usage/Bundle.page.md index 8eff433a..faf8fce3 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.3/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.3/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.1.3 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.4/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.4/Appointment-StandardPattern/Introduction.page.md index f57a7e76..4e5268f3 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.4/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.4/Appointment-StandardPattern/Introduction.page.md @@ -19,7 +19,7 @@ There are 4 capabilities that are required surrounding appointments. This sectio ## interface -The following table describes how the BaRS API accomodates these 4 capabilities using the /Appointment endpoint and the /Appointment/[id] endpoint +The following table describes how the BaRS API accommodates these 4 capabilities using the /Appointment endpoint and the /Appointment/[id] endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.4/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.4/BaRS-FHIR-Usage/Bundle.page.md index 780ea678..8024be81 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.4/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.4/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.1.4 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.5/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.5/Appointment-StandardPattern/Introduction.page.md index 4339eada..64c298a6 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.5/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.5/Appointment-StandardPattern/Introduction.page.md @@ -19,7 +19,7 @@ There are 4 capabilities that are required surrounding appointments. This sectio ## interface -The following table describes how the BaRS API accomodates these 4 capabilities using the /Appointment endpoint and the /Appointment/[id] endpoint +The following table describes how the BaRS API accommodates these 4 capabilities using the /Appointment endpoint and the /Appointment/[id] endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.5/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.5/BaRS-FHIR-Usage/Bundle.page.md index 10197a7d..1fce08b4 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.5/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.5/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.1.5 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/Appointment-StandardPattern/Introduction.page.md index 87abf1ef..2d5f4b94 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/Appointment-StandardPattern/Introduction.page.md @@ -12,7 +12,7 @@ topic: core-StandardPattern-appointment-Introduction-1.1.6 The [BaRS API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir) suite can be used where there is no specific use-case supported by the {{pagelink:Home/Applications/BaRS-Applications, text:Applications}} to fulfil generic Appointment workflows, referred to as Appointment Management Foundation. This section outlines the functionality supported, workflows involved and how these correspond with the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0). -This includes using {{pagelink:core-StandardPattern-document-reference-1.1.6, text: DocumentReference Standard Pattern}} to write pointers for Appointments to a central respository, commonly referred to as the Registry. +This includes using {{pagelink:core-StandardPattern-document-reference-1.1.6, text: DocumentReference Standard Pattern}} to write pointers for Appointments to a central repository, commonly referred to as the Registry. The Appointment Management Foundation is based on {{pagelink:design-core-1.1.6, text:BaRS Core}} and an understanding of the central tenets is essential before beginning. This includes: - * {{pagelink:core-EndToEndWorkflow-1.1.6, text:End to end workflow }} - how Senders and Receivers, interacting through the central Proxy, negotiate compatibility and engage @@ -29,7 +29,7 @@ There are four functions that are required surrounding appointments. This sectio ## Interface -The following table describes how the BaRS API accomodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0#put-/Appointment/-id-) endpoint +The following table describes how the BaRS API accommodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0#put-/Appointment/-id-) endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/BaRS-FHIR-Usage/Bundle.page.md index 7aed2236..0384fdff 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.1.6 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.0/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.0/Appointment-StandardPattern/Introduction.page.md index 326b9e09..043c862f 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.0/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.0/Appointment-StandardPattern/Introduction.page.md @@ -19,7 +19,7 @@ There are 4 capabilities that are required surrounding appointments. This sectio ## interface -The following table describes how the BaRS API accomodates these 4 capabilities using the /Appointment endpoint and the /Appointment/[id] endpoint +The following table describes how the BaRS API accommodates these 4 capabilities using the /Appointment endpoint and the /Appointment/[id] endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.0/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.0/BaRS-FHIR-Usage/Bundle.page.md index 111a7d46..813bf264 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.0/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.0/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.2.0 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.1/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.1/Appointment-StandardPattern/Introduction.page.md index 9c60096f..ceeff656 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.1/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.1/Appointment-StandardPattern/Introduction.page.md @@ -19,7 +19,7 @@ There are 4 capabilities that are required surrounding appointments. This sectio ## interface -The following table describes how the BaRS API accomodates these 4 capabilities using the /Appointment endpoint and the /Appointment/[id] endpoint +The following table describes how the BaRS API accommodates these 4 capabilities using the /Appointment endpoint and the /Appointment/[id] endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.1/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.1/BaRS-FHIR-Usage/Bundle.page.md index fec47005..a72b6604 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.1/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.1/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.2.1 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/Appointment-StandardPattern/Introduction.page.md index 2151eafc..fdcf076a 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/Appointment-StandardPattern/Introduction.page.md @@ -29,7 +29,7 @@ There are four functions that are required surrounding appointments. This sectio ## Interface -The following table describes how the BaRS API accomodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_2_0#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_2_0#put-/Appointment/-id-) endpoint +The following table describes how the BaRS API accommodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_2_0#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_2_0#put-/Appointment/-id-) endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/BaRS-FHIR-Usage/Bundle.page.md index b5d049ea..53b6aa7d 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.2.2 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Introduction.page.md index 701614b0..b4f33576 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/Appointment-StandardPattern/Introduction.page.md @@ -12,7 +12,7 @@ topic: core-StandardPattern-appointment-Introduction-1.3.0 The [BaRS API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir) suite can be used where there is no specific use-case supported by the {{pagelink:Home/Applications/BaRS-Applications, text:Applications}} to fulfil generic Appointment workflows, referred to as Appointment Management Foundation. This section outlines the functionality supported, workflows involved and how these correspond with the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0). -This includes using {{pagelink:core-StandardPattern-document-reference-1.3.0, text: DocumentReference Standard Pattern}} to write pointers for Appointments to a central respository, commonly referred to as the Registry. +This includes using {{pagelink:core-StandardPattern-document-reference-1.3.0, text: DocumentReference Standard Pattern}} to write pointers for Appointments to a central repository, commonly referred to as the Registry. The Appointment Management Foundation is based on {{pagelink:design-core-1.3.0, text:BaRS Core}} and an understanding of the central tenets is essential before beginning. This includes: - * {{pagelink:core-EndToEndWorkflow-1.3.0, text:End to end workflow }} - how Senders and Receivers, interacting through the central Proxy, negotiate compatibility and engage @@ -29,7 +29,7 @@ There are four functions that are required surrounding appointments. This sectio ## Interface -The following table describes how the BaRS API accomodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) endpoint +The following table describes how the BaRS API accommodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/BaRS-FHIR-Usage/Bundle.page.md index cf054ebc..bf5476f0 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.0/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.3.0 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Introduction.page.md index 3d370d27..0707650f 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/Appointment-StandardPattern/Introduction.page.md @@ -12,7 +12,7 @@ topic: core-StandardPattern-appointment-Introduction-1.3.1 The [BaRS API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir) suite can be used where there is no specific use-case supported by the {{pagelink:Home/Applications/BaRS-Applications, text:Applications}} to fulfil generic Appointment workflows, referred to as Appointment Management Foundation. This section outlines the functionality supported, workflows involved and how these correspond with the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0). -This includes using {{pagelink:core-StandardPattern-document-reference-1.3.1, text: Standard Pattern DocumentReference}} to write pointers for bookings to a central respository, commonly referred to as the Registry. +This includes using {{pagelink:core-StandardPattern-document-reference-1.3.1, text: Standard Pattern DocumentReference}} to write pointers for bookings to a central repository, commonly referred to as the Registry. The Appointment Management Foundation is based on {{pagelink:design-core-1.3.1, text:BaRS Core}} and an understanding of the central tenets is essential before beginning. This includes: - * {{pagelink:core-EndToEndWorkflow-1.3.1, text:End to end workflow }} - how Senders and Receivers, interacting through the central Proxy, negotiate compatibility and engage @@ -32,7 +32,7 @@ The ability to - ## Interface -The following table describes how the BaRS API accomodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) endpoint +The following table describes how the BaRS API accommodates these four capabilities using the [/Appointment](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#post-/Appointment) endpoint and the [/Appointment/\{id\}](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#put-/Appointment/-id-) endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/BaRS-FHIR-Usage/Bundle.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/BaRS-FHIR-Usage/Bundle.page.md index ed470960..6c4b9ce2 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.3.1/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.3.1 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Glossary/Index.guide.md b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Glossary/Index.guide.md index 479c4787..634ffcfb 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Glossary/Index.guide.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Glossary/Index.guide.md @@ -5,7 +5,7 @@ topic: glossary ## Glossary

-Below is a non exhaustive list of terms used throughout the BaRS documentation. +Below is a non-exhaustive list of terms used throughout the BaRS documentation.

|Term / Abbreviation | What it stands for | diff --git a/guides/Training-guide-BARS/Home/About-BaRS/Releases/Release-Notes.guide.md b/guides/Training-guide-BARS/Home/About-BaRS/Releases/Release-Notes.guide.md index 998577d7..998c514a 100644 --- a/guides/Training-guide-BARS/Home/About-BaRS/Releases/Release-Notes.guide.md +++ b/guides/Training-guide-BARS/Home/About-BaRS/Releases/Release-Notes.guide.md @@ -1,4 +1,4 @@ ## Releases -This section contains the release notes for the various elements of the booking and referral standard. In the table below you will find information about each element and links the the detailed change logs. +This section contains the release notes for the various elements of the booking and referral standard. In the table below you will find information about each element and links the detailed change logs. diff --git a/guides/Training-guide-BARS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.0.1.page.md b/guides/Training-guide-BARS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.0.1.page.md index 857b594f..73051ea9 100644 --- a/guides/Training-guide-BARS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.0.1.page.md +++ b/guides/Training-guide-BARS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.0.1.page.md @@ -9,10 +9,10 @@ | Change | Description | |--------------------------------------------------|----------------------------------------------------------------------------------------------------------| | Fixed issue with menu in Design/BaRS Core | The "Failure Scenarios" subsection had an erroneous entry in left-hand navigation. This has been removed | -| Updated release notes structure | This change was to accomodate historical releases by hiding them in an expander | +| Updated release notes structure | This change was to accommodate historical releases by hiding them in an expander | | Improved release notes navigation | a "back" button was added to each of the release note detail sections | | Updated FHIR assets section | Simplified approach with a link out to the full Simplifier project | -| TKW - Updated context description | Now includes detail of deployment on INT and rationale adopting this appraoch | +| TKW - Updated context description | Now includes detail of deployment on INT and rationale adopting this approach | | TKW - Corrected sentinel values | Some sentinel values for referencing UserTest DoS were out of date and did not return | | TKW - Updated Response scenarios | Added the sentinel values, under the Scenarios section, to elicit responses for interim and full Validation responses | | TKW - Added table of DoS Service Ids | Table of DoS Service Ids and how to obtain them to use as sentinel values for TKW Scenarios | @@ -20,7 +20,7 @@ | BARS-UEC-1 Application | Corrected how elements ServiceRequest.supportInfo and CarePlan.supportingInfo must be populated | | BARS-UEC-2 Application | Corrected how elements ServiceRequest.supportInfo and CarePlan.supportingInfo must be populated | | Fixed broken or incorrect links on "Home Page" | Some links were linking to the wrong page | -| Help and Support - fixed broken external links | Some external linkswere broken or still "boiler plate" links | +| Help and Support - fixed broken external links | Some external links were broken or still "boiler plate" links | | Updated Change Log naming | Change Log names have been changed to more in line with the rest of the change log names | | Updated wording on releases | Wording of guidance around support for new releases of Core was updated to provide more clarity | diff --git a/guides/Training-guide-BARS/Home/About-BaRS/Versioning.guide.md b/guides/Training-guide-BARS/Home/About-BaRS/Versioning.guide.md index 227a532f..f92070c8 100644 --- a/guides/Training-guide-BARS/Home/About-BaRS/Versioning.guide.md +++ b/guides/Training-guide-BARS/Home/About-BaRS/Versioning.guide.md @@ -8,7 +8,7 @@ The Booking and Referral Standard (BaRS) will follow [Semantic Versioning](https Full details can be found at the [Semantic Versioning](https://semver.org/) site, key points outlined below: #### Major version -The major version is incremented when an incompatible changes are made, i.e. a non backwards compatible change. +The major version is incremented when incompatible changes are made, i.e. a non backwards compatible change. #### Minor version The minor version increments when changes are made in a backwards compatible manner. diff --git a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Booking-Request-Payload.page.md b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Booking-Request-Payload.page.md index 234ddc60..e65afe74 100644 --- a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Booking-Request-Payload.page.md +++ b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Booking-Request-Payload.page.md @@ -24,7 +24,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Bundle | 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 | | 79120f41-a431-4f08-bcc5-1e67006fcae0 | @@ -50,7 +50,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.nhs.uk/StructureDefinition/BARSMessageHeader-booking-request, hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | MessageHeader | https://simplifier.net/nhsbookingandreferrals/barsmessageheaderbookingrequest-duplicate-2 | | 1..1 | | | MessageHeader.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | | @@ -107,7 +107,7 @@ This payload is used to support a booking workflow and contains all the required -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Appointment | https://simplifier.net/hl7fhirukcorer4/ukcoreappointment | | 1..1 | | | Appointment.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | | 3713c8fc-dbcf-4f90-bacf-89d99e434e9b | @@ -165,7 +165,7 @@ This payload is used to support a booking workflow and contains all the required -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Patient | https://simplifier.net/hl7fhirukcorer4/ukcorepatient | | 1..1 | | | Patient.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | | 9589fb37-87a2-48d8-968f-b371429208a8 | @@ -240,7 +240,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization , hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Organization | https://simplifier.net/hl7fhirukcorer4/ukcoreorganization | | 2..* | | | Organization.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | | 5d897313-c62d-4e7e-92b7-b2199804fed3 | @@ -263,7 +263,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Practitioner | https://simplifier.net/hl7fhirukcorer4/ukcorepractitioner | |0..* | | | Practitioner.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 1..1 | 51182cb1-b199-4222-85f5-16d5428f6358 | @@ -292,7 +292,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | PractitionerRole | https://simplifier.net/hl7fhirukcorer4/ukcorepractitionerrole | | 0..* | | | PractitionerRole.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 1..1 | 1801e180-e6a1-4753-8a55-ab2d1cff6549 | @@ -321,7 +321,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService , hybrid}} -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | HealthcareService | https://simplifier.net/hl7fhirukcorer4/ukcorehealthcareservice | | 1..1 | | | HealthcareService.id | This MUST be populated with the value retrieved for the resource via the GET /Sot request. | MUST | 1..1 | 1801e180-e6a1-4753-8a55-ab2d1cff6549 | diff --git a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Booking-Request-Payload.page.md b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Booking-Request-Payload.page.md index 6cdc2af0..6a027d83 100644 --- a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Booking-Request-Payload.page.md +++ b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/Booking-Request-Payload.page.md @@ -24,7 +24,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Bundle | 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 | | 79120f41-a431-4f08-bcc5-1e67006fcae0 | @@ -50,7 +50,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.nhs.uk/StructureDefinition/BARSMessageHeader-booking-request, hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | MessageHeader | https://simplifier.net/nhsbookingandreferrals/barsmessageheaderbookingrequest-duplicate-2 | | 1..1 | | | MessageHeader.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | | @@ -107,7 +107,7 @@ This payload is used to support a booking workflow and contains all the required -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Appointment | https://simplifier.net/hl7fhirukcorer4/ukcoreappointment | | 1..1 | | | Appointment.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | | 3713c8fc-dbcf-4f90-bacf-89d99e434e9b | @@ -165,7 +165,7 @@ This payload is used to support a booking workflow and contains all the required -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Patient | https://simplifier.net/hl7fhirukcorer4/ukcorepatient | | 1..1 | | | Patient.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | | 9589fb37-87a2-48d8-968f-b371429208a8 | @@ -240,7 +240,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization , hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Organization | https://simplifier.net/hl7fhirukcorer4/ukcoreorganization | | 2..* | | | Organization.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | | 5d897313-c62d-4e7e-92b7-b2199804fed3 | @@ -263,7 +263,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Practitioner | https://simplifier.net/hl7fhirukcorer4/ukcorepractitioner | |0..* | | | Practitioner.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 1..1 | 51182cb1-b199-4222-85f5-16d5428f6358 | @@ -292,7 +292,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | PractitionerRole | https://simplifier.net/hl7fhirukcorer4/ukcorepractitionerrole | | 0..* | | | PractitionerRole.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 1..1 | 1801e180-e6a1-4753-8a55-ab2d1cff6549 | @@ -321,7 +321,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService , hybrid}} -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | HealthcareService | https://simplifier.net/hl7fhirukcorer4/ukcorehealthcareservice | | 1..1 | | | HealthcareService.id | This MUST be populated with the value retrieved for the resource via the GET /Sot request. | MUST | 1..1 | 1801e180-e6a1-4753-8a55-ab2d1cff6549 | diff --git a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/How-does-it-work.page.md b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/How-does-it-work.page.md index 8a36ed22..7049155d 100644 --- a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/How-does-it-work.page.md +++ b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/How-does-it-work.page.md @@ -16,7 +16,7 @@ This workflow details a referral into a CAS from a 999 Ambulance Service Trust ( - Prior to referral the 999 AST will undertake a triage of the patient to determine the acuity of the case. This will typically be undertaken by a call handler on the Computer Aided Dispatch system (CAD) using an approved Clinical Decision Support System (CDSS) such as NHS Pathways or AMPDS. For cases with a non-ambulance disposition (CAT5), local business rules will be applied to determine if the case meets the requirement for referral to a CAS for consultation. - For cases requiring a referral to CAS, a suitable CAS is identified based on the patient’s clinical need and location. Service discovery will use local directories or UEC DOS to ascertain the Service ID - The Service ID is used to query the BaRS endpoint catalogue to identify the receiving CAS system's endpoint details. This process is happening in the background that Senders and Receivers do not need to manage. -- The 999-AST will send the referral to the CAS via the BaRS Proxy, including the information required by a CAS Clinician to continue the patent's clinical care. This will also include the Journey ID created at the patient's first contact. +- The 999-AST will send the referral to the CAS via the BaRS Proxy, including the information required by a CAS Clinician to continue the patient's clinical care. This will also include the Journey ID created at the patient's first contact. - The CAS system will acknowledge the referral on receipt, after which the case may be closed by the 999 AST on the CAD. It should be noted that Duty of care is passed from the 999 AST with the referral and is considered accepted by the CAS on receipt of the acknowledgement. - Prior to the consultation the case will typically be posted to a queue for prioritisation, based on information in the referral. This may be based on the call back time, determined locally or nationally based on the triage outcome codes. E.g. Where cases have a Pathways disposition (Dx) these are prioritised in accordance with the criteria specified in the IUC CAS service specification which sets out call-back times by Dx code. - The CAS Clinician will contact the patient, or their representative, utilising information in the referral message, then undertakes a consultation which may include a triage. The consultation will be informed by the clinical information sent by the referring service. This will be recorded in the CAS system. diff --git a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Payloads.page.md b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Payloads.page.md index 23c04c2a..78fdf96d 100644 --- a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Payloads.page.md +++ b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Payloads.page.md @@ -46,7 +46,7 @@ When a BARS Sender populates the Location resource: * what3words * They **should** populate the *Location.address* for all property based locations. -* They **should** populate *Location.address.line* which is a repeatable element, with the the order in which lines should appear in an address label +* They **should** populate *Location.address.line* which is a repeatable element, with the order in which lines should appear in an address label * They **should** populate *Location.name* when there is a property name * They **should** populate *Location.address.text* with a text representation of the full address (including the address name), with each line separated by a comma diff --git a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/How-does-it-work.page.md b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/How-does-it-work.page.md index ed14501e..018dc236 100644 --- a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/How-does-it-work.page.md +++ b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/How-does-it-work.page.md @@ -16,7 +16,7 @@ This details a 999 Ambulance Service Trust (AST) Referral into Clinical Assessme - Prior to making a Validation Request, the 999 AST will undertake a triage of the patient to determine the acuity of the case. This will typically be undertaken by a call handler on the Computer Aided Dispatch (CAD) system, using an approved Clinical Decision Support System (CDSS) such as NHS Pathways or AMPDS. For cases with an ambulance disposition, local business rules will be applied to determine if the case meets the requirement for validation by a CAS clinician. This will usually be Ambulance Response Programme (ARP) priority C3 and C4 cases, but may include C2 segmentation cases, subject to local agreements between the 999 AST and the CAS. - For cases requiring clinical validation, a suitable CAS is identified based on the patient’s clinical need and location. Service discovery will use local directories or UEC DOS to ascertain the ServiceID - The Service ID is used to query the BaRS Endpoint Catalogue to identify the receiving CAS system's endpoint details. -- The 999-AST will send the Validation Request to the CAS, which includes information required by a CAS Clinician to continue the patent's clinical care. This will also include the JourneyID created at the patient's first contact. +- The 999-AST will send the Validation Request to the CAS, which includes information required by a CAS Clinician to continue the patient's clinical care. This will also include the JourneyID created at the patient's first contact. - The CAS system will acknowledge the Validation Request on receipt. - On receipt of the Acknowledgment (synchronous response), the 999 AST CAD may move the case to a 'pending' stack. If the case exceeds the validation breach time before a validation response is received, a fail-safe process should be implemented to ensure that an ambulance is dispatched within the time frame determined by the original triage outcome. - If additional or changed information about the case is captured by the 999 AST subsequent to sending the Validation Request, but prior to receiving an Interim or Final Validation Response, they may send a Validation Request Update to ensure that the CAS has the most up to date information. diff --git a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Payloads-for-Responders.page.md b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Payloads-for-Responders.page.md index 398459fa..9816047a 100644 --- a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Payloads-for-Responders.page.md +++ b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Payloads-for-Responders.page.md @@ -90,7 +90,7 @@ When a BARS Responder populates the Location resource: * what3words * They **should** populate the *Location.address* for all property based locations. -* They **should** populate *Location.address.line* which is a repeatable element, with the the order in which lines should appear in an address label +* They **should** populate *Location.address.line* which is a repeatable element, with the order in which lines should appear in an address label * They **should** populate *Location.address.name* when there is a property name * They **should** populate *Location.address.text* with a text representation of the full address (including the address name), with each line separated by a comma diff --git a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/How-does-it-work.page.md b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/How-does-it-work.page.md index c4312783..263b3d3a 100644 --- a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/How-does-it-work.page.md +++ b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/How-does-it-work.page.md @@ -89,7 +89,7 @@ Calls may be re-routed by the BT Emergency Call Service to an Ambulance Service - The referral Receiver is identified based on nationally agreed polygons that set geographic boundaries of responsibility for each AST. Service discovery will use these polygons to ascertain the ServiceID of the referral Receiver. - The Service ID is used to query the BaRS Endpoint Catalogue to identify the referral Receiver's CAD system's endpoint details - The sender will check that the Receiver supports the intended Referral use case before sending. -- The referral Sender will send the BaRS Referral to the referral Receiver, which includes information required by the referral Receiver to continue the patent's clinical care. This will also include the JourneyID created at the patient's first contact. +- The referral Sender will send the BaRS Referral to the referral Receiver, which includes information required by the referral Receiver to continue the patient's clinical care. This will also include the JourneyID created at the patient's first contact. ### Create Case - The referral Receiver's CAD will create a new case (Encounter) on receipt of the BaRS Referral and populate it with the patient and clinical details provided in the referral diff --git a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md index b3dc571b..9f455a01 100644 --- a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md +++ b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md @@ -59,7 +59,7 @@ This page provides guidance for implementing the Referral Standard (BaRS) specif The referral information data model is based on user research with NHS 111 service providers, 999 Ambulance Service Trusts, Clinical Assessment Services and clinical and administrative Emergency Department staff. We carried out this research in parallel with the [Professional Records Standards Body (PRSB)](https://theprsb.org/) who examined the wider brief of 'referrals from NHS 111 to any other care setting' -For the CAD to CAD use case, the data model was agreed by the CAD to CAD Reference Group following a period of user research involving site visits, Reference Group workshops and desk research. This was endorsed by the CAD to CAD Working Group and shared with the the following organisations: +For the CAD to CAD use case, the data model was agreed by the CAD to CAD Reference Group following a period of user research involving site visits, Reference Group workshops and desk research. This was endorsed by the CAD to CAD Working Group and shared with the following organisations: * National Ambulance Programme Board (NAPB) * National Ambulance Advisory Group (NAAG) diff --git a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Booking-Request-Payload.page.md b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Booking-Request-Payload.page.md index 2763a05c..60801b4f 100644 --- a/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Booking-Request-Payload.page.md +++ b/guides/Training-guide-BARS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Booking-Request-Payload.page.md @@ -24,7 +24,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Bundle | 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 | | 79120f41-a431-4f08-bcc5-1e67006fcae0 | @@ -50,7 +50,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.nhs.uk/StructureDefinition/BARSMessageHeader-booking-request, hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | MessageHeader | https://simplifier.net/nhsbookingandreferrals/barsmessageheaderbookingrequest-duplicate-2 | | 1..1 | | | MessageHeader.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | | @@ -107,7 +107,7 @@ This payload is used to support a booking workflow and contains all the required -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Appointment | https://simplifier.net/hl7fhirukcorer4/ukcoreappointment | | 1..1 | | | Appointment.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | | 3713c8fc-dbcf-4f90-bacf-89d99e434e9b | @@ -165,7 +165,7 @@ This payload is used to support a booking workflow and contains all the required -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Patient | https://simplifier.net/hl7fhirukcorer4/ukcorepatient | | 1..1 | | | Patient.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | | 9589fb37-87a2-48d8-968f-b371429208a8 | @@ -240,7 +240,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization , hybrid}}

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Organization | https://simplifier.net/hl7fhirukcorer4/ukcoreorganization | | 2..* | | | Organization.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | | 5d897313-c62d-4e7e-92b7-b2199804fed3 | @@ -263,7 +263,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | Practitioner | https://simplifier.net/hl7fhirukcorer4/ukcorepractitioner | |0..* | | | Practitioner.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 1..1 | 51182cb1-b199-4222-85f5-16d5428f6358 | @@ -292,7 +292,7 @@ This payload is used to support a booking workflow and contains all the required

-| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | PractitionerRole | https://simplifier.net/hl7fhirukcorer4/ukcorepractitionerrole | | 0..* | | | PractitionerRole.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 1..1 | 1801e180-e6a1-4753-8a55-ab2d1cff6549 | @@ -321,7 +321,7 @@ This payload is used to support a booking workflow and contains all the required {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService , hybrid}} -| Data Item | Implementation Guidance | Necessity | Cadinality UKCore | Example Value(s) | +| Data Item | Implementation Guidance | Necessity | Cardinality UKCore | Example Value(s) | |------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|------------------------------------------------------------------------------------------| | HealthcareService | https://simplifier.net/hl7fhirukcorer4/ukcorehealthcareservice | | 1..1 | | | HealthcareService.id | This MUST be populated with the value retrieved for the resource via the GET /Sot request. | MUST | 1..1 | 1801e180-e6a1-4753-8a55-ab2d1cff6549 | diff --git a/guides/Training-guide-BARS/Home/Applications/BaRS-Core/BaRS-FHIR-usage.page.md b/guides/Training-guide-BARS/Home/Applications/BaRS-Core/BaRS-FHIR-usage.page.md index 7b3f5055..c1b8b857 100644 --- a/guides/Training-guide-BARS/Home/Applications/BaRS-Core/BaRS-FHIR-usage.page.md +++ b/guides/Training-guide-BARS/Home/Applications/BaRS-Core/BaRS-FHIR-usage.page.md @@ -40,7 +40,7 @@ You must implement a $process-message endpoint to be compliant with BaRS because The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.

\ No newline at end of file diff --git a/guides/Training-guide-BARS/Home/Core/1.0.3/BaRS-FHIR-Usage/Bundle.page.md b/guides/Training-guide-BARS/Home/Core/1.0.3/BaRS-FHIR-Usage/Bundle.page.md index 4e4619c9..92a8089a 100644 --- a/guides/Training-guide-BARS/Home/Core/1.0.3/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Training-guide-BARS/Home/Core/1.0.3/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.0.3 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Training-guide-BARS/Home/Core/1.1.3/Appointment-StandardPattern/Introduction.page.md b/guides/Training-guide-BARS/Home/Core/1.1.3/Appointment-StandardPattern/Introduction.page.md index d5d1d4b5..5e43741d 100644 --- a/guides/Training-guide-BARS/Home/Core/1.1.3/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Training-guide-BARS/Home/Core/1.1.3/Appointment-StandardPattern/Introduction.page.md @@ -19,7 +19,7 @@ There are 4 capabilities that are required surrounding appointments. This sectio ## interface -The following table describes how the BaRS API accomodates these 4 capabilities using the /Appointment endpoint and the /Appointment/[id] endpoint +The following table describes how the BaRS API accommodates these 4 capabilities using the /Appointment endpoint and the /Appointment/[id] endpoint | Capability | Endpoint | VERB | Description | |------------|-----------|-----|--------------| diff --git a/guides/Training-guide-BARS/Home/Core/1.1.3/BaRS-FHIR-Usage/Bundle.page.md b/guides/Training-guide-BARS/Home/Core/1.1.3/BaRS-FHIR-Usage/Bundle.page.md index 8eff433a..faf8fce3 100644 --- a/guides/Training-guide-BARS/Home/Core/1.1.3/BaRS-FHIR-Usage/Bundle.page.md +++ b/guides/Training-guide-BARS/Home/Core/1.1.3/BaRS-FHIR-Usage/Bundle.page.md @@ -7,7 +7,7 @@ topic: core-FHIRUsage-bundle-1.1.3 The use of the FHIR bundle in BaRS primarily supports the use of $process-message. It is also used as follows: - When $process-message is initiated, a sender packages up numerous FHIR resources (MessageHeader, Patient, ServiceRequest etc.), the bundle will include everything needed by a receiver to process the request being made. -- The $process-message endpoint is capable of receiving different types of request. The sender indicates the the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. +- The $process-message endpoint is capable of receiving different types of request. The sender indicates the action required by specifying in the MessageHeader resource, for example: booking or servicerequest, the operation, whether it be 'new' or 'update' and central FHIR resource from which to make sense of the bundle, the 'focus'. - A bundle type of 'searchset' is also used in BaRS when a receiver responds to a senders request for available slots, in the booking workflow. A receiver responds by bundling FHIR resources (HealthcareService, Schedule, Slot(s) etc.) related to particular HealthcareService which a sender will unpack and process to display service availability to a user.
diff --git a/guides/Training-guide-BARS/Home/Helpandsupport/Glossary.guide.md b/guides/Training-guide-BARS/Home/Helpandsupport/Glossary.guide.md index d7b54d4b..5e69965b 100644 --- a/guides/Training-guide-BARS/Home/Helpandsupport/Glossary.guide.md +++ b/guides/Training-guide-BARS/Home/Helpandsupport/Glossary.guide.md @@ -1,7 +1,7 @@ ## Glossary

-Below is a non exhaustive list of terms used throughout the BaRS documentation. +Below is a non-exhaustive list of terms used throughout the BaRS documentation.

|Term / Abbreviation | What it stands for |