Operation Definition: Get Medication List

Anforderungen

Invocations

URL: [base]/?_query=medication-list

This operation is a namedQuery

Parameters (In)

NameCardinalityTypeDocumentation
date0..2date

Limit the search to this date. Can specify upper or lower limits and periods by providing an upper and a lower limit.

_count0..1integer

Limit the result bundle to this many entries. To get more entries request the next page.

_offset0..1integer

Defines the offset of the first entry in the collection.

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1Bundle

Searchset bundle containing the requested entities.

OperationDefinition
<OperationDefinition xmlns="http://hl7.org/fhir">
    <id value="get-medication-list-op" />
    <url value="https://gematik.de/fhir/epa-medication/OperationDefinition/get-medication-list-op" />
    <version value="1.1.1" />
    <name value="Get Medication List" />
    <title value="$medication-list Operation" />
    <status value="active" />
    <kind value="query" />
    <date value="2024-08-14" />
    <publisher value="gematik GmbH" />
    <description value="Get a medication list" />
    <code value="medication-list" />
    <system value="true" />
    <type value="false" />
    <instance value="false" />
    <parameter>
        <name value="date" />
        <use value="in" />
        <min value="0" />
        <max value="2" />
        <documentation value="Limit the search to this date. Can specify upper or lower limits and periods by providing an upper and a lower limit." />
        <type value="date" />
    </parameter>
    <parameter>
        <name value="_count" />
        <use value="in" />
        <min value="0" />
        <max value="1" />
        <documentation value="Limit the result bundle to this many entries. To get more entries request the next page." />
        <type value="integer" />
    </parameter>
    <parameter>
        <name value="_offset" />
        <use value="in" />
        <min value="0" />
        <max value="1" />
        <documentation value="Defines the offset of the first entry in the collection." />
        <type value="integer" />
    </parameter>
    <parameter>
        <name value="return" />
        <use value="out" />
        <min value="1" />
        <max value="1" />
        <documentation value="Searchset bundle containing the requested entities." />
        <type value="Bundle" />
    </parameter>
</OperationDefinition>
{
    "resourceType": "OperationDefinition",
    "id": "get-medication-list-op",
    "url": "https://gematik.de/fhir/epa-medication/OperationDefinition/get-medication-list-op",
    "title": "$medication-list Operation",
    "description": "Get a medication list",
    "version": "1.1.1",
    "status": "active",
    "publisher": "gematik GmbH",
    "date": "2024-08-14",
    "kind": "query",
    "name": "Get Medication List",
    "code": "medication-list",
    "system": true,
    "type": false,
    "instance": false,
    "parameter":  [
        {
            "name": "date",
            "type": "date",
            "use": "in",
            "min": 0,
            "max": "2",
            "documentation": "Limit the search to this date. Can specify upper or lower limits and periods by providing an upper and a lower limit."
        },
        {
            "name": "_count",
            "type": "integer",
            "use": "in",
            "min": 0,
            "max": "1",
            "documentation": "Limit the result bundle to this many entries. To get more entries request the next page."
        },
        {
            "name": "_offset",
            "type": "integer",
            "use": "in",
            "min": 0,
            "max": "1",
            "documentation": "Defines the offset of the first entry in the collection."
        },
        {
            "name": "return",
            "type": "Bundle",
            "use": "out",
            "min": 1,
            "max": "1",
            "documentation": "Searchset bundle containing the requested entities."
        }
    ]
}