UKCoreServiceRequest (ServiceRequest) | C | | ServiceRequest | There are no (further) constraints on this element Element idServiceRequest Short descriptionA 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.
Data typeServiceRequest Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - prr-1: orderDetail SHALL only be present if code is present
orderDetail.empty() or code.exists() Mappings- rim: Entity. Role, or Act
- workflow: Request
- v2: ORC
- rim: Act[moodCode<=INT]
|
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typestring |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idServiceRequest.meta Short descriptionMetadata 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.
Data typeMeta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idServiceRequest.implicitRules Short descriptionA 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.
CommentsAsserting 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.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage 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).
Data typecode BindingCommonLanguages (preferred) Binding extensionsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
text | | 0..1 | Narrative | There are no (further) constraints on this element Element idServiceRequest.text Short descriptionText 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.
CommentsContained 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.
Data typeNarrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
contained | | 0..* | Resource | There are no (further) constraints on this element Element idServiceRequest.contained Short descriptionContained, 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.
CommentsThis 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.
Data typeResource Mappings |
extension | C | 0..* | Extension | Element idServiceRequest.extension Short descriptionAdditional 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
sourceOfServiceRequest | C | 0..1 | Extension(CodeableConcept) | Element idServiceRequest.extension:sourceOfServiceRequest Short descriptionThis represents the source of referral Alternate namesextensions, user content DefinitionThis represents the source of referral.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
additionalContact | C | 0..* | Extension(Reference(Organization | Practitioner | PractitionerRole)) | Element idServiceRequest.extension:additionalContact Short descriptionDetails of an additional contact Alternate namesextensions, user content DefinitionDetails of an additional contact, who should be contacted regarding questions arising from the service request.
CommentsThere 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.
Data typeExtension(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- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
coverage | C | 0..1 | Extension(CodeableConcept) | Element idServiceRequest.extension:coverage Short descriptionThe funding category for the Service Request Alternate namesextensions, user content DefinitionThe funding category for the Service Request.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.modifierExtension Short descriptionExtensions 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idServiceRequest.identifier Short descriptionIdentifiers assigned to this order DefinitionIdentifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
CommentsThe 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.
Data typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.identifier
- w5: FiveWs.identifier
- v2: ORC.2, ORC.3, RF1-6 / RF1-11,
- rim: .identifier
- quick: ClinicalStatement.identifier
|
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | There are no (further) constraints on this element Element idServiceRequest.instantiatesCanonical Short descriptionInstantiates 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.
CommentsNote: 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.
Data typecanonical(ActivityDefinition | PlanDefinition) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.instantiatesCanonical
- v2: Varies by domain
- rim: .outboundRelationship[typeCode=DEFN].target
|
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idServiceRequest.instantiatesUri Short descriptionInstantiates 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.
CommentsThis might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.instantiatesUri
- v2: Varies by domain
- rim: .outboundRelationship[typeCode=DEFN].target
|
basedOn | S Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | There are no (further) constraints on this element Element idServiceRequest.basedOn Short descriptionWhat request fulfills Alternate namesfulfills DefinitionPlan/proposal/order fulfilled by this request.
Data typeReference(CarePlan | ServiceRequest | MedicationRequest) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.basedOn
- v2: ORC.8 (plus others)
- rim: .outboundRelationship[typeCode=FLFS].target
|
replaces | Σ | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idServiceRequest.replaces Short descriptionWhat request replaces Alternate namessupersedes, prior, renewed order DefinitionThe request takes the place of the referenced completed or terminated request(s).
Data typeReference(ServiceRequest) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.replaces
- v2: Handled by message location of ORC (ORC.1=RO or RU)
- rim: .outboundRelationship[typeCode=RPLC].target
|
requisition | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idServiceRequest.requisition Short descriptionComposite 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.
RequirementsSome business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes.
CommentsRequests 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.
Data typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.groupIdentifier
- v2: ORC.4
- rim: .inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.status Short descriptiondraft | active | on-hold | revoked | completed | entered-in-error | unknown DefinitionCommentsThe 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.
Data typecode BindingThe status of a service order.
RequestStatus (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.status
- w5: FiveWs.status
- v2: ORC.5,RF1-1
- rim: .status
- quick: Action.currentStatus
|
intent | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.intent Short descriptionproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option DefinitionWhether the request is a proposal, plan, an original order or a reflex order.
CommentsThis element is labeled as a modifier because the intent alters when and how the resource is actually applicable.
Data typecode BindingThe kind of service request.
RequestIntent (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.intent
- w5: FiveWs.class
- v2: N/A
- rim: .moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)
|
category | S Σ | 0..* | CodeableConcept | Element idServiceRequest.category Short descriptionClassification of service DefinitionA code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
RequirementsUsed for filtering what service request are retrieved and displayed.
CommentsThere 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.
Data typeCodeableConcept SlicingUnordered, Open, by coding.system(Value) BindingClassification of the requested service.
ServiceRequestCategoryCodes (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.class
- v2: RF1-5
- rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="INT"].code
|
genomicsWholeCaseSequencing | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.category:genomicsWholeCaseSequencing Short descriptionClassification 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
RequirementsUsed for filtering what service request are retrieved and displayed.
CommentsThere 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.
Data typeCodeableConcept BindingClassification of the requested service.
UKCoreGenomeSequencingCategory (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.class
- v2: RF1-5
- rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="INT"].code
|
id | | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.extension Short descriptionAdditional 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding Short descriptionCode defined by a terminology system DefinitionA reference to a code defined by a terminology system.
RequirementsAllows for alternative encodings within a code system, and translations to other code systems.
CommentsCodes 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.
Data typeCoding Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: C*E.1-8, C*E.10-22
- rim: union(., ./translation)
- orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
id | | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.extension Short descriptionAdditional 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
system | Σ | 0..1 | uriAuto Value | Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.system Short descriptionIdentity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
RequirementsNeed to be unambiguous about the source of the definition of the symbol.
CommentsThe 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.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Auto valuehttps://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory Mappings- v2: C*E.3
- rim: ./codeSystem
- orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.version Short descriptionVersion 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.
CommentsWhere 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.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.code Short descriptionSymbol 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).
RequirementsNeed to refer to a particular code in the system.
Data typecode Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: C*E.1
- rim: ./code
- orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.display Short descriptionRepresentation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system.
RequirementsNeed to be able to carry a human-readable meaning of the code for readers that do not know the system.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: C*E.2 - but note this is not well followed
- rim: CV.displayName
- orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.coding.userSelected Short descriptionIf 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).
RequirementsThis 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.
CommentsAmongst 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.
Data typeboolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: Sometimes implied by being first
- rim: CD.codingRationale
- orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.category:genomicsWholeCaseSequencing.text Short descriptionPlain 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.
RequirementsThe 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.
CommentsVery often the text is the same as a displayName of one of the codings.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: C*E.9. But note many systems use C*E.2 for this
- rim: ./originalText[mediaType/code="text/plain"]/data
- orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
priority | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idServiceRequest.priority Short descriptionroutine | urgent | asap | stat DefinitionIndicates how quickly the ServiceRequest should be addressed with respect to other requests.
Meaning when missingIf missing, this task should be performed with normal priority
Data typecode BindingIdentifies the level of importance to be assigned to actioning the request.
RequestPriority (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.priority
- w5: FiveWs.grade
- v2: TQ1.9, RF1-2
- rim: .priorityCode
|
id | | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.priority.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references)
Data typestring |
extension | C | 0..* | Extension | Element idServiceRequest.priority.extension Short descriptionAdditional 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
priorityReason | C | 0..* | Extension(CodeableConcept) | Element idServiceRequest.priority.extension:priorityReason Short descriptionA SNOMED CT concept representing the reason a Service Request is urgent. Alternate namesextensions, user content DefinitionA SNOMED CT concept representing the reason a Service Request is urgent
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
value | | 0..1 | System.String | There are no (further) constraints on this element Element idServiceRequest.priority.value Short descriptionPrimitive value for code DefinitionData typeSystem.String |
doNotPerform | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idServiceRequest.doNotPerform Short descriptionTrue if service/procedure should not be performed DefinitionSet this to true if the record is saying that the service/procedure should NOT be performed.
RequirementsUsed 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.
CommentsIn 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.
Meaning when missingIf missing, the request is a positive request e.g. "do perform"
Data typeboolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.doNotPerform
- rim: .actionNegationInd
|
code | S Σ | 0..1 | CodeableConceptBinding | Element idServiceRequest.code Short descriptionWhat is being requested/ordered Alternate namesservice requested DefinitionA code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
CommentsMany 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.
Data typeCodeableConcept BindingA set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system.
UKCoreProcedureCode (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.code
- w5: FiveWs.what[x]
- v2: PR1-3 / OBR-4 (varies by domain)
- rim: .code
- quick: Procedure.procedureCode
|
orderDetail | Σ C | 0..* | CodeableConceptBinding | Element idServiceRequest.orderDetail Short descriptionAdditional 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.
CommentsFor information from the medical record intended to support the delivery of the requested services, use the supportingInformation element.
Data typeCodeableConcept BindingCodified order entry details which are based on order context.
UKCoreProcedureCode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: prr-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NTE
- rim: .code
- quick: Procedure.procedureCode
|
quantity[x] | Σ | 0..1 | | There are no (further) constraints on this element Element idServiceRequest.quantity[x] Short descriptionService 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).
RequirementsWhen ordering a service the number of service items may need to be specified separately from the the service item.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
quantityQuantity | | | Quantity | There are no (further) constraints on this element Data typeQuantity |
quantityRatio | | | Ratio | There are no (further) constraints on this element Data typeRatio |
quantityRange | | | Range | There are no (further) constraints on this element Data typeRange |
subject | S Σ | 1..1 | Reference(Patient | Group | Location | Device) | There are no (further) constraints on this element Element idServiceRequest.subject Short descriptionIndividual 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).
Data typeReference(Patient | Group | Location | Device) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.subject
- w5: FiveWs.subject[x]
- v2: PID
- rim: .participation[typeCode=SBJ].role
- quick: ClinicalStatement.subject
- w5: FiveWs.subject
|
encounter | Σ | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idServiceRequest.encounter Short descriptionEncounter in which the request was created Alternate namescontext DefinitionAn encounter that provides additional information about the healthcare context in which this request is made.
Data typeReference(Encounter) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.encounter
- w5: FiveWs.context
- v2: PV1
- rim: .inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]
- quick: ClinicalStatement.encounter
|
occurrence[x] | Σ | 0..1 | | There are no (further) constraints on this element Element idServiceRequest.occurrence[x] Short descriptionWhen service should occur Alternate namesschedule DefinitionThe date/time at which the requested service should occur.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.occurrence[x]
- w5: FiveWs.planned
- v2: TQ1/TQ2, OBR-7/OBR-8
- rim: .effectiveTime
- quick: Procedure.procedureSchedule
|
occurrenceDateTime | | | dateTime | There are no (further) constraints on this element Data typedateTime |
occurrencePeriod | | | Period | There are no (further) constraints on this element Data typePeriod |
occurrenceTiming | | | Timing | There are no (further) constraints on this element Data typeTiming |
asNeeded[x] | Σ | 0..1 | | There are no (further) constraints on this element Element idServiceRequest.asNeeded[x] Short descriptionPreconditions for service DefinitionIf a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
BindingA coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
SNOMEDCTMedicationAsNeededReasonCodes (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false CodeableConcept: precondition.observationEventCriterion[code="Assertion"].value
- quick: Proposal.prnReason.reason
|
asNeededBoolean | | | boolean | There are no (further) constraints on this element Data typeboolean |
asNeededCodeableConcept | | | CodeableConcept | There are no (further) constraints on this element Data typeCodeableConcept |
authoredOn | S Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idServiceRequest.authoredOn Short descriptionDate request signed Alternate namesorderedOn DefinitionWhen the request transitioned to being actionable.
Data typedateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.authoredOn
- w5: FiveWs.recorded
- v2: ORC.9, RF1-7 / RF1-9
- rim: .participation[typeCode=AUT].time
- quick: Proposal.proposedAtTime
|
requester | S Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | There are no (further) constraints on this element Element idServiceRequest.requester Short descriptionWho/what is requesting service Alternate namesauthor, orderer DefinitionThe individual who initiated the request and has responsibility for its activation.
CommentsThis 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.
Data typeReference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.requester
- w5: FiveWs.author
- v2: ORC.12, PRT
- rim: .participation[typeCode=AUT].role
- quick: ClinicalStatement.statementAuthor
|
performerType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.performerType Short descriptionPerformer role Alternate namesspecialty DefinitionDesired type of performer for doing the requested service.
CommentsThis 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”.
Data typeCodeableConcept BindingIndicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
ParticipantRoles (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.performerType
- w5: FiveWs.actor
- v2: PRT, RF!-3
- rim: .participation[typeCode=PRF].role[scoper.determinerCode=KIND].code
|
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | There are no (further) constraints on this element Element idServiceRequest.performer Short descriptionRequested performer Alternate namesrequest recipient DefinitionThe desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
CommentsIf 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).
Data typeReference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.performer
- w5: FiveWs.actor
- v2: PRT, Practitioner: PRD-2/PRD-7 where PRD-3 = RT; Organization: PRD-10 where PRD-3 = RT
- rim: .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
|
locationCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idServiceRequest.locationCode Short descriptionRequested 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.
Data typeCodeableConcept BindingA location type where services are delivered.
v3.ServiceDeliveryLocationRoleType (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.actor
- rim: .participation[typeCode=LOC].role[scoper.determinerCode=KIND].code
|
locationReference | Σ | 0..* | Reference(Location) | There are no (further) constraints on this element Element idServiceRequest.locationReference Short descriptionRequested location DefinitionA reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
Data typeReference(Location) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.actor
- rim: .participation[typeCode=LOC].role[scoper.determinerCode=INSTANCE]
|
reasonCode | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.reasonCode Short descriptionExplanation/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 supportingInfo .
CommentsThis 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 CodeableConcept.text element if the data is free (uncoded) text as shown in the CT Scan example.
Data typeCodeableConcept BindingA set of codes that define a reason for a service request.
UKCoreServiceRequestReasonCode (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.reasonCode
- w5: FiveWs.why[x]
- v2: ORC.16, RF1-10
- rim: .reasonCode
|
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idServiceRequest.reasonReference Short descriptionExplanation/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 supportingInfo .
CommentsThis 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 DiagnosticReport.conclusion and/or DiagnosticReport.conclusionCode . When using a reference to DocumentReference, the target document should contain clear findings language providing the relevant reason for this service request. Use the CodeableConcept text element in ServiceRequest.reasonCode if the data is free (uncoded) text as shown in the CT Scan example.
Data typeReference(Condition | Observation | DiagnosticReport | DocumentReference) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.reasonReference
- w5: FiveWs.why[x]
- v2: ORC.16
- rim: .outboundRelationship[typeCode=RSON].target
|
insurance | | 0..* | Reference(Coverage | ClaimResponse) | There are no (further) constraints on this element Element idServiceRequest.insurance Short descriptionAssociated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
Data typeReference(Coverage | ClaimResponse) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.insurance
- v2: IN1/IN2
- rim: .outboundRelationship[typeCode=COVBY].target
|
supportingInfo | | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idServiceRequest.supportingInfo Short descriptionAdditional 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.
CommentsTo represent information about how the services are to be delivered use the instructions element.
Data typeReference(Resource) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.supportingInfo
- v2: Accompanying segments
- rim: .outboundRelationship[typeCode=PERT].target
|
specimen | Σ | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idServiceRequest.specimen Short descriptionProcedure Samples DefinitionOne or more specimens that the laboratory procedure will use.
CommentsMany 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.
Data typeReference(Specimen) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: SPM
- rim: .participation[typeCode=SPC].role
|
bodySite | Σ | 0..* | CodeableConceptBinding | Element idServiceRequest.bodySite Short descriptionLocation on Body Alternate nameslocation DefinitionAnatomic location where the procedure should be performed. This is the target site.
RequirementsKnowing where the procedure is performed is important for tracking if multiple sites are possible.
CommentsOnly 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.
Data typeCodeableConcept BindingCodes describing anatomical locations. May include laterality.
SNOMEDCTBodyStructures (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: SPM
- rim: targetSiteCode
- quick: Procedure.targetBodySite
|
note | | 0..* | Annotation | There are no (further) constraints on this element Element idServiceRequest.note Short descriptionComments DefinitionAny other notes and comments made about the service request. For example, internal billing notes.
Data typeAnnotation Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.note
- v2: NTE
- rim: .inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]
- quick: ClinicalStatement.additionalText
|
patientInstruction | Σ | 0..1 | string | There are no (further) constraints on this element Element idServiceRequest.patientInstruction Short descriptionPatient or consumer-oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
relevantHistory | | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element idServiceRequest.relevantHistory Short descriptionRequest provenance DefinitionKey events in the history of the request.
CommentsThis 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.
Data typeReference(Provenance) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.relevantHistory
- v2: N/A
- rim: .inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]
|