List resource implementation guidance
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® CDS API.
List: Implementation Guidance
Usage
The List resource represents a flat, possibly ordered collection of ALL resources populated during the triage journey as part of the $evaluate
interaction. Lists will include references to the resources that make up the list.
The resources referenced by the List
resource SHOULD be used by the ERR to build a human readable Encounter Report that meets the needs of the Service Provider.
The resources referenced by the List
resource MAY be used to drive workflow at the receiving Service Provider (e.g. queue management)
Detailed implementation guidance for a List
resource within the scope of this implementation guide is given below:
Name | Cardinality | Type | FHIR Documentation | CDS Implementation Guidance |
---|---|---|---|---|
id |
0..1 |
id | Logical id of this artifact | |
meta |
0..1 |
Meta | Metadata about the resource | |
implicitRules |
0..1 |
uri | A set of rules under which this content was created | |
language |
0..1 |
code | Language of the resource content. Common Languages (Extensible but limited to All Languages) |
|
text |
0..1 |
Narrative | Text summary of the resource, for human interpretation | |
contained |
0..* |
Resource | Contained, inline Resources | |
extension |
0..* |
Extension | Additional Content defined by implementations | |
modifierExtension |
0..* |
Extension | Extensions that cannot be ignored | |
identifier |
0..* |
Identifier | Business identifier | |
status |
1..1 |
code | current | retired | entered-in-error ListStatus (Required) |
Status MUST carry the value 'current' after the journey is completed. |
mode |
1..1 |
code | working | snapshot | changes ListMode (Required) | |
title |
0..1 |
string | Descriptive name for the list | |
code |
0..1 |
CodeableConcept | What the purpose of this list is Example Use Codes for List (Example) |
This MUST be populated with SNOMED code 225390008 | Triage (procedure) as per CareConnect ValueSet | CareConnect-ListCode-1 |
intent |
1..1 |
code | proposal | plan | order + RequestIntent (Required) |
|
subject |
0..1 |
Reference(Patient | Group | Device | Location) | If all resources have the same subject | This MUST be populated with the Patient of the current Encounter. |
encounter |
0..1 |
Reference(Encounter) | Context in which list was created | This MUST be populated with the current Encounter. |
date |
0..1 |
dateTime | When the list was prepared | This MUST be populated with the date/time of the moment the triage ended. |
source |
0..1 |
Reference(Practitioner | Patient | Device) | Who and/or what defined the list contents (aka Author | When populated this MUST be populated with the EMS as a Device. |
orderedBy |
0..1 |
CodeableConcept | What order the list has List Order Codes (Preferred) |
This MUST carry the value 'event-date'. |
note |
0..* |
Annotation | Comments about the list | |
entry |
0..* |
BackboneElement | Entries in the list | |
flag |
0..1 |
CodeableConcept | Status/Workflow information about this item Patient Medicine Change Types (Example) |
This MUST NOT be populated. |
deleted |
0..1 |
boolean | If this item is actually marked as deleted | |
date |
0..1 |
dateTime | When item was added to list | This MUST NOT be populated. |
item |
1..1 |
Reference(Any) | Actual entry | The resource referenced - Questionnaire, Observation etc. |
emptyReason |
0..1 |
CodeableConcept | Why list is empty List Empty Reasons (Preferred) |