Copy of 'GP Connect Data Model | FHIR STU3 Representation'

Notice: This guidance is under active development by NHS England and content may be added or updated on a regular basis.

Profile: CareConnect-GPC-ProcedureRequest-1

profile1..
system1..
value1..
assignerReference(CareConnect-GPC-Organization-1)
statusFixed Value
urlFixed Value
system1..Fixed Value
version..0
code1..
display1..
urlFixed Value
system1..Fixed Value
version..0
code1..
display1..
subjectReference(Device) | Reference(CareConnect-GPC-Patient-1) | Reference(CareConnect-GPC-Location-1)
contextReference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-EpisodeOfCare-1) | Reference(CareConnect-GPC-Encounter-1)
agentReference(Device) | Reference(CareConnect-GPC-Organization-1) | Reference(CareConnect-GPC-Practitioner-1)
onBehalfOfReference(CareConnect-GPC-Organization-1)
performerSReference(CareConnect-GPC-Organization-1) | Reference(CareConnect-GPC-Practitioner-1)
urlFixed Value
system1..Fixed Value
version..0
code1..
display1..
reasonReferenceSReference(CareConnect-GPC-Condition-1) | Reference(CareConnect-GPC-Observation-1)
supportingInfoReference(Resource) | Reference(CareConnect-GPC-Observation-1)
specimenReference(CareConnect-GPC-Specimen-1)
urlFixed Value
system1..Fixed Value
version..0
code1..
display1..
authorReferenceReference(CareConnect-GPC-Patient-1) | Reference(CareConnect-GPC-Practitioner-1) | Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-RelatedPerson-1)
authorStringstring
ProcedureRequest.meta
ProcedureRequest.meta.profile
Cardinality1
ProcedureRequest.identifier
Cardinality1
ProcedureRequest.identifier.system
Cardinality1
ProcedureRequest.identifier.value
Cardinality1
ProcedureRequest.requisition.assigner
TypeReference(CareConnect-GPC-Organization-1)
ProcedureRequest.status
Definition

The status of the ProcedureRequest.

Fixed Value
active
ProcedureRequest.category.coding
Slicing

Unordered, Open, by system(Value)

ProcedureRequest.category.coding:snomedCT
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID
ShortThe SNOMED CT Description ID for the display
Definition

The SNOMED CT Description ID for the display.

Cardinality..1
TypeExtension
ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.url
Fixed Value
https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
ProcedureRequest.category.coding:snomedCT.system
Cardinality1
Fixed Value
http://snomed.info/sct
ProcedureRequest.category.coding:snomedCT.version
Cardinality..0
ProcedureRequest.category.coding:snomedCT.code
Cardinality1
ProcedureRequest.category.coding:snomedCT.display
Cardinality1
ProcedureRequest.code
ShortThe tests requested by the requesting health care professional.
ProcedureRequest.code.coding
Slicing

Unordered, Open, by system(Value)

ProcedureRequest.code.coding:snomedCT
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID
ShortThe SNOMED CT Description ID for the display
Definition

The SNOMED CT Description ID for the display.

Cardinality..1
TypeExtension
ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.url
Fixed Value
https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
ProcedureRequest.code.coding:snomedCT.system
Cardinality1
Fixed Value
http://snomed.info/sct
ProcedureRequest.code.coding:snomedCT.version
Cardinality..0
ProcedureRequest.code.coding:snomedCT.code
Cardinality1
ProcedureRequest.code.coding:snomedCT.display
Cardinality1
ProcedureRequest.subject
ShortA reference to the Patient that the ProcedureRequest is about.
TypeReference(Device) | Reference(CareConnect-GPC-Patient-1) | Reference(CareConnect-GPC-Location-1)
ProcedureRequest.context
TypeReference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-EpisodeOfCare-1) | Reference(CareConnect-GPC-Encounter-1)
ProcedureRequest.requesterS
ShortReference to the resource for the practitioner or organization that created the ProcedureRequest.
Must SupportTrue
ProcedureRequest.requester.agent
TypeReference(Device) | Reference(CareConnect-GPC-Organization-1) | Reference(CareConnect-GPC-Practitioner-1)
ProcedureRequest.requester.onBehalfOf
TypeReference(CareConnect-GPC-Organization-1)
ProcedureRequest.performerS
ShortReference to the resource for the practitioner or organization that is requested to perform this request the ProcedureRequest.
TypeReference(CareConnect-GPC-Organization-1) | Reference(CareConnect-GPC-Practitioner-1)
Must SupportTrue
ProcedureRequest.reasonCodeS
ShortAn explanation or justification for why this diagnostic investigation is being requested in coded or textual form.
Must SupportTrue
ProcedureRequest.reasonCode.coding
Slicing

Unordered, Open, by system(Value)

ProcedureRequest.reasonCode.coding:snomedCT
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID
ShortThe SNOMED CT Description ID for the display
Definition

The SNOMED CT Description ID for the display.

Cardinality..1
TypeExtension
ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.url
Fixed Value
https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
ProcedureRequest.reasonCode.coding:snomedCT.system
Cardinality1
Fixed Value
http://snomed.info/sct
ProcedureRequest.reasonCode.coding:snomedCT.version
Cardinality..0
ProcedureRequest.reasonCode.coding:snomedCT.code
Cardinality1
ProcedureRequest.reasonCode.coding:snomedCT.display
Cardinality1
ProcedureRequest.reasonReferenceS
ShortA reference to any conditions the patient has that are supplied by the requesting health care professional due to their relevance to the test request.
TypeReference(CareConnect-GPC-Condition-1) | Reference(CareConnect-GPC-Observation-1)
Must SupportTrue
ProcedureRequest.supportingInfo
TypeReference(Resource) | Reference(CareConnect-GPC-Observation-1)
ProcedureRequest.specimen
TypeReference(CareConnect-GPC-Specimen-1)
ProcedureRequest.bodySite.coding
Slicing

Unordered, Open, by system(Value)

ProcedureRequest.bodySite.coding:snomedCT
Binding

A code from the SNOMED Clinical Terminology UK with the expression (<<442083009 |anatomical or acquired body structure|).

(unbound) (preferred)

ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID
Cardinality..1
TypeExtension
ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.url
Fixed Value
https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
ProcedureRequest.bodySite.coding:snomedCT.system
Cardinality1
Fixed Value
http://snomed.info/sct
ProcedureRequest.bodySite.coding:snomedCT.version
Cardinality..0
ProcedureRequest.bodySite.coding:snomedCT.code
Cardinality1
ProcedureRequest.bodySite.coding:snomedCT.display
Cardinality1
ProcedureRequest.noteS
ShortA human readable explanation from the requesting health care professional containing an explanation on why the test has been requested and any contextual information they considered relevant.
Must SupportTrue
ProcedureRequest.note.author[x]
TypeReference(CareConnect-GPC-Patient-1) | Reference(CareConnect-GPC-Practitioner-1) | Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-RelatedPerson-1) | string
<StructureDefinition xmlns="http://hl7.org/fhir">
<url value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-ProcedureRequest-1" />
<version value="1.4.0" />
<name value="CareConnect-GPC-ProcedureRequest-1" />
<status value="draft" />
<date value="2023-07-03" />
<publisher value="NHS Digital" />
<name value="Interoperability Team" />
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
</telecom>
</contact>
<description value="A record of a request for diagnostic investigations, treatments, or operations to be performed." />
<purpose value="CURATED BY INTEROPen on 6th September 2019. See: http://www.interopen.org/careconnect-curation-methodology/" />
<copyright value="Copyright © 2020 HL7 UK\n \n 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\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n 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.\n \n HL7® FHIR® standard Copyright © 2011+ HL7\n \n The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at\n \n https://www.hl7.org/fhir/license.html" />
<fhirVersion value="3.0.2" />
<kind value="resource" />
<abstract value="false" />
<type value="ProcedureRequest" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/ProcedureRequest" />
<derivation value="constraint" />
<element id="ProcedureRequest.meta">
<path value="ProcedureRequest.meta" />
</element>
<element id="ProcedureRequest.meta.profile">
<path value="ProcedureRequest.meta.profile" />
<min value="1" />
</element>
<element id="ProcedureRequest.identifier">
<path value="ProcedureRequest.identifier" />
<min value="1" />
</element>
<element id="ProcedureRequest.identifier.system">
<path value="ProcedureRequest.identifier.system" />
<min value="1" />
</element>
<element id="ProcedureRequest.identifier.value">
<path value="ProcedureRequest.identifier.value" />
<min value="1" />
</element>
<element id="ProcedureRequest.requisition.assigner">
<path value="ProcedureRequest.requisition.assigner" />
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1" />
</type>
</element>
<element id="ProcedureRequest.status">
<path value="ProcedureRequest.status" />
<definition value="The status of the ProcedureRequest." />
<fixedCode value="active" />
</element>
<element id="ProcedureRequest.category.coding">
<path value="ProcedureRequest.category.coding" />
<type value="value" />
<path value="system" />
</discriminator>
<rules value="open" />
</slicing>
</element>
<element id="ProcedureRequest.category.coding:snomedCT">
<path value="ProcedureRequest.category.coding" />
<sliceName value="snomedCT" />
</element>
<element id="ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID">
<path value="ProcedureRequest.category.coding.extension" />
<sliceName value="snomedCTDescriptionID" />
<short value="The SNOMED CT Description ID for the display" />
<definition value="The SNOMED CT Description ID for the display." />
<max value="1" />
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</type>
</element>
<element id="ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.url">
<path value="ProcedureRequest.category.coding.extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</element>
<element id="ProcedureRequest.category.coding:snomedCT.system">
<path value="ProcedureRequest.category.coding.system" />
<min value="1" />
<fixedUri value="http://snomed.info/sct" />
</element>
<element id="ProcedureRequest.category.coding:snomedCT.version">
<path value="ProcedureRequest.category.coding.version" />
<max value="0" />
</element>
<element id="ProcedureRequest.category.coding:snomedCT.code">
<path value="ProcedureRequest.category.coding.code" />
<min value="1" />
</element>
<element id="ProcedureRequest.category.coding:snomedCT.display">
<path value="ProcedureRequest.category.coding.display" />
<min value="1" />
</element>
<element id="ProcedureRequest.code">
<path value="ProcedureRequest.code" />
<short value="The tests requested by the requesting health care professional." />
</element>
<element id="ProcedureRequest.code.coding">
<path value="ProcedureRequest.code.coding" />
<type value="value" />
<path value="system" />
</discriminator>
<rules value="open" />
</slicing>
</element>
<element id="ProcedureRequest.code.coding:snomedCT">
<path value="ProcedureRequest.code.coding" />
<sliceName value="snomedCT" />
</element>
<element id="ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID">
<path value="ProcedureRequest.code.coding.extension" />
<sliceName value="snomedCTDescriptionID" />
<short value="The SNOMED CT Description ID for the display" />
<definition value="The SNOMED CT Description ID for the display." />
<max value="1" />
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</type>
</element>
<element id="ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.url">
<path value="ProcedureRequest.code.coding.extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</element>
<element id="ProcedureRequest.code.coding:snomedCT.system">
<path value="ProcedureRequest.code.coding.system" />
<min value="1" />
<fixedUri value="http://snomed.info/sct" />
</element>
<element id="ProcedureRequest.code.coding:snomedCT.version">
<path value="ProcedureRequest.code.coding.version" />
<max value="0" />
</element>
<element id="ProcedureRequest.code.coding:snomedCT.code">
<path value="ProcedureRequest.code.coding.code" />
<min value="1" />
</element>
<element id="ProcedureRequest.code.coding:snomedCT.display">
<path value="ProcedureRequest.code.coding.display" />
<min value="1" />
</element>
<element id="ProcedureRequest.subject">
<path value="ProcedureRequest.subject" />
<short value="A reference to the Patient that the ProcedureRequest is about." />
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Location-1" />
</type>
</element>
<element id="ProcedureRequest.context">
<path value="ProcedureRequest.context" />
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-EpisodeOfCare-1" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Encounter-1" />
</type>
</element>
<element id="ProcedureRequest.requester">
<path value="ProcedureRequest.requester" />
<short value="Reference to the resource for the practitioner or organization that created the ProcedureRequest." />
<mustSupport value="true" />
</element>
<element id="ProcedureRequest.requester.agent">
<path value="ProcedureRequest.requester.agent" />
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1" />
</type>
</element>
<element id="ProcedureRequest.requester.onBehalfOf">
<path value="ProcedureRequest.requester.onBehalfOf" />
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1" />
</type>
</element>
<element id="ProcedureRequest.performer">
<path value="ProcedureRequest.performer" />
<short value="Reference to the resource for the practitioner or organization that is requested to perform this request the ProcedureRequest." />
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1" />
</type>
<mustSupport value="true" />
</element>
<element id="ProcedureRequest.reasonCode">
<path value="ProcedureRequest.reasonCode" />
<short value="An explanation or justification for why this diagnostic investigation is being requested in coded or textual form." />
<mustSupport value="true" />
</element>
<element id="ProcedureRequest.reasonCode.coding">
<path value="ProcedureRequest.reasonCode.coding" />
<type value="value" />
<path value="system" />
</discriminator>
<rules value="open" />
</slicing>
</element>
<element id="ProcedureRequest.reasonCode.coding:snomedCT">
<path value="ProcedureRequest.reasonCode.coding" />
<sliceName value="snomedCT" />
</element>
<element id="ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID">
<path value="ProcedureRequest.reasonCode.coding.extension" />
<sliceName value="snomedCTDescriptionID" />
<short value="The SNOMED CT Description ID for the display" />
<definition value="The SNOMED CT Description ID for the display." />
<max value="1" />
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</type>
</element>
<element id="ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.url">
<path value="ProcedureRequest.reasonCode.coding.extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</element>
<element id="ProcedureRequest.reasonCode.coding:snomedCT.system">
<path value="ProcedureRequest.reasonCode.coding.system" />
<min value="1" />
<fixedUri value="http://snomed.info/sct" />
</element>
<element id="ProcedureRequest.reasonCode.coding:snomedCT.version">
<path value="ProcedureRequest.reasonCode.coding.version" />
<max value="0" />
</element>
<element id="ProcedureRequest.reasonCode.coding:snomedCT.code">
<path value="ProcedureRequest.reasonCode.coding.code" />
<min value="1" />
</element>
<element id="ProcedureRequest.reasonCode.coding:snomedCT.display">
<path value="ProcedureRequest.reasonCode.coding.display" />
<min value="1" />
</element>
<element id="ProcedureRequest.reasonReference">
<path value="ProcedureRequest.reasonReference" />
<short value="A reference to any conditions the patient has that are supplied by the requesting health care professional due to their relevance to the test request." />
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Condition-1" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Observation-1" />
</type>
<mustSupport value="true" />
</element>
<element id="ProcedureRequest.supportingInfo">
<path value="ProcedureRequest.supportingInfo" />
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Observation-1" />
</type>
</element>
<element id="ProcedureRequest.specimen">
<path value="ProcedureRequest.specimen" />
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Specimen-1" />
</type>
</element>
<element id="ProcedureRequest.bodySite.coding">
<path value="ProcedureRequest.bodySite.coding" />
<type value="value" />
<path value="system" />
</discriminator>
<rules value="open" />
</slicing>
</element>
<element id="ProcedureRequest.bodySite.coding:snomedCT">
<path value="ProcedureRequest.bodySite.coding" />
<sliceName value="snomedCT" />
<strength value="preferred" />
<description value="A code from the SNOMED Clinical Terminology UK with the expression (<<442083009 |anatomical or acquired body structure|)." />
</binding>
</element>
<element id="ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID">
<path value="ProcedureRequest.bodySite.coding.extension" />
<sliceName value="snomedCTDescriptionID" />
<max value="1" />
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</type>
</element>
<element id="ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.url">
<path value="ProcedureRequest.bodySite.coding.extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</element>
<element id="ProcedureRequest.bodySite.coding:snomedCT.system">
<path value="ProcedureRequest.bodySite.coding.system" />
<min value="1" />
<fixedUri value="http://snomed.info/sct" />
</element>
<element id="ProcedureRequest.bodySite.coding:snomedCT.version">
<path value="ProcedureRequest.bodySite.coding.version" />
<max value="0" />
</element>
<element id="ProcedureRequest.bodySite.coding:snomedCT.code">
<path value="ProcedureRequest.bodySite.coding.code" />
<min value="1" />
</element>
<element id="ProcedureRequest.bodySite.coding:snomedCT.display">
<path value="ProcedureRequest.bodySite.coding.display" />
<min value="1" />
</element>
<element id="ProcedureRequest.note">
<path value="ProcedureRequest.note" />
<short value="A human readable explanation from the requesting health care professional containing an explanation on why the test has been requested and any contextual information they considered relevant." />
<mustSupport value="true" />
</element>
<element id="ProcedureRequest.note.author[x]">
<path value="ProcedureRequest.note.author[x]" />
<code value="string" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1" />
</type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-RelatedPerson-1" />
</type>
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-ProcedureRequest-1",
"version": "1.4.0",
"name": "CareConnect-GPC-ProcedureRequest-1",
"status": "draft",
"date": "2023-07-03",
"publisher": "NHS Digital",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work"
}
]
}
],
"description": "A record of a request for diagnostic investigations, treatments, or operations to be performed.",
"purpose": "CURATED BY INTEROPen on 6th September 2019. See: http://www.interopen.org/careconnect-curation-methodology/",
"copyright": "Copyright © 2020 HL7 UK\n \n 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\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n 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.\n \n HL7® FHIR® standard Copyright © 2011+ HL7\n \n The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at\n \n https://www.hl7.org/fhir/license.html",
"fhirVersion": "3.0.2",
"kind": "resource",
"abstract": false,
"type": "ProcedureRequest",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest",
"derivation": "constraint",
"element": [
{
"id": "ProcedureRequest.meta",
"path": "ProcedureRequest.meta"
},
{
"id": "ProcedureRequest.meta.profile",
"path": "ProcedureRequest.meta.profile",
"min": 1
},
{
"id": "ProcedureRequest.identifier",
"path": "ProcedureRequest.identifier",
"min": 1
},
{
"id": "ProcedureRequest.identifier.system",
"path": "ProcedureRequest.identifier.system",
"min": 1
},
{
"id": "ProcedureRequest.identifier.value",
"path": "ProcedureRequest.identifier.value",
"min": 1
},
{
"id": "ProcedureRequest.requisition.assigner",
"path": "ProcedureRequest.requisition.assigner",
"type": [
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1"
]
}
]
},
{
"id": "ProcedureRequest.status",
"path": "ProcedureRequest.status",
"definition": "The status of the ProcedureRequest.",
"fixedCode": "active"
},
{
"id": "ProcedureRequest.category.coding",
"path": "ProcedureRequest.category.coding",
"slicing": {
{
"type": "value",
"path": "system"
}
],
"rules": "open"
}
},
{
"id": "ProcedureRequest.category.coding:snomedCT",
"path": "ProcedureRequest.category.coding",
"sliceName": "snomedCT"
},
{
"id": "ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "ProcedureRequest.category.coding.extension",
"sliceName": "snomedCTDescriptionID",
"short": "The SNOMED CT Description ID for the display",
"definition": "The SNOMED CT Description ID for the display.",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
]
}
]
},
{
"id": "ProcedureRequest.category.coding:snomedCT.extension:snomedCTDescriptionID.url",
"path": "ProcedureRequest.category.coding.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
},
{
"id": "ProcedureRequest.category.coding:snomedCT.system",
"path": "ProcedureRequest.category.coding.system",
"min": 1,
"fixedUri": "http://snomed.info/sct"
},
{
"id": "ProcedureRequest.category.coding:snomedCT.version",
"path": "ProcedureRequest.category.coding.version",
"max": "0"
},
{
"id": "ProcedureRequest.category.coding:snomedCT.code",
"path": "ProcedureRequest.category.coding.code",
"min": 1
},
{
"id": "ProcedureRequest.category.coding:snomedCT.display",
"path": "ProcedureRequest.category.coding.display",
"min": 1
},
{
"id": "ProcedureRequest.code",
"path": "ProcedureRequest.code",
"short": "The tests requested by the requesting health care professional."
},
{
"id": "ProcedureRequest.code.coding",
"path": "ProcedureRequest.code.coding",
"slicing": {
{
"type": "value",
"path": "system"
}
],
"rules": "open"
}
},
{
"id": "ProcedureRequest.code.coding:snomedCT",
"path": "ProcedureRequest.code.coding",
"sliceName": "snomedCT"
},
{
"id": "ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "ProcedureRequest.code.coding.extension",
"sliceName": "snomedCTDescriptionID",
"short": "The SNOMED CT Description ID for the display",
"definition": "The SNOMED CT Description ID for the display.",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
]
}
]
},
{
"id": "ProcedureRequest.code.coding:snomedCT.extension:snomedCTDescriptionID.url",
"path": "ProcedureRequest.code.coding.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
},
{
"id": "ProcedureRequest.code.coding:snomedCT.system",
"path": "ProcedureRequest.code.coding.system",
"min": 1,
"fixedUri": "http://snomed.info/sct"
},
{
"id": "ProcedureRequest.code.coding:snomedCT.version",
"path": "ProcedureRequest.code.coding.version",
"max": "0"
},
{
"id": "ProcedureRequest.code.coding:snomedCT.code",
"path": "ProcedureRequest.code.coding.code",
"min": 1
},
{
"id": "ProcedureRequest.code.coding:snomedCT.display",
"path": "ProcedureRequest.code.coding.display",
"min": 1
},
{
"id": "ProcedureRequest.subject",
"path": "ProcedureRequest.subject",
"short": "A reference to the Patient that the ProcedureRequest is about.",
"type": [
{
"code": "Reference",
"http://hl7.org/fhir/StructureDefinition/Device"
]
},
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1"
]
},
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Location-1"
]
}
]
},
{
"id": "ProcedureRequest.context",
"path": "ProcedureRequest.context",
"type": [
{
"code": "Reference",
"https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-EpisodeOfCare-1"
]
},
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Encounter-1"
]
}
]
},
{
"id": "ProcedureRequest.requester",
"path": "ProcedureRequest.requester",
"short": "Reference to the resource for the practitioner or organization that created the ProcedureRequest.",
"mustSupport": true
},
{
"id": "ProcedureRequest.requester.agent",
"path": "ProcedureRequest.requester.agent",
"type": [
{
"code": "Reference",
"http://hl7.org/fhir/StructureDefinition/Device"
]
},
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1"
]
},
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1"
]
}
]
},
{
"id": "ProcedureRequest.requester.onBehalfOf",
"path": "ProcedureRequest.requester.onBehalfOf",
"type": [
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1"
]
}
]
},
{
"id": "ProcedureRequest.performer",
"path": "ProcedureRequest.performer",
"short": "Reference to the resource for the practitioner or organization that is requested to perform this request the ProcedureRequest.",
"type": [
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1"
]
},
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1"
]
}
],
"mustSupport": true
},
{
"id": "ProcedureRequest.reasonCode",
"path": "ProcedureRequest.reasonCode",
"short": "An explanation or justification for why this diagnostic investigation is being requested in coded or textual form.",
"mustSupport": true
},
{
"id": "ProcedureRequest.reasonCode.coding",
"path": "ProcedureRequest.reasonCode.coding",
"slicing": {
{
"type": "value",
"path": "system"
}
],
"rules": "open"
}
},
{
"id": "ProcedureRequest.reasonCode.coding:snomedCT",
"path": "ProcedureRequest.reasonCode.coding",
"sliceName": "snomedCT"
},
{
"id": "ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "ProcedureRequest.reasonCode.coding.extension",
"sliceName": "snomedCTDescriptionID",
"short": "The SNOMED CT Description ID for the display",
"definition": "The SNOMED CT Description ID for the display.",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
]
}
]
},
{
"id": "ProcedureRequest.reasonCode.coding:snomedCT.extension:snomedCTDescriptionID.url",
"path": "ProcedureRequest.reasonCode.coding.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
},
{
"id": "ProcedureRequest.reasonCode.coding:snomedCT.system",
"path": "ProcedureRequest.reasonCode.coding.system",
"min": 1,
"fixedUri": "http://snomed.info/sct"
},
{
"id": "ProcedureRequest.reasonCode.coding:snomedCT.version",
"path": "ProcedureRequest.reasonCode.coding.version",
"max": "0"
},
{
"id": "ProcedureRequest.reasonCode.coding:snomedCT.code",
"path": "ProcedureRequest.reasonCode.coding.code",
"min": 1
},
{
"id": "ProcedureRequest.reasonCode.coding:snomedCT.display",
"path": "ProcedureRequest.reasonCode.coding.display",
"min": 1
},
{
"id": "ProcedureRequest.reasonReference",
"path": "ProcedureRequest.reasonReference",
"short": "A reference to any conditions the patient has that are supplied by the requesting health care professional due to their relevance to the test request.",
"type": [
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Condition-1"
]
},
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Observation-1"
]
}
],
"mustSupport": true
},
{
"id": "ProcedureRequest.supportingInfo",
"path": "ProcedureRequest.supportingInfo",
"type": [
{
"code": "Reference",
"http://hl7.org/fhir/StructureDefinition/Resource"
]
},
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Observation-1"
]
}
]
},
{
"id": "ProcedureRequest.specimen",
"path": "ProcedureRequest.specimen",
"type": [
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Specimen-1"
]
}
]
},
{
"id": "ProcedureRequest.bodySite.coding",
"path": "ProcedureRequest.bodySite.coding",
"slicing": {
{
"type": "value",
"path": "system"
}
],
"rules": "open"
}
},
{
"id": "ProcedureRequest.bodySite.coding:snomedCT",
"path": "ProcedureRequest.bodySite.coding",
"sliceName": "snomedCT",
"binding": {
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-BodySite-1"
},
"strength": "preferred",
"description": "A code from the SNOMED Clinical Terminology UK with the expression (<<442083009 |anatomical or acquired body structure|)."
}
},
{
"id": "ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "ProcedureRequest.bodySite.coding.extension",
"sliceName": "snomedCTDescriptionID",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
]
}
]
},
{
"id": "ProcedureRequest.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.url",
"path": "ProcedureRequest.bodySite.coding.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
},
{
"id": "ProcedureRequest.bodySite.coding:snomedCT.system",
"path": "ProcedureRequest.bodySite.coding.system",
"min": 1,
"fixedUri": "http://snomed.info/sct"
},
{
"id": "ProcedureRequest.bodySite.coding:snomedCT.version",
"path": "ProcedureRequest.bodySite.coding.version",
"max": "0"
},
{
"id": "ProcedureRequest.bodySite.coding:snomedCT.code",
"path": "ProcedureRequest.bodySite.coding.code",
"min": 1
},
{
"id": "ProcedureRequest.bodySite.coding:snomedCT.display",
"path": "ProcedureRequest.bodySite.coding.display",
"min": 1
},
{
"id": "ProcedureRequest.note",
"path": "ProcedureRequest.note",
"short": "A human readable explanation from the requesting health care professional containing an explanation on why the test has been requested and any contextual information they considered relevant.",
"mustSupport": true
},
{
"id": "ProcedureRequest.note.author[x]",
"path": "ProcedureRequest.note.author[x]",
"type": [
{
"code": "string"
},
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1"
]
},
{
"code": "Reference",
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1"
]
},
{
"code": "Reference",
"https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-RelatedPerson-1"
]
}
]
}
]
}
}
Command 'details' could not render: There is no placeholder called 'details'


Reference

Canonical URI: https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-ProcedureRequest-1

The canonical URI is the stable FHIR identifier for this profile and is not currently available as a browsable web page.

Background

The ProcedureRequest profile is used for both investigations and dairy entries. Where applicable, any differences in how the element is used and populated is highlighted in the guidance below.

Element Use CareConnect (STU3) UK Core (R4)
id
meta.versionId
meta.lastUpdated
meta.profile
meta.security
meta.tag
identifier
definition
basedOn
replaces
requisition
status
intent
priority
category
intent
context
occurrence[x]
asNeeded[x]
authoredOn
requester
performerType
performer
reasonCode
reasonReference
supportingInfo
specimen
note

id

Usage

Mandatory

Guidance

The id is the logical identifier for the CareConnect-GPC-ProcedureRequest-1 profile.

Example
<id value="567f2acc-b015-4d70-adde-fe15c5d3ab09" />


meta.versionId

Usage

Optional

Guidance

A use-case for the meta.versionId element within GP Connect has not been defined.

Example
<meta>
    <versionId value="1" />
</meta>


meta.lastUpdated

Usage

Optional

Guidance

The meta.lastUpdated element could be useful alongside the meta.versionIdelement could be useful if sending an adendum of something previously sent to help the consumer (receiver) in understanding there is a "newer" version.

Example
<meta>
    <lastUpdated value="2022-10-28T08:06:00+00:00" />
</meta>


meta.profile

Usage

Mandatory

Guidance

The meta.profile contains a fixed value of the URL for the CareConnect-GPC-ProcedureRequest-1 profile.

Example
<meta>
    <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-ProcedureRequest-1" />
</meta>


meta.security

Usage

Optional

Guidance

The security label(s) applicable to the resource.

See Resources not to be disclosed to a patient for more details on how to populate the element.

Example
<meta>
    <security>
        <system value="http://hl7.org/fhir/v3/ActCode"/>
        <code value="NOPAT"/>
        <display value="no disclosure to patient, family or caregivers without attending provider's authorization"/>
    </security>
</meta>


meta.tag

Usage

Optional

Guidance

A use-case for the meta.tag element within GP Connect has not been defined.

Example
<meta>
    <tag>
        <coding>
            <system value="http://hl7.org/fhir/common-tags" />
            <code value="actionable" />
            <display value="Actionable" />
        </coding>
    </tag>
</meta>


identifier

Usage

Mandatory

Guidance

The identifier element MUST be populated with a globally unique and persistent identifier (that is, it doesn’t change between requests and therefore stored with the source data). This MUST be scoped by a provider specific namespace for the identifier.

Where consuming systems are integrating data from this resource to their local system, they MUST also persist this identifier at the same time.

Example
<identifier>
    <system value="https://foo.bar/id/procedure-request" />
    <value value="5e19e7a4-686b-4a6e-9530-8d7406d3b172" />
</identifier>


status

Usage

Mandatory

Guidance

The status of the ProcedureRequest.

The status MUST only be active.

Code System Request Status

For investigations:

This is mandatory in the base FHIR resource. However, as this resource is not being used as a request but to hold data that would have been in a request submitted in a different format we have chosen to use the default value stated.

For diary entries

The provider MUST only include incomplete diary entries - that is, complete or cancelled MUST NOT be included.

Example
<status value="active" />


intent

Usage

Mandatory

Guidance

The status of the ProcedureRequest.

Code System Request Intent

For investigations:

The intent MUST only be order.

Example
<intent value="order" />

For diary entries

The intent MUST only be plan.

Example
<intent value="plan" />


code

Usage

Mandatory

Guidance

For investigations:

The code element can be used to represent the tests requested by the requesting healthcare professional.

In the event of a code not being available, providers MUST populate the code.text field with the text No code available.

Example
<code>
    <coding>
        <system value="http://snomed.info/sct" />
        <code value="8941001000001100" />
        <display value="Not available (qualifier value)" />
        <snomedCT>
            <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
            <extension>
            <valueId value="8941001000001100" />
                <descriptionId value="8941001000001100" />
                <descriptionDisplay value="Not available (qualifier value)" />
            </extesion>
        </snomedCT>
    </coding>
    <text value="No code available" />
</code>

For diary entries

The planned event, action or activity.

Example
<code>
    <coding>
        <system value="http://snomed.info/sct" />
        <code value="408490001" />
        <display value="Antipsychotic drug therapy" />
    </coding>
    <text value="No code available" />
</code>


subject

Usage

Mandatory

Guidance

The subject element will contain a reference to the Patient that the ProcedureRequest is regarding. This can either be as a reference within the payload, or using the reference.identifier.

Example
<subject>
    <extension>
        <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1" />
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1" />
                <code value="01" />
                <display value="Number present and verified" />
            </coding>
            <!-- text optional as already stipulated within the codeable concept -->
            <text value="Number present and verified" />
        </valueCodeableConcept>
    </extension>
    <system value="https://fhir.nhs.uk/Id/nhs-number" />
    <value value="4857773456" />
</subject>


context

Usage

Optional

Guidance

For investigations

A use-case for the context element has not been defined.

For diary entries

A reference to the consultation from which the diary entry originates - that is, the consultation which the diary entry was created within.

Example
<context>
    <reference value="encounter--episode-of-care--00123sal" />
</context>


occurrence[x]

Usage

Optional

Guidance

For investigations

A use-case for the occurrence[x] element has not been defined.

For diary entries

The date or date range when the diary entry is planned to occur.

Example
<occurrenceDateTime value="2022-12-09T12:50:00Z" />


authoredOn

Usage

Optional

Guidance

For investigations

A use-case for the authoredOn element has not been defined.

For diary entries

The date the diary entry was entered into the original source system. This may be the audit or equivalent created date for the diary entry.

Example
<authoredOn value="2022-12-09T12:50:00Z" />


requester

Usage

For investigations

Required

For diary entries

Mandatory

Guidance

For investigations

Reference to the resource for the practitioner or organization that created the ProcedureRequest.

For diary entries

The person or system who entered the diary entry into the original source system.

Example
<requester>
    <reference>
        <identifier>
            <system value="https://fhir.hl7.org.uk/Id/gmc-number" />
            <value value="000000000" />
            <display value="Test GP" />
        </identifier>
    </reference>
</requester>


requester.agent

Usage

For investigations

Optional

For diary entries

Required

Guidance

For investigations

A use-case for the requester.agent element has not been defined.

For diary entries

This MUST be the practitioner who entered the diary entry in the original source system, if it was entered by a user. If the diary entry was system generated and it is not possible to meaningfully associate the diary entry to a system user then this MUST be a Device representing the providing system or an Organization representing the GP practice responsible for creating the record.

Example
<requester>
    <agent>
        <reference value="Practitioner/6c41ebfd-57c3-4162-9d7b-208c171a2fd7" />
    </agent>
</requester>


performer

Usage

For investigations

Required

For diary entries

Optional

Guidance

For investigations

Reference to the resource for the practitioner or organization that is requested to perform this request the ProcedureRequest.

Example
<performer>
    <reference>
        <identifier>
            <system value="https://fhir.hl7.org.uk/Id/gmc-number" />
            <value value="000000000" />
            <display value="Test GP" />
        </identifier>
    </reference>
</performer>

For diary entries

A use-case for the performer element has not been defined.


reasonCode

Usage

For investigations

Required

For diary entries

Optional

Guidance

For investigations

An explanation or justification for why this diagnostic investigation is being requested in coded or textual form.

For diary entries

The reason the action recorded in the diary entry is needed. This is the trigger reason for the diary entry not the action of the diary entry.

Example
<reasonCode>
    <coding>
        <system value="http://snomed.info/sct" />
        <code value="123823007" />
        <display value="Decreased blood oxygen pressure (finding)" />
        <snomedCT>
            <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
            <extension>
            <valueId value="123823007" />
                <descriptionId value="123823007" />
                <descriptionDisplay value="Decreased blood oxygen pressure (finding)" />
            </extesion>
        </snomedCT>
    </coding>
    <text value="Decreased blood oxygen pressure (finding)" />
</reasonCode>


reasonReference

Usage

For investigations

Required

For diary entries

Optional

Guidance

For investigations

A reference to any conditions the patient has that are supplied by the requesting healthcare professional due to their relevance to the test request.

For diary entries

A diary entry may have a linked problem which represents the reason for the diary entry. This is required information where it exists, but the problem MUST be included and reference the diary entry. The diary entry MUST NOT reference to the problem.

Example
<reasonReference>
    <reference value="condition-00t29s" />
</reasonReference>


supportingInfo

Usage

Optional

Guidance

For investigations

A use-case for the supportingInfo element has not been defined.

For diary entries

Additional clinical information linked to the diary entry MAY be included, except a linked problem which MUST be included in the bundle as a

Command 'pagelink' could not render: Page not found.
which references the diary entry, not vice versa.

A document MAY be linked through a reference to the Resource.

Example
<supportingInfo>
    <reference value="observation-001sdk345" />
</supportingInfo>


note

Usage

Required

Guidance

For investigations

A human readable explanation from the requesting healthcare professional containing an explanation on why the test has been requested and any contextual information they considered relevant.

For diary entries

Free text narrative to describe the reason for the diary entry or the action / activity required by the diary entry. This is for additional content beyond the code and reasonCode coded elements and is not intended to duplicate the content of those elements.

Example
<note>
    <author>
        <reference value="practitioner-948392" />
    </author>
    <time value="2022-10-13T16:59:00Z" />
    <text>
        Free text... R4 of the FHIR standard supports GitHub Flavoured Markdown (GFM).
    </text>
</note>

Diary Entry ProcedureRequest elements not in use

The following elements MUST NOT be populated:

priority

doNotPerform

category

asNeeded

requester.onBehalfOf

performerType

performer

reasonReference

A diary entry may have a linked problem which represents the reason for the diary entry. This is required information where it exists, but the problem MUST be included and reference the diary entry. The diary entry MUST NOT reference to the problem.

specimen

bodySite

relevantHistory

Investigations ProcedureRequest elements not in use

The following elements MUST NOT be populated:

definition

basedOn

replaces

requisition

priority

Out of scope for the current iteration.

doNotPerform

Out of scope for the current iteration.

category

context

occurrence[x]

Out of scope for the current iteration.

asNeeded[x]

authoredOn

performerType

Out of scope for the current iteration.

supportingInformation

specimen

bodySite

relevantHistory

back to top