- This version of the UK Core is a development copy.
- This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
- This version is not yet reviewed for implementation. Other versions are available on the UK Core Version History Guide
- Please follow the guidance on the Contact Us page if you need any assistance.
- A summary of changes is available on the STU3 Sequence Change Log
StructureDefinition UKCore-ServiceRequest
Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest | active | 2.5.1 | 2024-07-23 | This profile defines the UK constraints and extensions on the International FHIR resource ServiceRequest. |
Profile_Purpose |
---|
This profile is a record of a request for a procedure or diagnostic or other service to be planned, proposed, or performed, as distinguished by the ServiceRequest.intent field value, with or on a patient. |
Detailed Descriptions
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 |
|
Table View
ServiceRequest | .. | |
ServiceRequest.extension | Extension | ..1 |
ServiceRequest.extension | Extension | .. |
ServiceRequest.extension | Extension | ..1 |
ServiceRequest.basedOn | .. | |
ServiceRequest.status | .. | |
ServiceRequest.intent | .. | |
ServiceRequest.category | .. | |
ServiceRequest.category | .. | |
ServiceRequest.category.coding | .. | |
ServiceRequest.category.coding.system | .. | |
ServiceRequest.priority | .. | |
ServiceRequest.priority.extension | Extension | .. |
ServiceRequest.code | .. | |
ServiceRequest.orderDetail | .. | |
ServiceRequest.subject | .. | |
ServiceRequest.authoredOn | .. | |
ServiceRequest.requester | .. | |
ServiceRequest.reasonCode | .. | |
ServiceRequest.bodySite | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-ServiceRequest" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest" /> <version value="2.5.1" /> <name value="UKCoreServiceRequest" /> <title value="UK Core Service Request" /> <status value="active" /> <date value="2024-07-23" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="ukcore@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This profile defines the UK constraints and extensions on the International FHIR resource [ServiceRequest](https://hl7.org/fhir/R4/ServiceRequest.html)." /> <purpose value="This profile is a record of a request for a procedure or diagnostic or other service to be planned, proposed, or performed, as distinguished by the ServiceRequest.intent field value, with or on a patient." /> <copyright value="Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="ServiceRequest" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ServiceRequest" /> <derivation value="constraint" /> <differential> <element id="ServiceRequest.extension:sourceOfServiceRequest"> <path value="ServiceRequest.extension" /> <sliceName value="sourceOfServiceRequest" /> <short value="Describes the source of the Service Request." /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest" /> </type> <isModifier value="false" /> </element> <element id="ServiceRequest.extension:additionalContact"> <path value="ServiceRequest.extension" /> <sliceName value="additionalContact" /> <short value="Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact" /> </type> <isModifier value="false" /> </element> <element id="ServiceRequest.extension:coverage"> <path value="ServiceRequest.extension" /> <sliceName value="coverage" /> <short value="Supports the exchange of information describing the method of funding for the Service Request." /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage" /> </type> <isModifier value="false" /> </element> <element id="ServiceRequest.basedOn"> <path value="ServiceRequest.basedOn" /> <short value="What the service request fulfils." /> <mustSupport value="true" /> </element> <element id="ServiceRequest.status"> <path value="ServiceRequest.status" /> <short value="The status of the order." /> <mustSupport value="true" /> </element> <element id="ServiceRequest.intent"> <path value="ServiceRequest.intent" /> <short value="Whether the request is a proposal, plan, an original order or a reflex order." /> <mustSupport value="true" /> </element> <element id="ServiceRequest.category"> <path value="ServiceRequest.category" /> <slicing> <discriminator> <type value="value" /> <path value="coding.system" /> </discriminator> <rules value="open" /> </slicing> <short value="A code that classifies the service for searching, sorting and display purposes." /> <mustSupport value="true" /> </element> <element id="ServiceRequest.category:genomicsWholeCaseSequencing"> <path value="ServiceRequest.category" /> <sliceName value="genomicsWholeCaseSequencing" /> <short value="Classification of Genomics service" /> <definition value="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" /> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory" /> </binding> </element> <element id="ServiceRequest.category:genomicsWholeCaseSequencing.coding.system"> <path value="ServiceRequest.category.coding.system" /> <fixedUri value="https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory" /> </element> <element id="ServiceRequest.priority"> <path value="ServiceRequest.priority" /> <short value="Indicates how quickly the ServiceRequest should be addressed with respect to other requests." /> <mustSupport value="true" /> </element> <element id="ServiceRequest.priority.extension:priorityReason"> <path value="ServiceRequest.priority.extension" /> <sliceName value="priorityReason" /> <short value="Supports the underlying reason why a Service Request is urgent." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason" /> </type> <isModifier value="false" /> </element> <element id="ServiceRequest.code"> <path value="ServiceRequest.code" /> <short value="What is being requested/ordered." /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <description value="A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode" /> </binding> </element> <element id="ServiceRequest.orderDetail"> <path value="ServiceRequest.orderDetail" /> <binding> <strength value="preferred" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode" /> </binding> </element> <element id="ServiceRequest.subject"> <path value="ServiceRequest.subject" /> <short value="The individual or entity the service is ordered for." /> <mustSupport value="true" /> </element> <element id="ServiceRequest.authoredOn"> <path value="ServiceRequest.authoredOn" /> <short value="The date the request was signed." /> <mustSupport value="true" /> </element> <element id="ServiceRequest.requester"> <path value="ServiceRequest.requester" /> <short value="Who / what is requesting the service" /> <mustSupport value="true" /> </element> <element id="ServiceRequest.reasonCode"> <path value="ServiceRequest.reasonCode" /> <binding> <strength value="preferred" /> <description value="A set of codes that define a reason for a service request." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode" /> </binding> </element> <element id="ServiceRequest.bodySite"> <path value="ServiceRequest.bodySite" /> <binding> <strength value="preferred" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-ServiceRequest", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest", "version": "2.5.1", "name": "UKCoreServiceRequest", "title": "UK Core Service Request", "status": "active", "date": "2024-07-23", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [ServiceRequest](https://hl7.org/fhir/R4/ServiceRequest.html).", "purpose": "This profile is a record of a request for a procedure or diagnostic or other service to be planned, proposed, or performed, as distinguished by the ServiceRequest.intent field value, with or on a patient.", "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "ServiceRequest", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "derivation": "constraint", "differential": { "element": [ { "id": "ServiceRequest.extension:sourceOfServiceRequest", "path": "ServiceRequest.extension", "sliceName": "sourceOfServiceRequest", "short": "Describes the source of the Service Request.", "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest" ] } ], "isModifier": false }, { "id": "ServiceRequest.extension:additionalContact", "path": "ServiceRequest.extension", "sliceName": "additionalContact", "short": "Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact" ] } ], "isModifier": false }, { "id": "ServiceRequest.extension:coverage", "path": "ServiceRequest.extension", "sliceName": "coverage", "short": "Supports the exchange of information describing the method of funding for the Service Request.", "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage" ] } ], "isModifier": false }, { "id": "ServiceRequest.basedOn", "path": "ServiceRequest.basedOn", "short": "What the service request fulfils.", "mustSupport": true }, { "id": "ServiceRequest.status", "path": "ServiceRequest.status", "short": "The status of the order.", "mustSupport": true }, { "id": "ServiceRequest.intent", "path": "ServiceRequest.intent", "short": "Whether the request is a proposal, plan, an original order or a reflex order.", "mustSupport": true }, { "id": "ServiceRequest.category", "path": "ServiceRequest.category", "slicing": { "discriminator": [ { "type": "value", "path": "coding.system" } ], "rules": "open" }, "short": "A code that classifies the service for searching, sorting and display purposes.", "mustSupport": true }, { "id": "ServiceRequest.category:genomicsWholeCaseSequencing", "path": "ServiceRequest.category", "sliceName": "genomicsWholeCaseSequencing", "short": "Classification of Genomics service", "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", "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory" } }, { "id": "ServiceRequest.category:genomicsWholeCaseSequencing.coding.system", "path": "ServiceRequest.category.coding.system", "fixedUri": "https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory" }, { "id": "ServiceRequest.priority", "path": "ServiceRequest.priority", "short": "Indicates how quickly the ServiceRequest should be addressed with respect to other requests.", "mustSupport": true }, { "id": "ServiceRequest.priority.extension:priorityReason", "path": "ServiceRequest.priority.extension", "sliceName": "priorityReason", "short": "Supports the underlying reason why a Service Request is urgent.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason" ] } ], "isModifier": false }, { "id": "ServiceRequest.code", "path": "ServiceRequest.code", "short": "What is being requested/ordered.", "mustSupport": true, "binding": { "strength": "preferred", "description": "A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode" } }, { "id": "ServiceRequest.orderDetail", "path": "ServiceRequest.orderDetail", "binding": { "strength": "preferred", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode" } }, { "id": "ServiceRequest.subject", "path": "ServiceRequest.subject", "short": "The individual or entity the service is ordered for.", "mustSupport": true }, { "id": "ServiceRequest.authoredOn", "path": "ServiceRequest.authoredOn", "short": "The date the request was signed.", "mustSupport": true }, { "id": "ServiceRequest.requester", "path": "ServiceRequest.requester", "short": "Who / what is requesting the service", "mustSupport": true }, { "id": "ServiceRequest.reasonCode", "path": "ServiceRequest.reasonCode", "binding": { "strength": "preferred", "description": "A set of codes that define a reason for a service request.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode" } }, { "id": "ServiceRequest.bodySite", "path": "ServiceRequest.bodySite", "binding": { "strength": "preferred" } } ] } }
Feedback
Click here to:Report issue for UKCore-ServiceRequest, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Examples
Additional Contact - An example to illustrate providing an additional contact with a service request.Example UKCore-Extension-AdditionalContact
Colonoscopy Request - An example to illustrate a service request regarding a colonoscopy.
Example UKCore-ServiceRequest-ColonoscopyRequest
Coverage - An example to illustrate the extension for a service request, to state the the coverage of the funding for this request.
Example UKCore-Extension-Coverage
CT Chest Scan Request - An example to illustrate a service request for a CT scan.
Example UKCore-ServiceRequest-CTChestScan
ECG Request - An example to illustrate a service request for an ECG.
Example UKCore-ServiceRequest-ECG
Priority Reason - An example to illustrate the priority reason extension, using a SNOMED CT concept, for a service request marked as urgent.
Example UKCore-Extension-PriorityReason
Priority Reason - An example to illustrate the priority reason extension, using a plain text reason, for a service request marked as urgent.
Example UKCore-Extension-PriorityReason-SendingAsText
Source of Service Request - An example to illustrate the source of service request extension associated with a service request.
Example UKCore-Extension-SourceOfServiceRequest
Example Usage Scenarios
The following are example usage scenarios for the UK Core ServiceRequest profile:
- Query for service request information for a given Patient
- Exchange service request information within a FHIR document or message.
Profile Specific Implementation Guidance:
Mandatory and Must Support Data Elements
The following elements are identified as MustSupport, and it is expected that consumers and suppliers SHALL support these as per the MustSupport Guidance.
Element | Reason |
---|---|
ServiceRequest.basedOn | What the service request fulfils. |
ServiceRequest.status | The status of the order. |
ServiceRequest.intent | Whether the request is a proposal, plan, an original order or a reflex order. |
ServiceRequest.category | A code that classifies the service for searching, sorting and display purposes. |
ServiceRequest.priority | Indicates how quickly the ServiceRequest should be addressed with respect to other requests. |
ServiceRequest.code | What is being requested/ordered. |
ServiceRequest.subject | The individual or entity the service is ordered for. |
ServiceRequest.authoredOn | The date the request was signed. |
ServiceRequest.requester | Who / what is requesting the service |
Extensions
More information about the extensions on the UKCore-ServiceRequest
profile can be found using the links below.
Extension | Context | Link | Comment |
---|---|---|---|
sourceOfServiceRequest | ServiceRequest.extension | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest | Describes the source of the Service Request. |
additionalContact | ServiceRequest.extension | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact | Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician. |
coverage | ServiceRequest.extension | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage | Supports the exchange of information describing the method of funding for the Service Request. |
priorityReason | ServiceRequest.priority.extension | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason | Supports the underlying reason why a Service Request is urgent. |
Bindings (differential)
More information about the bindings to UK Core ValueSets can be found below.
Context | Strength | Link |
---|---|---|
ServiceRequest.category | extensible | https://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory |
ServiceRequest.code | preferred | https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode |
ServiceRequest.orderDetail | preferred | https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode |
ServiceRequest.reasonCode | preferred | https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode |
ServiceRequest.extension:coverage | extensible | ValueSet UKCore-FundingCategory |
ServiceRequest.extension:sourceOfServiceRequest | preferred | ValueSet UKCore-SourceOfServiceRequest |
ServiceRequest.category:genomicsWholeCaseSequencing | extensible | ValueSet UKCore-GenomeSequencingCategory |
ServiceRequest.priority.extension:priorityReason | preferred | ValueSet UKCore-ServiceRequestReasonCode |
basedOn
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
replaces
The resource being referenced SHALL conform to the following:
category
The slice ServiceRequest.category:genomicsWholeCaseSequencing
has been added to aid in identifying the category of service request for Genomics use cases.
code
This SHOULD be from ValueSet UKCore-ProcedureCode if possible.
Regarding this ValueSet:
The "procedure with explicit context" hierarchy within the ValueSet will include "referral by [person/service]" and "referral to [person/service]" concepts where there is potentially overlap with other elements of the ServiceRequest resource. If any such concepts are not appropriate for the
ServiceRequest.code
element then it would be expected that systems would recognise this rather than it being appropriate to explicitly exclude parts of this hierarchy within a ValueSet definition.The use of concepts within this ValueSet which include context depends to some extent on whether the lifecycle of the ServiceRequest resource is covered by other elements within the resource (e.g. status, intent, doNotPerform).
It is understood that the Procedure hierarchy SHOULD cover all things that are likely to be requested e.g. enrolment on a care plan, referral for physiotherapy.
As the ServiceRequest resource is intended to be used for general referrals, there could be duplication of context carried within the ServiceRequest.code
element as well as other elements but this is not considered an issue.
orderDetail
This SHOULD be from ValueSet UKCore-ProcedureCode if possible.
The use of text might be considered more appropriate for the type of data that the definition describes. Therefore this element SHOULD be used with caution as there is no specific UK use case identified for it.
subject
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
encounter
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Encounter.
requester
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
- Profile UKCore-Device (draft)
- Profile UKCore-Organization
- Profile UKCore-Patient
- Profile UKCore-Practitioner
- Profile UKCore-PractitionerRole
- Profile UKCore-RelatedPerson
performer
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
- Profile UKCore-CareTeam (draft)
- Profile UKCore-Device (draft)
- Profile UKCore-HealthcareService
- Profile UKCore-Organization
- Profile UKCore-Patient
- Profile UKCore-Practitioner
- Profile UKCore-PractitionerRole
- Profile UKCore-RelatedPerson
locationReference
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Location.
reasonReference
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
- Profile UKCore-Condition
- Profile UKCore-DiagnosticReport
- UKCore-DocumentReference (draft)
- Profile UKCore-Observation
supportingInfo
Where a UK Core profile exists the resource being referenced SHOULD conform to the profile.
specimen
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Specimen.
relevantHistory
Where possible, it is expected that the resource being referenced SHOULD conform to