Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 


ProcedureRequest

Guidance on the representation of investigations reporting in GP Connect

Introduction

The headings below list the elements of the ProcedureRequest resource and describe how to populate and consume them.

ProcedureRequest resource elements

id

Data type: Id Optionality: Mandatory Cardinality: 1..1

The logical identifier of the DiagnosticReport resource.

meta.profile

Data type: uri Optionality: Mandatory Cardinality: 1..1

The DiagnosticReport profile URL.

Fixed value https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-DiagnostocReport-1

identifier

Data type: Identifier Optionality: Mandatory Cardinality: 1..*

This 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.

status

Data type: Code Optionality: Mandatory Cardinality: 1..1

The status of the ProcedureRequest. Set value of active.

This is mandatory in the base FHIR resource. However as this resource in our model 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.

intent

Data type: Code Optionality: Mandatory Cardinality: 1..1

The status of the ProcedureRequest. Set value of order.

This is mandatory in the base FHIR resource.

code

Data type: CodableConcept Optionality: Mandatory Cardinality: 1..1

The tests requested by the requesting HCP. Where no code is available then providers Must populate the code.text field with the text ‘No code available’.

subject

Data type: Reference(Patient) Optionality: Mandatory Cardinality: 1..1

A reference to the Patient that the ProcedureRequest is about.

performer

Data type: Reference (Practitioner/Organization) Optionality: Required Cardinality: 0..1

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

requester

Data type: Reference (Practitioner/Organization) Optionality: Required Cardinality: 0..1

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

reasonCode

Data type: codeableConcept Optionality: Required Cardinality: 0..*

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

reasonReference

Data type: reference Optionality: Required Cardinality: 0..*

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

note

Data type: string Optionality: Required Cardinality: 0..*

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


Elements not in use

The following elements MUST NOT be populated:

definition

Data type: reference

basedOn

Data type: reference

replaces

Data type: reference

requistion

Data type: Identifier

priority

Data type: code

Out of scope for the current iteration.

doNotPerform

Data type: boolean

Out of scope for the current iteration.

category

Data type: CodeableConcept

context

Data type: Reference

occurrence[x]

Data type: dateTime/Period/Timing

Out of scope for the current iteration.

asNeeded[x]

Data type: Boolean/CodeableConcept

authoredOn

Data type: dateTime

performerType

Data type: CodeableConcept

Out of scope for the current itera

supportingInformation

Data type: Reference

specimen

Data type: Reference

bodySite

Data type: CodeablConcept

relevantHistory

Data type: Reference

All content is available under the Open Government Licence v3.0, except where otherwise stated