Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

List

Guidance for populating and consuming the List profile

Introduction

The headings below detail the elements of the List profile and describe how to populate and consume them.

List elements

meta.profile

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

The List profile URL.

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

extension[warningCode]

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

A code or codes warning of an issue related to this list.

This extension is used to capture warnings that the list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit. It MUST be populated using the appropriate code from the table in the warning codes section on the resource population fundamentals page.

extension[clinicalSetting]

Data type: Extension Optionality: Required Cardinality: 0..1

For GP Connect this should be set to ‘1060971000000108 General practice service’.

status

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

Whether the list is current, retired or entered-in-error.

current MUST be used for all lists in GP Connect.

mode

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

Whether the List has a mode of working, snapshot, or changes.

snapshot MUST be used for all lists in GP Connect.

title

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

Descriptive name for the list. This will be taken from the ‘display’ element from the ‘code’ field.

code

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

The purpose of the list.

There are currently 6 possible purposes of a list in response to a query for a clinical area in GP Connect that will be represented by the following SNOMED codes.

Purpose SNOMED Code SNOMED Preferred Term / List.title
Medications and medical devices 933361000000108 Medications and medical devices
Allergies and adverse reactions 886921000000105 Allergies and adverse reaction
Ended allergies 1103671000000101 Ended allergies
Immunisations 1102181000000102 Immunisations
List of consultations 1149501000000101 List of consultations
Problems 717711000000103 Problems
Uncategorised data 826501000000100 Miscellaneous record

The above code for ‘Ended allergies’ should be used for resolved allergies.

subject

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

Reference to the patient.

date

Data type: dateTime Optionality: Optional Cardinality: 0..1

When the list was created.

orderedBy

Data type: CodeableConcept Optionality: Optional Cardinality: 0..1

What order the list is in.

note

Data type: Annotation Optionality: Required Cardinality: 0..1

The text versions of any warning messages included with the list. Where there are multiple warning messages their text is concatenated.

entry

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

Entries in the list. Entries are populated in no specific order.

See below for sub elements.

entry.date

Data type: Boolean Optionality: Optional Cardinality: 0..1

When the item was added to the list.

As GP Connect represents a snapshot at the time the request was made by the consuming system, this is not required to be populated.

entry.item

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

Actual entry.

Reference to the item that is part of the list.

emptyReason

Data type: CodeableConcept Optionality: Required Cardinality: 0..1

Why the list is empty.

A FHIR code of no-content-recorded MUST be recorded in emptyReason.code if a query returns no results to enter into a list. In this case, List.note MUST be populated with the text ‘Information not available’.

List elements not in use

The following elements MUST NOT be populated:

id

Data type: Id

meta.versionId

Data type: Id

meta.lastUpdated

Data type: Instant

source

Data type: Reference(Practitioner, Patient, Device)

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