IHE Pharmacy Medication Overview
1.0.0-preview - Preview
IHE Pharmacy Medication Overview
1.0.0-preview - Preview
This page is part of the IHE Pharmacy Medication Overview (v1.0.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Active as of 2025-01-01 |
{
"resourceType" : "CapabilityStatement",
"id" : "MedicationOverviewResponder",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement MedicationOverviewResponder</b></p><a name=\"MedicationOverviewResponder\"> </a><a name=\"hcMedicationOverviewResponder\"> </a><h2 id=\"title\">Medication Overview Responder</h2><ul><li>Implementation Guide Version: 1.0.0-preview </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+json</code>, <code>application/fhir+xml</code></li><li>Published on: 2025-01-01 </li><li>Published by: Integrating the Healthcare Enterprise (IHE) </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>The Responder responds to PHARM-11 search queries with searchset Bundles containing\nMedicationTreatmentLine resources. With the Document Option, it also responds to\nPHARM-12 requests with MedicationOverviewBundle documents.</p>\n</div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#MedicationStatement1-1\">MedicationStatement</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-MedicationTreatmentLine.html\">Medication Treatment Line</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>patient, status, effective, category, _lastUpdated</td><td><code>MedicationStatement:medication</code>, <code>MedicationStatement:derivedFrom</code>, <code>MedicationStatement:partOf</code></td><td><code>MedicationDispense:prescription</code>, <code>MedicationAdministration:request</code></td><td/></tr><tr><td><a href=\"#CarePlan1-2\">CarePlan</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-MedicationTreatment.html\">Medication Treatment</a></td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td/></tr><tr><td><a href=\"#MedicationRequest1-3\">MedicationRequest</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td/></tr><tr><td><a href=\"#MedicationDispense1-4\">MedicationDispense</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td/></tr><tr><td><a href=\"#MedicationAdministration1-5\">MedicationAdministration</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td/></tr><tr><td><a href=\"#Medication1-6\">Medication</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-IHEMedication.html\">Medicinal product</a></td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td/></tr><tr><td><a href=\"#Bundle1-7\">Bundle</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-MedicationOverview.html\">Medication Overview Bundle</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>type, patient, date</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MedicationStatement1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>MedicationStatement</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/medicationstatement.html\">MedicationStatement</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>search-type</code>, <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-MedicationTreatmentLine.html\">Medication Treatment Line</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>The Repository SHALL support search on MedicationStatement using the defined\nsearch parameters. The patient parameter is required on all searches.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div><p>Required. Patient whose treatment lines are requested.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>Filter by treatment line status.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>effective</td><td><code>date</code></td><td><div><p>Filter by effective period.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>category</td><td><code>token</code></td><td><div><p>Filter by list category / type.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_lastUpdated</td><td><code>date</code></td><td><div><p>Filter by last update time (incremental sync support).</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"CarePlan1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>CarePlan</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/careplan.html\">CarePlan</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-MedicationTreatment.html\">Medication Treatment</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Returned as an _include of MedicationStatement:partOf when MedicationTreatment grouping is present.</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MedicationRequest1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>MedicationRequest</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/medicationrequest.html\">MedicationRequest</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Optionally returned as _include of MedicationStatement:derivedFrom (prescriptions).</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MedicationDispense1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>MedicationDispense</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/medicationdispense.html\">MedicationDispense</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Optionally returned as _revinclude of MedicationDispense:prescription.</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MedicationAdministration1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>MedicationAdministration</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/medicationadministration.html\">MedicationAdministration</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Optionally returned as _revinclude of MedicationAdministration:request.</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Medication1-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>Medication</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/medication.html\">Medication</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-IHEMedication.html\">Medicinal product</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Optionally returned as _include of MedicationStatement:medication.</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Bundle1-7\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>Bundle</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-MedicationOverview.html\">Medication Overview Bundle</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Document Option (PHARM-12). The Repository stores and serves MedicationOverviewBundle\ndocuments. Supports retrieval by logical id and by patient/type/date search.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>Filter by document type / medication list category.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div><p>Required for patient-scoped document search.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>Filter by document creation date.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
},
"url" : "https://profiles.ihe.net/PHARM/MEOW/CapabilityStatement/MedicationOverviewResponder",
"version" : "1.0.0-preview",
"name" : "MedicationOverviewResponder",
"title" : "Medication Overview Responder",
"status" : "active",
"experimental" : false,
"date" : "2025-01-01",
"publisher" : "Integrating the Healthcare Enterprise (IHE)",
"contact" : [
{
"name" : "Integrating the Healthcare Enterprise (IHE)",
"telecom" : [
{
"system" : "url",
"value" : "http://ihe.net"
},
{
"system" : "email",
"value" : "secretary@ihe.net"
}
]
},
{
"name" : "Jose Costa Teixeira",
"telecom" : [
{
"system" : "email",
"value" : "jose.a.teixeira@gmail.com",
"use" : "work"
}
]
}
],
"description" : "CapabilityStatement for the Medication Overview Responder actor in the IHE PHARM MEOW profile.\n\nThe Responder is a server that stores and/or assembles medication overview data for patients\nand serves it in response to Consumer requests. It supports PHARM-11 (Query Medication\nResources) as a required capability, and optionally PHARM-12 (Retrieve Medication Document)\nwhen the Document Option is declared.\n\nHow the Responder obtains its data (continuous store, on-demand aggregation, document\nassembly) is an implementation concern outside the scope of this profile.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"copyright" : "IHE http://www.ihe.net/Governance/#Intellectual_Property",
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+json",
"application/fhir+xml"
],
"rest" : [
{
"mode" : "server",
"documentation" : "The Responder responds to PHARM-11 search queries with searchset Bundles containing\nMedicationTreatmentLine resources. With the Document Option, it also responds to\nPHARM-12 requests with MedicationOverviewBundle documents.",
"resource" : [
{
"type" : "MedicationStatement",
"supportedProfile" : [
🔗 "https://profiles.ihe.net/PHARM/MEOW/StructureDefinition/MedicationTreatmentLine"
],
"documentation" : "The Repository SHALL support search on MedicationStatement using the defined\nsearch parameters. The patient parameter is required on all searches.",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchInclude" : [
"MedicationStatement:medication",
"MedicationStatement:derivedFrom",
"MedicationStatement:partOf"
],
"searchRevInclude" : [
"MedicationDispense:prescription",
"MedicationAdministration:request"
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference",
"documentation" : "Required. Patient whose treatment lines are requested."
},
{
"name" : "status",
"type" : "token",
"documentation" : "Filter by treatment line status."
},
{
"name" : "effective",
"type" : "date",
"documentation" : "Filter by effective period."
},
{
"name" : "category",
"type" : "token",
"documentation" : "Filter by list category / type."
},
{
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "Filter by last update time (incremental sync support)."
}
]
},
{
"type" : "CarePlan",
"supportedProfile" : [
🔗 "https://profiles.ihe.net/PHARM/MEOW/StructureDefinition/MedicationTreatment"
],
"documentation" : "Returned as an _include of MedicationStatement:partOf when MedicationTreatment grouping is present.",
"interaction" : [
{
"code" : "read"
}
]
},
{
"type" : "MedicationRequest",
"documentation" : "Optionally returned as _include of MedicationStatement:derivedFrom (prescriptions).",
"interaction" : [
{
"code" : "read"
}
]
},
{
"type" : "MedicationDispense",
"documentation" : "Optionally returned as _revinclude of MedicationDispense:prescription.",
"interaction" : [
{
"code" : "read"
}
]
},
{
"type" : "MedicationAdministration",
"documentation" : "Optionally returned as _revinclude of MedicationAdministration:request.",
"interaction" : [
{
"code" : "read"
}
]
},
{
"type" : "Medication",
"supportedProfile" : [
🔗 "https://profiles.ihe.net/PHARM/MEOW/StructureDefinition/IHEMedication"
],
"documentation" : "Optionally returned as _include of MedicationStatement:medication.",
"interaction" : [
{
"code" : "read"
}
]
},
{
"type" : "Bundle",
"supportedProfile" : [
🔗 "https://profiles.ihe.net/PHARM/MEOW/StructureDefinition/MedicationOverview"
],
"documentation" : "Document Option (PHARM-12). The Repository stores and serves MedicationOverviewBundle\ndocuments. Supports retrieval by logical id and by patient/type/date search.",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "type",
"type" : "token",
"documentation" : "Filter by document type / medication list category."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "Required for patient-scoped document search."
},
{
"name" : "date",
"type" : "date",
"documentation" : "Filter by document creation date."
}
]
}
]
}
]
}
IG © 2022+ Integrating the Healthcare Enterprise (IHE). Package ihe.pharm.meow#1.0.0-preview based on FHIR 4.0.1. Generated 2026-06-26
Links: Table of Contents |
QA Report
Version History |
|
Propose a change