Generated Narrative: CapabilityStatement MedicationOverviewResponder

Medication Overview Responder

  • Implementation Guide Version: 1.0.0-preview
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json, application/fhir+xml
  • Published on: 2025-01-01
  • Published by: Integrating the Healthcare Enterprise (IHE)

Note to Implementers: FHIR Capabilities

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.

FHIR RESTful Capabilities

Mode: server

The Responder responds to PHARM-11 search queries with searchset Bundles containing MedicationTreatmentLine resources. With the Document Option, it also responds to PHARM-12 requests with MedicationOverviewBundle documents.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
MedicationStatementSupported Profiles
  Medication Treatment Line		yypatient, status, effective, category, _lastUpdatedMedicationStatement:medication, MedicationStatement:derivedFrom, MedicationStatement:partOfMedicationDispense:prescription, MedicationAdministration:request
CarePlanSupported Profiles
  Medication Treatment		y
MedicationRequest y
MedicationDispense y
MedicationAdministration y
MedicationSupported Profiles
  Medicinal product		y
BundleSupported Profiles
  Medication Overview Bundle		yytype, patient, date

Resource Conformance: unspecified MedicationStatement

Core FHIR Resource
MedicationStatement
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

Medication Treatment Line

Documentation

The Repository SHALL support search on MedicationStatement using the defined search parameters. The patient parameter is required on all searches.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Required. Patient whose treatment lines are requested.

SHALLstatustoken

Filter by treatment line status.

SHALLeffectivedate

Filter by effective period.

SHALLcategorytoken

Filter by list category / type.

SHALL_lastUpdateddate

Filter by last update time (incremental sync support).

 

Resource Conformance: unspecified CarePlan

Core FHIR Resource
CarePlan
Reference Policy
Interaction summary
  • Supports read.

Supported Profiles

Medication Treatment

Documentation

Returned as an _include of MedicationStatement:partOf when MedicationTreatment grouping is present.

Resource Conformance: unspecified MedicationRequest

Core FHIR Resource
MedicationRequest
Reference Policy
Interaction summary
  • Supports read.

Documentation

Optionally returned as _include of MedicationStatement:derivedFrom (prescriptions).

Resource Conformance: unspecified MedicationDispense

Core FHIR Resource
MedicationDispense
Reference Policy
Interaction summary
  • Supports read.

Documentation

Optionally returned as _revinclude of MedicationDispense:prescription.

Resource Conformance: unspecified MedicationAdministration

Core FHIR Resource
MedicationAdministration
Reference Policy
Interaction summary
  • Supports read.

Documentation

Optionally returned as _revinclude of MedicationAdministration:request.

Resource Conformance: unspecified Medication

Core FHIR Resource
Medication
Reference Policy
Interaction summary
  • Supports read.

Supported Profiles

Medicinal product

Documentation

Optionally returned as _include of MedicationStatement:medication.

Resource Conformance: unspecified Bundle

Core FHIR Resource
Bundle
Reference Policy
Interaction summary
  • Supports read, search-type.

Supported Profiles

Medication Overview Bundle

Documentation

Document Option (PHARM-12). The Repository stores and serves MedicationOverviewBundle documents. Supports retrieval by logical id and by patient/type/date search.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLtypetoken

Filter by document type / medication list category.

SHALLpatientreference

Required for patient-scoped document search.

SHALLdatedate

Filter by document creation date.

 
 <status value="active"/> <experimental value="false"/> <date value="2025-01-01"/> <publisher value="Integrating the Healthcare Enterprise (IHE)"/> <contact> <name value="Integrating the Healthcare Enterprise (IHE)"/> <telecom> <system value="url"/> <value value="http://ihe.net"/> </telecom> <telecom> <system value="email"/> <value value="secretary@ihe.net"/> </telecom> </contact> <contact> <name value="Jose Costa Teixeira"/> <telecom> <system value="email"/> <value value="jose.a.teixeira@gmail.com"/> <use value="work"/> </telecom> </contact> <description value="CapabilityStatement for the Medication Overview Responder actor in the IHE PHARM MEOW profile. The Responder is a server that stores and/or assembles medication overview data for patients and serves it in response to Consumer requests. It supports PHARM-11 (Query Medication Resources) as a required capability, and optionally PHARM-12 (Retrieve Medication Document) when the Document Option is declared. How the Responder obtains its data (continuous store, on-demand aggregation, document assembly) is an implementation concern outside the scope of this profile."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> </coding> </jurisdiction> <copyright value="IHE http://www.ihe.net/Governance/#Intellectual_Property"/> <kind value="requirements"/> <fhirVersion value="4.0.1"/> <format value="application/fhir+json"/> <format value="application/fhir+xml"/> <rest> <mode value="server"/> <documentation value="The Responder responds to PHARM-11 search queries with searchset Bundles containing MedicationTreatmentLine resources. With the Document Option, it also responds to PHARM-12 requests with MedicationOverviewBundle documents."/> <resource> <type value="MedicationStatement"/> <supportedProfile value="https://profiles.ihe.net/PHARM/MEOW/StructureDefinition/MedicationTreatmentLine"/> <documentation value="The Repository SHALL support search on MedicationStatement using the defined search parameters. The patient parameter is required on all searches."/> <interaction> <code value="search-type"/> </interaction> <interaction> <code value="read"/> </interaction> <searchInclude value="MedicationStatement:medication"/> <searchInclude value="MedicationStatement:derivedFrom"/> <searchInclude value="MedicationStatement:partOf"/> <searchRevInclude value="MedicationDispense:prescription"/> <searchRevInclude value="MedicationAdministration:request"/> <searchParam> <name value="patient"/> <type value="reference"/> <documentation value="Required. Patient whose treatment lines are requested."/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> <documentation value="Filter by treatment line status."/> </searchParam> <searchParam> <name value="effective"/> <type value="date"/> <documentation value="Filter by effective period."/> </searchParam> <searchParam> <name value="category"/> <type value="token"/> <documentation value="Filter by list category / type."/> </searchParam> <searchParam> <name value="_lastUpdated"/> <type value="date"/> <documentation value="Filter by last update time (incremental sync support)."/> </searchParam> </resource> <resource> <type value="CarePlan"/> <supportedProfile value="https://profiles.ihe.net/PHARM/MEOW/StructureDefinition/MedicationTreatment"/> <documentation value="Returned as an _include of MedicationStatement:partOf when MedicationTreatment grouping is present."/> <interaction> <code value="read"/> </interaction> </resource> <resource> <type value="MedicationRequest"/> <documentation value="Optionally returned as _include of MedicationStatement:derivedFrom (prescriptions)."/> <interaction> <code value="read"/> </interaction> </resource> <resource> <type value="MedicationDispense"/> <documentation value="Optionally returned as _revinclude of MedicationDispense:prescription."/> <interaction> <code value="read"/> </interaction> </resource> <resource> <type value="MedicationAdministration"/> <documentation value="Optionally returned as _revinclude of MedicationAdministration:request."/> <interaction> <code value="read"/> </interaction> </resource> <resource> <type value="Medication"/> <supportedProfile value="https://profiles.ihe.net/PHARM/MEOW/StructureDefinition/IHEMedication"/> <documentation value="Optionally returned as _include of MedicationStatement:medication."/> <interaction> <code value="read"/> </interaction> </resource> <resource> <type value="Bundle"/> <supportedProfile value="https://profiles.ihe.net/PHARM/MEOW/StructureDefinition/MedicationOverview"/> <documentation value="Document Option (PHARM-12). The Repository stores and serves MedicationOverviewBundle documents. Supports retrieval by logical id and by patient/type/date search."/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <searchParam> <name value="type"/> <type value="token"/> <documentation value="Filter by document type / medication list category."/> </searchParam> <searchParam> <name value="patient"/> <type value="reference"/> <documentation value="Required for patient-scoped document search."/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="Filter by document creation date."/> </searchParam> </resource> </rest> </CapabilityStatement>