Implementation Guide
ePA Medication Service
Version 1.0.5-ballot.1 - draft

: Get Medication List - JSON Representation

Draft as of 2025-02-14

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "get-medication-list-op",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition get-medication-list-op</b></p><a name=\"get-medication-list-op\"> </a><a name=\"hcget-medication-list-op\"> </a><a name=\"get-medication-list-op-en-US\"> </a><p>URL: [base]/$medication-list</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>date</td><td/><td>0..2</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>Limit the search to this date. Can specify upper or lower limits and periods by providing an upper and a lower limit.</p>\n</div></td></tr><tr><td>IN</td><td>_count</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>Limit the result bundle to this many entries. To get more entries request the next page.</p>\n</div></td></tr><tr><td>IN</td><td>_offset</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>Defines the offset of the first entry in the collection.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>Searchset bundle containing the requested entities.</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://gematik.de/fhir/epa-medication/OperationDefinition/get-medication-list-op",
  "version" : "1.0.5-ballot.1",
  "name" : "Get Medication List",
  "title" : "Get Medication List",
  "status" : "draft",
  "kind" : "query",
  "date" : "2025-02-14",
  "publisher" : "gematik GmbH",
  "contact" : [
    {
      "name" : "gematik GmbH",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.gematik.de"
        },
        {
          "system" : "email",
          "value" : "patientteam [ at ] gematik.de"
        }
      ]
    }
  ],
  "description" : "Get a medication list",
  "code" : "medication-list",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "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.",
      "type" : "date"
    },
    {
      "name" : "_count",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Limit the result bundle to this many entries. To get more entries request the next page.",
      "type" : "integer"
    },
    {
      "name" : "_offset",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Defines the offset of the first entry in the collection.",
      "type" : "integer"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Searchset bundle containing the requested entities.",
      "type" : "Bundle"
    }
  ]
}