diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..598ae792 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/.vscode diff --git a/BaRS-Images/WorkFlows/CADOutOfArea-1.0.3.svg b/BaRS-Images/WorkFlows/CADOutOfArea-1.0.3.svg new file mode 100644 index 00000000..4a115696 --- /dev/null +++ b/BaRS-Images/WorkFlows/CADOutOfArea-1.0.3.svg @@ -0,0 +1,4 @@ + + + +

CAD to CAD Simplified Workflow - Use Case: Out of Area Referral 

No
No
Update Transfer details
Scene safety update
Business
Ack HTTP
Response
Receive acknowledgment
BaRS HTTP
Response
BaRS Update
BaRS HTTP
Response
Yes 
Process case update
Business Ack
- Action
Triggered
Manage stack
Update demographics
Update triage
Update Location detaIs
Continue Updates
Yes
Suitable for dispatch
Suitable for Validation?
No
Yes
Yes
Home 999 AST
Suitable for Referral to CAS?
National Telephony
                                                 Receiving 999 AST
Route to available Trust
Record Demographics
Complete 999 Triage
Confirm Location
BT EISEC
Create case
Receive Call
Create case
Identify Home Trust
Transfer Case
BaRS Referral
Pre Triage Sieve
Reason for Call
Pre alert
Record Nature of Call
New Workflow
Existing BaRS Workflow
Close case
Continue Updates
No
Receive acknowledgment
Update MDT
Dispatch resource
Send for Validation
Refer to CAS
Existing Workflow
Pre alert
Business
Ack HTTP
Response
Pre alert
Home Trust available?
Yes
No
BAU workflow
Acknowledge receipt of update
Acknowledge receipt of case
Business Ack
- Action
Triggered
 \ No newline at end of file diff --git a/BaRS-Images/WorkFlows/CADOutOfAreaAsncResponses-1.0.0.svg b/BaRS-Images/WorkFlows/CADOutOfAreaAsncResponses-1.0.0.svg new file mode 100644 index 00000000..ca890eac --- /dev/null +++ b/BaRS-Images/WorkFlows/CADOutOfAreaAsncResponses-1.0.0.svg @@ -0,0 +1,4 @@ + + + +
Status updates:  Business Acknowledgement Action Triggered 
Sender
(Receiving 999 AST)
Start
Send/Update OOA referral 
('planned')
await update
Y
more info?
Allocate Update ('in-progress')
Arrived Update ('arrived')
Complete Update ('finished')
Closed call 
End
Receiver
(Home 999 AST)
Receive referral/update
Add to queue
Allocate Resource
Resource Arrived
Call Complete
End
Key
= Asynchronous response 
= Optional workflow 

BaRS Application 6 - Asychronous Response flows 

CAD-CAD Out of Area Referral  
= New workflow - v1.0.0-beta.8
 \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md index 51bbe268..7680eaa0 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md @@ -20,7 +20,9 @@ Implementation Guide | 1.11.1 | v1 | Live | Current Release | 19/05 ### Overview of the release -TBC +Release 1.11.1 of the BaRS Implementation Guide is a patch release including an additional encounter.status value for Application 6 CAD-CAD Out of Area Referral, published with supporting documentation. BaRS Core version is uplifted to 1.4.1 in line with an update to the BaRS FHIR API OAS file. + +Also included in this release are minor changes to BaRS Application 8 and bug fixes and corrections throughout the guide. A clinical safety assessment of the scope of this release has determined that it has not significantly changed the clinical safety profile of the BaRS. No new hazards have been identified in this release. The latest version of the BaRS clinical safety case and hazard log can be downloaded from the  BaRS FHIR API onboarding support information page . diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.3.0.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.3.0.page.md index 375c018d..945337fe 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.3.0.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.3.0.page.md @@ -14,9 +14,9 @@ topic: TRN-API-1.3.0 | Change | Description | Impact | |----------------------------------------------|---------------------------------------------------------------------|--------| -|
{{render:handshake}}
- Additional patient demographic parameters added to GET /Appointment | 1.9.0 | Patient demographic parameters (Name, Date of Birth and Address) added to support patient lookup for cancellation and update workflows. | Addition | -|
{{render:handshake}}
- Additional patient demographic parameters added to GET /ServiceRequest | 1.9.0 | Patient demographic parameters (Name, Date of Birth and Address) added to support patient lookup for cancellation and update workflows. | Addition | -| Fixed incorrect character display on GET /Slot description | 1.9.0 | Character display for a double quote was illegible. | correction | +|
{{render:handshake}}
- Additional patient demographic parameters added to GET /Appointment | Patient demographic parameters (Name, Date of Birth and Address) added to support patient lookup for cancellation and update workflows. | Addition | +|
{{render:handshake}}
- Additional patient demographic parameters added to GET /ServiceRequest | Patient demographic parameters (Name, Date of Birth and Address) added to support patient lookup for cancellation and update workflows. | Addition | +| Fixed incorrect character display on GET /Slot description | Character display for a double quote was illegible. | correction |
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.0.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.0.page.md index e9afa61a..8949b0d9 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.0.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.0.page.md @@ -14,7 +14,7 @@ topic: TRN-API-1.4.0 | Change | Description | Impact | |----------------------------------------------|---------------------------------------------------------------------|--------| -|
{{render:handshake}}
- Describe change | 1.11.0 | Describe impact | Addition | +|
{{render:handshake}}
- Added Endpoint Catalogue related endpoints | Added preview operations for use in the Endpoint Catalogue, related to entities like Endpoints and Endpoint Templates | Addition | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.1.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.1.page.md index 252543d2..99597d5f 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.1.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.1.page.md @@ -14,7 +14,7 @@ topic: TRN-API-1.4.1 | Change | Description | Impact | |----------------------------------------------|---------------------------------------------------------------------|--------| -|
{{render:handshake}}
- Describe change | 1.11.1 | Describe impact | Addition | +|
{{render:handshake}}
- Corrections on EPC preview endpoints | Minor fixes to the preview version of the Endpoint Catalogue related endpoints | correction | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.8.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.8.page.md index 492d393b..a3dee445 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.8.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.8.page.md @@ -8,9 +8,10 @@ This is a minor "patch" with clarifications to limited areas of the Implementati | Change | Description | Impact | -|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------| -| -| Implementation guidance updated | patient.id implementation guidance corrected | correction | +|-------------------------------------------|-------------------------------------------------|------------------------------------------------------------------------- +|Implementation guidance updated | encounter.status implementation guidance updated to include "arrived" | non-breaking | +| Out of Area Worflow diagram updated | Workflow diagram updated to reference additional workflow explanation of status updates (action triggered business acknowledgement) | non-breaking | +| BaRS Application 6 - Asynchronous Response flows diagram added | Workflow diagram added for status updates (action triggered business acknowledgement) | non-breaking | ### Payload Change Log @@ -18,7 +19,7 @@ This is a minor "patch" with clarifications to limited areas of the Implementati | FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact | |------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------| -| tbc | tbc | tbc | Update | Referral Request |Bug fix | correction | +| encounter.status | | ...For a case where a resource has arrived on scene this MUST be populated with ‘arrived’... | Update | Referral Response |Change | non-breaking |
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md index a4db5c9d..213893f8 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md @@ -581,7 +581,7 @@ Receive_Request if (Message == "update") { - if (currentLocalData.LastUpdated > originaRequest.ReceivedDate) + if (currentLocalData.LastUpdated > originalRequest.ReceivedDate) { OperationOutcome.issue.code = "conflict" throw exception with 'REC_CONFLICT' @@ -592,7 +592,7 @@ Receive_Request { if (currentLocalData.Item.exists) { - if (currentLocalData.LastUpdated > originaRequest.Received) + if (currentLocalData.LastUpdated > originalRequest.Received) { OperationOutcome.issue.code = "conflict" throw exception with 'REC_CONFLICT' @@ -720,7 +720,20 @@ This means that these services will only accept a referral if a booking has also If no appointment is available then a referral should not be made. -To achieve this, a "service attribute" is configurable against services. This will allow the service to be flagged as "booking only". Therefore if this attribute is present on the service all consumer systems should withhold referrals. The DoS API documentation for this can be found here. +To achieve this, a "service attribute" is configurable against services. This will allow the service to be flagged as "booking only". Therefore if this attribute is present on the service all consumer systems should withhold referrals. The DoS API documentation for this can be found here. + + ##### Workflow diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Referral-Response-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Referral-Response-Payload.page.md deleted file mode 100644 index 42194400..00000000 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Referral-Response-Payload.page.md +++ /dev/null @@ -1,527 +0,0 @@ ---- -topic: 111-ED-ReferralResponsePayload ---- - -### Payload for a referral response, using Service Request - - -Here is some placeholder text for the service request payload for this Application. Diagrams and other things can come here. - - -
- > Bundle - - - -

- -

The Bundle resource is the container for the event message 

- {{tree:https://fhir.nhs.uk/StructureDefinition/BARSBundleMessage, hybrid}} -

- - -| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | -|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Bundle | https://simplifier.net/nhsbookingandreferrals/barsbundlemessage | | | | -| Bundle.id | This id is generated by the originating sender of the message, retained in subsequent messages.. | MUST | 1..1 | 79120f41-a431-4f08-bcc5-1e67006fcae0 | -| Bundle.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | | -| Bundle.meta.versionId | This MUST be populated with the version of the Application the bundle complies with. The Receiver will read this to know whether they are capable of processing. | MUST | 0..1 | 1.0.0-beta | -| Bundle.meta.profile | This MUST be populated with the structure definition for BaRSBundleMessage : 'https://fhir.nhs.uk/StructureDefinition/BARSBundleMessage' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/StructureDefinition/BARSBundleMessage | -| Bundle.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under the meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates to resources, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | -| Bundle.type | This MUST be populated with 'message' - FIXED VALUE | MUST | 1..1 | message | -| Bundle.timestamp | This MUST be populated with the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | -| Bundle.entry(s) | Follow BaRS profile guidance for populating this element | MUST | 0..* | | -| Bundle.entry.fullUrl | This MUST be populated with the unique identifier for the resource entry. Transient id relative to the bundle | MUST | 0..1 | urn:uuid:1cbdfb97-5859-48a4-8301-d54eab818d68 | -| Bundle.entry.resourceType | This MUST be populated with the Resources detailed in the message definition. | MUST | 0..1 | MessageHeader,Patient, Encounter | - - -

-

-

- > Message Header - - -

- -

A resource that describes the BaRS message being exchanged between two systems. It defines the way that the referral bundle should be processed when it is being consumed by a receiver

- {{tree:https://fhir.nhs.uk/StructureDefinition/BARSMessageHeader-servicerequest-request, hybrid}} -

- -| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | -|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| MessageHeader | https://simplifier.net/nhsbookingandreferrals/barsmessageheaderservicerequestresponse | MUST | | | -| MessageHeader.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | | -| MessageHeader.meta.profile | This MUST be populated with the structure definition for BaRSMessageHeader-servicerequest-response. | MUST | 0..1 | https://fhir.nhs.uk/StructureDefinition/BARSMessageHeader-servicerequest-response | -| MessageHeader.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under the meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates to resources, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | -| MessageHeader.extension | This MUST be populated with details of the Clinical Decision Support System used | MUST | 0..* | | -| MessageHeader.extension.url | This MUST be populated with 'https://fhir.nhs.uk/StructureDefinition/CDSSExtension' - FIXED VALUE | MUST | 1..1 | https://fhir.nhs.uk/StructureDefinition/CDSSExtension | -| MessageHeader.extension.extension | | MUST | 0..* | | -| MessageHeader.extension.extension.url | This MUST be populated with the pre-defined Clinical Decision Support System software url - FIXED VALUE | MUST | 1..1 | requesterCDSSSoftware | -| MessageHeader.extension.extension.valueString | This MUST be populated with the Clinical Decision Support System software name e.g. Pathways | MUST | 0..1 | Pathways | -| MessageHeader.extension.extension | | MUST | 0..* | | -| MessageHeader.extension.extension.url | This MUST be populated with the pre-defined Clinical Decision Support System software Version url - FIXED VALUE | MUST | 1..1 | requesterCDSSVersion | -| MessageHeader.extension.extension.valueString | This MUST be populated with the Clinical Decision Support System software Version name e.g. 30.2.0 | MUST | 0..1 | 30.2.0 | -| MessageHeader.eventcoding | | MUST | 1..1 | | -| MessageHeader.eventcoding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/message-events-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-events-bars | -| MessageHeader.eventcoding.code | The status MUST be populated with 'servicerequest-request'. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-events-bars' | MUST | 0..1 | servicerequest-response | -| MessageHeader.destination | | MUST | 0..1 | | -| MessageHeader.destination.receiver | | MUST | 0..1 | | -| MessageHeader.destination.receiver.reference | This MUST be populated with the full url to the Receiving Organisation resource. | MUST | 0..1 | urn:uuid:10397afd-479c-42ea-9d5d-e4024481e0f8 | -| MessageHeader.destination.endpoint | This MUST be populated with the system and Service ID separated by a pipe. for example https://fhir.nhs.uk/id/dos-service-id\|11111111, this is to ensure the receiver knows the intended destination. | MUST | 1..1 | https://fhir.nhs.uk/id/dos-service-id\|1122334455 | -| MessageHeader.sender | | MUST | 0..1 | | -| MessageHeader.sender.reference | This MUST be populated. Follow BaRS profile guidance for populating this element | MUST | 0..1 | urn:uuid:07939a0c-2854-46ff-9282-ad906bc93679 | -| MessageHeader.source | | MUST | 1..1 | | -| MessageHeader.source.name | This MUST be populated with the sending system supplier name | MUST | 0..1 | Patient Access System | -| MessageHeader.source.software | This SHOULD be populated with the sending software application name | SHOULD | 0..1 | Supplier Software | -| MessageHeader.source.version | This SHOULD be populated with the sending software version | SHOULD | 0..1 | V1.0.0 | -| MessageHeader.source.contact | | SHOULD | 0..1 | | -| MessageHeader.source.contact.system | This SHOULD be populated with the Contact Type - phone \| fax \| email \| pager \| url \| sms \| other | SHOULD | 0..1 | phone | -| MessageHeader.source.contact.value | This SHOULD be populated with the Contact Type value | SHOULD | 0..1 | +44 (0123) 123 4567 | -| MessageHeader.source.endpoint | This MUST be populated with the system and Service ID separated by a pipe. for example https://fhir.nhs.uk/id/dos-service-id\|11111111, this is to ensure the receiver knows where any response messages SHOULD be addressed. | MUST | 1..1 | https://fhir.nhs.uk/id/dos-service-id\\|5566778899 | -| MessageHeader.reason | | MUST | 0..1 | | -| MessageHeader.reason.coding | | MUST | 0..1 | | -| MessageHeader.reason.coding.system | This MUST be populated with 'https://fhir.nhs.uk/CodeSystem/message-reason-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-reason-bars | -| MessageHeader.reason.coding.code | This MUST be populated with 'new' in a new message and 'update' for an update. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-events-bars' | MUST | 0..1 | new | -| MessageHeader.reason.coding.display | This SHOULD be populated with 'new' in a new message and 'update' for an update. | SHOULD | 0..1 | New | -| MessageHeader.focus | | MUST | 0..* | | -| MessageHeader.focus.reference | This MUST be populated with a reference to the ServiceRequest | MUST | 0..1 | urn:uuid:236bb75d-90ef-461f-b71e-fde7f899802c | -| MessageHeader.definition | This MUST be populated with the MessageDefinition the bundle is based on. This will be used for validation. Value - https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-referral | MUST | 0..1 | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-response-referral | -| MessageHeader.response | | MUST | 0..1 | | -| MessageHeader.response.identifier | This MUST be populated with the id of the original Bundle.id this message is a response to. | MUST | 0..1 | 79120f41-a431-4f08-bcc5-1e67006fcae0 | -| MessageHeader.response.code | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | ok | - - -

-

-

- > Service Request - - -
-

- -

This Resource is the focus of the Referral interaction

- {{tree:https://fhir.nhs.uk/StructureDefinition/BARSMessageHeader-servicerequest-request , hybrid}} -

- - - -| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | -|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ServiceRequest | https://simplifier.net/nhsbookingandreferrals/barsservicerequestrequestcasetransfer | | | | -| ServiceRequest.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c | -| ServiceRequest.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | | -| ServiceRequest.meta.profile | This MUST be populated with the structure definition for BaRSServiceRequest-request-referral | MUST | 0..1 | https://fhir.nhs.uk/StructureDefinition/BARSServiceRequest-request-referral | -| ServiceRequest.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under the meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates to resources, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | -| ServiceRequest.basedOn | | MUST | 0..* | | -| ServiceRequest.basedOnreference | This MUST be populated with a reference to the CarePlan resource | MUST | 0..1 | urn:uuid:236bb75d-90ef-461f-b71e-fde7f899802c | -| ServiceRequest.status | This MUST be populated with: 'revoked'. 'revoked' is used when a SR is cancelled. - FIXED VALUE | MUST | 1..1 | revoked | -| ServiceRequest.intent | This MUST be populated with 'plan' - FIXED VALUE | MUST | 1..1 | plan | -| ServiceRequest.category | | MUST | 1..1 | | -| ServiceRequest.category.coding | BaRS Referral Type | MUST | 0..* | | -| ServiceRequest.category.coding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/message-category-servicerequest' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-category-servicerequest | -| ServiceRequest.category.coding.code | This MUST be populated with Code 'referral'. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-category-servicerequest' | MUST | 0..1 | referral | -| ServiceRequest.category.coding.display | This MUST be populated with Display 'Transfer of Care'. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-category-servicerequest' | MUST | 0..1 | Transfer of Care | -| ServiceRequest.category.coding | BaRS Use Case | MUST | 0..* | | -| ServiceRequest.category.coding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/usecases-categories-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/usecases-categories-bars | -| ServiceRequest.category.coding.code | This MUST be populated with Code for the use-case. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/usecases-categories-bars' | MUST | 0..1 | A1T1 | -| ServiceRequest.category.coding.display | This MUST be populated with Display for the use-case. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/usecases-categories-bars' | MUST | 0..1 | 111 - ED | -| ServiceRequest.subject | Follow BaRS profile guidance for populating this element | MUST | 1..1 | | -| ServiceRequest.subjectreference | This MUST be populated. Follow BaRS profile guidance for populating this element | MUST | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 | -| ServiceRequest.encounter | | MUST | 0..1 | | -| ServiceRequest.encounter.reference | This MUST be populated with a Reference to the Encounter resource | MUST | 0..1 | urn:uuid:8c63d621-4d86-4f57-8699-e8e22d49935d | -| ServiceRequest.occurrencePeriod | | SHOULD | 0..1 | | -| ServiceRequest.occurrencePeriod.start | This SHOULD be populated. The start of the period MUST be ‘now’. | SHOULD | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | -| ServiceRequest.occurrencePeriod.end | This SHOULD be populated with the time by which the next service provision SHOULD have started (this aligns with the disposition timeframe from Pathways) | SHOULD | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | -| ServiceRequest.authoredOn | This MUST be populated with the date time the request transitioned to being actionable. In case it's 'blank' the date time SHOULD fall back to the submission time/system time of the SENDING system. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | -| ServiceRequest.requester | | MUST | 0..1 | | -| ServiceRequest.requester.reference | This MUST be populated with a reference to the Practitioner resource. This is the Healthcare Professional making the request. This does not strictly need to be a clinician. | MUST | 0..1 | urn:uuid:8c63d621-3424-4f57-8699-e8e22d32423g | -| ServiceRequest.performer | | MUST | 0..* | | -| ServiceRequest.performer.reference | This MUST be populated with a reference to the requested HealthcareService resource | MUST | 0..1 | urn:uuid:8c63d621-2344-4f57-8699-e8e22d44235h | -| ServiceRequest.locationReference | | MAY | 0..* | | -| ServiceRequest.locationReference.reference | This MAY be populated Where used this will link to the Location resource. Location is typically used in 111 to ED when an address is not present because the patient is at a lat/long, WhatThreeWords, etc. location | MAY | 0..1 | urn:uuid:8c63d621-4g67-4f57-8699-e8e22d44234i | -| ServiceRequest.reasonCode | This will ONLY be populated in a cancellation message with the reason for cancellation | SHOULD | 0..* | | -| ServiceRequest.reasonCode.text | This SHOULD be populated. This will ONLY be populated in a cancellation message with the reason for cancellation and SHOULD only be used in conjunction with a corresponding status - revoked or entered-in-error | SHOULD | 0..1 | Revoked as patient has been dealt with. | -| ServiceRequest.supportingInfo | | SHOULD | 0..* | | -| ServiceRequest.supportingInfo.reference | This SHOULD be populated with a reference to Rejected Services Questionnaire Response or Flag (Safeguarding) or, alternatively, link to an Appointment (where a booking is made first in the workflow) | SHOULD | 0..1 | urn:uuid:65508934-c9e6-46d2-a393-af096b502daf | -| ServiceRequest.supportingInfo.display | This SHOULD be populated. Follow BaRS profile guidance for populating this element | SHOULD | 0..1 | Rejected Services - Patient Choice in Service Selection - Details | - - - -

-
-

-

- > Encounter - - -
-

- -

In the Referral response the Encounter is a echo back to the original sender of what was received in the original request.

- {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter , hybrid}} -

- - -| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | -|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Encounter | https://simplifier.net/hl7fhirukcorer4/ukcore-encounter | | UK Core | | -| Encounter.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c | -| Encounter.meta | This MUST be populated with https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | | -| Encounter.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter | -| Encounter.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under the meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates to resources, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | -| Encounter.Identifier | SHOULD be the human readable identifier of the encounter. | SHOULD | 0..* | | -| Encounter.status | This MUST be populated with 'finished' or 'triaged'. | MUST | 1..1 | triaged | -| Encounter.class | | MUST | 1..1 | | -| Encounter.class.system | This MUST be populated with CodeSystem 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | | 0..1 | http://terminology.hl7.org/CodeSystem/v3-ActCode | -| Encounter.class.code | This MUST be populated with Code 'EMER'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | EMER | -| Encounter.class.display | This MUST be populated with Display 'emergency'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | SHOULD | 0..1 | emergency | -| Encounter.subject | | MUST | 0..1 | | -| Encounter.subject.reference | This MUST be populated with a reference to the Patient resource. | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 | -| Encounter.episodeOfCare | | MUST | 0..* | | -| Encounter.episodeOfCare.reference | This MUST be populated with the JourneyID which links all encounters within the patient’s journey. This MUST be created at the patient’s first contact and passed in all subsequent referrals. | MUST | 1..1 | 9589fb37-87a2-48d8-968f-b371429208a8 | -| Encounter.period | | SHOULD | 0..1 | | -| Encounter.period.start | This SHOULD be populated with the time the contact with the practitioner was established. This SHOULD be the contact immediately prior to the referral being sent. | SHOULD | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | -| Encounter.reasonReference | | | 0..* | | -| Encounter.reasonReference.reference | This MUST be populared with the safeguarding reason. | | | urn:uuid:660f804e-9003-4623-b6c0-9f0faae50434 | -| Encounter.reasonReference.display | This MUST be populared with the safeguarding reason. | | | Social Context - Accommodation Status | - -

-
-

-

- > CarePlan - - -
-

- -

In the Referral response the CarePlan is a echo back to the original sender of what was received in the original request.

- {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-CarePlan , hybrid}} -

- - - -| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | -|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| CarePlan | https://simplifier.net/hl7fhirukcorer4/ukcore-careplan | | | | -| CarePlan.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c | -| CarePlan.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | | -| CarePlan.meta.lastUpdated | This MUST be populated. All resources MUST include 'lastUpdated' value, under meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | -| CarePlan.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-CarePlan | -| CarePlan.status | This MUST be populated with ‘completed’ - FIXED VALUE | MUST | 1..1 | completed | -| CarePlan.intent | This MUST be populated with ‘plan’ - FIXED VALUE | MUST | 1..1 | plan | -| CarePlan.subject | | MUST | 1..1 | | -| CarePlan.subject.reference | This MUST be populated with a reference to the Patient resource | MUST | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 | -| CarePlan.encounter | | MUST | 0..1 | | -| CarePlan.encounter.reference | This MUST be populated with a reference to the sender's Encounter resource | MUST | 1..1 | urn:uuid:b83d13e2-8c2e-422c-88ac-63b8e86a4413 | -| CarePlan.period | | MUST | 0..1 | | -| CarePlan.period.start | This MUST be populated with the date/time the triage Disposition was identified | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | -| CarePlan.activity | This MUST be populated with the action to occur as part of the plan | MUST | 0..* | | -| CarePlan.activity.outcomeCodeableConcept | This MUST be populated with the triage outcomes | MUST | 0..* | | -| CarePlan.activity.outcomeCodeableConcept.text | This MUST be populated with the clinical narrative. | MUST | 0..1 | CONSULTATION SUMMARY
PRINTED ON 30/03/2022 09:53:52
CASE ID: d7e773ac-7710-42d9-849d-bf83119c3549
NHS PATHWAYS R32.1.0_internalV1 (Alpha)

PATIENT: Julie Jones
TELEPHONE:
AGE GROUP: Adult
GENDER: Female
PARTY: 1
POSTCODE: DH1 2HP
NOTES:

SKILLSET: 111 Call Handler
CALL HANDLER USER ID: sam.harris@nhs.net
PATHWAY: PW1267 - Hand or Wrist Injury, Blunt
SYMPTOM GROUP: SG1107 - Hand or Wrist Injury, Blunt
SYMPTOM DISCRIMINATOR: SD4500 - ED fracture and or dislocation
DISPOSITION: Dx02 - The individual needs to be referred to a treatment centre within 1 hour.
SELECTED CARE SERVICE: 119857, ED: University Hospital North Durham (Durham), University Hospital of North Durham, North Road, Durham, DH1 5TW0191 3332333

CONSULTATION SUMMARY:

Injury, illness or other health problem
Injury within 7 days - Suspected broken wrist
Warm to touch
New limb deformity

PATHWAYS ASSESSMENT:

An injury, illness or health problem was the reason for the contact.
There was no blood loss.
An injury or symptom relating to an injury was the main problem. - Suspected broken wrist
The injury was not minor in nature.
The individual was not fighting for breath.
The skin on the torso felt normal, warm or hot.
Major trauma had not occurred.
The problem did not result from a suicide attempt or self-harm.
The individual was not trapped at the scene.
There was no feeling of illness or other unusual symptoms before the injury.
Pathway Selected: PW1267, Hand or Wrist Injury, Blunt
The individual had no associated arm injury.
The individual was able to get up from the floor.
Injury was not restricted to the digits.
There was new limb deformity.
The hand had not become cold, pale, blue or grey.

ADVICE GIVEN:

The individual SHOULD not eat or drink anything before going to hospital (a sip of water is fine if medication needs to be taken).
Remove any jewellery or tight clothing from around the swelling.
Wrap an ice pack (or bag of frozen peas) in a cloth and put it on the area for 15-20 minutes. Repeat every 2-3 hours when awake.
If possible raise a swollen hand or wrist with a sling. When in bed raise it on pillows.
Remember to take a list of any current medications if you go to the out of hours surgery. | -| CarePlan.activity.outcomeCodeableConcept.coding | This SHOULD be populated with the triage outcome codes | SHOULD | 0..1 | | -| CarePlan.activity.outcomeCodeableConcept.coding.system | This SHOULD be populated as follows:
* Pathways Symptom Group (SG) code use ‘https://fhir.nhs.uk/Id/pathways-sg-code’ value
* Pathways Symptom Discriminator (SD) code use ‘https://fhir.nhs.uk/Id/pathways-sd-code’ value
* Pathways Disposition (DX) code use ‘https://fhir.nhs.uk/Id/pathways-dx-code’ value | SHOULD | 0..1 | https://fhir.nhs.uk/CodeSystem/sd-codes | -| CarePlan.activity.outcomeCodeableConcept.coding.code | This SHOULD be populated as follows:
When you are passing an SG code this MUST be populated with the SG code When you are passing an SD code this MUST be populated with the SG code When you are passing an Dx code this MUST be populated with the Dx code | SHOULD | 0..1 | SD4500 | -| CarePlan.activity.outcomeCodeableConcept.coding.display | This SHOULD be populated as follows:
When you are passing an SG code this MUST be populated the SG code description
When you are passing an SD code this MUST be populated the SD code description
When you are passing an Dx code this MUST be populated the Dx code description | SHOULD | 0..1 | ED fracture and or dislocation | - - -

-
-

-

- > Patient -

This resource is used to communicate details about the patient who is the subject of the referral.
It also includes contact information for third parties when required.

- {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient , hybrid}} -

- - -| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | -|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Patient | https://simplifier.net/hl7fhirukcorer4/ukcore-patient | | | | -| Patient.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 9589fb37-87a2-48d8-968f-b371429208a8 | -| Patient.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | | -| Patient.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient | -| Patient.meta.LastUpdate | This MUST be populated. All resources MUST include 'lastUpdated' value, under meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | -| Patient.identifier | | SHOULD | 0..* | | -| Patient.identifier.system | This SHOULD be populated with namespace for the Identifier | SHOULD | 1..1 | https://fhir.nhs.uk/Id/nhs-number | -| Patient.identifier.value | This SHOULD be populated with a human readable patient identifier. When used this MUST be populated with the NHS number when available.If no NHS number is available this SHOULD be populated with the Local patient identifier. | SHOULD | 1..1 | 3478526985 | -| Patient.identifier.extension | This extension is used to record the NHS number Verification status | SHOULD | 0..* | | -| Patient.identifier.extension.url | This SHOULD be populated. Where used this MUST be populated with Structure Definition 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus' - FIXED VALUE | SHOULD | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus | -| Patient.identifier.extension.valueCodeableConcept | | SHOULD | 0..1 | | -| Patient.identifier.extension.valueCodeableConcept.coding | | SHOULD | 0..1 | | -| Patient.identifier.extension.valueCodeableConcept.coding.system | This SHOULD be populated. Where used this MUST be populated with CodeSystem - 'https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus' - FIXED VALUE | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus | -| Patient.identifier.extension.valueCodeableConcept.coding.code | This SHOULD be populated. Where used this MUST either be number-present-and-verified or no NHS number MUST be sent, no other status is valid | SHOULD | 0..1 | number-present-and-verified | -| Patient.identifier.extension.valueCodeableConcept.coding.display | This SHOULD be populated. Where used this MUST either be populated with 'Number present and-verified' no other status is valid | MAY | 0..1 | Number present and verified | -| Patient.name | | SHOULD | 0..* | | -| Patient.name.use | Follow UK Core guidance for populating this element | SHOULD | 0..1 | official | -| Patient.name.text | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Mrs Julie Jones | -| Patient.name.family | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Jones | -| Patient.name.given | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Julie | -| Patient.name.prefix | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Mrs | -| Patient.gender | Follow UK Core guidance for populating this element | SHOULD | 0..1 | female | -| Patient.birthDate | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 1959-05-04 | -| Patient.address | | SHOULD | 0..* | | -| Patient.address.use | This SHOULD be populated. Where used 'home' MUST only be used for the patient's official residing address. 'temp' is used for alternative current locations with an address format, otherwise, a Location resource can be used to pinpoint a location without a building address | SHOULD | 0..1 | home | -| Patient.address.type | Follow UK Core guidance for populating this element | SHOULD | 0..1 | both | -| Patient.address.text | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 22 Brightside Crescent, Overtown, West Yorkshire, LS10 4YU | -| Patient.address.line | Follow UK Core guidance for populating this element | SHOULD | 0..* | 22 Brightside Crescent | -| Patient.address.city | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Overtown | -| Patient.address.district | Follow UK Core guidance for populating this element | SHOULD | 0..1 | West Yorkshire | -| Patient.address.postalCode | Follow UK Core guidance for populating this element | SHOULD | 0..1 | LS10 4YU | -| Patient.contact | This MUST be used to record telecom information for the patient and/or the patient's representative for the encounter | MUST | 0..* | | -| Patient.contact.extension | | MUST | 0..* | | -| Patient.contact.extension.url | This MUST be populated with Structure Definition 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank' - FIXED VALUE | MUST | 0..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank | -| Patient.contact.extension.urlvaluePositiveInt | This MUST be populated with the rank of the whole contact and MUST be populated with the value '1' for the primary person to contact for referral. There MUST be at least one contact for the referral. | MUST | 0..1 | 1 | -| Patient.contact.relationship | | MUST | 0..* | | -| Patient.contact.relationship.coding | | MUST | | | -| Patient.contact.relationship.coding.system | This MUST be populated with the CodeSystem from the ValueSet 'https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-personrelationshiptype'.
Where the contact details relate to the patient this relationship MUST be populated with the value 'self'.
Where the contact details relate to a patient's representative this SHOULD be populated with their relationship to the patient.
If the relationship is not known this SHOULD be populated with the value 'Unknown' | MUST | 0..1 | http://terminology.hl7.org/CodeSystem/v2-0131 | -| Patient.contact.relationship.coding.code | This MUST be populated with Code of CodeSystem value. See ValueSet 'https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-personrelationshiptype'. | MUST | 0..1 | EP | -| Patient.contact.relationship.coding.display | This MUST be populated with Display of CodeSystem value. See ValueSet 'https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-personrelationshiptype'. | MUST | 0..1 | EP | -| Patient.contact.name | | SHOULD | 0..1 | | -| Patient.contact.name.family | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | Grayson | -| Patient.contact.name.given | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | Jack | -| Patient.contact.telecom | | SHOULD | 0..* | | -| Patient.contact.telecom.system | This MUST be populated for the rank 1 contact. There MUST be at least one contact phone number for the referral | MUST | 0..1 | phone | -| Patient.contact.telecom.value | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | 0789 1234567 | -| Patient.contact.gender | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | male | -| Patient.Communication | | SHOULD | 0..* | | -| Patient.Communication.Language | | SHOULD | 1..1 | | -| Patient.Communication.Language.coding | | SHOULD | 1..1 | | -| Patient.Communication.Language.coding.code | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | en | -| Patient.Communication.Language.coding.system | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage | -| Patient.Communication.Language.coding.display | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | English | -| Patient.Communication.Language.preferred | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | TRUE | -| Patient.extension | | SHOULD | 0..* | | -| Patient.extension.url | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory | -| Patient.extension.valueCodeableConcept | | SHOULD | 0..1 | | -| Patient.extension.valueCodeableConcept.coding | | SHOULD | 0..* | | -| Patient.extension.valueCodeableConcept.coding.system | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategory | -| Patient.extension.valueCodeableConcept.coding.code | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | A | -| Patient.extension.valueCodeableConcept.coding.display | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | British, Mixed British | -| Patient.generalPractitioner | This SHOULD be populated with a reference to the GP Surgery ONLY rather than a specific practitioner | SHOULD | 0..* | | -| Patient.generalPractitioner.reference | This SHOULD be populated. Where populated this MUST reference to an Organisation resource | SHOULD | 1..1 | urn:uuid:b83d13e2-8c2e-422c-88ac-63b8e86a4411 | - - - -

-

-

- > Organization -

This resource is used to communicate details about the sender and receiver organisations.

- {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization , hybrid}} -

- -| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | -|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Organisation | https://simplifier.net/hl7fhirukcorer4/ukcore-organization | | | | -| Organisation.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 5d897313-c62d-4e7e-92b7-b2199804fed3 | -| Organisation.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | | -| Organisation.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization | -| Organisation.meta.lastUpdated | This MUST be populated. All resources MUST include 'lastUpdated' value, under meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | -| Organisation.identifier | This MUST be populated with an organisation identifier e.g. ODS code | MUST | 0..* | | -| Organisation.identifier.system | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | https://fhir.nhs.uk/id/ods-organization-code | -| Organisation.identifier.value | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | ABD01 | -| Organisation.name | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | Organisation name | - - - - -

-

- -

- > Practitioner -

This is used to carry details of the healthcare professional making the referral

- {{tree:https://simplifier.net/hl7fhirukcorer4/ukcore-practitioner , hybrid}} -

- -| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | -|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Practitioner | https://simplifier.net/hl7fhirukcorer4/ukcore-practitioner | | 1..* | | -| Practitioner.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 51182cb1-b199-4222-85f5-16d5428f6358 | -| Practitioner.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | | -| Practitioner.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner | -| Practitioner.meta.lastUpdated | This MUST be populated. All resources MUST include 'lastUpdated' value, under meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | -| Practitioner.identifier | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..* | | -| Practitioner.identifier.system | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | https://fhir.nhs.uk/Id/sds-role-profile-id | -| Practitioner.identifier.value | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | PT2489 | -| Practitioner.name | | SHOULD | 0..* | | -| Practitioner.name.family | Follow UK Core guidance for populating this element | SHOULD | 0..1 | BLAKE | -| Practitioner.name.given | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Marcy | -| Practitioner.telecom | | SHOULD | 0..* | | -| Practitioner.telecom.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | phone | -| Practitioner.telecom.value | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 0205568263 | -| Practitioner.telecom.use | Follow UK Core guidance for populating this element | SHOULD | 0..1 | work | - - - -

-

- -

- > Practitioner Role -

This is used to carry the role of the practitioner making the referral. Note this may be the call handler

- {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole , hybrid}} -

- - -| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | -|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| PractitionerRole | https://simplifier.net/hl7fhirukcorer4/ukcore-practitionerrole | | 1..* | | -| PractitionerRole.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 1801e180-e6a1-4753-8a55-ab2d1cff6549 | -| PractitionerRole.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | | -| PractitionerRole.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole | -| PractitionerRole.meta.lastUpdated | This MUST be populated. All resources MUST include 'lastUpdated' value, under meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | -| PractitionerRole.practitioner | | MUST | 0..1 | | -| PractitionerRole.practitioner.reference | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | urn:uuid:7d948662-bade-450e-b6c5-9bb6ee39cb56 | -| PractitionerRole.Organisation | | MUST | 0..1 | | -| PractitionerRole.Organisation.reference | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | urn:uuid:7d948662-bade-450e-b6c5-9bb6ee39cb51 | -| PractitionerRole.code | | SHOULD | 0..* | | -| PractitionerRole.code.coding | This SHOULD be populated when indicating the roles a practitioner can perform | SHOULD | 1..1 | | -| PractitionerRole.code.coding.system | This MUST be populated with the CodeSystem from the ValueSet 'https://fhir.hl7.org.uk/ValueSet/UKCore-PractitionerRoleCode' - FIXED VALUE | SHOULD | 0..1 | https://fhir.hl7.org.uk/ValueSet/UKCore-PractitionerRoleCode | -| PractitionerRole.code.coding.code | This MUST be populated with Code of CodeSystem value. See ValueSet 'https://fhir.hl7.org.uk/ValueSet/UKCore-PractitionerRoleCode'. | SHOULD | 0..1 | 224508005 | -| PractitionerRole.code.coding.display | This MUST be populated with Display of CodeSystem value. See ValueSet 'https://fhir.hl7.org.uk/ValueSet/UKCore-PractitionerRoleCode'. | SHOULD | 0..1 | Administrative healthcare staff | - - -

-

- -

- > Flag -

In the Referral response the Flag is a echo back to the original sender of what was received in the original request.

- {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance , hybrid}} -

- - - -| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | -|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Flag | https://www.hl7.org/fhir/flag.html | | 0..* | | -| Flag.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 77be46e3-7f01-4afe-b37d-7a301db6df63 | -| Flag.meta | https://www.hl7.org/fhir/resource.html#Meta | | 1..1 | | -| Flag.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | http://hl7.org/fhir/StructureDefinition/Flag | -| Flag.meta.lastUpdated | This MUST be populated. All resources MUST include 'lastUpdated' value, under meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | -| Flag.status | A status of 'active' MUST be assigned | MUST | 1..1 | active | -| Flag.category | | MUST | 0..* | | -| Flag.category.coding | This MUST be populated with the overarching Flag Category: e.g. Safeguarding, Reasonable Adjustment, Rejected Services from CodeSystem 'https://fhir.nhs.uk/CodeSystem/flag-categories-bars' | MUST | 1..1 | | -| Flag.category.coding.system | This MUST be populated with 'https://fhir.nhs.uk/CodeSystem/flag-categories-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/flag-categories-bars | -| Flag.category.coding.code | This MUST be populated with the Code of the Flag Category. See CodeSystem https://fhir.nhs.uk/CodeSystem/flag-categories-bars | MUST | 0..1 | RA | -| Flag.category.coding.display | This MUST be populated with the Display of the Flag Category. See CodeSystem https://fhir.nhs.uk/CodeSystem/flag-categories-bars | MUST | 0..1 | Reasonable Adjustment | -| Flag.code | | MUST | 1..1 | | -| Flag.code.coding | This MUST be populated with the detail of what is being flagged in Flag Category. e.g. for Reasonable Adjustment (Flag Category): 'adjustforneedlephobia'(Code) 'Adjust for needle phobia'(Display). It would not be appropriate to indicate a Category of 'Safeguarding' and a Code of 'Reasonable Adjustment'. The Category and Code MUST correlate. | MUST | 1..1 | | -| Flag.code.coding.system | This MUST be populated with the Coding System for what is being flagged e.g. https://fhir.nhs.uk/CodeSystem/reasonable-adjustment-codes-bars | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/reasonable-adjustment-codes-bars | -| Flag.code.coding.code | This MUST be populated with the relevant Code from the selected Flag code CodeSystem | MUST | 0..1 | adjustforneedlephobia | -| Flag.code.coding.display | This MUST be populated with the Display text from the Flag code CodeSystem | MUST | 0..1 | Adjust for needle phobia | -| Flag.subject | | MUST | 1..1 | | -| Flag.subject.reference | This MUST be populated with the subject that the flag refers to. Where the flag relates to the patient (e.g. reasonable adjustments) this will reference the Patient resource | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 | -| Flag.period | | SHOULD | 0..1 | | -| Flag.period.start | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | -| Flag.period.end | Follow UK Core guidance for populating this element | MAY | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | - - - -

-

-

- > Questionnaire Response -

This resource is used to communicate links to external sources of clinical information used in the triage/assessment of the patient that would be useful to the recipient.

- {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse , hybrid}} - - -| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | -|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| QuestionnaireResponse | This resource is used to communicate links to external sources of clinical information used in the triage/assessment of the patient that would be useful to the recipient.

https://simplifier.net/hl7fhirukcorer4/ukcore-questionnaireresponse | | 0..* | | -| QuestionnaireResponse.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 65508934-c9e6-46d2-a393-af096b502daf | -| QuestionnaireResponse.id.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | | -| QuestionnaireResponse.id.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-QuestionnaireResponse | -| QuestionnaireResponse.lastUpdated | This MUST be populated. All resources MUST include 'lastUpdated' value, under meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | -| QuestionnaireResponse.extension | | MUST | 0..* | | -| QuestionnaireResponse.extension.url | This MUST be populated with Structure Definition 'http://hl7.org/fhir/StructureDefinition/questionnaireresponse-reason' - FIXED VALUE | MUST | 1..1 | http://hl7.org/fhir/StructureDefinition/questionnaireresponse-reason | -| QuestionnaireResponse.extension.valueCodeableConcept | | MUST | 0..* | | -| QuestionnaireResponse.extension.valueCodeableConcept.text | This MUST be populated to Indicate the type of QuestionnaireResponse e.g.
EITHER 'Rejected Services - Patient Choice in Service Selection' for Rejected Services
OR 'Additional Information Sources' for Additional Information Sources | MUST | 0..1 | Rejected Services - Patient Choice in Service Selection | -| QuestionnaireResponse.basedOn | | SHOULD | 0..* | | -| QuestionnaireResponse.basedOn.reference | This SHOULD be populated with EITHER reference to ServiceRequest for 'Rejected Services' OR CarePlan for 'Additional Information Services' | SHOULD | 0..1 | urn:uuid:236bb75d-90ef-461f-b71e-fde7f899802c | -| QuestionnaireResponse.subject | Follow UK Core guidance for populating this element | MUST | 0..1 | | -| QuestionnaireResponse.subject.reference | Flag resource for 'Rejected Services' or Patient for 'Additional Information Services' | MUST | 0..1 | urn:uuid:41e591ab-d333-4fb8-87b4-d35f740b6bfc | -| QuestionnaireResponse.authored | Date/Time added during encounter | MAY | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | -| QuestionnaireResponse.author | Follow UK Core guidance for populating this element | SHOULD | 0..1 | | -| QuestionnaireResponse.author.reference | This SHOULD be populated with a reference to the Practitioner who created as part of the assessment | SHOULD | 0..1 | urn:uuid:7d948662-bade-450e-b6c5-9bb6ee39cb56 | -| QuestionnaireResponse.source | Follow UK Core guidance for populating this element | SHOULD | 0..1 | | -| QuestionnaireResponse.source.reference | This SHOULD be populated with a Reference to the Patient resource when they are answering the questions. Otherwise, for 3rd parties, it would require a Reference to the RelatedPerson resource | SHOULD | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 | -| QuestionnaireResponse.item | This MUST be populated with the overarching Item array | MUST | 0..* | | -| QuestionnaireResponse.item.linkid | This MUST be populated with the type of item EITHER 'RejectedServices' OR 'AdditionalSources' | MUST | 1..1 | RejectedServices | -| QuestionnaireResponse.item.text | This MUST be populated with a description of item | MUST | 0..1 | RejectedServices | -| QuestionnaireResponse.item.item | This MUST be populated with the Specific Item | MUST | 0..* | | -| QuestionnaireResponse.item.item.linkid | Thid MUST be populated with EITHER Service for 'RejectedServices' OR Source for 'AdditionalSources' | MUST | 1..1 | Service1 | -| QuestionnaireResponse.item.item.item | This MUST be populated with the Elements within the above 'item' within an array e.g. EITHER DoS Service Id, DoS Service Name, Reject Reason and Rejection Comment for 'RejectedServices' OR Additional Source Name (e.g. MIG) and Additional Source URL for 'AdditionalSources' | MUST | 0..1 | | -| QuestionnaireResponse.item.item.item.linkid | This MUST be populated with EITHER the ServiceId for 'RejectedServices' OR SourceName for 'AdditionalSources'. In the case of 'AdditionalSources', this could either be 3rd party source i.e. Graphnet or a local Special-Patient-Note (SPN) | MUST | 1..1 | ServiceId | -| QuestionnaireResponse.item.item.item.answer | This MUST be populated with the Specific answer | MUST | 0..* | | -| QuestionnaireResponse.item.item.item.answer.valueString | This MUST be populated with the answer Value for the item declared above EITHER the DoS Service Id for 'RejectedServices' OR Source name e.g. 'Graphnet' for 'AdditionalSources' | MUST | 0..1 | 200000359 | - - - -
-

-

- > Observation -

This resource can be used to communicate measurements and simple assertions made about a patient.

- {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation , hybrid}} - - -| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | -|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Observation | https://simplifier.net/hl7fhirukcorer4/ukcoreobservation | | 0..* | | -| Observation.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | e3dd3833-5622-4cdd-bddf-97942c58d190 | -| Observation.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | | -| Observation.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation | -| Observation.meta.lastUpdated | This MUST be populated. All resources MUST include 'lastUpdated' value, under meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | -| Observation.status | This SHOULD be populated and set to FINAL. | SHOULD | 1..1 | final | -| Observation.code | | SHOULD | 1..1 | | -| Observation.code.text | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | Expectations and wishes | -| Observation.performer | | SHOULD | 0..* | | -| Observation.performer.reference | This SHOULD be populated. Where populated this MUST reference to a Practitioner resource | SHOULD | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 | -| Observation.subject | | MUST | 0..1 | | -| Observation.subject.reference | This MUST be populated. Where populated this MUST reference to a Patient resource | MUST | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 | -| Observation.encounter | | MUST | 0..1 | | -| Observation.encounter.reference | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | urn:uuid:8c63d621-4d86-4f57-8699-e8e22d49935d | -| Observation.effectiveDateTime | Follow UK Core guidance for populating this element | MAY | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | - - - -
-

-

- > Appointment -

This resource can be used to communicate information about an appointment slot

- {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment , hybrid}} - -| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | -|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Appointment | https://simplifier.net/hl7fhirukcorer4/ukcore-appointment | | | | -| Appointment.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | | | 3713c8fc-dbcf-4f90-bacf-89d99e434e9b | -| Appointment.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | | -| Appointment.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment | -| Appointment.meta.lastupdated | This MUST be populated. All resources MUST include 'lastUpdated' value, under meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | -| Appointment.status | This MUST be populated with 'noshow' - FIXED VALUE | MUST | 1..1 | noshow | -| Appointment.description | This SHOULD be populated. It is the human readable description of the booking | SHOULD | 0..1 | Reason for calling | -| Appointment.start | This MUST be populated with the Start time of the booking | MUST | 1..1 | 2021-10-12T12:30:00+00:00 | -| Appointment.end | This MUST be populated with the End time of the booking | MUST | 1..1 | 2021-10-12T12:30:00+00:00 | -| Appointment.slot | | MUST | 1..1 | | -| Appointment.slot.reference | This MUST be populated with the local logical bundle reference to the Slot resource | MUST | 1..1 | urn:uuid:c3f6145e-1a26-4345-b3f2-dccbcba62049 | -| Appointment.created | This MUST only be populated with the date/time the booking was generated by the Receiver. | MUST | 0..1 | 2021-10-11T15:01:30+00:00" | -| Appointment.basedOn | This MUST be populated with the Service Request | MUST | 0..1 | | -| Appointment.basedOn.reference | This MUST be populated with the Service Request local logical bundle reference | MUST | 0..1 | ServiceRequest/236bb75d-90ef-461f-b71e-fde7f899802c | -| Appointment.basedOn.type | UKCore | SHOULD | 1..1 | serviceRequest | -| Appointment.participant | | MUST | 1..1 | | -| Appointment.participant.actor | This MUST be populated with reference to the patient | MUST | 1..1 | | -| Appointment.participant.actor.reference | This MUST be populated with the local logical bundle reference to the Patient resource | MUST | 1..1 | urn:uuid:3a62607b-df65-4932-940c-14262787f62d | -| Appointment.participant.actor.status | This MUST be populated with 'accepted' - FIXED VALUE | | 1..1 | accepted | - - - -
-
-

- -
\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/toc.yaml index 9c7a2ff3..d2666a3b 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/toc.yaml +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/toc.yaml @@ -12,7 +12,5 @@ filename: Booking-Request-Payload.page.md - name: Entity Relationship Diagrams filename: Entity-Relationship-Diagrams.page.md -- name: - filename: Referral-Response-Payload.page.md - name: filename: Service-Request2.page.md \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md index f9526996..5606acf0 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md @@ -382,7 +382,7 @@ Receive_Request if (Message == "update") { - if (currentLocalData.LastUpdated > originaRequest.ReceivedDate) + if (currentLocalData.LastUpdated > originalRequest.ReceivedDate) { OperationOutcome.issue.code = "conflict" throw exception with 'REC_CONFLICT' @@ -393,7 +393,7 @@ Receive_Request { if (currentLocalData.Item.exists) { - if (currentLocalData.LastUpdated > originaRequest.Received) + if (currentLocalData.LastUpdated > originalRequest.Received) { OperationOutcome.issue.code = "conflict" throw exception with 'REC_CONFLICT' @@ -521,7 +521,20 @@ This means that these services will only accept a referral if a booking has also If no appointment is available then a referral should not be made. -To achieve this, a "service attribute" is configurable against services. This will allow the service to be flagged as "booking only". Therefore if this attribute is present on the service all consumer systems should withhold referrals. The DoS API documentation for this can be found here. +To achieve this, a "service attribute" is configurable against services. This will allow the service to be flagged as "booking only". Therefore if this attribute is present on the service all consumer systems should withhold referrals. The DoS API documentation for this can be found here. + + ##### Workflow @@ -550,6 +563,6 @@ This attribute will have three possible states: * present and false * present and true -For the first two cases, it can be assumed that referrals can be made without a booking. Only if the attribute is *present* **and** *true* should a referral be witheld if there has been no booking. +For the first two cases, it can be assumed that referrals can be made without a booking. Only if the attribute is *present* **and** *true* should a referral be withheld if there has been no booking.
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/How-does-it-work.page.md index bee92c9d..ea604dd0 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/How-does-it-work.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/How-does-it-work.page.md @@ -16,10 +16,23 @@ To support the workflows for this application of the standard the operations tha ### Find a Service -The BaRS referral process as shown above does not include guidance on how a user should determine if a referral to Pharmacy is appropriate for the patient. It is the responsibility of the referring organisaton to ensure patients are pre-screened by GP Practice staff (care navigators or clinicians) prior to beginning the referral process, using their own judgement or an appropriate triage tool. +The BaRS referral process as shown above does not include guidance on how a user should determine if a referral to Pharmacy is appropriate for the patient. It is the responsibility of the referring organisation to ensure patients are pre-screened by GP Practice staff (care navigators or clinicians) prior to beginning the referral process, using their own judgement or an appropriate triage tool. #### Directory of Services API + + Pharmacy services are profiled on the Directory of Services (DoS). For this application, systems should use the Directory of Services - Urgent and Emergency Care - REST API. @@ -27,7 +40,7 @@ For this application, systems should use the Search by Service Type | docs-dos-api (developer.nhs.uk). +Search by Service Type. #### Guidance on how to call the DoS API @@ -46,7 +59,7 @@ The search parameters to be used are as follows: Parameter Type Required? - GP to Pharamcy Guidance Notes + GP to Pharmacy Guidance Notes @@ -517,7 +530,7 @@ Receive_Request if (Message == "update") { - if (currentLocalData.LastUpdated > originaRequest.ReceivedDate) + if (currentLocalData.LastUpdated > originalRequest.ReceivedDate) { OperationOutcome.issue.code = "conflict" throw exception with 'REC_CONFLICT' @@ -528,7 +541,7 @@ Receive_Request { if (currentLocalData.Item.exists) { - if (currentLocalData.LastUpdated > originaRequest.Received) + if (currentLocalData.LastUpdated > lRequest.Received) { OperationOutcome.issue.code = "conflict" throw exception with 'REC_CONFLICT' diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Scope-and-Requirements.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Scope-and-Requirements.page.md index aa6334bd..b70faa78 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Scope-and-Requirements.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Scope-and-Requirements.page.md @@ -16,7 +16,7 @@ The payload and workflow have been designed to support this service. Other {{pag ### Functional Scope **Service Discovery** - Establishing a service to direct requests to is a mandatory step in the workflow -- There is no restriction on the service discovery tools used. Any are capable of being supported whether national or proprietary. However, the NHS England Directory of Services supports this application and futher details are provided in the 'Find a Service' section +- There is no restriction on the service discovery tools used. Any are capable of being supported whether national or proprietary. However, the NHS England Directory of Services supports this application and further details are provided in the 'Find a Service' section - The service **must** be configured within the BaRS infrastructure (Endpoint Catalogue) before requests can be made **Referral** @@ -32,7 +32,7 @@ The payload and workflow have been designed to support this service. Other {{pag - Consent within BaRS will be for Direct-Care only - Certificates for Receiving messages to use nhs.uk domains only - Receiving endpoints are to be internet facing -- Clincial Constraints exist - See Hazard Log +- Clinical Constraints exist - See Hazard Log - No element level 'updates' to requests are supported. A new request must be generated to change information in the referral request - Where an Online Consultation tool is used to refer, the referral must be verified by a human representative of the sending organisation before the request is made - Referrals to the Oral Contraception service must adhere to the [published policy specification](https://www.england.nhs.uk/long-read/nhs-pharmacy-contraception-service/) @@ -78,7 +78,7 @@ The payload and workflow have been designed to support this service. Other {{pag **Re-refer** - The referral Sender **must** be capable of re-referring within the current consultation or after the consultation event -- If the patient recontacts the sending service after the sender's consultation has been completed, the patient **should** be reassessed prior to attempting to re-refer +- If the patient re-contacts the sending service after the sender's consultation has been completed, the patient **should** be reassessed prior to attempting to re-refer - The referral Sender **should** revoke the original referral prior to making a re-referral, whether within the current consultation or after the consultation event - Where the re-referral was not successful, the Receiver **must** send an appropriate response. See {{pagelink:core-failure_scenarios-1.4.1, text:failure scenarios}} for more detail. - Where the re-referral was not successful, the Sender **must** present an appropriate message to the end user. See {{pagelink:core-failure_scenarios-1.4.1, text:failure scenarios}} for more detail. 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 85750b0c..07b483db 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 @@ -10,8 +10,12 @@ This section describes how the primary operations used in this application work. * CAD to CAD Mutual Aid Request
- - + + + +
+ +
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Response-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Response-Payload.page.md index b32d8b92..4963b4c3 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Response-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Response-Payload.page.md @@ -10,8 +10,9 @@ This payload is used to communicate the following: * Business acknowledgement of the receipt and progression of a case through status updates * When a case has been accepted and is waiting for a resource to be allocated * When a case has a resource allocated + * When a case has a resource arrive * When a resource for a case is cancelled - * When a resource has cleared the scene + * When a resource has completed the case * When a case has been rejected by the Receiver (Mutual Aid Request and Call Assist Request ONLY) @@ -160,7 +161,7 @@ ONLY) | Encounter.id | MUST only be generated by the originating system of the encounter as the id for the resource in the original HTTP request. It MUST be echoed back when returning an encounter. Subsequent new Encounters will be generated by the originating system of that encounter. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c | | Encounter.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | | | Encounter.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter | -| Encounter.status | The status must be set to the current Encounter status:

- When the case is waiting for a resource to be allocated OR a resource has been cancelled, this MUST be populated with 'planned'
- When the case has had a resource allocated this MUST be populated with 'in-progress'
- For a case where the resource has cleared the scene this MUST be populated with 'finished'
- Where a Mutual Aid or Call Assist request is being rejected, this MUST be populated with 'cancelled' | MUST | 1..1 | in-progress | +| Encounter.status | The status must be set to the current Encounter status:

- When the case is waiting for a resource to be allocated OR a resource has been cancelled, this MUST be populated with 'planned'
- When the case has had a resource allocated this MUST be populated with 'in-progress'
- For a case where a resource has arrived on scene this MUST be populated with ‘arrived’
- For a case where the resource has cleared the scene this MUST be populated with 'finished'
- Where a Mutual Aid or Call Assist request is being rejected, this MUST be populated with 'cancelled' | MUST | 1..1 | in-progress | | Encounter.statusHistory | List of past and current encounter statuses. These SHOULD NOT be populated in the Receiver's Encounter and asynchronous responses. | SHOULD NOT | 0..* | | | Encounter.statusHistory.status |
This SHOULD NOT be populated in the Receiver's response Encounter. | SHOULD NOT | 1..1 | | | Encounter.statusHistory.period |
This SHOULD NOT be populated in the Receiver's response Encounter. | SHOULD NOT | | | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md index 5d89bce5..ca4bd8b2 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md @@ -23,7 +23,7 @@ topic: Application8 Application 8 v1.0.0-alpha.2 v1.1.x - v1.11.1 + v1.11.1 v1.4.x diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md index 8aebc38f..b639bcd4 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md @@ -49,7 +49,7 @@ The Task is used to direct the next action(s) required by the Sender making the ### Flag Resource The Flag resource is used to communicate prospective warnings of potential issues when providing care to the patient. The population of the Flag Resource is optional as not all subjects will have relevant issues. -BaRS Senders **should** populate Flag resources and **should** make adequate provision in their solution to support key flags in BaRS Application workflows, for example, Additional Patient Information. When populating this resource, Senders **must** include both *flag.category* and *flag.code* values using the specific [BaRS CodeSystems](https://simplifier.net/nhsbookingandreferrals/~resources?category=CodeSystem&sortBy=DisplayName). +BaRS Senders **should** populate Flag resources and **should** make adequate provision in their solution to support key flags in BaRS Application workflows, for example, [Additional Patient Information](https://simplifier.net/NHSBookingandReferrals/01dcdcbb-93c0-4418-a5f5-d8b2573d4866). When populating this resource, Senders **must** include both *flag.category* and *flag.code* values using the specific [BaRS CodeSystems](https://simplifier.net/nhsbookingandreferrals/~resources?category=CodeSystem&sortBy=DisplayName). When a BARS Receiver processes information in a Flag resource; diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md index 62c486f8..5c28aea3 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md @@ -133,7 +133,7 @@ This payload is used to transmit all the necessary information that is required | ServiceRequest.subject.reference | This MUST be populated. Follow BaRS profile guidance for populating this element | MUST | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 | | ServiceRequest.encounter | | MUST | 0..1 | | | ServiceRequest.encounter.reference | This MUST be populated with a Reference to the Encounter resource | MUST | 0..1 | urn:uuid:8c63d621-4d86-4f57-8699-e8e22d49935d | -| ServiceRequest.occurencePeriod | Timeframe within which pharmacy must manage the referral (Urgency) | MAY | 0..1 | | +| ServiceRequest.occurencePeriod | Timeframe within which the referral must be managed (Urgency) | MAY | 0..1 | | | ServiceRequest.occurrencePeriod.start | This SHOULD be populated. The start of the period MUST be ‘now’. | SHOULD | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | | ServiceRequest.occurrencePeriod.end | This SHOULD be populated with the time by which the next service provision SHOULD have started (this aligns with the disposition timeframe from Pathways) | SHOULD | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | | ServiceRequest.authoredOn | This MUST be populated with the date time the request transitioned to being actionable. In case it's 'blank' the date time SHOULD fall back to the submission time/system time of the SENDING system. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | @@ -244,8 +244,8 @@ This payload is used to transmit all the necessary information that is required | Patient.identifier.extension.valueCodeableConcept | | MUST | 0..1 | | | Patient.identifier.extension.valueCodeableConcept.coding | | MUST | 0..* | | | Patient.identifier.extension.valueCodeableConcept.coding.system | This SHOULD be populated. Where used this MUST be populated with CodeSystem - 'https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus' - FIXED VALUE | MUST | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus | -| Patient.identifier.extension.valueCodeableConcept.coding.code | This SHOULD be populated. Where used this MUST be 'number-present-and-verified' or 'number-present-but-not-traced', else no NHS number MUST be sent. No other statuses are permitted. | MUST | 0..1 | number-present-and-verified | -| Patient.identifier.extension.valueCodeableConcept.coding.display | This SHOULD be populated. Where used this MUST be populated with 'Number present and verified' or 'Number present but not traced'. No other statuses are permitted. | MUST | 0..1 | Number present and verified | +| Patient.identifier.extension.valueCodeableConcept.coding.code | This SHOULD be populated. Where used this MUST be 'number-present-and-verified' else no NHS number MUST be sent. No other statuses are permitted. | MUST | 0..1 | number-present-and-verified | +| Patient.identifier.extension.valueCodeableConcept.coding.display | This SHOULD be populated. Where used this MUST be populated with 'Number present and verified'. No other statuses are permitted. | MUST | 0..1 | Number present and verified | | Patient.name | | SHOULD | 0..* | | | Patient.name.use | Follow UK Core guidance for populating this element | SHOULD | 0..1 | official | | Patient.name.text | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Mrs Julie Jones | @@ -340,10 +340,10 @@ This payload is used to transmit all the necessary information that is required | Task.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under meta section which must be the same timestamp for each resource when created from new, but must be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | | Task.status | This MUST be populated with 'requested' - Fixed Value | MUST | 1..1 | requested | | Task.intent | This MUST be populated with 'order' - Fixed Value | MUST | 1..1 | order | -| Task.code | This MUST be populated with the action (by the specific Pharmacy Service (Referral Type)) the Sender is requesting of the Receiver. If multiple actions (which are to occur within different timeframes) are to be requested these would be represented in independent Task resources. | MUST | 0..1 | | +| Task.code | This MUST be populated with the action the Sender is requesting of the Receiver. If multiple actions (which are to occur within different timeframes) are to be requested these would be represented in independent Task resources. | MUST | 0..1 | | | Task.code.coding.system | This MUST be populated with CodeSystem - http://snomed.info/sct | MUST | 0..1 | http://snomed.info/sct | -| Task.code.coding.code | This MUST be populated with the Code (SNOMED) of action by the Pharmacy Service | MUST | 0..1 | 792891000000102 | -| Task.code.coding.display | This MUST be populated with the human readable Display (SNOMED) of action by the Pharmacy Service | MUST | 0..1 | Inbound referral | +| Task.code.coding.code | This MUST be populated with the Code (SNOMED) of action | MUST | 0..1 | 792891000000102 | +| Task.code.coding.display | This MUST be populated with the human readable Display (SNOMED) of action | MUST | 0..1 | Inbound referral | | Task.description | This SHOULD be populated with a human readable summary of the intended instruction of the Task, combining the key elements e.g. Task.code and Task.restriction.period | SHOULD | 0..1 | Provide healthcare service options to patient/client for selection' | | Task.encounter | | SHOULD | 0..1 | | | Task.encounter.reference | This MUST be populated with a reference to the senders Encounter | SHOULD | 0..1 | urn:uuid:b83d13e2-8c2e-422c-88ac-63b8e86a4413 | @@ -481,7 +481,7 @@ This payload is used to transmit all the necessary information that is required | Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) | |------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|-----------------------------------------------------| -| Flag | The Flag resource is used to risks and special patient requirements e.g. transport requirements, accessibility requirements, and reasonable adjustments. It can also be used to carry information about safeguarding concerns.

https://simplifier.net/hl7fhirukcorer4/ukcore-flag | | 0..* | | +| Flag | The Flag resource is used to risks and special patient requirements e.g. transport requirements, accessibility requirements, and reasonable adjustments. It can also be used to carry information about safeguarding concerns.

'https://simplifier.net/hl7fhirukcorer4/ukcore-flag' | | 0..* | | | Flag.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 77be46e3-7f01-4afe-b37d-7a301db6df63 | | Flag.meta | https://www.hl7.org/fhir/resource.html#Meta | | 1..1 | | | Flag.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | http://hl7.org/fhir/StructureDefinition/Flag | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/TKW.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/TKW.page.md index 130ca743..16ff7d5a 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/TKW.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/TKW.page.md @@ -33,7 +33,7 @@ During the registration process, the 'Target Identifier' and 'ODS Code' values a Once registered, requests can be made of TKW in any given workflow e.g. booking, validation etc. and the tool will record and provide downloadable validation reports for each request made.  -The Scenarios (including Stateful Scenarios) outlined below highlight how to elicit particular behaviour required, note the specific sentinel values for NHSD-Target-Identifier and patient NHS Number. As a Sender, the various requests can be made and TKW will repond accoridngly.  +The Scenarios (including Stateful Scenarios) outlined below highlight how to elicit particular behaviour required, note the specific sentinel values for NHSD-Target-Identifier and patient NHS Number. As a Sender, the various requests can be made and TKW will respond accordingly.  NB: It is important for Senders to remember TKW is a stateless receiver and is not checking the relationship between requests (except in a handful of stateful scenarios - outlined below). This is important when developing workflows such as linking a booking and referral and transactional Integrity. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md index c55ac843..dadf8997 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md @@ -22,11 +22,11 @@ The BaRS API will facilitate the DocumentReference Endpoints for BaRS enabled sy This table describes the two endpoints behaviours for the interaction From a BaRS enabled system through to NRLF. -All Endpoints will use the exsiting Access Control Headers and Transaction Integrity Headers. +All Endpoints will use the existing Access Control Headers and Transaction Integrity Headers. | Behaviour | Initiator | VERB | API Path | Parameters | Payload | Reactor | Reactor Behaviour | Happy Response | Response Definition | |-----------------|---------------|--------|-------------------------|---------------------------------------------------------------------------------------------|-------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------------------| -| Search Pointers | BaRS Sender | GET | /DocumentReference | Query: subject:identifier
Query: custodian:identifier
Query: next-page-token
Query:type | N/A | BaRS & NRLF | BaRS: Request forwarded verbatim to NRLF Consumer Endpoint
NRLF: NRLF returns Bundle of DocumentReferences matching search critieria. | 200 | Search Bundle Response containing DocumentReferences | +| Search Pointers | BaRS Sender | GET | /DocumentReference | Query: subject:identifier
Query: custodian:identifier
Query: next-page-token
Query:type | N/A | BaRS & NRLF | BaRS: Request forwarded verbatim to NRLF Consumer Endpoint
NRLF: NRLF returns Bundle of DocumentReferences matching search criteria. | 200 | Search Bundle Response containing DocumentReferences | | Get Pointer | BaRS Receiver | GET | /DocumentReference/[id] | Path: id | N/A | BaRS & NRLF | BaRS: Request forwarded verbatim to NRLF Producer Endpoint
NRLF: NRLF returns Bundle of DocumentReference matching path param [id]. | 200 | DocumentReference | | Add Pointer | BaRS Receiver | POST | /DocumentReference | N/A | DocumentReference | BaRS & NRLF | BaRS: Request forwarded verbatim to NRLF Producer Endpoint
NRLF: returns a DocumentReference | 201 | OperationOutcome/DocumentReference | | Update Pointer | BaRS Receiver | PUT | /DocumentReference/[id] | Path: id | DocumentReference | BaRS & NRLF | BaRS: Request forwarded verbatim to NRLF Producer Endpoint
NRLF: NRLF updates the DocumentReference | 200 | OperationOutcome/DocumentReference | @@ -39,7 +39,7 @@ All Endpoints will use the exsiting Access Control Headers and Transaction Integ | /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y | | /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N | | /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N | -| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequesr | N | +| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequest | N | | /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y | ## Payload \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/EndpointCatalogue-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/EndpointCatalogue-StandardPattern/Introduction.page.md index 1f1f0108..8defaf84 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/EndpointCatalogue-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1-4-1/EndpointCatalogue-StandardPattern/Introduction.page.md @@ -5,7 +5,7 @@ topic: core-StandardPattern-Endpoint-Introduction-1.4.1