StructureDefinition-UKCore-ServiceRequest-Lab

Canonical_URLCurrent_VersionLast_UpdatedDescription
https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest-Lab1.0.02023-04-28

Defines the constraints and extensions on the UK Core Profile ServiceRequest.


Profile_Purpose

To provide implementers additional support for requesting a procedure or diagnostic or other service to be planned, proposed, or performed, with regards to a laboratory observation or a laboratory diagnostic report.

sourceOfServiceRequestI0..1Extension(CodeableConcept)
additionalContactI0..*Extension(Reference(UK Core Organization | UK Core Practitioner | UK Core PractitionerRole))
coverageI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
instantiatesCanonicalΣ0..*canonical(ActivityDefinition | PlanDefinition)
instantiatesUriΣ0..*uri
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
intentΣ ?!1..1codeBinding
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
priorityReasonI0..*Extension(CodeableConcept)
doNotPerformΣ ?!0..1boolean
codeΣ0..1CodeableConceptBinding
orderDetailΣ I0..*CodeableConceptBinding
quantityQuantityQuantity
quantityRatioRatio
quantityRangeRange
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
occurrenceDateTimedateTime
occurrencePeriodPeriod
occurrenceTimingTiming
asNeededBooleanboolean
asNeededCodeableConceptCodeableConcept
authoredOnΣ0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
performerTypeΣ0..1CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
locationCodeΣ0..*CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
reasonCodeΣ0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
bodySiteΣ0..*CodeableConceptBinding
note0..*Annotation
patientInstructionΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-ServiceRequest-Lab" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest-Lab" />
    <version value="1.0.0" />
    <name value="UKCoreServiceRequestLab" />
    <title value="UK Core ServiceRequest Lab" />
    <status value="active" />
    <date value="2023-04-28" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="Defines the constraints and extensions on the UK Core Profile ServiceRequest." />
    <purpose value="To provide implementers additional support for requesting a procedure or diagnostic or other service to be planned, proposed, or performed, with regards to a laboratory observation or a laboratory diagnostic report." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="ServiceRequest" />
    <baseDefinition value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest" />
    <derivation value="constraint" />
    <differential>
        <element id="ServiceRequest.code">
            <path value="ServiceRequest.code" />
            <definition value="A set of codes from the SNOMED Clinical Terminology UK coding system regrading laboratory medicine test requests and results." />
            <binding>
                <strength value="preferred" />
                <description value="A set of codes that define laboratory medicine test requests and results. Selected from the SNOMED CT UK coding system." />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-UnifiedTestList" />
            </binding>
        </element>
        <element id="ServiceRequest.reasonReference">
            <path value="ServiceRequest.reasonReference" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport-Lab" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-Lab" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-LabGroup" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-ServiceRequest-Lab",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest-Lab",
    "version": "1.0.0",
    "name": "UKCoreServiceRequestLab",
    "title": "UK Core ServiceRequest Lab",
    "status": "active",
    "date": "2023-04-28",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "Defines the constraints and extensions on the UK Core Profile ServiceRequest.",
    "purpose": "To provide implementers additional support for requesting a procedure or diagnostic or other service to be planned, proposed, or performed, with regards to a laboratory observation or a laboratory diagnostic report.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "ServiceRequest",
    "baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "ServiceRequest.code",
                "path": "ServiceRequest.code",
                "definition": "A set of codes from the SNOMED Clinical Terminology UK coding system regrading laboratory medicine test requests and results.",
                "binding": {
                    "strength": "preferred",
                    "description": "A set of codes that define laboratory medicine test requests and results. Selected from the SNOMED CT UK coding system.",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-UnifiedTestList"
                }
            },
            {
                "id": "ServiceRequest.reasonReference",
                "path": "ServiceRequest.reasonReference",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport-Lab",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-Lab",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-LabGroup"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

C Reactive Protein Request - An example to illustrate a request for a C Reactive Protein test based on an inflammed finger joint observation.
Example UKCore-ServiceRequest-Lab-CReactiveProtein

Usage

This Profile has the following derived profiles:


This Profile is referenced in the following Extensions:


This Profile is referenced in the following Profiles:

Example Usage Scenarios

The following are example usage scenarios for the UK Core ServiceRequest-Lab profile:

  • Query for ServiceRequest-Lab information
  • Exchange ServiceRequest-Lab information used in Observations and DiagnosticReport

Profile Specific Implementation Guidance:

This is a derived profile of UKCore-ServiceRequest and this page only shows the differences between the two. Refer to the base Profile for more implementation guidance.

Minimum Viable Content

The minimum viable content that all provider and consumer systems SHALL support are the elements within the corresponding UKCore-ServiceRequest table, along with the following.

Element Reason
ServiceRequest.reasonReference Explanation/Justification for service or service.

Bindings (differential)

More information about the bindings to UK Core ValueSets can be found below.

Context Strength Link
ServiceRequest.code Preferred ValueSet UKCore-UnifiedTestList