diff --git a/BaRS-Images/EntityMaps/EntityMapReferralRequest-1.0.0.svg b/BaRS-Images/EntityMaps/EntityMapReferralRequest-1.0.0.svg index b26bc3ef..9f44155c 100644 --- a/BaRS-Images/EntityMaps/EntityMapReferralRequest-1.0.0.svg +++ b/BaRS-Images/EntityMaps/EntityMapReferralRequest-1.0.0.svg @@ -1,4 +1,4 @@ - + -FHIR BundleIdGUID_1FHIR MessageHeaderFullUrlurn:uuid:GUID_2eventCodingservicerequest-request*reasonnew**focusurn:uuid:GUID_4 (ServiceRequest)destinationurn:uuid:GUID_5 (Organisation)senderurn:uuid:GUID_6 (Organisation)source.endpoint'<system>/<value>' ++FHIR OrganisationFullUrlurn:uuid:GUID_5IdGUID_002FHIR OrganisationFullUrlurn:uuid:GUID_6IdGUID_001FHIR ServiceRequestFullUrlurn:uuid:GUID_4IdGUID_003categoryreferral***subjecturn:uuid:GUID_9 (Patient)basedOnurn:uuid:GUID_29 (CarePlan)encounterurn:uuid:GUID_10 (Encounter)requesterurn:uuid:GUID_11 (Practitioner)performerurn:uuid:GUID_28 (HealthcareService)supportingInfo (Flag)urn:uuid:GUID_17 (Flag)supportingInfo (QuestionnaireResponse) urn:uuid:GUID_18 (QuestionnaireResponse)locationReferenceurn:uuid:GUID_25 (Location)FHIR PatientFullUrlurn:uuid:GUID_9IdGUID_004identifier3478526985 (NHS Number)FHIR EncounterFullUrlurn:uuid:GUID_10IdGUID_005identity(local system encounter ref)subjecturn:uuid:GUID_9 (Patient)episodeOfCareGUID_13FHIR PractitionerFullUrlurn:uuid:GUID_11IdGUID_006FHIR Flag (e.g. Rejected Services)FullUrlurn:uuid:GUID_17IdGUID_009subjecturn:uuid:GUID_9 (Patient)categorybehavioral+codepatientChoice+FHIR PractitionerRoleFullUrlurn:uuid:GUID_12IdGUID_007practitionerurn:uuid:GUID_11 (Practitioner)FHIR QuestionnaireResponse (Rejected Services)FullUrlurn:uuid:GUID_18IdGUID_010basedOnurn:uuid:GUID_4 (Service Request)subjecturn:uuid:GUID_17 (Flag)authorurn:uuid:GUID_11 (Practitioner)sourceurn:uuid:GUID_9 (Patient)FHIR Observation (e.g. Clinical Narrative) 0 ...*FullUrlurn:uuid:GUID_14IdGUID_017performerurn:uuid:GUID_11 (Practitioner)subjecturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)code   ClinicalNarrative+FHIR Observation (Symptoms)FullUrlurn:uuid:GUID_16IdGUID_008performerurn:uuid:GUID_11 (Practitioner)subjecturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)codeSymptoms+Flag (e.g. Reasonable Adjustment) 0...*FullUrlurn:uuid:GUID_19IdGUID_014subjecturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)categorypersonalisation+codeadjustforneedlephobia+FHIR ConsentFullUrlurn:uuid:GUID_22IdGUID_013patienturn:uuid:GUID_9 (Patient)FHIR AllergyIntoleranceFullUrlurn:uuid:GUID_23IdGUID_016recorderurn:uuid:GUID_11 (Practitioner)patienturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)FHIR MedicationStatementFullUrlurn:uuid:GUID_24IdGUID_015subjecturn:uuid:GUID_9 (Patient)contexturn:uuid:GUID_10 (Encounter)FHIR LocationFullUrlurn:uuid:GUID_25IdGUID_012
Key: - 

Key: -...
Mandatory Resource
Mandatory Resource
Receiver defined value (in http response)
Receiver defined value (in http r...
Optional Resource
Optional Resource
Resources
* https://simplifier.net/nhsdigitalspine/message-events
** https://simplifier.net/nhsdigitalspine/message-reason-servicerequest
*** https://simplifier.net/nhsdigitalspine/message-category-servicerequest

+ Support for numerous valueSets
++ The Sender must populate the 'NHSD-Target-Identifier' value a Receiver needs to populate in order to send a response to them via the BaRS API
Resources...
Text
Text
Entity map of FHIR Resources for BaRS ServiceRequest - Referral Request
Entity map of FHIR Resources for BaRS ServiceRequest - Referral Request
Sender defined value 
Sender defined value 
= 1 ... 1
= 1 ... 1
= 0 ... *
= 0 ... *
= 0 ... 1
= 0 ... 1FHIR HealthcareServiceFullUrlurn:uuid:GUID_28IdGUID_019FHIR CarePlanFullUrlurn:uuid:GUID_29IdGUID_020subjecturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)FHIR Encounter (Receiver new)FullUrlurn:uuid:GUID_30IdGUID_021identity(local system encounter ref)statusplannedsubjectGUID_004episodeOfCareGUID_13
Receiver included resource in http response only
Receiver included resource in htt...Text is not SVG - cannot display \ No newline at end of file +FHIR BundleIdGUID_1FHIR MessageHeaderFullUrlurn:uuid:GUID_2eventCodingservicerequest-request*reasonnew**focusurn:uuid:GUID_4 (ServiceRequest)destinationurn:uuid:GUID_5 (Organisation)senderurn:uuid:GUID_6 (Organisation)source.endpoint'<system>/<value>' ++FHIR OrganisationFullUrlurn:uuid:GUID_5IdGUID_002FHIR OrganisationFullUrlurn:uuid:GUID_6IdGUID_001FHIR ServiceRequestFullUrlurn:uuid:GUID_4IdGUID_003categoryreferral***subjecturn:uuid:GUID_9 (Patient)basedOnurn:uuid:GUID_29 (CarePlan)encounterurn:uuid:GUID_10 (Encounter)requesterurn:uuid:GUID_11 (Practitioner)performerurn:uuid:GUID_28 (HealthcareService)supportingInfo (Flag)urn:uuid:GUID_17 (Flag)supportingInfo (QuestionnaireResponse) urn:uuid:GUID_18 (QuestionnaireResponse)locationReferenceurn:uuid:GUID_25 (Location)FHIR PatientFullUrlurn:uuid:GUID_9IdGUID_004identifier3478526985 (NHS Number)FHIR EncounterFullUrlurn:uuid:GUID_10IdGUID_005identity(local system encounter ref)subjecturn:uuid:GUID_9 (Patient)episodeOfCareGUID_13FHIR PractitionerFullUrlurn:uuid:GUID_11IdGUID_006FHIR Flag (e.g. Rejected Services)FullUrlurn:uuid:GUID_17IdGUID_009subjecturn:uuid:GUID_9 (Patient)categorybehavioral+codepatientChoice+FHIR PractitionerRoleFullUrlurn:uuid:GUID_12IdGUID_007practitionerurn:uuid:GUID_11 (Practitioner)FHIR QuestionnaireResponse (Rejected Services)FullUrlurn:uuid:GUID_18IdGUID_010basedOnurn:uuid:GUID_4 (Service Request)subjecturn:uuid:GUID_17 (Flag)authorurn:uuid:GUID_11 (Practitioner)sourceurn:uuid:GUID_9 (Patient)FHIR Observation (e.g. Clinical Narrative) 0 ...*FullUrlurn:uuid:GUID_14IdGUID_017performerurn:uuid:GUID_11 (Practitioner)subjecturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)code   ClinicalNarrative+FHIR Observation (Symptoms)FullUrlurn:uuid:GUID_16IdGUID_008performerurn:uuid:GUID_11 (Practitioner)subjecturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)codeSymptoms+Flag (e.g. Reasonable Adjustment) 0...*FullUrlurn:uuid:GUID_19IdGUID_014subjecturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)categorypersonalisation+codeadjustforneedlephobia+FHIR ConsentFullUrlurn:uuid:GUID_22IdGUID_013patienturn:uuid:GUID_9 (Patient)FHIR AllergyIntoleranceFullUrlurn:uuid:GUID_23IdGUID_016recorderurn:uuid:GUID_11 (Practitioner)patienturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)FHIR MedicationStatementFullUrlurn:uuid:GUID_24IdGUID_015subjecturn:uuid:GUID_9 (Patient)contexturn:uuid:GUID_10 (Encounter)FHIR LocationFullUrlurn:uuid:GUID_25IdGUID_012
Key: - 

Mandatory Resource
Receiver defined value (in http response)
Optional Resource
Resources
* https://simplifier.net/nhsdigitalspine/message-events
** https://simplifier.net/nhsdigitalspine/message-reason-servicerequest
*** https://simplifier.net/nhsdigitalspine/message-category-servicerequest

+ Support for numerous valueSets
++ The Sender must populate the 'NHSD-Target-Identifier' value a Receiver needs to populate in order to send a response to them via the BaRS API
Text
Entity map of FHIR Resources for BaRS ServiceRequest - Referral Request
Sender defined value 
= 1 ... 1
= 0 ... *
= 0 ... 1
FHIR HealthcareServiceFullUrlurn:uuid:GUID_28IdGUID_019FHIR CarePlanFullUrlurn:uuid:GUID_29IdGUID_020subjecturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)FHIR Encounter (Receiver new)FullUrlurn:uuid:GUID_30IdGUID_021identity(local system encounter ref)statusplannedsubjectGUID_004episodeOfCareGUID_13
Receiver included resource in http response only
FHIR Related PersonFullUrlurn:uuid:GUID_36IdGUID_027subjecturn:uuid:GUID_9 (Patient)codeNOK \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Payloads.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Payloads.page.md index a7d88586..99a9a801 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Payloads.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Payloads.page.md @@ -41,7 +41,7 @@ The Encounter is used to represent the interaction between a patient and healthc In the initial referral request, the Sender will include an Encounter resource as the container for their assessment, which established the need for the referral. This encounter **should** include a reference to the Sender's assessment under *encounter.identifier*. Additionally, the *encounter.episodeOfCare* **must** be populated with a 'Journey ID' reference which can be used in subsequent referrals to allow the audit of the route a patient took through service providers to resolve their initial request for care. -A second Encounter resource is used to transfer the human readable reference of the newly created referral, at the Receiver side. When a referral request is made, the Receiver **should** include a new, secondary, encounter resource with the status of 'planned' in their synchronous HTTP response to the Sender's request. This new 'planned' encounter will have both an Id and an Identifier value, indicating the Receiver's human readable and local references, respectively. This secondary, 'planned', encounter is not mandatory and has a cardinality of 0..1, unlike the primary encounter resource (1..1)(See the Entity Relationship Diagram for reference). The human readable (Identifier) reference is intended to allow Senders to provide something to the patient which they can take between services to support consistent joined up care, although, it is also a useful link for the services themselves to use when discussing a patient's transition of care. The local (Id) reference is not intended to be human readable but rather machine readable. +A second Encounter resource is used to transfer the human readable reference of the newly created referral, at the Receiver side. When a referral request is made, the Receiver **should** include a new, secondary, encounter resource with the status of 'planned' in their synchronous HTTP response to the Sender's request. This new 'planned' encounter will have both an id and an identifier value, representing the Receiver's local reference and human readable reference respectively. This secondary, 'planned', encounter is not mandatory and has a cardinality of 0..1, unlike the primary encounter resource (1..1)(See the Entity Relationship Diagram for reference). The human readable (Identifier) reference is intended to allow Senders to provide something to the patient which they can take between services to support consistent joined up care, although, it is also a useful link for the services themselves to use when discussing a patient's transition of care. The local (Id) reference is not intended to be human readable but rather machine readable. ### CarePlan Resource The CarePlan resource is used in a referral request to communicate the assessment triage outcome and any associated clinical information, based on the assessment performed by the Sender. The Receiver will utilise the detail in this resource to summarise what the previous assessment ascertained about the patient, to be used in any subsequent consultation with the patient. @@ -79,6 +79,10 @@ Using a nested set of *questionnaireResponse.item*, *questionnaireResponse.linkI ### Consent In the BaRS UEC Applications the level of consent is stipulated to be for 'Direct Care' only. A referral **must** contain a Consent resource and it **must** adhere to the [example](https://simplifier.net/NHSBookingandReferrals/8fc39b95-89a6-45fb-914f-1458a10e9e14/~json) provided under the BaRS FHIR assets. +### Related Person  + +Related Person is used to carry information about the patient's Next of Kin and their contact details.  This is different to 3rd party contact details which are carried in the Patient resource. +