List

See FHIR specification

Semantical type

The “code” field of the resource is used to determine the semantical type of the resource. It is mandantory. Look at the List of registered codes for a complete list of codes registered in MIDATA. Include the required codes into your applications access filter if you need to use this resource.

Resource owner

If the resource contains a subject which is a Patient or Practitioner that user is the owner of the resource. Otherwise the creator of the resource is the owner.

Default value for “subject”

If a resource with no subject field is send to MIDATA, the backend will set the subject to the current user.

Read

Read a single List by id.

Request:

[GET] /fhir/List/<id>

Read specific version

Read a specific version of a single List by id.

Request:

[GET] /fhir/List/<id>/_history/<version>

Retrieve history

Retrieve all versions of a single resource.

Request:

[GET] /fhir/List/<id>/_history

Search

Search for resources of type List

Request:

[GET] /fhir/List?searchParams

List of supported search parameters:

Supported query parameters:

Name	Type	Description
_id	string	The resource identity
_lastUpdated	date	Only return resources which were last updated as specified by the given range
_page	string
code	token	What the purpose of this list is
date	date	When the list was prepared
empty-reason	token	Why list is empty
encounter	reference	Context in which list was created
identifier	token	Business identifier
item	reference	Actual entry
notes	string	The annotation - text content (as markdown)
patient	reference	If all resources have the same subject
source	reference	Who and/or what defined the list contents (aka Author)
status	token	current - retired - entered-in-error
subject	reference	If all resources have the same subject
title	string	Descriptive name for the list

Create

Create a new resource of type List.

Request:

[POST] /fhir/List

Update

Updates a resource of type List.

Request:

[PUT] /fhir/List/<id>