Notice
- Important: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
- This Implementation Guide is currently in Draft and SHOULD NOT be used for development or active implementation without express direction from the NHS England Genomics Unit.
Genomics-ServiceRequest
Focal resource for test order messages. All additional information or resources SHOULD be linked back to the ServiceRequest or be referenced from the ServiceRequest directly.
ServiceRequests which have been updated post submission SHALL be accompanied by Provenance resources, referencing the ServiceRequest which detail when the resource was changed, who made the change and why.
An illustrative diagram of the links between ServiceRequests and other resources is provided below. Note: not all resource links are represented, to increase legibility of the diagram.
Profile url | FHIR Module | Normative Status |
---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest | UKCore | trial-use |
UKCoreServiceRequest (ServiceRequest) | I | ServiceRequest | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
sourceOfServiceRequest | I | 0..1 | Extension(CodeableConcept) |
additionalContact | I | 0..* | Extension(Reference(Organization | Practitioner | PractitionerRole)) |
coverage | I | 0..1 | Extension(CodeableConcept) |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) |
instantiatesUri | Σ | 0..* | uri |
basedOn | S Σ I | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) |
replaces | Σ I | 0..* | Reference(ServiceRequest) |
requisition | Σ | 0..1 | Identifier |
status | S Σ ?! | 1..1 | codeBinding |
intent | S Σ ?! | 1..1 | codeBinding |
category | S Σ | 0..* | CodeableConcept |
genomicsWholeCaseSequencing | Σ | 0..* | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
priority | S Σ | 0..1 | codeBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
priorityReason | I | 0..* | Extension(CodeableConcept) |
value | 0..1 | System.String | |
doNotPerform | Σ ?! | 0..1 | boolean |
code | S Σ | 0..1 | CodeableConceptBinding |
orderDetail | Σ I | 0..* | CodeableConceptBinding |
quantity[x] | Σ | 0..1 | |
quantityQuantity | Quantity | ||
quantityRatio | Ratio | ||
quantityRange | Range | ||
subject | S Σ I | 1..1 | Reference(Patient | Group | Location | Device) |
encounter | Σ I | 0..1 | Reference(Encounter) |
occurrence[x] | Σ | 0..1 | |
occurrenceDateTime | dateTime | ||
occurrencePeriod | Period | ||
occurrenceTiming | Timing | ||
asNeeded[x] | Σ | 0..1 | |
asNeededBoolean | boolean | ||
asNeededCodeableConcept | CodeableConcept | ||
authoredOn | S Σ | 0..1 | dateTime |
requester | S Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) |
performerType | Σ | 0..1 | CodeableConcept |
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) |
locationCode | Σ | 0..* | CodeableConcept |
locationReference | Σ I | 0..* | Reference(Location) |
reasonCode | Σ | 0..* | CodeableConceptBinding |
reasonReference | Σ I | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) |
insurance | I | 0..* | Reference(Coverage | ClaimResponse) |
supportingInfo | I | 0..* | Reference(Resource) |
specimen | Σ I | 0..* | Reference(Specimen) |
bodySite | Σ | 0..* | CodeableConceptBinding |
note | 0..* | Annotation | |
patientInstruction | Σ | 0..1 | string |
relevantHistory | I | 0..* | Reference(Provenance) |
Differential from ServiceRequest
UKCoreServiceRequest (ServiceRequest) | I | ServiceRequest | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
sourceOfServiceRequest | I | 0..1 | Extension(CodeableConcept) |
additionalContact | I | 0..* | Extension(Reference(Organization | Practitioner | PractitionerRole)) |
coverage | I | 0..1 | Extension(CodeableConcept) |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) |
instantiatesUri | Σ | 0..* | uri |
basedOn | S Σ I | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) |
replaces | Σ I | 0..* | Reference(ServiceRequest) |
requisition | Σ | 0..1 | Identifier |
status | S Σ ?! | 1..1 | codeBinding |
intent | S Σ ?! | 1..1 | codeBinding |
category | S Σ | 0..* | CodeableConcept |
genomicsWholeCaseSequencing | Σ | 0..* | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
priority | S Σ | 0..1 | codeBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
priorityReason | I | 0..* | Extension(CodeableConcept) |
value | 0..1 | System.String | |
doNotPerform | Σ ?! | 0..1 | boolean |
code | S Σ | 0..1 | CodeableConceptBinding |
orderDetail | Σ I | 0..* | CodeableConceptBinding |
quantity[x] | Σ | 0..1 | |
quantityQuantity | Quantity | ||
quantityRatio | Ratio | ||
quantityRange | Range | ||
subject | S Σ I | 1..1 | Reference(Patient | Group | Location | Device) |
encounter | Σ I | 0..1 | Reference(Encounter) |
occurrence[x] | Σ | 0..1 | |
occurrenceDateTime | dateTime | ||
occurrencePeriod | Period | ||
occurrenceTiming | Timing | ||
asNeeded[x] | Σ | 0..1 | |
asNeededBoolean | boolean | ||
asNeededCodeableConcept | CodeableConcept | ||
authoredOn | S Σ | 0..1 | dateTime |
requester | S Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) |
performerType | Σ | 0..1 | CodeableConcept |
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) |
locationCode | Σ | 0..* | CodeableConcept |
locationReference | Σ I | 0..* | Reference(Location) |
reasonCode | Σ | 0..* | CodeableConceptBinding |
reasonReference | Σ I | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) |
insurance | I | 0..* | Reference(Coverage | ClaimResponse) |
supportingInfo | I | 0..* | Reference(Resource) |
specimen | Σ I | 0..* | Reference(Specimen) |
bodySite | Σ | 0..* | CodeableConceptBinding |
note | 0..* | Annotation | |
patientInstruction | Σ | 0..1 | string |
relevantHistory | I | 0..* | Reference(Provenance) |
ServiceRequest | |
Definition | A record of a request for service such as diagnostic investigations, treatments, or operations to be performed. |
Cardinality | 0...* |
Alias | diagnostic request, referral, referral request, transfer of care request |
Invariants |
|
Mappings |
|
ServiceRequest.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
ServiceRequest.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
ServiceRequest.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
ServiceRequest.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
ServiceRequest.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
ServiceRequest.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
ServiceRequest.extension:sourceOfServiceRequest | |
Definition | This represents the source of referral. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
ServiceRequest.extension:additionalContact | |
Definition | Details of an additional contact, who should be contacted regarding questions arising from the service request. |
Cardinality | 0...* |
Type | Extension(Reference(Organization | Practitioner | PractitionerRole)) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
ServiceRequest.extension:coverage | |
Definition | The funding category for the Service Request. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
ServiceRequest.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
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. |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
ServiceRequest.identifier | |
Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Comments | The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below. |
Invariants |
|
Mappings |
|
ServiceRequest.instantiatesCanonical | |
Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
Cardinality | 0...* |
Type | canonical(ActivityDefinition | PlanDefinition) |
Summary | True |
Comments | Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
Invariants |
|
Mappings |
|
ServiceRequest.instantiatesUri | |
Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
Cardinality | 0...* |
Type | uri |
Summary | True |
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. |
Invariants |
|
Mappings |
|
ServiceRequest.basedOn | |
Definition | Plan/proposal/order fulfilled by this request. |
Cardinality | 0...* |
Type | Reference(CarePlan | ServiceRequest | MedicationRequest) |
Must Support | True |
Summary | True |
Alias | fulfills |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ServiceRequest.replaces | |
Definition | The request takes the place of the referenced completed or terminated request(s). |
Cardinality | 0...* |
Type | Reference(ServiceRequest) |
Summary | True |
Alias | supersedes, prior, renewed order |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ServiceRequest.requisition | |
Definition | A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Alias | grouperId, groupIdentifier |
Requirements | Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes. |
Comments | Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation. |
Invariants |
|
Mappings |
|
ServiceRequest.status | |
Definition | The status of the order. |
Cardinality | 1...1 |
Type | code |
Binding | The status of a service order. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource. |
Invariants |
|
Mappings |
|
ServiceRequest.intent | |
Definition | Whether the request is a proposal, plan, an original order or a reflex order. |
Cardinality | 1...1 |
Type | code |
Binding | The kind of service request. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. |
Invariants |
|
Mappings |
|
ServiceRequest.category | |
Definition | A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Classification of the requested service. |
Must Support | True |
Summary | True |
Requirements | Used for filtering what service request are retrieved and displayed. |
Comments | There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. |
Slicing | Unordered, Open, by coding.system(Value) |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing | |
Definition | A code that classifies the service for Genomics, whether it is a Whole Case Genome Sequencing or non-Whole Genome Sequencing for cancer or rare diseases |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Classification of the requested service. |
Summary | True |
Requirements | Used for filtering what service request are retrieved and displayed. |
Comments | There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory |
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
ServiceRequest.priority | |
Definition | Indicates how quickly the ServiceRequest should be addressed with respect to other requests. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the level of importance to be assigned to actioning the request. |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
ServiceRequest.priority.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
ServiceRequest.priority.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
ServiceRequest.priority.extension:priorityReason | |
Definition | A SNOMED CT concept representing the reason a Service Request is urgent |
Cardinality | 0...* |
Type | Extension(CodeableConcept) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
ServiceRequest.priority.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
ServiceRequest.doNotPerform | |
Definition | Set this to true if the record is saying that the service/procedure should NOT be performed. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
Requirements | Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc. |
Comments | In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation. |
Invariants |
|
Mappings |
|
ServiceRequest.code | |
Definition | A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system. |
Must Support | True |
Summary | True |
Alias | service requested |
Comments | Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code. |
Invariants |
|
Mappings |
|
ServiceRequest.orderDetail | |
Definition | Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codified order entry details which are based on order context. |
Summary | True |
Alias | detailed instructions |
Comments | For information from the medical record intended to support the delivery of the requested services, use the |
Invariants |
|
Mappings |
|
ServiceRequest.quantity[x] | |
Definition | An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction). |
Cardinality | 0...1 |
Type | Quantity |
Summary | True |
Requirements | When ordering a service the number of service items may need to be specified separately from the the service item. |
Invariants |
|
Mappings |
|
ServiceRequest.subject | |
Definition | On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). |
Cardinality | 1...1 |
Type | Reference(Patient | Group | Location | Device) |
Must Support | True |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ServiceRequest.encounter | |
Definition | An encounter that provides additional information about the healthcare context in which this request is made. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Summary | True |
Alias | context |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ServiceRequest.occurrence[x] | |
Definition | The date/time at which the requested service should occur. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Alias | schedule |
Invariants |
|
Mappings |
|
ServiceRequest.asNeeded[x] | |
Definition | If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. |
Cardinality | 0...1 |
Type | boolean |
Binding | A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.authoredOn | |
Definition | When the request transitioned to being actionable. |
Cardinality | 0...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Alias | orderedOn |
Invariants |
|
Mappings |
|
ServiceRequest.requester | |
Definition | The individual who initiated the request and has responsibility for its activation. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) |
Must Support | True |
Summary | True |
Alias | author, orderer |
Comments | This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource. |
Invariants |
|
Mappings |
|
ServiceRequest.performerType | |
Definition | Desired type of performer for doing the requested service. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
Summary | True |
Alias | specialty |
Comments | This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”. |
Invariants |
|
Mappings |
|
ServiceRequest.performer | |
Definition | The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) |
Summary | True |
Alias | request recipient |
Comments | If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the request-performerOrder extension. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B). |
Invariants |
|
Mappings |
|
ServiceRequest.locationCode | |
Definition | The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A location type where services are delivered. |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
ServiceRequest.locationReference | |
Definition | A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. |
Cardinality | 0...* |
Type | Reference(Location) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ServiceRequest.reasonCode | |
Definition | An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A set of codes that define a reason for a service request. |
Summary | True |
Comments | This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. Use |
Invariants |
|
Mappings |
|
ServiceRequest.reasonReference | |
Definition | Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`. |
Cardinality | 0...* |
Type | Reference(Condition | Observation | DiagnosticReport | DocumentReference) |
Summary | True |
Comments | This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise when referencing DiagnosticReport it should contain a finding in |
Invariants |
|
Mappings |
|
ServiceRequest.insurance | |
Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. |
Cardinality | 0...* |
Type | Reference(Coverage | ClaimResponse) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ServiceRequest.supportingInfo | |
Definition | Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. |
Cardinality | 0...* |
Type | Reference(Resource) |
Alias | Ask at order entry question, AOE |
Comments | To represent information about how the services are to be delivered use the |
Invariants |
|
Mappings |
|
ServiceRequest.specimen | |
Definition | One or more specimens that the laboratory procedure will use. |
Cardinality | 0...* |
Type | Reference(Specimen) |
Summary | True |
Comments | Many diagnostic procedures need a specimen, but the request itself is not actually about the specimen. This element is for when the diagnostic is requested on already existing specimens and the request points to the specimen it applies to. Conversely, if the request is entered first with an unknown specimen, then the Specimen resource points to the ServiceRequest. |
Invariants |
|
Mappings |
|
ServiceRequest.bodySite | |
Definition | Anatomic location where the procedure should be performed. This is the target site. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes describing anatomical locations. May include laterality. |
Summary | True |
Alias | location |
Requirements | Knowing where the procedure is performed is important for tracking if multiple sites are possible. |
Comments | Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension procedure-targetBodyStructure. |
Invariants |
|
Mappings |
|
ServiceRequest.note | |
Definition | Any other notes and comments made about the service request. For example, internal billing notes. |
Cardinality | 0...* |
Type | Annotation |
Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). |
Invariants |
|
Mappings |
|
ServiceRequest.patientInstruction | |
Definition | Instructions in terms that are understood by the patient or consumer. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
ServiceRequest.relevantHistory | |
Definition | Key events in the history of the request. |
Cardinality | 0...* |
Type | Reference(Provenance) |
Comments | This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject. |
Invariants |
|
Mappings |
|
key | human | severity | expression |
---|---|---|---|
gen-1 | Extension must be present if priority is not routine | error | (ServiceRequest.extension(priorityReason).exists() and ServiceRequest.priority!=routine) or ServiceRequest.priority=routine |
FHIR | MDS | HL7v2 |
---|---|---|
ServiceRequest.requester | Requester (more details in PractitionerRole resource mappings), PLCM activity - Commissioned service category code, Previous genomic report - Original requester full name, Previous genomic report - Original requester organisation ODS code, Previous genomic report - Original requester reason for request, Previous non genomic report - Original requester full name, Previous non genomic report - Original requester organisation ODS code, Previous non genomic report - Original requester reason for request | Various ORC/STF segments |
ServiceRequest.extension:additionalContact | Additional Contact (more details in PractitionerRole resource mappings) | Various STF segments |
ServiceRequest.subject | Patient (more details in Patient resource mappings), Patient - Is relative | First PID segment in OML message, relatives referenced through NK1 segments |
ServiceRequest.identifier | Test request - Test request id, PLCM activity - NGIS referral identifier, Previous genomic report - Report lab test number | ORC-2, ORC-3 |
ServiceRequest.extension:coverage | Test request - Payment status | IN1-15 |
ServiceRequest.authoredOn | Test request - Date and time request sent, PLCM activity - Financial month, PLCM activity - Financial year, PLCM activity - Turnaround time (calendar days) | ORC-9 (for TAT subtracted from OBR-7) |
ServiceRequest.priority | Test request - Is urgent | TQ1-9 |
ServiceRequest.extension:priorityReason | Test request - Urgency reason | N/A could possibly use TQ1-10 |
ServiceRequest.code.coding.system | Test request - Test Directory version | OBR-4.3 |
ServiceRequest.code | Test request - CI code, Test request - CITT code, PLCM activity - Service code, PLCM activity - Point of delivery code, PLCM activity - Local point of delivery code, PLCM activity - Test method code | OBR-4 |
ServiceRequest.orderDetail | Test request - CI code for multipurpose CITT, Test request - Type of reanalysis, Test request - DNA storage information | NTE segment attached to OBR |
ServiceRequest.reasonCode | Test request - Reason for testing, Test request - Reason for reanalysis | OBR-13 segment linked to ORC |
ServiceRequest.supportingInfo | Test request - Detail of reason for reanalysis, Test request - Further information | NTE segments linked to OBR segment for reanalysis reason, Additional segments attached to ORC/OBR |
ServiceRequest.occurrenceDateTime | Test request - Date report required by | OBR-8 |
ServiceRequest.performer | PLCM activity - ODS code of organisation commissioned to deliver requested test | PRD-7 where PRD-1=RT |
ServiceRequest.note | Raw specimen/biopsy - Sample to follow reason | NTE segment attached to ORC |
Constraint Profiles
Profiles indicating preferred element cardinality for use in Genomics, not to be used for validation
name | profile |
---|---|
NHSDigital_ServiceRequest_Genomics | https://fhir.nhs.uk/StructureDefinition/NHSDigital-ServiceRequest-Genomics |
Additional Guidance
- extension:additionalContact
- extension:coverage
- identifier
- basedOn
- status
- intent
- category
- priority
- doNotPerform
- code
- orderDetail
- subject
- occurrence[x]
- authoredOn
- requester
- performer
- reasonCode
- reasonReference
- supportingInfo
- specimen
- note
extension:additionalContact
Extension used for recording additional personnel who should be contacted regarding questions related to a test order. This is separate from the requester or reporting address.
The additional contact SHOULD be a reference to a PractitionerRole resource wherever possible and SHALL contain contact details for the practitioner.
Additionally, where are there multiple practitioners involved in providing care who need to be listed as contacts, the contact details for each practitioner (or service) SHOULD be specified through additional additionalContact entries.
{ "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact", "valueReference": { "reference": "PractitionerRole/PractitionerRole-AdditionalContact-Example" } },
extension:coverage
SHALL be present for Genomic Order Management test orders. Extension for recording how work against the test order is being funded. The ValueSet bound to this extension is currently under review by the NHS England Genomics Informatics Working Advisory Group and subject to change.
{ "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage", "valueCoding": { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-FundingCategory", "code": "nhs", "display": "NHS" } }
identifier
Automatically assigned by the central service, though source systems MAY provide a local identifier for tracking within their own system, in which case the central order number is appended to the identifiers array.
"identifier": [ { "system": "https://fhir.nhs.uk/Id/GMSOrder", "value": "ROA43728" } ],
basedOn
SHALL reference a parent request where this ServiceRequest is based on a previous request, e.g. in the case of reanalysis and cascade testing, or Germline Late tests in the Tumour First/Germline Late scenario.
"basedOn": [ { "reference": "ServiceRequest/ServiceRequest-NonWGSTestOrderForm-FatherOfFayMutlow-Example" } ],
status
SHALL be provided. ServiceRequests SHOULD be marked as 'draft' until submitted, after which they will be marked as 'active' automatically by the central GMS system.
A ServiceRequest may be marked as 'on-hold' if work against it cannot continue temporarily, e.g. due to certain prerequisite information not being provided. A ServiceRequest SHOULD be marked as 'revoked' if cancelled, either by the lab performing work against the order or at the request of the requesting clinician, though in each case a Provenance resource SHALL be provided to capture why the state change has occurred. The requesting clinician may also mark the ServiceRequest as entered-in-error, though implications for work already in progress needs to be investigated further.
A ServiceRequest SHOULD only be marked as completed by the requesting clinician upon receipt and review of the resulting DiagnosticReport.
For the full list of expected/supported ServiceRequest statuses, please see the table below:
Status | Description | Genomic workflow usage |
---|---|---|
Draft | The request has been created but is not yet complete or ready for action. | Saved but not submitted to central service (out of scope for Alpha). |
Active | The request is in force and ready to be acted upon. | Submitted to central service. |
On Hold | The request (and any implicit authorization to act) has been temporarily withdrawn but is expected to resume in the future. | Issue with the authorization for the test (potentially recoverable), not expected to be driven by on-hold statuses of Tasks. |
Revoked | The request (and any implicit authorization to act) has been terminated prior to the known full completion of the intended actions. No further activity should occur. | Unrecoverable issue with order. Either used when the test is no longer needed or there is an is an unrecoverable failure with its fulfillment (driven by the requesting clinician). This status will propagate down to any Tasks which have not already moved into in-progress, Tasks not started will be marked with the status of cancelled. |
Completed | The activity described by the request has been fully performed. No further activity will occur. | Completed order, marked by requestor once DiagnosticReport is received and accepted. |
Entered in Error | This request should never have existed and should be considered 'void'. (It is possible that real-world decisions were based on it. If real-world activity has occurred, the status should be "revoked" rather than "entered-in-error".) | MAY be used for ServiceRequests created in error, can only be set if no Tasks have been started. If a Task has been moved out of its initial state, the status of Revoked SHOULD be used instead. This status will propagate down to Tasks, marking the tasks as entered-in-error. |
Unknown | The authoring/source system does not know which of the status values currently applies for this request. Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, but the authoring/source system does not know which. | Should not be used. |
"status": "active",
intent
SHALL be provided. ServiceRequests SHOULD be marked as 'order' unless they have been raised by a lab in response to an existing ServiceRequest, in which case they SHOULD be marked as 'reflex-order'. For reflex orders, the ServiceRequest.basedOn field SHALL be populated with the original ServiceRequest, for traceability.
"intent": "order",
category
ServiceRequests SHOULD use the Genomics Sequencing Category ValueSet when categorising the test order in order to aid analytics (e.g. PLCM). This list is pending review from the Informatics Working Advisory Group, after which a full list of possible categorisations will be finalised.
"category": [ { "coding": [ { "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory", "code": "rare-disease-non-wgs", "display": "Rare Disease - Non-WGS" } ] } ],
priority
ServiceRequests marked as urgent (i.e. not routine) SHOULD populate the extension:priorityReason with why an urgent test is being requested. This SHOULD ideally be coded using SNOMED CT concepts. Multiple priorityReason extensions are allowed within a single ServiceRequest in order to aid post-coordination.
"priority": "urgent", "_priority": { "extension" : [ { "url" : "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason", "valueCodeableConcept" : { "coding": [ { "system": "http://snomed.info/sct", "code": "722480002", "display": "Chemotherapy started" } ] } } ] }
doNotPerform
For the purposes of Genomic Test Ordering, the doNotPerform field SHALL NOT be used. All ServiceRequests requests received by the system will be assumed to be orders for services/testing.
code
SHALL be provided. Code SHOULD contain the CI or CITT Test Directory code, currently available at https://www.england.nhs.uk/publication/national-genomic-test-directories/. There is currently no CodeSystem or queryable API for retrieving codes but work to address this is underway within the NHS England Genomics Unit.
Codes from the Genomic Test Directory SHOULD also specify the version number of the test directory at the time the test is being ordered, to ensure the test methods used are consistent with that version of the directory.
"code": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory", "code": "R67.2", "display": "Monogenic hearing loss", "version": "7" } ] },
orderDetail
If multiple codes are being requested within one Test Order, these SHOULD be represented using the 'orderDetail' field, with the main indication captured using the 'code' field above. If completely separate pathways/samples etc. are required for processing against the codes, it is expected these would be requested via multiple ServiceRequests instead of a single ServiceRequest with multiple orderDetail codes. The exact cut-off for when orderDetail vs. multiple ServiceRequest should be used is still being investigated. An appropriate code(Panel codes) SHOULD come from the following NamingSystem: England-GenomicTestPanelCode
"orderDetail": [ { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory", "code": "R67.1", "display": "Monogenic hearing loss" } ] } ],
subject
SHALL be provided. Reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS
"subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
occurrence[x]
If a result is required by a specific date, this MAY be indicated though occurrenceDateTime, though there is no guarantee from the GMS that the ServiceRequest will be processed in the time frame specified.
"occurrenceDateTime": "2023-08-25",
authoredOn
SHALL be populated by the client upon submission, either manually by the user or automatically by the system integrating with the central GMS.
"authoredOn": "2023-08-05",
requester
SHALL be populated on all ServiceRequests submitted to the central GMS. This SHALL reference a PractitionerRole resource also submitted to the system (either within a single transaction or previously POSTed).
"requester": { "reference": "PractitionerRole/PractitionerRole-GeneSmithENT-Example" },
performer
Allows a requester to assign processing of the ServiceRequest to a particular organization (e.g. a remote GLH). The performer field SHOULD be populated with the ODS code for the managing organization/GLH.
In the future state, ServiceRequests may be kept open, by not specifying a performer, allowing them to be picked up by the local GLH or otherwise routed based on by test routing (TBC).
"performer": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RGT01" } } ]
reasonCode
reasonCode SHOULD be populated with the type of request being ordered e.g. Diagnostic, Carrier, Predictive, Stored DNA etc. The final list of applicable codes which can be selected is still under review. It is expected that a fixed list of SNOMED CT codes will be permissible, to allow appropriate categorisation by the central service.
This mapping is currently under review as the CI/CITT code is also technically the reason/indication for testing.
"reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "103693007", "display": "Diagnostic procedure" } ] } ],
reasonReference
Reference SHOULD be associated to the primary condition being tested for. i.e,
"reasonReference": { "reference": "Condition/Condition-LungTumor-Example" },
supportingInfo
Any clinical information provided about the patient for whom the testing is being requested SHALL be referenced though the supportingInfo field, to ensure all the information relevant to the ServiceRequest can be easily retrieved. This includes Observations, Conditions, Procedures, FamilyMemberHistories etc.
This also includes resources related to family members included as part of testing (consultands), e.g. in Duo/Trio scenarios. In this instance, RelatedPerson and Patient resource references for the consultands SHALL be added to the supportingInfo array, as well as any clinical resources related to these individuals. This is to ensure the number of participants for a given test can be calculated correctly, e.g. through counting the number of RelatedPerson resources referenced from ServiceRequest.supportingInfo plus the subject of the ServiceRequest itself (the proband).
For WGS testing, where Records of Discussion are required in order to process the test, Consent resources SHOULD also be added to the supportingInfo array once available.
"supportingInfo": [ { "reference": "Observation/Observation-DiseaseStatus-Example" }, { "reference": "Observation/Observation-GenomicEthnicity-Example" }, { "reference": "Observation/Observation-NoPregnancy-Example" }, { "reference": "FamilyMemberHistory/FamilyMemberHistory-NonConsanguinousUnion-Example" }, { "reference": "Observation/Observation-NoTransplant-Example" }, { "reference": "Observation/Observation-NoTransfusion-Example" }, { "reference": "Condition/Condition-HearingLoss-Example" }, { "reference": "RelatedPerson/RelatedPerson-AliceSmithamProbandMother-Example" }, { "reference": "Patient/Patient-PheobeSmithamMother-Example" }, ],
specimen
ServiceRequests where the required samples already exist, e.g. in the case where a specimen already in storage needs to be processed, SHOULD reference these samples through the ServiceRequest.specimen field. Where samples need to be collected to support testing, these SHOULD instead reference the ServiceRequest, through Specimen.request (i.e. the service request has prompted collection of the sample), and SHOULD also be referenced from within ServiceRequest.supportingInfo as per the guidance above (pending review). The referenced Specimen resources SHOULD either be contained within the test order transaction bundle or already exist on the central GMS.
In the case of Reanalysis or Reinterpretation tests, Specimens related to previous ServiceRequest are not required to be added to the new test request. The links from the previous ServiceRequest can be followed to identify the Specimens that resulted in the data being reanalysed, e.g. (reanalysis) ServiceRequest.basedOn -> (prior) ServiceRequest, (prior) ServiceRequest <- (original) Specimen.request
"specimen": [ { "reference": "Specimen/Specimen-BloodSerum-Example" } ],
note
Any information which cannot be readily be structured SHOULD be entered into the note field, though prolific use of the field to capture clinical information which better fits in level 3/4 FHIR resources is discouraged.
"note": [ { "text": "No family history of genomic testing" } ]