NHS North West Genomics
2.2.5 - ci-build United Kingdom flag

NHS North West Genomics - Local Development build (v2.2.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: Genetic Clinical Referral - Detailed Descriptions

Draft as of 2026-11-05

Definitions for the GeneticClinicalReferral logical model

See the documentation on how to interpret the contents of this table

0. GeneticClinicalReferral
Definition

For analysis purposes only - not an active or planned project. This referral is not expected to be implemented within this IG; it is expected to be implemented via a Genomics England Limited application, NHS England BaRS/eRS or the NHS England Genomic Order Management Service.

A closed-loop clinical referral into a genomics/clinical genetics service (see Genetic Referrals), modelled on the IHE 360X HL7 v2 referral order OMG^O19 with OSU^O51 status updates (see Referral Request [PCC-55]) - not a laboratory order. The referral itself stays small: clinical content travels as forms, clinical documents (pathology report, patient summary) and family history referenced from the referral.

This is a logical model - it is not exchanged as is. It breaks down into ServiceRequest, Patient, PractitionerRole, Organization, HealthcareService, QuestionnaireResponse, RelatedPerson, Observation and clinical documents (DocumentReference or a FHIR Document Bundle).

ShortGenetic Clinical Referral
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. GeneticClinicalReferral.referralIdentifier
Definition

Originating referral identifier, assigned by the referrer and used in every message

ShortReferral Identifier
Control1..1
TypeIdentifier(Order Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
4. GeneticClinicalReferral.status
Definition

e.g. active, completed, revoked

ShortReferral Status
Control1..1
BindingThe codes SHALL be taken from RequestStatus
(required to http://hl7.org/fhir/ValueSet/request-status)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. GeneticClinicalReferral.priority
Definition

Urgency of the referral

ShortPriority
Control0..1
BindingThe codes SHALL be taken from Request Priority
(required to https://fhir.nwgenomics.nhs.uk/ValueSet/RequestPriority)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. GeneticClinicalReferral.dateOfReferral
Definition

When the referral was made

ShortDate of referral
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. GeneticClinicalReferral.patient
Definition

The proband. Same items as Genomic Test Order's patient.

ShortPatient
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. GeneticClinicalReferral.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
14. GeneticClinicalReferral.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 GeneticClinicalReferral.patient.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. GeneticClinicalReferral.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())
18. GeneticClinicalReferral.patient.nhsNumber
Definition

NHS Number of the patient

ShortNHS Number
Control0..1
TypeIdentifier(NHS Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
20. GeneticClinicalReferral.patient.medicalRecordNumber
Definition

Local hospital number of the patient

ShortHospital Number (Medical Record Number)
Control0..1
TypeIdentifier(Medical Record Number The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
22. GeneticClinicalReferral.patient.familyName
Definition

Patient surname

ShortPatient surname
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. GeneticClinicalReferral.patient.givenName
Definition

Patient first name

ShortPatient first name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. GeneticClinicalReferral.patient.birthDate
Definition

Patient date of birth

ShortDate of birth
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. GeneticClinicalReferral.patient.address
Definition

Address line(s) and postcode

ShortAddress
Control0..1
TypeAddress
30. GeneticClinicalReferral.patient.sexRegisteredAtBirth
Definition

Administrative gender

ShortSex registered at birth
Control0..1
BindingThe codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. GeneticClinicalReferral.patient.accountNumber
Definition

Patient account number

ShortAccount Number (Episode or Stay Number)
Control0..1
TypeIdentifier(Hospital Provider Spell Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
34. GeneticClinicalReferral.patient.pedigreeNumber
Definition

Links the proband to consultands (at-risk relatives) referred as part of the same family investigation. Not a Patient identifier.

ShortG Number (Pedigree Number)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. GeneticClinicalReferral.referrer
Definition

The referring clinician and organisation. Same items as Genomic Test Order's requester.

ShortReferring Provider
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. GeneticClinicalReferral.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
40. GeneticClinicalReferral.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 GeneticClinicalReferral.referrer.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
42. GeneticClinicalReferral.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())
44. GeneticClinicalReferral.referrer.name
Definition

Referring clinician name

ShortReferring Clinician Name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. GeneticClinicalReferral.referrer.specialty
Definition

Referring clinician specialty

ShortReferring Clinician Current Speciality
Control0..1
BindingUnless not suitable, these codes SHALL be taken from UK Core Practice Setting Code
(extensible to https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode)
TypeCodeableConcept
48. GeneticClinicalReferral.referrer.professionalIdentifier
Definition

e.g. GMC/GMP number

ShortReferring Clinician Professional Identifier
Control0..1
TypeIdentifier(Practitioner Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
50. GeneticClinicalReferral.referrer.email
Definition

Referring clinician email

ShortEmail
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. GeneticClinicalReferral.referrer.phone
Definition

Referring clinician telephone

ShortPhone
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. GeneticClinicalReferral.referrer.organisation
Definition

ODS code of the referring organisation

ShortReferring Organisation
Control0..1
TypeIdentifier(Organisation Code The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
56. GeneticClinicalReferral.recipient
Definition

Who the referral is sent to - a named clinician or a service/clinic. Genomic Test Order has no equivalent: an order's Order Filler is fixed.

ShortReferred-to Provider/Service
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. GeneticClinicalReferral.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
60. GeneticClinicalReferral.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 GeneticClinicalReferral.recipient.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
62. GeneticClinicalReferral.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())
64. GeneticClinicalReferral.recipient.service
Definition

e.g. clinical genetics clinic

ShortReferred-to Service/Clinic Name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
66. GeneticClinicalReferral.recipient.organisation
Definition

ODS code of the receiving organisation

ShortReferred-to Organisation
Control0..1
TypeIdentifier(Organisation Code The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
68. GeneticClinicalReferral.recipient.clinician
Definition

Named clinician, if any

ShortNamed Consultant/Clinician (if known)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
70. GeneticClinicalReferral.serviceRequested
Definition

The clinical service/assessment requested (e.g. genetic counselling, cascade testing) - not a Genomic Test Directory code. For a clinical genetics referral this is SNOMED CT 306119003.

ShortReferral Type / Service Requested
Control1..1
TypeCodeableConcept
Pattern Value
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "306119003"
    }
  ]
}
<serviceRequested>
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="306119003"/>
  </coding>
</serviceRequested>
72. GeneticClinicalReferral.reasonForReferral
Definition

Suspected/confirmed condition

ShortReason for referral
Control0..*
BindingUnless not suitable, these codes SHALL be taken from Genomic Clinical Indication Codes
(extensible to https://fhir.nwgenomics.nhs.uk/ValueSet/GenomicClinicalIndicationCodes)
TypeCodeableConcept
74. GeneticClinicalReferral.clinicalInformation
Definition

Brief free-text note, if no family letter is attached

ShortClinical details
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
76. GeneticClinicalReferral.forms
Definition

Completed referral forms, e.g. a national GMS test order form or a service-specific referral form, as structured answers.

ShortReferral forms
Control0..*
TypeReference(QuestionnaireResponse)
78. GeneticClinicalReferral.consultand
Definition

A named at-risk relative being referred alongside the proband - one per relative

ShortConsultand
Control0..*
TypeReference(RelatedPerson)
80. GeneticClinicalReferral.pathologyReport
Definition

The pathology report supporting the referral. Ideally a reference to a clinical document shared via the NHS England Single Patient Record (SPR); in the interim this may be an attached PDF (DocumentReference -> Binary). NHS England NDRS also holds Cancer Pathology Reports.

ShortPathology report
Control0..*
TypeReference(DocumentReference, Bundle)
82. GeneticClinicalReferral.patientSummary
Definition

The patient summary, as a clinical document. Not part of the NHS England Genomics ServiceRequest specification.

ShortPatient summary
Control0..1
TypeReference(DocumentReference, Bundle)
84. GeneticClinicalReferral.familyHistory
Definition

Structured family history (FamilyMemberHistory, one per relative), or the unstructured family letter as a clinical document. At present clinical genetics is believed to retrieve structured family history from NHS England NDRS (National Disease Registration Service). NDRS is a reporting/analytical service, so the information may not be current.

ShortFamily history
Control0..*
TypeReference(FamilyMemberHistory, DocumentReference, Bundle)

See the documentation on how to interpret the contents of this table

0. GeneticClinicalReferral
Definition

For analysis purposes only - not an active or planned project. This referral is not expected to be implemented within this IG; it is expected to be implemented via a Genomics England Limited application, NHS England BaRS/eRS or the NHS England Genomic Order Management Service.

A closed-loop clinical referral into a genomics/clinical genetics service (see Genetic Referrals), modelled on the IHE 360X HL7 v2 referral order OMG^O19 with OSU^O51 status updates (see Referral Request [PCC-55]) - not a laboratory order. The referral itself stays small: clinical content travels as forms, clinical documents (pathology report, patient summary) and family history referenced from the referral.

This is a logical model - it is not exchanged as is. It breaks down into ServiceRequest, Patient, PractitionerRole, Organization, HealthcareService, QuestionnaireResponse, RelatedPerson, Observation and clinical documents (DocumentReference or a FHIR Document Bundle).

ShortGenetic Clinical Referral
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. GeneticClinicalReferral.referralIdentifier
Definition

Originating referral identifier, assigned by the referrer and used in every message

ShortReferral Identifier
Control1..1
TypeIdentifier(Order Identifier)
4. GeneticClinicalReferral.status
Definition

e.g. active, completed, revoked

ShortReferral Status
Control1..1
BindingThe codes SHALL be taken from RequestStatus
(required to http://hl7.org/fhir/ValueSet/request-status)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. GeneticClinicalReferral.priority
Definition

Urgency of the referral

ShortPriority
Control0..1
BindingThe codes SHALL be taken from Request Priority
(required to https://fhir.nwgenomics.nhs.uk/ValueSet/RequestPriority)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. GeneticClinicalReferral.dateOfReferral
Definition

When the referral was made

ShortDate of referral
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. GeneticClinicalReferral.patient
Definition

The proband. Same items as Genomic Test Order's patient.

ShortPatient
Control1..1
TypeBackboneElement
12. GeneticClinicalReferral.patient.nhsNumber
Definition

NHS Number of the patient

ShortNHS Number
Control0..1
TypeIdentifier(NHS Identifier)
14. GeneticClinicalReferral.patient.medicalRecordNumber
Definition

Local hospital number of the patient

ShortHospital Number (Medical Record Number)
Control0..1
TypeIdentifier(Medical Record Number)
16. GeneticClinicalReferral.patient.familyName
Definition

Patient surname

ShortPatient surname
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. GeneticClinicalReferral.patient.givenName
Definition

Patient first name

ShortPatient first name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. GeneticClinicalReferral.patient.birthDate
Definition

Patient date of birth

ShortDate of birth
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. GeneticClinicalReferral.patient.address
Definition

Address line(s) and postcode

ShortAddress
Control0..1
TypeAddress
24. GeneticClinicalReferral.patient.sexRegisteredAtBirth
Definition

Administrative gender

ShortSex registered at birth
Control0..1
BindingThe codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. GeneticClinicalReferral.patient.accountNumber
Definition

Patient account number

ShortAccount Number (Episode or Stay Number)
Control0..1
TypeIdentifier(Hospital Provider Spell Identifier)
28. GeneticClinicalReferral.patient.pedigreeNumber
Definition

Links the proband to consultands (at-risk relatives) referred as part of the same family investigation. Not a Patient identifier.

ShortG Number (Pedigree Number)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. GeneticClinicalReferral.referrer
Definition

The referring clinician and organisation. Same items as Genomic Test Order's requester.

ShortReferring Provider
Control1..1
TypeBackboneElement
32. GeneticClinicalReferral.referrer.name
Definition

Referring clinician name

ShortReferring Clinician Name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. GeneticClinicalReferral.referrer.specialty
Definition

Referring clinician specialty

ShortReferring Clinician Current Speciality
Control0..1
BindingUnless not suitable, these codes SHALL be taken from UK Core Practice Setting Code
(extensible to https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode)
TypeCodeableConcept
36. GeneticClinicalReferral.referrer.professionalIdentifier
Definition

e.g. GMC/GMP number

ShortReferring Clinician Professional Identifier
Control0..1
TypeIdentifier(Practitioner Identifier)
38. GeneticClinicalReferral.referrer.email
Definition

Referring clinician email

ShortEmail
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. GeneticClinicalReferral.referrer.phone
Definition

Referring clinician telephone

ShortPhone
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. GeneticClinicalReferral.referrer.organisation
Definition

ODS code of the referring organisation

ShortReferring Organisation
Control0..1
TypeIdentifier(Organisation Code)
44. GeneticClinicalReferral.recipient
Definition

Who the referral is sent to - a named clinician or a service/clinic. Genomic Test Order has no equivalent: an order's Order Filler is fixed.

ShortReferred-to Provider/Service
Control0..1
TypeBackboneElement
46. GeneticClinicalReferral.recipient.service
Definition

e.g. clinical genetics clinic

ShortReferred-to Service/Clinic Name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. GeneticClinicalReferral.recipient.organisation
Definition

ODS code of the receiving organisation

ShortReferred-to Organisation
Control0..1
TypeIdentifier(Organisation Code)
50. GeneticClinicalReferral.recipient.clinician
Definition

Named clinician, if any

ShortNamed Consultant/Clinician (if known)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. GeneticClinicalReferral.serviceRequested
Definition

The clinical service/assessment requested (e.g. genetic counselling, cascade testing) - not a Genomic Test Directory code. For a clinical genetics referral this is SNOMED CT 306119003.

ShortReferral Type / Service Requested
Control1..1
TypeCodeableConcept
Pattern Value
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "306119003"
    }
  ]
}
<serviceRequested>
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="306119003"/>
  </coding>
</serviceRequested>
54. GeneticClinicalReferral.reasonForReferral
Definition

Suspected/confirmed condition

ShortReason for referral
Control0..*
BindingUnless not suitable, these codes SHALL be taken from Genomic Clinical Indication Codes
(extensible to https://fhir.nwgenomics.nhs.uk/ValueSet/GenomicClinicalIndicationCodes)
TypeCodeableConcept
56. GeneticClinicalReferral.clinicalInformation
Definition

Brief free-text note, if no family letter is attached

ShortClinical details
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
58. GeneticClinicalReferral.forms
Definition

Completed referral forms, e.g. a national GMS test order form or a service-specific referral form, as structured answers.

ShortReferral forms
Control0..*
TypeReference(QuestionnaireResponse)
60. GeneticClinicalReferral.consultand
Definition

A named at-risk relative being referred alongside the proband - one per relative

ShortConsultand
Control0..*
TypeReference(RelatedPerson)
62. GeneticClinicalReferral.pathologyReport
Definition

The pathology report supporting the referral. Ideally a reference to a clinical document shared via the NHS England Single Patient Record (SPR); in the interim this may be an attached PDF (DocumentReference -> Binary). NHS England NDRS also holds Cancer Pathology Reports.

ShortPathology report
Control0..*
TypeReference(DocumentReference, Bundle)
64. GeneticClinicalReferral.patientSummary
Definition

The patient summary, as a clinical document. Not part of the NHS England Genomics ServiceRequest specification.

ShortPatient summary
Control0..1
TypeReference(DocumentReference, Bundle)
66. GeneticClinicalReferral.familyHistory
Definition

Structured family history (FamilyMemberHistory, one per relative), or the unstructured family letter as a clinical document. At present clinical genetics is believed to retrieve structured family history from NHS England NDRS (National Disease Registration Service). NDRS is a reporting/analytical service, so the information may not be current.

ShortFamily history
Control0..*
TypeReference(FamilyMemberHistory, DocumentReference, Bundle)

See the documentation on how to interpret the contents of this table

0. GeneticClinicalReferral
Definition

For analysis purposes only - not an active or planned project. This referral is not expected to be implemented within this IG; it is expected to be implemented via a Genomics England Limited application, NHS England BaRS/eRS or the NHS England Genomic Order Management Service.

A closed-loop clinical referral into a genomics/clinical genetics service (see Genetic Referrals), modelled on the IHE 360X HL7 v2 referral order OMG^O19 with OSU^O51 status updates (see Referral Request [PCC-55]) - not a laboratory order. The referral itself stays small: clinical content travels as forms, clinical documents (pathology report, patient summary) and family history referenced from the referral.

This is a logical model - it is not exchanged as is. It breaks down into ServiceRequest, Patient, PractitionerRole, Organization, HealthcareService, QuestionnaireResponse, RelatedPerson, Observation and clinical documents (DocumentReference or a FHIR Document Bundle).

ShortGenetic Clinical Referral
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. GeneticClinicalReferral.referralIdentifier
Definition

Originating referral identifier, assigned by the referrer and used in every message

ShortReferral Identifier
Control1..1
TypeIdentifier(Order Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
4. GeneticClinicalReferral.status
Definition

e.g. active, completed, revoked

ShortReferral Status
Control1..1
BindingThe codes SHALL be taken from RequestStatus
(required to http://hl7.org/fhir/ValueSet/request-status)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. GeneticClinicalReferral.priority
Definition

Urgency of the referral

ShortPriority
Control0..1
BindingThe codes SHALL be taken from Request Priority
(required to https://fhir.nwgenomics.nhs.uk/ValueSet/RequestPriority)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. GeneticClinicalReferral.dateOfReferral
Definition

When the referral was made

ShortDate of referral
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. GeneticClinicalReferral.patient
Definition

The proband. Same items as Genomic Test Order's patient.

ShortPatient
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. GeneticClinicalReferral.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
14. GeneticClinicalReferral.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 GeneticClinicalReferral.patient.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. GeneticClinicalReferral.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())
18. GeneticClinicalReferral.patient.nhsNumber
Definition

NHS Number of the patient

ShortNHS Number
Control0..1
TypeIdentifier(NHS Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
20. GeneticClinicalReferral.patient.medicalRecordNumber
Definition

Local hospital number of the patient

ShortHospital Number (Medical Record Number)
Control0..1
TypeIdentifier(Medical Record Number The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
22. GeneticClinicalReferral.patient.familyName
Definition

Patient surname

ShortPatient surname
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. GeneticClinicalReferral.patient.givenName
Definition

Patient first name

ShortPatient first name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. GeneticClinicalReferral.patient.birthDate
Definition

Patient date of birth

ShortDate of birth
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. GeneticClinicalReferral.patient.address
Definition

Address line(s) and postcode

ShortAddress
Control0..1
TypeAddress
30. GeneticClinicalReferral.patient.sexRegisteredAtBirth
Definition

Administrative gender

ShortSex registered at birth
Control0..1
BindingThe codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. GeneticClinicalReferral.patient.accountNumber
Definition

Patient account number

ShortAccount Number (Episode or Stay Number)
Control0..1
TypeIdentifier(Hospital Provider Spell Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
34. GeneticClinicalReferral.patient.pedigreeNumber
Definition

Links the proband to consultands (at-risk relatives) referred as part of the same family investigation. Not a Patient identifier.

ShortG Number (Pedigree Number)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. GeneticClinicalReferral.referrer
Definition

The referring clinician and organisation. Same items as Genomic Test Order's requester.

ShortReferring Provider
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. GeneticClinicalReferral.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
40. GeneticClinicalReferral.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 GeneticClinicalReferral.referrer.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
42. GeneticClinicalReferral.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())
44. GeneticClinicalReferral.referrer.name
Definition

Referring clinician name

ShortReferring Clinician Name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. GeneticClinicalReferral.referrer.specialty
Definition

Referring clinician specialty

ShortReferring Clinician Current Speciality
Control0..1
BindingUnless not suitable, these codes SHALL be taken from UK Core Practice Setting Code
(extensible to https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode)
TypeCodeableConcept
48. GeneticClinicalReferral.referrer.professionalIdentifier
Definition

e.g. GMC/GMP number

ShortReferring Clinician Professional Identifier
Control0..1
TypeIdentifier(Practitioner Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
50. GeneticClinicalReferral.referrer.email
Definition

Referring clinician email

ShortEmail
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. GeneticClinicalReferral.referrer.phone
Definition

Referring clinician telephone

ShortPhone
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. GeneticClinicalReferral.referrer.organisation
Definition

ODS code of the referring organisation

ShortReferring Organisation
Control0..1
TypeIdentifier(Organisation Code The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
56. GeneticClinicalReferral.recipient
Definition

Who the referral is sent to - a named clinician or a service/clinic. Genomic Test Order has no equivalent: an order's Order Filler is fixed.

ShortReferred-to Provider/Service
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. GeneticClinicalReferral.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
60. GeneticClinicalReferral.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 GeneticClinicalReferral.recipient.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
62. GeneticClinicalReferral.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())
64. GeneticClinicalReferral.recipient.service
Definition

e.g. clinical genetics clinic

ShortReferred-to Service/Clinic Name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
66. GeneticClinicalReferral.recipient.organisation
Definition

ODS code of the receiving organisation

ShortReferred-to Organisation
Control0..1
TypeIdentifier(Organisation Code The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well)
68. GeneticClinicalReferral.recipient.clinician
Definition

Named clinician, if any

ShortNamed Consultant/Clinician (if known)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
70. GeneticClinicalReferral.serviceRequested
Definition

The clinical service/assessment requested (e.g. genetic counselling, cascade testing) - not a Genomic Test Directory code. For a clinical genetics referral this is SNOMED CT 306119003.

ShortReferral Type / Service Requested
Control1..1
TypeCodeableConcept
Pattern Value
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "306119003"
    }
  ]
}
<serviceRequested>
  <coding>
    <system value="http://snomed.info/sct"/>
    <code value="306119003"/>
  </coding>
</serviceRequested>
72. GeneticClinicalReferral.reasonForReferral
Definition

Suspected/confirmed condition

ShortReason for referral
Control0..*
BindingUnless not suitable, these codes SHALL be taken from Genomic Clinical Indication Codes
(extensible to https://fhir.nwgenomics.nhs.uk/ValueSet/GenomicClinicalIndicationCodes)
TypeCodeableConcept
74. GeneticClinicalReferral.clinicalInformation
Definition

Brief free-text note, if no family letter is attached

ShortClinical details
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
76. GeneticClinicalReferral.forms
Definition

Completed referral forms, e.g. a national GMS test order form or a service-specific referral form, as structured answers.

ShortReferral forms
Control0..*
TypeReference(QuestionnaireResponse)
78. GeneticClinicalReferral.consultand
Definition

A named at-risk relative being referred alongside the proband - one per relative

ShortConsultand
Control0..*
TypeReference(RelatedPerson)
80. GeneticClinicalReferral.pathologyReport
Definition

The pathology report supporting the referral. Ideally a reference to a clinical document shared via the NHS England Single Patient Record (SPR); in the interim this may be an attached PDF (DocumentReference -> Binary). NHS England NDRS also holds Cancer Pathology Reports.

ShortPathology report
Control0..*
TypeReference(DocumentReference, Bundle)
82. GeneticClinicalReferral.patientSummary
Definition

The patient summary, as a clinical document. Not part of the NHS England Genomics ServiceRequest specification.

ShortPatient summary
Control0..1
TypeReference(DocumentReference, Bundle)
84. GeneticClinicalReferral.familyHistory
Definition

Structured family history (FamilyMemberHistory, one per relative), or the unstructured family letter as a clinical document. At present clinical genetics is believed to retrieve structured family history from NHS England NDRS (National Disease Registration Service). NDRS is a reporting/analytical service, so the information may not be current.

ShortFamily history
Control0..*
TypeReference(FamilyMemberHistory, DocumentReference, Bundle)