Care Coordination and 360 Referrals (Proof of Concept)
0.1.0 - proof-of-concept United Kingdom flag

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

Logical Model: Clinical Referral - Detailed Descriptions

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.

ShortClinical Referral
Control0..*
Is Modifierfalse
Logical ModelInstances 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

ShortReferral ID
Control1..1
TypeIdentifier
4. Referral.ubrn
Definition

eRS identifier, if the referral was made through eRS

ShortUnique Booking Reference Number
Control0..1
TypeIdentifier
6. Referral.patient
Definition

The patient referred

ShortPatient
Control1..1
TypeBackboneElement
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Referral.patient.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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

ShortNHS Number
Control0..1
TypeIdentifier
16. Referral.patient.localIdentifier
Definition

Referral Initiator's identifier (360X sourcePatientId), and any identifier the Referral Recipient adds

ShortLocal patient identifier
Control0..*
TypeIdentifier
18. Referral.patient.demographics
Definition

Name, date of birth, sex, address

ShortDemographics
Control1..1
TypeBackboneElement
20. Referral.referrer
Definition

The Referral Initiator

ShortReferrer
Control1..1
TypeBackboneElement
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Referral.referrer.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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

ShortReferring clinician
Control1..1
TypeIdentifier
30. Referral.referrer.organisation
Definition

ODS code

ShortReferring organisation
Control1..1
TypeIdentifier
32. Referral.recipient
Definition

The Referral Recipient

ShortReferred to
Control0..1
TypeBackboneElement
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Referral.recipient.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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

ShortService
Control0..1
TypeIdentifier
42. Referral.recipient.clinician
Definition

Named clinician, if any

ShortClinician
Control0..1
TypeIdentifier
44. Referral.recipient.organisation
Definition

ODS code

ShortOrganisation
Control0..1
TypeIdentifier
46. Referral.serviceRequested
Definition

Specialty, clinic type or referral procedure

ShortService requested
Control1..1
TypeCodeableConcept
48. Referral.priority
Definition

routine, urgent, urgent suspected cancer, two week wait

ShortPriority
Control0..1
Typecode
Primitive ValueThis 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)

ShortExpected service provision time
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. Referral.validityPeriod
Definition

Period the referral is valid for

ShortValidity
Control0..1
TypePeriod
54. Referral.reasonForReferral
Definition

Coded (SNOMED CT) or text

ShortReason for referral
Control1..*
TypeCodeableConcept
56. Referral.referralQuestion
Definition

The clinical question for the Referral Recipient

ShortReferral question
Control0..1
Typestring
Primitive ValueThis 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

ShortClinical document
Control0..*
TypeReference(DocumentReference, Bundle)
60. Referral.patientSummary
Definition

The patient's background (HL7 Europe Patient Summary), when the recipient cannot query the record

ShortPatient summary
Control0..1
TypeReference(DocumentReference, Bundle)
62. Referral.forms
Definition

Forms completed for the referral - see Referral Forms

ShortReferral forms
Control0..*
TypeReference(QuestionnaireResponse)
64. Referral.observations
Definition

Findings needed by the recipient, e.g. vital signs

ShortObservations
Control0..*
TypeReference(Observation)
66. Referral.carePlan
Definition

The care plan this referral carries out, if any

ShortCare plan
Control0..1
TypeReference(CarePlan)
68. Referral.dateOfReferral
Definition

When the referral was made

ShortDate of referral
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
70. Referral.status
Definition

360X state - see Referral Workflow Status

ShortReferral status
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
72. Referral.statusReason
Definition

Free text at least

ShortReason for decline or cancellation
Control0..1
TypeCodeableConcept
74. Referral.appointment
Definition

Appointments booked to carry out the referral

ShortAppointment
Control0..*
TypeBackboneElement
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Referral.appointment.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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

ShortAppointment ID
Control1..1
TypeIdentifier
84. Referral.appointment.dateTime
Definition

At least the date

ShortAppointment date and time
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
86. Referral.appointment.provider
Definition

Clinician or service seeing the patient

ShortAppointment provider
Control0..1
TypeIdentifier
88. Referral.appointment.status
Definition

booked, rescheduled, cancelled, no-show

ShortAppointment status
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
90. Referral.interimNote
Definition

Results sent before the end of care

ShortInterim consultation note
Control0..*
TypeReference(DocumentReference, Bundle)
92. Referral.outcome
Definition

Report that closes the loop - consultation note, discharge report or care plan

ShortReferral outcome
Control0..1
TypeReference(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.

ShortClinical Referral
Logical ModelInstances 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

ShortReferral ID
Control1..1
TypeIdentifier
4. Referral.ubrn
Definition

eRS identifier, if the referral was made through eRS

ShortUnique Booking Reference Number
Control0..1
TypeIdentifier
6. Referral.patient
Definition

The patient referred

ShortPatient
Control1..1
TypeBackboneElement
8. Referral.patient.nhsNumber
Definition

Traced NHS Number

ShortNHS Number
Control0..1
TypeIdentifier
10. Referral.patient.localIdentifier
Definition

Referral Initiator's identifier (360X sourcePatientId), and any identifier the Referral Recipient adds

ShortLocal patient identifier
Control0..*
TypeIdentifier
12. Referral.patient.demographics
Definition

Name, date of birth, sex, address

ShortDemographics
Control1..1
TypeBackboneElement
14. Referral.referrer
Definition

The Referral Initiator

ShortReferrer
Control1..1
TypeBackboneElement
16. Referral.referrer.clinician
Definition

Professional registration or GP code

ShortReferring clinician
Control1..1
TypeIdentifier
18. Referral.referrer.organisation
Definition

ODS code

ShortReferring organisation
Control1..1
TypeIdentifier
20. Referral.recipient
Definition

The Referral Recipient

ShortReferred to
Control0..1
TypeBackboneElement
22. Referral.recipient.service
Definition

eRS service ID, Directory of Services ID or local service

ShortService
Control0..1
TypeIdentifier
24. Referral.recipient.clinician
Definition

Named clinician, if any

ShortClinician
Control0..1
TypeIdentifier
26. Referral.recipient.organisation
Definition

ODS code

ShortOrganisation
Control0..1
TypeIdentifier
28. Referral.serviceRequested
Definition

Specialty, clinic type or referral procedure

ShortService requested
Control1..1
TypeCodeableConcept
30. Referral.priority
Definition

routine, urgent, urgent suspected cancer, two week wait

ShortPriority
Control0..1
Typecode
Primitive ValueThis 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)

ShortExpected service provision time
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. Referral.validityPeriod
Definition

Period the referral is valid for

ShortValidity
Control0..1
TypePeriod
36. Referral.reasonForReferral
Definition

Coded (SNOMED CT) or text

ShortReason for referral
Control1..*
TypeCodeableConcept
38. Referral.referralQuestion
Definition

The clinical question for the Referral Recipient

ShortReferral question
Control0..1
Typestring
Primitive ValueThis 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

ShortClinical document
Control0..*
TypeReference(DocumentReference, Bundle)
42. Referral.patientSummary
Definition

The patient's background (HL7 Europe Patient Summary), when the recipient cannot query the record

ShortPatient summary
Control0..1
TypeReference(DocumentReference, Bundle)
44. Referral.forms
Definition

Forms completed for the referral - see Referral Forms

ShortReferral forms
Control0..*
TypeReference(QuestionnaireResponse)
46. Referral.observations
Definition

Findings needed by the recipient, e.g. vital signs

ShortObservations
Control0..*
TypeReference(Observation)
48. Referral.carePlan
Definition

The care plan this referral carries out, if any

ShortCare plan
Control0..1
TypeReference(CarePlan)
50. Referral.dateOfReferral
Definition

When the referral was made

ShortDate of referral
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. Referral.status
Definition

360X state - see Referral Workflow Status

ShortReferral status
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. Referral.statusReason
Definition

Free text at least

ShortReason for decline or cancellation
Control0..1
TypeCodeableConcept
56. Referral.appointment
Definition

Appointments booked to carry out the referral

ShortAppointment
Control0..*
TypeBackboneElement
58. Referral.appointment.appointmentId
Definition

Unique identifier of the appointment

ShortAppointment ID
Control1..1
TypeIdentifier
60. Referral.appointment.dateTime
Definition

At least the date

ShortAppointment date and time
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
62. Referral.appointment.provider
Definition

Clinician or service seeing the patient

ShortAppointment provider
Control0..1
TypeIdentifier
64. Referral.appointment.status
Definition

booked, rescheduled, cancelled, no-show

ShortAppointment status
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
66. Referral.interimNote
Definition

Results sent before the end of care

ShortInterim consultation note
Control0..*
TypeReference(DocumentReference, Bundle)
68. Referral.outcome
Definition

Report that closes the loop - consultation note, discharge report or care plan

ShortReferral outcome
Control0..1
TypeReference(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.

ShortClinical Referral
Control0..*
Is Modifierfalse
Logical ModelInstances 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

ShortReferral ID
Control1..1
TypeIdentifier
4. Referral.ubrn
Definition

eRS identifier, if the referral was made through eRS

ShortUnique Booking Reference Number
Control0..1
TypeIdentifier
6. Referral.patient
Definition

The patient referred

ShortPatient
Control1..1
TypeBackboneElement
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Referral.patient.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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

ShortNHS Number
Control0..1
TypeIdentifier
16. Referral.patient.localIdentifier
Definition

Referral Initiator's identifier (360X sourcePatientId), and any identifier the Referral Recipient adds

ShortLocal patient identifier
Control0..*
TypeIdentifier
18. Referral.patient.demographics
Definition

Name, date of birth, sex, address

ShortDemographics
Control1..1
TypeBackboneElement
20. Referral.referrer
Definition

The Referral Initiator

ShortReferrer
Control1..1
TypeBackboneElement
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Referral.referrer.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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

ShortReferring clinician
Control1..1
TypeIdentifier
30. Referral.referrer.organisation
Definition

ODS code

ShortReferring organisation
Control1..1
TypeIdentifier
32. Referral.recipient
Definition

The Referral Recipient

ShortReferred to
Control0..1
TypeBackboneElement
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Referral.recipient.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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

ShortService
Control0..1
TypeIdentifier
42. Referral.recipient.clinician
Definition

Named clinician, if any

ShortClinician
Control0..1
TypeIdentifier
44. Referral.recipient.organisation
Definition

ODS code

ShortOrganisation
Control0..1
TypeIdentifier
46. Referral.serviceRequested
Definition

Specialty, clinic type or referral procedure

ShortService requested
Control1..1
TypeCodeableConcept
48. Referral.priority
Definition

routine, urgent, urgent suspected cancer, two week wait

ShortPriority
Control0..1
Typecode
Primitive ValueThis 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)

ShortExpected service provision time
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. Referral.validityPeriod
Definition

Period the referral is valid for

ShortValidity
Control0..1
TypePeriod
54. Referral.reasonForReferral
Definition

Coded (SNOMED CT) or text

ShortReason for referral
Control1..*
TypeCodeableConcept
56. Referral.referralQuestion
Definition

The clinical question for the Referral Recipient

ShortReferral question
Control0..1
Typestring
Primitive ValueThis 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

ShortClinical document
Control0..*
TypeReference(DocumentReference, Bundle)
60. Referral.patientSummary
Definition

The patient's background (HL7 Europe Patient Summary), when the recipient cannot query the record

ShortPatient summary
Control0..1
TypeReference(DocumentReference, Bundle)
62. Referral.forms
Definition

Forms completed for the referral - see Referral Forms

ShortReferral forms
Control0..*
TypeReference(QuestionnaireResponse)
64. Referral.observations
Definition

Findings needed by the recipient, e.g. vital signs

ShortObservations
Control0..*
TypeReference(Observation)
66. Referral.carePlan
Definition

The care plan this referral carries out, if any

ShortCare plan
Control0..1
TypeReference(CarePlan)
68. Referral.dateOfReferral
Definition

When the referral was made

ShortDate of referral
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
70. Referral.status
Definition

360X state - see Referral Workflow Status

ShortReferral status
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
72. Referral.statusReason
Definition

Free text at least

ShortReason for decline or cancellation
Control0..1
TypeCodeableConcept
74. Referral.appointment
Definition

Appointments booked to carry out the referral

ShortAppointment
Control0..*
TypeBackboneElement
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Referral.appointment.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
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).

ShortExtensions 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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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 Namesextensions, user content, modifiers
Invariantsele-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

ShortAppointment ID
Control1..1
TypeIdentifier
84. Referral.appointment.dateTime
Definition

At least the date

ShortAppointment date and time
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
86. Referral.appointment.provider
Definition

Clinician or service seeing the patient

ShortAppointment provider
Control0..1
TypeIdentifier
88. Referral.appointment.status
Definition

booked, rescheduled, cancelled, no-show

ShortAppointment status
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
90. Referral.interimNote
Definition

Results sent before the end of care

ShortInterim consultation note
Control0..*
TypeReference(DocumentReference, Bundle)
92. Referral.outcome
Definition

Report that closes the loop - consultation note, discharge report or care plan

ShortReferral outcome
Control0..1
TypeReference(DocumentReference, Bundle)