Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Test Request Summary

National Pathology FHIR Message Profiles

Test Request Summary Overview for a Haemotology or Chemical Biology Test

Information from the original request that is returned with the test report. This has two purposes.

  • 1) To assist in linking the report to the original request;
  • 2) Give context to the test report where the receiving HCP is different to the requesting HCP and does not have access to the original request.

Mapping for Procedure Request

How to populate the Procedure Request instance to conform to the profiles below:

Level 1 Procedure Request Resource Level 2 CareConnect-ProcedureRequest-1 Level 3 None
Name Card. Conformance Type Description, Constraints and mapping for National Pathology Implementation
ProcedureRequest     A request for a procedure or diagnostic to be performed
Constraint (dom-2): If the resource is contained in another resource, it SHALL NOT contain nested Resources
Constraint (dom-1): If the resource is contained in another resource, it SHALL NOT contain any narrative
Constraint (dom-4): If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
Constraint (dom-3): If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
- id 0..1 Required Id Logical id of this artifact
Must contain a UUID to identify the instance of a procedureRequest
- meta 0..1 Required Meta Metadata about the resource
The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-ProcedureRequest-1'
- identifier 0..* Optional Identifier Identifiers assigned to this order
- - system 1..1 Mandatory Uri The namespace for the identifier value
MUST contain the value 'https://tools.ietf.org/html/rfc4122'.
- - value 1..1 Mandatory String The value that is unique
MUST contain a UUID
- status 1..1 Mandatory Code draft : active : suspended : completed : entered-in-error : cancelled
Binding (required): The status of a procedure or diagnostic order. RequestStatus
MUST contain the value 'active'.
- intent 1..1 Mandatory Code proposal : plan : order +
Binding (required): The kind of procedure or diagnostic request RequestIntent
MUST contain the value 'order'.
- priority 0..1 Required Code routine | urgent | asap | stat
Binding (required): Identifies the level of importance to be assigned to actioning the request http://hl7.org/fhir/stu3/valueset-request-priority.html The urgency of the test request
- code 1..1 Required CodeableConcept What is being requested/ordered
Binding (example): Codes identifying names of simple observations. The tests requested by the requesting HCP.
- - coding 0..* Optional Coding Code defined by a terminology system
- - coding (snomedCT) 0..1 Mandatory Coding Code defined by a terminology system
Binding (extensible): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation CareConnect-ObservationType-1
- - - extension (snomedCTDescriptionID) 0..1 Optional Extension-coding-sctdescid The SNOMED CT Description ID for the display.
Constraint (ext-1): Must have either extensions or value[x], not both
- - - system 0..1 Mandatory Uri Identity of the terminology system
- - - code 0..1 Mandatory Code Symbol in syntax defined by the system
- - - display 0..1 Mandatory String Representation defined by the system
- - text 0..1 Optional String Plain text representation of the concept
- subject 1..1 Mandatory Reference Individual the service is ordered for
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Required CareConnect-Patient-1 This MUST be to the Organization resource profiled as CareConnect-Patient-1
- - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL a reference to the Patient resource instance in the message in the format of a UUID prefixed with 'urn:uuid:'.
- authoredOn 0..1 Required dateTime Date request signed
The date and time of the test request
- requester 0..1 Mandatory BackboneElement Who/what is requesting procedure or diagnosticReference to the resource for the Practitioner and/or Organization that requested the DiagnosticReport. At least one MUST be populated.
- - agent 1..1 Mandatory Reference Individual making the request
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Mandatory CareConnect-Practitioner-1 The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-Practitioner-1'
Requesting HCP
- - - reference 1..1 Mandatory String Literal reference, Relative, internal or absolute URL a reference to the location resource instance in the message in the format of a UUID prefixed with 'urn:uuid:'.
- - onBehalfOf 0..1 Mandatory Reference Organization agent is acting for
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Mandatory CareConnect-Organization-1 The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-Organization-1'
Requesting Organisation
- - - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL
a reference to the location resource instance in the message in the format of a UUID prefixed with 'urn:uuid:'.
- performer 0..1 Mandatory Reference Requested perfomer
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Mandatory CareConnect-Practitioner-1 This MUST be to the Organization resource profiled as CareConnect-Practitioner-1
    Mandatory CareConnect-Organisation-1 This MUST be to the Organization resource profiled as CareConnect-Organisation-1
- - reference 1..1 Mandatory String Literal reference, Relative, internal or absolute URL a reference to the Patient resource instance in the message in the format of a UUID prefixed with 'urn:uuid:'.
- reasonCode 0..* Required CodeableConcept Explanation/Justification for test
Binding (example): Diagnosis or problem codes justifying the reason for requesting the procedure or diagnostic investigation. Procedure Reason Codes
A structured and coded explanation from the requesting HCP containing an explanation on why the test has been requested and any contextual information they considered relevant. Use FHIR default value set
- - coding 0..* Required Coding Code defined by a terminology system
- - - system 1..1 Mandatory Uri Identity of the terminology system
- - - code 1..1 Mandatory Code Symbol in syntax defined by the system
- - - display 1..1 Mandatory String Representation defined by the system
- - text 0..1 Optional String Plain text representation of the concept
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.
- reasonReference 0..* Required Reference Explanation/Justification for test
Constraint (ref-1): SHALL have a contained resource if a local reference is provided. The clinical code of conditions the patient has that are supplied by the requesting HCP due to their relevance to the test request.
    Required CareConnect-Condition-1 This MUST be to the Organization resource profiled as CareConnect-Condition-1
- - reference 0..1 Required String Literal reference, Relative, internal or absolute URL a reference to the Patient resource instance in the message in the format of a UUID prefixed with 'urn:uuid:'.
- note 0..* Required Annotation Comments Notes relating to the test request, as provided by the requester. May be used to provide further clinical context and/or the reason for requesting the tests.
- - text 1..1 Required String The annotation - text content E.G. Patient always feels tired

Test Request Summary Example

Tags: fhir

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