UKCore-ServiceRequest-Lab
Summary
The test request that a test report is based on.
The associated test report is represented using UKCore-DiagnosticReport-Lab and is linked to UKCore-ServiceRequest-Lab using UKCore-DiagnosticReport-Lab.basedOn. Refer to the profile description for UKCore-DiagnosticReport-Lab for further information.
If multiple tests or test groups are requested as part of the same “event” (generally by the same practitioner at the same time for the same subject), an instance of UKCore-ServiceRequest-Lab is required for each requested test or test group. UKCore-ServiceRequest-Lab.requisition acts as a common identifier to link the requests.
Resource and Profile Links
- R4 Resource (Base): ServiceRequest
- R4 UK Core Profile: UKCore-ServiceRequest-Lab
Profile Views
Refer to Profile Descriptions for a definition of the different profile view formats.
| UKCoreServiceRequestLab (ServiceRequest) | C | ServiceRequest | There are no (further) constraints on this element Element idServiceRequestShort description A request for a service to be performed Alternate namesdiagnostic request, referral, referral request, transfer of care request DefinitionA record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idServiceRequest.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idServiceRequest.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idServiceRequest.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idServiceRequest.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| sourceOfServiceRequest | C | 0..1 | Extension(CodeableConcept) | Element idServiceRequest.extension:sourceOfServiceRequestShort description Describes the source of the Service Request. Alternate namesextensions, user content DefinitionThis represents the source of referral. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| additionalContact | C | 0..* | Extension(Reference(Organization | Practitioner | PractitionerRole)) | Element idServiceRequest.extension:additionalContactShort description Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician. Alternate namesextensions, user content DefinitionDetails of an additional contact, who should be contacted regarding questions arising from the service request. 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. Extension(Reference(Organization | Practitioner | PractitionerRole)) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coverage | C | 0..1 | Extension(CodeableConcept) | Element idServiceRequest.extension:coverageShort description Supports the exchange of information describing the method of funding for the Service Request. Alternate namesextensions, user content DefinitionThe funding category for the Service Request. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idServiceRequest.identifierShort description Identifiers assigned to this order DefinitionIdentifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idServiceRequest.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. 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. canonical(ActivityDefinition | PlanDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idServiceRequest.instantiatesUriShort description Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | Σ C | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.basedOnShort description What request fulfills Alternate namesfulfills DefinitionPlan/proposal/order fulfilled by this request. 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. Reference(CarePlan | MedicationRequest | ServiceRequest) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| replaces | Σ C | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.replacesShort description What request replaces Alternate namessupersedes, prior, renewed order DefinitionThe request takes the place of the referenced completed or terminated request(s). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| requisition | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.requisitionShort description Composite Request ID Alternate namesgrouperId, groupIdentifier DefinitionA shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | Element idServiceRequest.statusShort description The status of the order. DefinitionThe status of the order. 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. The status of a service order. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| intent | S Σ ?! | 1..1 | codeBinding | Element idServiceRequest.intentShort description Whether the request is a proposal, plan, an original order or a reflex order. DefinitionWhether the request is a proposal, plan, an original order or a reflex order. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. The kind of service request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| category | Σ | 0..* | CodeableConcept | Element idServiceRequest.categoryShort description Classification of service DefinitionA code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). Used for filtering what service request are retrieved and displayed. 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. Unordered, Open, by coding.system(Value) BindingClassification of the requested service. ServiceRequestCategoryCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| genomicsWholeCaseSequencing | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.category:genomicsWholeCaseSequencingShort description Classification of Genomics service DefinitionA 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 Used for filtering what service request are retrieved and displayed. 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. Classification of the requested service. UKCoreGenomeSequencingCategory (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 0..1 | uriFixed Value | Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategoryMappings
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | code | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.textShort description Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the ServiceRequest should be addressed with respect to other requests. Note that FHIR strings SHALL NOT exceed 1MB in size If missing, this task should be performed with normal priority Identifies the level of importance to be assigned to actioning the request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.priority.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.priority.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priorityReason | C | 0..* | Extension(CodeableConcept) | Element idServiceRequest.priority.extension:priorityReasonShort description Supports the underlying reason why a Service Request is urgent. Alternate namesextensions, user content DefinitionA SNOMED CT concept representing the reason a Service Request is urgent 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value | 0..1 | System.String | There are no (further) constraints on this element Element idServiceRequest.priority.valueShort description Primitive value for code DefinitionPrimitive value for code System.String Maximum string length1048576 | |||
| doNotPerform | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.doNotPerformShort description True if service/procedure should not be performed DefinitionSet this to true if the record is saying that the service/procedure should NOT be performed. 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. 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. If missing, the request is a positive request e.g. "do perform" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | CodeableConceptBinding | Element idServiceRequest.codeShort description What is being requested/ordered Alternate namesservice requested DefinitionA set of codes from the SNOMED Clinical Terminology UK coding system regarding laboratory medicine test requests. 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. A set of codes that define laboratory medicine test requests. Selected from the SNOMED CT UK coding system. https://fhir.hl7.org.uk/ValueSet/UKCore-PathologyAndLaboratoryMedicineProcedures (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| orderDetail | Σ C | 0..* | CodeableConceptBinding | Element idServiceRequest.orderDetailShort description Additional order information Alternate namesdetailed instructions DefinitionAdditional 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. For information from the medical record intended to support the delivery of the requested services, use the Codified order entry details which are based on order context. UKCoreProcedureCode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, prr-1 Constraints
| ||
| quantity[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.quantity[x]Short description Service amount DefinitionAn 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). When ordering a service the number of service items may need to be specified separately from the the service item. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| quantityQuantity | Quantity | There are no (further) constraints on this element Data type | ||||
| quantityRange | Range | There are no (further) constraints on this element Data type | ||||
| quantityRatio | Ratio | There are no (further) constraints on this element Data type | ||||
| subject | S Σ C | 1..1 | Reference(Device | Group | Location | Patient) | Element idServiceRequest.subjectShort description The individual or entity the service is ordered for. DefinitionOn 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). 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. Reference(Device | Group | Location | Patient) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | Σ C | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idServiceRequest.encounterShort description Encounter in which the request was created Alternate namescontext DefinitionAn encounter that provides additional information about the healthcare context in which this request is made. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| occurrence[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]Short description When service should occur Alternate namesschedule DefinitionThe date/time at which the requested service should occur. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
| occurrenceTiming | Timing | There are no (further) constraints on this element Data type | ||||
| asNeeded[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.asNeeded[x]Short description Preconditions for service DefinitionIf a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. SNOMEDCTMedicationAsNeededReasonCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| asNeededBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| asNeededCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| authoredOn | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idServiceRequest.authoredOnShort description Date request signed Alternate namesorderedOn DefinitionWhen the request transitioned to being actionable. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| requester | S Σ C | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idServiceRequest.requesterShort description Who / what is requesting the service Alternate namesauthor, orderer DefinitionThe individual who initiated the request and has responsibility for its activation. 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. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performerType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.performerTypeShort description Performer role Alternate namesspecialty DefinitionDesired type of performer for doing the requested service. 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”. Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performer | Σ C | 0..* | Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idServiceRequest.performerShort description Requested performer Alternate namesrequest recipient DefinitionThe desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. 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). Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| locationCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.locationCodeShort description Requested location DefinitionThe preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center. 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. A location type where services are delivered. v3.ServiceDeliveryLocationRoleType (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| locationReference | Σ C | 0..* | Reference(Location) | There are no (further) constraints on this element Element idServiceRequest.locationReferenceShort description Requested location DefinitionA reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonCode | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.reasonCodeShort description Explanation/Justification for procedure or service DefinitionAn 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 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 A set of codes that define a reason for a service request. UKCoreServiceRequestReasonCode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonReference | Σ C | 0..* | Reference(Condition | DiagnosticReport | DocumentReference | Observation) | There are no (further) constraints on this element Element idServiceRequest.reasonReferenceShort description Explanation/Justification for service or service DefinitionIndicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in 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 Reference(Condition | DiagnosticReport | DocumentReference | Observation) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| insurance | C | 0..* | Reference(ClaimResponse | Coverage) | There are no (further) constraints on this element Element idServiceRequest.insuranceShort description Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. 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. Reference(ClaimResponse | Coverage) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| supportingInfo | C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idServiceRequest.supportingInfoShort description Additional clinical information Alternate namesAsk at order entry question, AOE DefinitionAdditional 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. To represent information about how the services are to be delivered use the The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| specimen | Σ C | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idServiceRequest.specimenShort description Procedure Samples DefinitionOne or more specimens that the laboratory procedure will use. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| bodySite | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.bodySiteShort description Location on Body Alternate nameslocation DefinitionAnatomic location where the procedure should be performed. This is the target site. Knowing where the procedure is performed is important for tracking if multiple sites are possible. 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. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| note | 0..* | Annotation | There are no (further) constraints on this element Element idServiceRequest.noteShort description Comments DefinitionAny other notes and comments made about the service request. For example, internal billing notes. 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| patientInstruction | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.patientInstructionShort description Patient or consumer-oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relevantHistory | C | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idServiceRequest.relevantHistoryShort description Request provenance DefinitionKey events in the history of the request. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| UKCoreServiceRequestLab (ServiceRequest) | C | ServiceRequest | There are no (further) constraints on this element Element idServiceRequestShort description A request for a service to be performed Alternate namesdiagnostic request, referral, referral request, transfer of care request DefinitionA record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idServiceRequest.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idServiceRequest.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idServiceRequest.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idServiceRequest.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| sourceOfServiceRequest | C | 0..1 | Extension(CodeableConcept) | Element idServiceRequest.extension:sourceOfServiceRequestShort description Describes the source of the Service Request. Alternate namesextensions, user content DefinitionThis represents the source of referral. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| additionalContact | C | 0..* | Extension(Reference(Organization | Practitioner | PractitionerRole)) | Element idServiceRequest.extension:additionalContactShort description Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician. Alternate namesextensions, user content DefinitionDetails of an additional contact, who should be contacted regarding questions arising from the service request. 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. Extension(Reference(Organization | Practitioner | PractitionerRole)) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coverage | C | 0..1 | Extension(CodeableConcept) | Element idServiceRequest.extension:coverageShort description Supports the exchange of information describing the method of funding for the Service Request. Alternate namesextensions, user content DefinitionThe funding category for the Service Request. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idServiceRequest.identifierShort description Identifiers assigned to this order DefinitionIdentifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idServiceRequest.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. 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. canonical(ActivityDefinition | PlanDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idServiceRequest.instantiatesUriShort description Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | Σ C | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.basedOnShort description What request fulfills Alternate namesfulfills DefinitionPlan/proposal/order fulfilled by this request. 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. Reference(CarePlan | MedicationRequest | ServiceRequest) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| replaces | Σ C | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.replacesShort description What request replaces Alternate namessupersedes, prior, renewed order DefinitionThe request takes the place of the referenced completed or terminated request(s). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| requisition | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.requisitionShort description Composite Request ID Alternate namesgrouperId, groupIdentifier DefinitionA shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | Element idServiceRequest.statusShort description The status of the order. DefinitionThe status of the order. 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. The status of a service order. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| intent | S Σ ?! | 1..1 | codeBinding | Element idServiceRequest.intentShort description Whether the request is a proposal, plan, an original order or a reflex order. DefinitionWhether the request is a proposal, plan, an original order or a reflex order. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. The kind of service request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| category | Σ | 0..* | CodeableConcept | Element idServiceRequest.categoryShort description Classification of service DefinitionA code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). Used for filtering what service request are retrieved and displayed. 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. Unordered, Open, by coding.system(Value) BindingClassification of the requested service. ServiceRequestCategoryCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| genomicsWholeCaseSequencing | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.category:genomicsWholeCaseSequencingShort description Classification of Genomics service DefinitionA 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 Used for filtering what service request are retrieved and displayed. 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. Classification of the requested service. UKCoreGenomeSequencingCategory (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 0..1 | uriFixed Value | Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategoryMappings
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | code | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.textShort description Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the ServiceRequest should be addressed with respect to other requests. Note that FHIR strings SHALL NOT exceed 1MB in size If missing, this task should be performed with normal priority Identifies the level of importance to be assigned to actioning the request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.priority.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.priority.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priorityReason | C | 0..* | Extension(CodeableConcept) | Element idServiceRequest.priority.extension:priorityReasonShort description Supports the underlying reason why a Service Request is urgent. Alternate namesextensions, user content DefinitionA SNOMED CT concept representing the reason a Service Request is urgent 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value | 0..1 | System.String | There are no (further) constraints on this element Element idServiceRequest.priority.valueShort description Primitive value for code DefinitionPrimitive value for code System.String Maximum string length1048576 | |||
| doNotPerform | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.doNotPerformShort description True if service/procedure should not be performed DefinitionSet this to true if the record is saying that the service/procedure should NOT be performed. 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. 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. If missing, the request is a positive request e.g. "do perform" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | CodeableConceptBinding | Element idServiceRequest.codeShort description What is being requested/ordered Alternate namesservice requested DefinitionA set of codes from the SNOMED Clinical Terminology UK coding system regarding laboratory medicine test requests. 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. A set of codes that define laboratory medicine test requests. Selected from the SNOMED CT UK coding system. https://fhir.hl7.org.uk/ValueSet/UKCore-PathologyAndLaboratoryMedicineProcedures (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| orderDetail | Σ C | 0..* | CodeableConceptBinding | Element idServiceRequest.orderDetailShort description Additional order information Alternate namesdetailed instructions DefinitionAdditional 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. For information from the medical record intended to support the delivery of the requested services, use the Codified order entry details which are based on order context. UKCoreProcedureCode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, prr-1 Constraints
| ||
| quantity[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.quantity[x]Short description Service amount DefinitionAn 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). When ordering a service the number of service items may need to be specified separately from the the service item. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| quantityQuantity | Quantity | There are no (further) constraints on this element Data type | ||||
| quantityRange | Range | There are no (further) constraints on this element Data type | ||||
| quantityRatio | Ratio | There are no (further) constraints on this element Data type | ||||
| subject | S Σ C | 1..1 | Reference(Device | Group | Location | Patient) | Element idServiceRequest.subjectShort description The individual or entity the service is ordered for. DefinitionOn 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). 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. Reference(Device | Group | Location | Patient) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | Σ C | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idServiceRequest.encounterShort description Encounter in which the request was created Alternate namescontext DefinitionAn encounter that provides additional information about the healthcare context in which this request is made. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| occurrence[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]Short description When service should occur Alternate namesschedule DefinitionThe date/time at which the requested service should occur. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
| occurrenceTiming | Timing | There are no (further) constraints on this element Data type | ||||
| asNeeded[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.asNeeded[x]Short description Preconditions for service DefinitionIf a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. SNOMEDCTMedicationAsNeededReasonCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| asNeededBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| asNeededCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| authoredOn | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idServiceRequest.authoredOnShort description Date request signed Alternate namesorderedOn DefinitionWhen the request transitioned to being actionable. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| requester | S Σ C | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idServiceRequest.requesterShort description Who / what is requesting the service Alternate namesauthor, orderer DefinitionThe individual who initiated the request and has responsibility for its activation. 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. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performerType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.performerTypeShort description Performer role Alternate namesspecialty DefinitionDesired type of performer for doing the requested service. 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”. Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performer | Σ C | 0..* | Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idServiceRequest.performerShort description Requested performer Alternate namesrequest recipient DefinitionThe desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. 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). Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| locationCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.locationCodeShort description Requested location DefinitionThe preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center. 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. A location type where services are delivered. v3.ServiceDeliveryLocationRoleType (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| locationReference | Σ C | 0..* | Reference(Location) | There are no (further) constraints on this element Element idServiceRequest.locationReferenceShort description Requested location DefinitionA reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonCode | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.reasonCodeShort description Explanation/Justification for procedure or service DefinitionAn 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 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 A set of codes that define a reason for a service request. UKCoreServiceRequestReasonCode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonReference | Σ C | 0..* | Reference(Condition | DiagnosticReport | DocumentReference | Observation) | There are no (further) constraints on this element Element idServiceRequest.reasonReferenceShort description Explanation/Justification for service or service DefinitionIndicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in 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 Reference(Condition | DiagnosticReport | DocumentReference | Observation) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| insurance | C | 0..* | Reference(ClaimResponse | Coverage) | There are no (further) constraints on this element Element idServiceRequest.insuranceShort description Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. 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. Reference(ClaimResponse | Coverage) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| supportingInfo | C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idServiceRequest.supportingInfoShort description Additional clinical information Alternate namesAsk at order entry question, AOE DefinitionAdditional 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. To represent information about how the services are to be delivered use the The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| specimen | Σ C | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idServiceRequest.specimenShort description Procedure Samples DefinitionOne or more specimens that the laboratory procedure will use. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| bodySite | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.bodySiteShort description Location on Body Alternate nameslocation DefinitionAnatomic location where the procedure should be performed. This is the target site. Knowing where the procedure is performed is important for tracking if multiple sites are possible. 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. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| note | 0..* | Annotation | There are no (further) constraints on this element Element idServiceRequest.noteShort description Comments DefinitionAny other notes and comments made about the service request. For example, internal billing notes. 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| patientInstruction | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.patientInstructionShort description Patient or consumer-oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relevantHistory | C | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idServiceRequest.relevantHistoryShort description Request provenance DefinitionKey events in the history of the request. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| UKCoreServiceRequestLab (ServiceRequest) | C | ServiceRequest | There are no (further) constraints on this element Element idServiceRequestShort description A request for a service to be performed Alternate namesdiagnostic request, referral, referral request, transfer of care request DefinitionA record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idServiceRequest.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idServiceRequest.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idServiceRequest.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idServiceRequest.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| sourceOfServiceRequest | C | 0..1 | Extension(CodeableConcept) | Element idServiceRequest.extension:sourceOfServiceRequestShort description Describes the source of the Service Request. Alternate namesextensions, user content DefinitionThis represents the source of referral. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| additionalContact | C | 0..* | Extension(Reference(Organization | Practitioner | PractitionerRole)) | Element idServiceRequest.extension:additionalContactShort description Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician. Alternate namesextensions, user content DefinitionDetails of an additional contact, who should be contacted regarding questions arising from the service request. 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. Extension(Reference(Organization | Practitioner | PractitionerRole)) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coverage | C | 0..1 | Extension(CodeableConcept) | Element idServiceRequest.extension:coverageShort description Supports the exchange of information describing the method of funding for the Service Request. Alternate namesextensions, user content DefinitionThe funding category for the Service Request. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idServiceRequest.identifierShort description Identifiers assigned to this order DefinitionIdentifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idServiceRequest.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. 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. canonical(ActivityDefinition | PlanDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idServiceRequest.instantiatesUriShort description Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | Σ C | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.basedOnShort description What request fulfills Alternate namesfulfills DefinitionPlan/proposal/order fulfilled by this request. 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. Reference(CarePlan | MedicationRequest | ServiceRequest) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| replaces | Σ C | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.replacesShort description What request replaces Alternate namessupersedes, prior, renewed order DefinitionThe request takes the place of the referenced completed or terminated request(s). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| requisition | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.requisitionShort description Composite Request ID Alternate namesgrouperId, groupIdentifier DefinitionA shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | Element idServiceRequest.statusShort description The status of the order. DefinitionThe status of the order. 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. The status of a service order. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| intent | S Σ ?! | 1..1 | codeBinding | Element idServiceRequest.intentShort description Whether the request is a proposal, plan, an original order or a reflex order. DefinitionWhether the request is a proposal, plan, an original order or a reflex order. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. The kind of service request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| category | Σ | 0..* | CodeableConcept | Element idServiceRequest.categoryShort description Classification of service DefinitionA code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). Used for filtering what service request are retrieved and displayed. 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. Unordered, Open, by coding.system(Value) BindingClassification of the requested service. ServiceRequestCategoryCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| genomicsWholeCaseSequencing | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.category:genomicsWholeCaseSequencingShort description Classification of Genomics service DefinitionA 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 Used for filtering what service request are retrieved and displayed. 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. Classification of the requested service. UKCoreGenomeSequencingCategory (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 0..1 | uriFixed Value | Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategoryMappings
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | code | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.codeShort description Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.textShort description Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the ServiceRequest should be addressed with respect to other requests. Note that FHIR strings SHALL NOT exceed 1MB in size If missing, this task should be performed with normal priority Identifies the level of importance to be assigned to actioning the request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.priority.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.priority.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priorityReason | C | 0..* | Extension(CodeableConcept) | Element idServiceRequest.priority.extension:priorityReasonShort description Supports the underlying reason why a Service Request is urgent. Alternate namesextensions, user content DefinitionA SNOMED CT concept representing the reason a Service Request is urgent 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value | 0..1 | System.String | There are no (further) constraints on this element Element idServiceRequest.priority.valueShort description Primitive value for code DefinitionPrimitive value for code System.String Maximum string length1048576 | |||
| doNotPerform | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.doNotPerformShort description True if service/procedure should not be performed DefinitionSet this to true if the record is saying that the service/procedure should NOT be performed. 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. 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. If missing, the request is a positive request e.g. "do perform" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | CodeableConceptBinding | Element idServiceRequest.codeShort description What is being requested/ordered Alternate namesservice requested DefinitionA set of codes from the SNOMED Clinical Terminology UK coding system regarding laboratory medicine test requests. 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. A set of codes that define laboratory medicine test requests. Selected from the SNOMED CT UK coding system. https://fhir.hl7.org.uk/ValueSet/UKCore-PathologyAndLaboratoryMedicineProcedures (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| orderDetail | Σ C | 0..* | CodeableConceptBinding | Element idServiceRequest.orderDetailShort description Additional order information Alternate namesdetailed instructions DefinitionAdditional 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. For information from the medical record intended to support the delivery of the requested services, use the Codified order entry details which are based on order context. UKCoreProcedureCode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, prr-1 Constraints
| ||
| quantity[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.quantity[x]Short description Service amount DefinitionAn 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). When ordering a service the number of service items may need to be specified separately from the the service item. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| quantityQuantity | Quantity | There are no (further) constraints on this element Data type | ||||
| quantityRange | Range | There are no (further) constraints on this element Data type | ||||
| quantityRatio | Ratio | There are no (further) constraints on this element Data type | ||||
| subject | S Σ C | 1..1 | Reference(Device | Group | Location | Patient) | Element idServiceRequest.subjectShort description The individual or entity the service is ordered for. DefinitionOn 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). 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. Reference(Device | Group | Location | Patient) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | Σ C | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idServiceRequest.encounterShort description Encounter in which the request was created Alternate namescontext DefinitionAn encounter that provides additional information about the healthcare context in which this request is made. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| occurrence[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.occurrence[x]Short description When service should occur Alternate namesschedule DefinitionThe date/time at which the requested service should occur. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
| occurrenceTiming | Timing | There are no (further) constraints on this element Data type | ||||
| asNeeded[x] | Σ | 0..1 | There are no (further) constraints on this element Element idServiceRequest.asNeeded[x]Short description Preconditions for service DefinitionIf a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. SNOMEDCTMedicationAsNeededReasonCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| asNeededBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| asNeededCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| authoredOn | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idServiceRequest.authoredOnShort description Date request signed Alternate namesorderedOn DefinitionWhen the request transitioned to being actionable. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| requester | S Σ C | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idServiceRequest.requesterShort description Who / what is requesting the service Alternate namesauthor, orderer DefinitionThe individual who initiated the request and has responsibility for its activation. 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. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performerType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.performerTypeShort description Performer role Alternate namesspecialty DefinitionDesired type of performer for doing the requested service. 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”. Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performer | Σ C | 0..* | Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idServiceRequest.performerShort description Requested performer Alternate namesrequest recipient DefinitionThe desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. 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). Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| locationCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.locationCodeShort description Requested location DefinitionThe preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center. 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. A location type where services are delivered. v3.ServiceDeliveryLocationRoleType (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| locationReference | Σ C | 0..* | Reference(Location) | There are no (further) constraints on this element Element idServiceRequest.locationReferenceShort description Requested location DefinitionA reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonCode | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.reasonCodeShort description Explanation/Justification for procedure or service DefinitionAn 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 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 A set of codes that define a reason for a service request. UKCoreServiceRequestReasonCode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonReference | Σ C | 0..* | Reference(Condition | DiagnosticReport | DocumentReference | Observation) | There are no (further) constraints on this element Element idServiceRequest.reasonReferenceShort description Explanation/Justification for service or service DefinitionIndicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in 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 Reference(Condition | DiagnosticReport | DocumentReference | Observation) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| insurance | C | 0..* | Reference(ClaimResponse | Coverage) | There are no (further) constraints on this element Element idServiceRequest.insuranceShort description Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. 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. Reference(ClaimResponse | Coverage) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| supportingInfo | C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idServiceRequest.supportingInfoShort description Additional clinical information Alternate namesAsk at order entry question, AOE DefinitionAdditional 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. To represent information about how the services are to be delivered use the The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| specimen | Σ C | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idServiceRequest.specimenShort description Procedure Samples DefinitionOne or more specimens that the laboratory procedure will use. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| bodySite | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.bodySiteShort description Location on Body Alternate nameslocation DefinitionAnatomic location where the procedure should be performed. This is the target site. Knowing where the procedure is performed is important for tracking if multiple sites are possible. 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. Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| note | 0..* | Annotation | There are no (further) constraints on this element Element idServiceRequest.noteShort description Comments DefinitionAny other notes and comments made about the service request. For example, internal billing notes. 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| patientInstruction | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.patientInstructionShort description Patient or consumer-oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relevantHistory | C | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idServiceRequest.relevantHistoryShort description Request provenance DefinitionKey events in the history of the request. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Additional Guidance
The following additional guidance SHOULD be applied when implementing this profile. It SHOULD be used in conjunction with the profile definition presented above and the Profile Specific Implementation Guidance for UKCore-ServiceRequest-Lab in the UK Core Implementation Guide (STU3 Sequence).
requisition
A shared identifier that is used to link multiple test requests.
If multiple tests or test groups are requested as part of the same “event” (generally by the same practitioner at the same time for the same subject), an instance of ServiceRequest is required for each requested test or test group. ServiceRequest.requisition acts as a common identifier to link the requests.
For further information refer to:
- the description of shared requisition id in the Compound Requests section of the base FHIR R4 Specification
status
This SHOULD be populated with a value of active.
Additional values from the CodeSystem RequestStatus MAY need to be supported in the future.
intent
This SHOULD be populated with a value of order.
Additional values from the CodeSystem RequestIntent MAY need to be supported in the future.
category
The general type of requested test. The following SHOULD be used:
ServiceRequest.category.coding.system=http://snomed.info/sctServiceRequest.category.coding.code=108252007ServiceRequest.category.coding.display=Laboratory procedure
authoredOn
The date and time of the test request.
requester
This SHALL reference a PractitionerRole. The referenced PractitionerRole:
- SHALL reference the requesting
Organization. - SHOULD reference the requesting
Practitioner, where known.
reasonCode
An explanation in coded or textual form that describes why the tests have been requested.
reasonReference
Reference(s) to any conditions the patient has (as supplied by the requester) that are relevant to the test request.
specimen
Reference(s) to the Specimen(s) that will be used for testing. This should only be used when a test is requested and the specimen has already been collected.
It is also possible to link a Specimen to a ServiceRequest using the Specimen.request data element. This should be used when a test was requested before the specimen was collected.
For further information refer to:
- the description of the UKCore-Specimen profile in this implementation guide, and
- the notes relating to the use of the
ServiceRequestresource in the base FHIR R4 Specification.
note
Any other notes relating to the test request, as provided by the requester. Clinical information relating to the test request SHOULD be conveyed using ServiceRequest.reasonCode and/or ServiceRequest.reasonReference.