Trial Use 4
Foundation
A List is a curated collection of resources, for things such as problem lists, allergy lists, facility list, organization list, etc.
Endpoints
devhttps://api.sandbox.ovok.com/fhir/R5/List
| Interaction | Method | Path |
|---|
| Read | GET | /fhir/R5/List/[id] |
| Vread | GET | /fhir/R5/List/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/List/[id] |
| Patch | PATCH | /fhir/R5/List/[id] |
| Delete | DELETE | /fhir/R5/List/[id] |
| Create | POST | /fhir/R5/List |
| Search | GET | /fhir/R5/List?... |
| History | GET | /fhir/R5/List/[id]/_history |
| Type-history | GET | /fhir/R5/List/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|
identifier | Identifier | 0..* | Business identifier |
status | code | 1..1 | current |
mode | code | 1..1 | working |
title | string | 0..1 | Descriptive name for the list |
code | CodeableConcept | 0..1 | What the purpose of this list is |
subject | Reference | 0..* | If all resources have the same subject(s) |
encounter | Reference | 0..1 | Context in which list created |
date | dateTime | 0..1 | When the list was prepared |
source | Reference | 0..1 | Who and/or what defined the list contents (aka Author) |
orderedBy | CodeableConcept | 0..1 | What order the list has |
note | Annotation | 0..* | Comments about the list |
entry | BackboneElement | 0..* | Entries in the list |
emptyReason | CodeableConcept | 0..1 | Why list is empty |
Resource-specific search parameters
| Parameter | Type | Description |
|---|
code | token | Event or incident that occurred or was averted |
| | |
date | date | When the event occurred |
| | |
empty-reason | token | Why list is empty |
encounter | reference | Encounter related to the activity recorded in the AuditEvent |
| | |
identifier | token | Account number |
| | |
item | reference | Actual entry |
notes | string | The annotation - text content (as markdown) |
patient | reference | The entity that caused the expenses |
| | |
source | reference | Who and/or what defined the list contents (aka Author) |
status | token | current |
subject | reference | If all resources have the same subject |
title | string | Descriptive name for the list |
Reference
- Official FHIR R5 spec:
List
- Maturity: Trial Use 4 (FMM 4).