List

Guidance for populating and consuming the List resource

Introduction

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

Important: Any element not specifically detailed below MUST NOT be populated or consumed.

Tip: You’ll find it helpful to read it in conjunction with the underlying List profile definition.

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 3 possible purposes of a list in GP Connect that will be represented by the following SNOMED codes.

Medications and medical devices - 933361000000108
Allergies and adverse reactions - 886921000000105
Ended allergies - 1103671000000101

The above code for ‘Ended allergies’ should be used for resolved allergies. This code is new at the time of publishing this version of the specification and will be included in the October 2018 SNOMED release.

Tip: Please see CodeableConcept and common code systems when populating this element.

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.

source

Data type: Reference(Practitioner, Patient, Device) Optionality: Optional Cardinality: 0..1

Who and/or what defined the list contents (that is, the author).

orderedBy

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

What order the list has.

As the data where lists are being used in GP Connect is structured, it is simple for the consumer to put in order.

note

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

Comments about this list.

entry

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

Entries in the list.

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 SHALL be used if a query returns no results to enter into a list. In this case, the ‘note’ field SHALL be populated with the text ‘Information not available’.

List elements not in use

The following elements SHALL NOT be populated:

id

Data type: Id

meta.versionId