Care Coordination and 360 Referrals (Proof of Concept)
0.1.0 - proof-of-concept
Care Coordination and 360 Referrals (Proof of Concept) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2026-11-03 |
Definitions for the Referral logical model
See the documentation on how to interpret the contents of this table
| 0. Referral | |
| Definition | Proof of concept - not an authoritative source. The information exchanged during a closed loop referral, from the referral request to the referral outcome. Based on the data items of the IHE 360X transactions (PCC TF-2 3.55 to 3.61), FHIR Workflow and HL7 v2 orders, with the UBRN from eRS. It is the same for a referral to an outpatient clinic, a community service or a virtual ward. National services such as BaRS are mapped onto this model (see the BaRS review), not the other way round. The PRSB Clinical Referral Information Standard v1.0 gives the clinical headings. The referral stays small: the clinical content is in separate documents referenced as supporting information - a Discharge Report or clinic letter for the episode, a Patient Summary and referral forms. A referral may be one activity of a Care Plan. The Mappings tab shows each element in HL7 v2 (360X) and FHIR. |
| Short | Clinical Referral |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. Referral.referralId | |
| Definition | Unique identifier assigned by the Referral Initiator, used in every message about the referral |
| Short | Referral ID |
| Control | 1..1 |
| Type | Identifier |
| 4. Referral.ubrn | |
| Definition | eRS identifier, if the referral was made through eRS |
| Short | Unique Booking Reference Number |
| Control | 0..1 |
| Type | Identifier |
| 6. Referral.patient | |
| Definition | The patient referred |
| Short | Patient |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Referral.patient.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 10. Referral.patient.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Referral.patient.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 12. Referral.patient.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 14. Referral.patient.nhsNumber | |
| Definition | Traced NHS Number |
| Short | NHS Number |
| Control | 0..1 |
| Type | Identifier |
| 16. Referral.patient.localIdentifier | |
| Definition | Referral Initiator's identifier (360X sourcePatientId), and any identifier the Referral Recipient adds |
| Short | Local patient identifier |
| Control | 0..* |
| Type | Identifier |
| 18. Referral.patient.demographics | |
| Definition | Name, date of birth, sex, address |
| Short | Demographics |
| Control | 1..1 |
| Type | BackboneElement |
| 20. Referral.referrer | |
| Definition | The Referral Initiator |
| Short | Referrer |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. Referral.referrer.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 24. Referral.referrer.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Referral.referrer.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 26. Referral.referrer.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 28. Referral.referrer.clinician | |
| Definition | Professional registration or GP code |
| Short | Referring clinician |
| Control | 1..1 |
| Type | Identifier |
| 30. Referral.referrer.organisation | |
| Definition | ODS code |
| Short | Referring organisation |
| Control | 1..1 |
| Type | Identifier |
| 32. Referral.recipient | |
| Definition | The Referral Recipient |
| Short | Referred to |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. Referral.recipient.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 36. Referral.recipient.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Referral.recipient.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 38. Referral.recipient.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 40. Referral.recipient.service | |
| Definition | eRS service ID, Directory of Services ID or local service |
| Short | Service |
| Control | 0..1 |
| Type | Identifier |
| 42. Referral.recipient.clinician | |
| Definition | Named clinician, if any |
| Short | Clinician |
| Control | 0..1 |
| Type | Identifier |
| 44. Referral.recipient.organisation | |
| Definition | ODS code |
| Short | Organisation |
| Control | 0..1 |
| Type | Identifier |
| 46. Referral.serviceRequested | |
| Definition | Specialty, clinic type or referral procedure |
| Short | Service requested |
| Control | 1..1 |
| Type | CodeableConcept |
| 48. Referral.priority | |
| Definition | routine, urgent, urgent suspected cancer, two week wait |
| Short | Priority |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 50. Referral.expectedBy | |
| Definition | The date by which the service should be provided (urgency converted to a date) |
| Short | Expected service provision time |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 52. Referral.validityPeriod | |
| Definition | Period the referral is valid for |
| Short | Validity |
| Control | 0..1 |
| Type | Period |
| 54. Referral.reasonForReferral | |
| Definition | Coded (SNOMED CT) or text |
| Short | Reason for referral |
| Control | 1..* |
| Type | CodeableConcept |
| 56. Referral.referralQuestion | |
| Definition | The clinical question for the Referral Recipient |
| Short | Referral question |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 58. Referral.clinicalDocument | |
| Definition | The referrer's account of the episode that led to the referral - Discharge Report (HL7 Europe HDR) or clinic letter |
| Short | Clinical document |
| Control | 0..* |
| Type | Reference(DocumentReference, Bundle) |
| 60. Referral.patientSummary | |
| Definition | The patient's background (HL7 Europe Patient Summary), when the recipient cannot query the record |
| Short | Patient summary |
| Control | 0..1 |
| Type | Reference(DocumentReference, Bundle) |
| 62. Referral.forms | |
| Definition | Forms completed for the referral - see Referral Forms |
| Short | Referral forms |
| Control | 0..* |
| Type | Reference(QuestionnaireResponse) |
| 64. Referral.observations | |
| Definition | Findings needed by the recipient, e.g. vital signs |
| Short | Observations |
| Control | 0..* |
| Type | Reference(Observation) |
| 66. Referral.carePlan | |
| Definition | The care plan this referral carries out, if any |
| Short | Care plan |
| Control | 0..1 |
| Type | Reference(CarePlan) |
| 68. Referral.dateOfReferral | |
| Definition | When the referral was made |
| Short | Date of referral |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 70. Referral.status | |
| Definition | 360X state - see Referral Workflow Status |
| Short | Referral status |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 72. Referral.statusReason | |
| Definition | Free text at least |
| Short | Reason for decline or cancellation |
| Control | 0..1 |
| Type | CodeableConcept |
| 74. Referral.appointment | |
| Definition | Appointments booked to carry out the referral |
| Short | Appointment |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 76. Referral.appointment.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 78. Referral.appointment.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Referral.appointment.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 80. Referral.appointment.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 82. Referral.appointment.appointmentId | |
| Definition | Unique identifier of the appointment |
| Short | Appointment ID |
| Control | 1..1 |
| Type | Identifier |
| 84. Referral.appointment.dateTime | |
| Definition | At least the date |
| Short | Appointment date and time |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 86. Referral.appointment.provider | |
| Definition | Clinician or service seeing the patient |
| Short | Appointment provider |
| Control | 0..1 |
| Type | Identifier |
| 88. Referral.appointment.status | |
| Definition | booked, rescheduled, cancelled, no-show |
| Short | Appointment status |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 90. Referral.interimNote | |
| Definition | Results sent before the end of care |
| Short | Interim consultation note |
| Control | 0..* |
| Type | Reference(DocumentReference, Bundle) |
| 92. Referral.outcome | |
| Definition | Report that closes the loop - consultation note, discharge report or care plan |
| Short | Referral outcome |
| Control | 0..1 |
| Type | Reference(DocumentReference, Bundle) |
See the documentation on how to interpret the contents of this table
| 0. Referral | |
| Definition | Proof of concept - not an authoritative source. The information exchanged during a closed loop referral, from the referral request to the referral outcome. Based on the data items of the IHE 360X transactions (PCC TF-2 3.55 to 3.61), FHIR Workflow and HL7 v2 orders, with the UBRN from eRS. It is the same for a referral to an outpatient clinic, a community service or a virtual ward. National services such as BaRS are mapped onto this model (see the BaRS review), not the other way round. The PRSB Clinical Referral Information Standard v1.0 gives the clinical headings. The referral stays small: the clinical content is in separate documents referenced as supporting information - a Discharge Report or clinic letter for the episode, a Patient Summary and referral forms. A referral may be one activity of a Care Plan. The Mappings tab shows each element in HL7 v2 (360X) and FHIR. |
| Short | Clinical Referral |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. Referral.referralId | |
| Definition | Unique identifier assigned by the Referral Initiator, used in every message about the referral |
| Short | Referral ID |
| Control | 1..1 |
| Type | Identifier |
| 4. Referral.ubrn | |
| Definition | eRS identifier, if the referral was made through eRS |
| Short | Unique Booking Reference Number |
| Control | 0..1 |
| Type | Identifier |
| 6. Referral.patient | |
| Definition | The patient referred |
| Short | Patient |
| Control | 1..1 |
| Type | BackboneElement |
| 8. Referral.patient.nhsNumber | |
| Definition | Traced NHS Number |
| Short | NHS Number |
| Control | 0..1 |
| Type | Identifier |
| 10. Referral.patient.localIdentifier | |
| Definition | Referral Initiator's identifier (360X sourcePatientId), and any identifier the Referral Recipient adds |
| Short | Local patient identifier |
| Control | 0..* |
| Type | Identifier |
| 12. Referral.patient.demographics | |
| Definition | Name, date of birth, sex, address |
| Short | Demographics |
| Control | 1..1 |
| Type | BackboneElement |
| 14. Referral.referrer | |
| Definition | The Referral Initiator |
| Short | Referrer |
| Control | 1..1 |
| Type | BackboneElement |
| 16. Referral.referrer.clinician | |
| Definition | Professional registration or GP code |
| Short | Referring clinician |
| Control | 1..1 |
| Type | Identifier |
| 18. Referral.referrer.organisation | |
| Definition | ODS code |
| Short | Referring organisation |
| Control | 1..1 |
| Type | Identifier |
| 20. Referral.recipient | |
| Definition | The Referral Recipient |
| Short | Referred to |
| Control | 0..1 |
| Type | BackboneElement |
| 22. Referral.recipient.service | |
| Definition | eRS service ID, Directory of Services ID or local service |
| Short | Service |
| Control | 0..1 |
| Type | Identifier |
| 24. Referral.recipient.clinician | |
| Definition | Named clinician, if any |
| Short | Clinician |
| Control | 0..1 |
| Type | Identifier |
| 26. Referral.recipient.organisation | |
| Definition | ODS code |
| Short | Organisation |
| Control | 0..1 |
| Type | Identifier |
| 28. Referral.serviceRequested | |
| Definition | Specialty, clinic type or referral procedure |
| Short | Service requested |
| Control | 1..1 |
| Type | CodeableConcept |
| 30. Referral.priority | |
| Definition | routine, urgent, urgent suspected cancer, two week wait |
| Short | Priority |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. Referral.expectedBy | |
| Definition | The date by which the service should be provided (urgency converted to a date) |
| Short | Expected service provision time |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. Referral.validityPeriod | |
| Definition | Period the referral is valid for |
| Short | Validity |
| Control | 0..1 |
| Type | Period |
| 36. Referral.reasonForReferral | |
| Definition | Coded (SNOMED CT) or text |
| Short | Reason for referral |
| Control | 1..* |
| Type | CodeableConcept |
| 38. Referral.referralQuestion | |
| Definition | The clinical question for the Referral Recipient |
| Short | Referral question |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. Referral.clinicalDocument | |
| Definition | The referrer's account of the episode that led to the referral - Discharge Report (HL7 Europe HDR) or clinic letter |
| Short | Clinical document |
| Control | 0..* |
| Type | Reference(DocumentReference, Bundle) |
| 42. Referral.patientSummary | |
| Definition | The patient's background (HL7 Europe Patient Summary), when the recipient cannot query the record |
| Short | Patient summary |
| Control | 0..1 |
| Type | Reference(DocumentReference, Bundle) |
| 44. Referral.forms | |
| Definition | Forms completed for the referral - see Referral Forms |
| Short | Referral forms |
| Control | 0..* |
| Type | Reference(QuestionnaireResponse) |
| 46. Referral.observations | |
| Definition | Findings needed by the recipient, e.g. vital signs |
| Short | Observations |
| Control | 0..* |
| Type | Reference(Observation) |
| 48. Referral.carePlan | |
| Definition | The care plan this referral carries out, if any |
| Short | Care plan |
| Control | 0..1 |
| Type | Reference(CarePlan) |
| 50. Referral.dateOfReferral | |
| Definition | When the referral was made |
| Short | Date of referral |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 52. Referral.status | |
| Definition | 360X state - see Referral Workflow Status |
| Short | Referral status |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 54. Referral.statusReason | |
| Definition | Free text at least |
| Short | Reason for decline or cancellation |
| Control | 0..1 |
| Type | CodeableConcept |
| 56. Referral.appointment | |
| Definition | Appointments booked to carry out the referral |
| Short | Appointment |
| Control | 0..* |
| Type | BackboneElement |
| 58. Referral.appointment.appointmentId | |
| Definition | Unique identifier of the appointment |
| Short | Appointment ID |
| Control | 1..1 |
| Type | Identifier |
| 60. Referral.appointment.dateTime | |
| Definition | At least the date |
| Short | Appointment date and time |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 62. Referral.appointment.provider | |
| Definition | Clinician or service seeing the patient |
| Short | Appointment provider |
| Control | 0..1 |
| Type | Identifier |
| 64. Referral.appointment.status | |
| Definition | booked, rescheduled, cancelled, no-show |
| Short | Appointment status |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 66. Referral.interimNote | |
| Definition | Results sent before the end of care |
| Short | Interim consultation note |
| Control | 0..* |
| Type | Reference(DocumentReference, Bundle) |
| 68. Referral.outcome | |
| Definition | Report that closes the loop - consultation note, discharge report or care plan |
| Short | Referral outcome |
| Control | 0..1 |
| Type | Reference(DocumentReference, Bundle) |
See the documentation on how to interpret the contents of this table
| 0. Referral | |
| Definition | Proof of concept - not an authoritative source. The information exchanged during a closed loop referral, from the referral request to the referral outcome. Based on the data items of the IHE 360X transactions (PCC TF-2 3.55 to 3.61), FHIR Workflow and HL7 v2 orders, with the UBRN from eRS. It is the same for a referral to an outpatient clinic, a community service or a virtual ward. National services such as BaRS are mapped onto this model (see the BaRS review), not the other way round. The PRSB Clinical Referral Information Standard v1.0 gives the clinical headings. The referral stays small: the clinical content is in separate documents referenced as supporting information - a Discharge Report or clinic letter for the episode, a Patient Summary and referral forms. A referral may be one activity of a Care Plan. The Mappings tab shows each element in HL7 v2 (360X) and FHIR. |
| Short | Clinical Referral |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. Referral.referralId | |
| Definition | Unique identifier assigned by the Referral Initiator, used in every message about the referral |
| Short | Referral ID |
| Control | 1..1 |
| Type | Identifier |
| 4. Referral.ubrn | |
| Definition | eRS identifier, if the referral was made through eRS |
| Short | Unique Booking Reference Number |
| Control | 0..1 |
| Type | Identifier |
| 6. Referral.patient | |
| Definition | The patient referred |
| Short | Patient |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Referral.patient.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 10. Referral.patient.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Referral.patient.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 12. Referral.patient.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 14. Referral.patient.nhsNumber | |
| Definition | Traced NHS Number |
| Short | NHS Number |
| Control | 0..1 |
| Type | Identifier |
| 16. Referral.patient.localIdentifier | |
| Definition | Referral Initiator's identifier (360X sourcePatientId), and any identifier the Referral Recipient adds |
| Short | Local patient identifier |
| Control | 0..* |
| Type | Identifier |
| 18. Referral.patient.demographics | |
| Definition | Name, date of birth, sex, address |
| Short | Demographics |
| Control | 1..1 |
| Type | BackboneElement |
| 20. Referral.referrer | |
| Definition | The Referral Initiator |
| Short | Referrer |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. Referral.referrer.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 24. Referral.referrer.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Referral.referrer.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 26. Referral.referrer.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 28. Referral.referrer.clinician | |
| Definition | Professional registration or GP code |
| Short | Referring clinician |
| Control | 1..1 |
| Type | Identifier |
| 30. Referral.referrer.organisation | |
| Definition | ODS code |
| Short | Referring organisation |
| Control | 1..1 |
| Type | Identifier |
| 32. Referral.recipient | |
| Definition | The Referral Recipient |
| Short | Referred to |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. Referral.recipient.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 36. Referral.recipient.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Referral.recipient.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 38. Referral.recipient.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 40. Referral.recipient.service | |
| Definition | eRS service ID, Directory of Services ID or local service |
| Short | Service |
| Control | 0..1 |
| Type | Identifier |
| 42. Referral.recipient.clinician | |
| Definition | Named clinician, if any |
| Short | Clinician |
| Control | 0..1 |
| Type | Identifier |
| 44. Referral.recipient.organisation | |
| Definition | ODS code |
| Short | Organisation |
| Control | 0..1 |
| Type | Identifier |
| 46. Referral.serviceRequested | |
| Definition | Specialty, clinic type or referral procedure |
| Short | Service requested |
| Control | 1..1 |
| Type | CodeableConcept |
| 48. Referral.priority | |
| Definition | routine, urgent, urgent suspected cancer, two week wait |
| Short | Priority |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 50. Referral.expectedBy | |
| Definition | The date by which the service should be provided (urgency converted to a date) |
| Short | Expected service provision time |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 52. Referral.validityPeriod | |
| Definition | Period the referral is valid for |
| Short | Validity |
| Control | 0..1 |
| Type | Period |
| 54. Referral.reasonForReferral | |
| Definition | Coded (SNOMED CT) or text |
| Short | Reason for referral |
| Control | 1..* |
| Type | CodeableConcept |
| 56. Referral.referralQuestion | |
| Definition | The clinical question for the Referral Recipient |
| Short | Referral question |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 58. Referral.clinicalDocument | |
| Definition | The referrer's account of the episode that led to the referral - Discharge Report (HL7 Europe HDR) or clinic letter |
| Short | Clinical document |
| Control | 0..* |
| Type | Reference(DocumentReference, Bundle) |
| 60. Referral.patientSummary | |
| Definition | The patient's background (HL7 Europe Patient Summary), when the recipient cannot query the record |
| Short | Patient summary |
| Control | 0..1 |
| Type | Reference(DocumentReference, Bundle) |
| 62. Referral.forms | |
| Definition | Forms completed for the referral - see Referral Forms |
| Short | Referral forms |
| Control | 0..* |
| Type | Reference(QuestionnaireResponse) |
| 64. Referral.observations | |
| Definition | Findings needed by the recipient, e.g. vital signs |
| Short | Observations |
| Control | 0..* |
| Type | Reference(Observation) |
| 66. Referral.carePlan | |
| Definition | The care plan this referral carries out, if any |
| Short | Care plan |
| Control | 0..1 |
| Type | Reference(CarePlan) |
| 68. Referral.dateOfReferral | |
| Definition | When the referral was made |
| Short | Date of referral |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 70. Referral.status | |
| Definition | 360X state - see Referral Workflow Status |
| Short | Referral status |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 72. Referral.statusReason | |
| Definition | Free text at least |
| Short | Reason for decline or cancellation |
| Control | 0..1 |
| Type | CodeableConcept |
| 74. Referral.appointment | |
| Definition | Appointments booked to carry out the referral |
| Short | Appointment |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 76. Referral.appointment.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 78. Referral.appointment.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Referral.appointment.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 80. Referral.appointment.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 82. Referral.appointment.appointmentId | |
| Definition | Unique identifier of the appointment |
| Short | Appointment ID |
| Control | 1..1 |
| Type | Identifier |
| 84. Referral.appointment.dateTime | |
| Definition | At least the date |
| Short | Appointment date and time |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 86. Referral.appointment.provider | |
| Definition | Clinician or service seeing the patient |
| Short | Appointment provider |
| Control | 0..1 |
| Type | Identifier |
| 88. Referral.appointment.status | |
| Definition | booked, rescheduled, cancelled, no-show |
| Short | Appointment status |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 90. Referral.interimNote | |
| Definition | Results sent before the end of care |
| Short | Interim consultation note |
| Control | 0..* |
| Type | Reference(DocumentReference, Bundle) |
| 92. Referral.outcome | |
| Definition | Report that closes the loop - consultation note, discharge report or care plan |
| Short | Referral outcome |
| Control | 0..1 |
| Type | Reference(DocumentReference, Bundle) |