List
A list is a curated collection of resources.
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/List| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/List/[id] |
| Vread | GET | /fhir/R4/List/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/List/[id] |
| Patch | PATCH | /fhir/R4/List/[id] |
| Delete | DELETE | /fhir/R4/List/[id] |
| Create | POST | /fhir/R4/List |
| Search | GET | /fhir/R4/List |
| History | GET | /fhir/R4/List/[id]/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
identifier | Identifier | 0..* | Business identifier |
status | code | 1..1 | current | retired | entered-in-error modifier |
mode | code | 1..1 | working | snapshot | changes modifier |
title | string | 0..1 | Descriptive name for the list |
code | CodeableConcept | 0..1 | What the purpose of this list is |
subject | Reference | 0..1 | If all resources have the same subject |
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
Reference
- Official FHIR R4 spec:
List - Maturity: Trial Use 1 (FMM 1).