Medicinalproductdefinition-operation-everything

Release 5 Preview #2

This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B

11.11.9.1 Operation $everything on MedicinalProductDefinition

Biomedical Research and Regulation

Work Group

Maturity Level: 1

Trial Use

Compartments: N/A

This operation is used to return all the information related to one or more products described in the resource or context on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the product resource(s) itself is returned, along with any other resources that the server has that are related to the products(s), and that are available for the given user. This is typically the marketing authorisations, ingredients, packages, therapeutic indications and so on. The server also returns whatever resources are needed to support the records - e.g. linked organizations, document references etc.

The official URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/MedicinalProductDefinition-everything

Formal Definition (as a OperationDefinition).

URL: [base]/MedicinalProductDefinition/$everything

URL: [base]/MedicinalProductDefinition/[id]/$everything

This is an idempotent operation

In Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

_since

0..1

instant

Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time

_count

0..1

integer

See discussion below on the utility of paging through the results of the $everything operation

Out Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

return

1..1

Bundle

The bundle type is "searchset"

Note: as this is the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource

The key differences between this operation and simply performing a search and using _include and _revinclude are:

unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging)
the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones).

This frees the client from needing to determine what it could or should ask for, particularly with regard to included resources. It also makes for a much shorter and easier to construct query string. Servers should consider returning appropriate Provenance and AuditTrail on the returned resources, even though these are not directly part of the product data.

When this operation is used to access multiple product records at once, the return bundle could be rather a lot of data; servers may choose to require that such requests are made asynchronously, and associated with bulk data formats. Alternatively, clients may choose to page through the result set (or servers may require this). Paging through the results is done the same as for Searching, using the _count parameter, and Bundle links. Implementers should note that paging will be slower than simply returning all the results at once (more network traffic, multiple latency delays) but may be required in order not to exhaust available memory reading or writing the whole response in a single package. Unlike searching, there is no inherent user-display order for the $everything operation. Servers might consider sorting the returned resources in descending order of last record update, but are not required to do so.

The _since parameter is provided to support periodic queries to get additional information that has changed about the product since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.

11.11.9.1.1 Examples

Request: Get all resources linked to a single medicinal product


GET /open/MedicinalProductDefinition/example/$everything
[some headers]

Response: Everything linked to the nominated medicinal product (in this case, built automatically by the publication tooling)


HTTP/1.1 200 OK
[other headers]

<Bundle xml="http://hl7.org/fhir">
  <id value="25ffae98-e416-4b74-97ce-7d1b477bca66"/>
  <type value="searchset"/>
  <entry>
    <fullUrl value="http://hl7.org/fhir/MedicinalProductDefinition/example"/>
    <resource>
     <MedicinalProductDefinition xmlns="http://hl7.org/fhir">
     	<id value="example"/>
     	<identifier>
     		<system value="http://ema.europa.eu/example/MPID"/>
     		<value value="{mpid}"/>
     	</identifier>
     	<productClassification>
     		<coding>
     			<system value="http://ema.europa.eu/example/WHOAnatomicalTherapeuticChemicalATCClassificationSystem"/>
     			<code value="WHOAnatomicalTherapeuticChemicalATCClassificationSystem|B01AF02"/>
     		</coding>
     	</productClassification>
     	<attachedDocument>
     		<reference value="DocumentReference/example"/>
     	</attachedDocument>
     	<masterFile>
     		<reference value="DocumentReference/example"/>
     	</masterFile>
     	<name>
     		<productName value="Equilidem 2.5 mg film-coated tablets"/>
     		<namePart>
     			<part value="Equilidem"/>
     			<type>
     				<coding>
     					<code value="INV"/>
     				</coding>
     			</type>
     		</namePart>
     		<namePart>
     			<part value="2.5 mg"/>
     			<type>
     				<coding>
     					<code value="STR"/>
     				</coding>
     			</type>
     		</namePart>
     		<namePart>
     			<part value="film-coated tablets"/>
     			<type>
     				<coding>
     					<code value="FRM"/>
     				</coding>
     			</type>
     		</namePart>
     		<countryLanguage>
     			<country>
     				<coding>
     					<system value="http://ema.europa.eu/example/countryCode"/>
     					<code value="EU"/>
     				</coding>
     			</country>
     			<jurisdiction>
     				<coding>
     					<system value="http://ema.europa.eu/example/jurisdictionCode"/>
     					<code value="EU"/>
     				</coding>
     			</jurisdiction>
     			<language>
     				<coding>
     					<system value="http://ema.europa.eu/example/languageCode"/>
     					<code value="EN"/>
     				</coding>
     			</language>
     		</countryLanguage>
     	</name>
     	<manufacturingBusinessOperation>
     		<type>
     			<concept>
     				<coding>
     					<system value="http://ema.europa.eu/example/manufacturingOperationType"/>
     					<code value="Batchrelease"/>
     				</coding>
     			</concept>
     		</type>
     		<effectiveDate>
     			<start value="2013-03-15"/>
     		</effectiveDate>
     		<authorization>
     			<identifier>
     				<system value="http://ema.europa.eu/example/manufacturingAuthorisationReferenceNumber"/>
     				<value value="1324TZ"/>
     			</identifier>
     		</authorization>
     	</manufacturingBusinessOperation>
     </MedicinalProductDefinition>
    </resource>
  </entry>
</Bundle>

For more information about operations, including how they are invoked, see Operations.