lists

Create List

post
/organizations/{organizationId}/fhir/3/List

A set of information summarized from a list of other resources.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringListThis is a List resource
identifierarray(Identifier)Identifier for the List assigned for business purposes outside the context of FHIR.
statusstringcurrent|retired|entered-in-errorIndicates the current state of this list.
modestringworking|snapshot|changesHow this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
titlestringA label for the list assigned by the author.
codeCodeableConceptThis code defines the purpose of the list - why it was created.
subjectReferenceThe common subject (or patient) of the resources that are in the list, if there is one.
encounterReferenceThe encounter that is the context in which this list was created.
datestringThe date that the list was prepared.
sourceReferenceThe entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.
orderedByCodeableConceptWhat order applies to the items in the list.
notearray(Annotation)Comments that apply to the overall list.
entryarray(List_Entry)Entries in this list.
emptyReasonCodeableConceptIf the list is empty, why the list is empty.

Response

Patch List

patch
/organizations/{organizationId}/fhir/3/List/{resourceId}

A set of information summarized from a list of other resources.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringListThis is a List resource
identifierarray(Identifier)Identifier for the List assigned for business purposes outside the context of FHIR.
statusstringcurrent|retired|entered-in-errorIndicates the current state of this list.
modestringworking|snapshot|changesHow this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
titlestringA label for the list assigned by the author.
codeCodeableConceptThis code defines the purpose of the list - why it was created.
subjectReferenceThe common subject (or patient) of the resources that are in the list, if there is one.
encounterReferenceThe encounter that is the context in which this list was created.
datestringThe date that the list was prepared.
sourceReferenceThe entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.
orderedByCodeableConceptWhat order applies to the items in the list.
notearray(Annotation)Comments that apply to the overall list.
entryarray(List_Entry)Entries in this list.
emptyReasonCodeableConceptIf the list is empty, why the list is empty.

Response

Read List

get
/organizations/{organizationId}/fhir/3/List/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History List

get
/organizations/{organizationId}/fhir/3/List/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version List

get
/organizations/{organizationId}/fhir/3/List/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove List

delete
/organizations/{organizationId}/fhir/3/List/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get List

get
/organizations/{organizationId}/fhir/3/List

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
codestring
datestring
empty-reasonstring
encounterstring
identifierstring
itemstring
notesstring
patientstring
sourcestring
statusstring
subjectstring
titlestring

Params

organizationId*string|stringid|slug

Response

Search History List

get
/organizations/{organizationId}/fhir/3/List/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post List

post
/organizations/{organizationId}/fhir/3/List/_search

A set of information summarized from a list of other resources.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
codestring
datestring
empty-reasonstring
encounterstring
identifierstring
itemstring
notesstring
patientstring
sourcestring
statusstring
subjectstring
titlestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringListThis is a List resource
identifierarray(Identifier)Identifier for the List assigned for business purposes outside the context of FHIR.
statusstringcurrent|retired|entered-in-errorIndicates the current state of this list.
modestringworking|snapshot|changesHow this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
titlestringA label for the list assigned by the author.
codeCodeableConceptThis code defines the purpose of the list - why it was created.
subjectReferenceThe common subject (or patient) of the resources that are in the list, if there is one.
encounterReferenceThe encounter that is the context in which this list was created.
datestringThe date that the list was prepared.
sourceReferenceThe entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.
orderedByCodeableConceptWhat order applies to the items in the list.
notearray(Annotation)Comments that apply to the overall list.
entryarray(List_Entry)Entries in this list.
emptyReasonCodeableConceptIf the list is empty, why the list is empty.

Response

Update List

put
/organizations/{organizationId}/fhir/3/List/{resourceId}

A set of information summarized from a list of other resources.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringListThis is a List resource
identifierarray(Identifier)Identifier for the List assigned for business purposes outside the context of FHIR.
statusstringcurrent|retired|entered-in-errorIndicates the current state of this list.
modestringworking|snapshot|changesHow this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
titlestringA label for the list assigned by the author.
codeCodeableConceptThis code defines the purpose of the list - why it was created.
subjectReferenceThe common subject (or patient) of the resources that are in the list, if there is one.
encounterReferenceThe encounter that is the context in which this list was created.
datestringThe date that the list was prepared.
sourceReferenceThe entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.
orderedByCodeableConceptWhat order applies to the items in the list.
notearray(Annotation)Comments that apply to the overall list.
entryarray(List_Entry)Entries in this list.
emptyReasonCodeableConceptIf the list is empty, why the list is empty.

Response