PhPID related resources

Resource examples

Substance Definitions

Substances are modeled as 'Substance Definition' resources in the GSRS system and referenced both in the request Task and in the resulting PhPID

GET
Omeprazole

GET
Simvastatin

GET
Methotrexat

GET
Methotrexat sodium (salt to Methotrexat)

Administrable Product Definitions

GET
AdministrableProductDefinition resource (PhPID)

Medicinal Product Definitions

GET
Methotrexaat sandoz (Netherlands)

Searching

Searching for an AdministrableProductDefinition

Search by substance (Methotrexat):

GET
Try it out

Here we use the search parameter _has:Ingredient:for:substance-code=GSID23G92UMX93H45.

Search by parent PhPID (i.e. searching all PhPIDs that has a specific level1, 2, or 3 PhPID as parent):

GET
AdministrableProductDefinition?parent-php=8195D4AF1287CCE3442C2F308F61DBBC

or we can explicitly specify the system

GET
AdministrableProductDefinition?parent-php:identifier=http://who-umc.org/idmp/phpid|8195D4AF1287CCE3442C2F308F61DBBC

Search by MedicinalProductId

GET
AdministrableProductDefinition?form-of.identifier=4C34BE81784

Here we use the search parameter 'form-of.identifier=[MPID]'

The identifier can also be specified as 'form-of.identifier=[System|MPID]'

Searching for substances

Search by id:

GET
SubstanceDefinition?_id=GSID3TYT75JEH6X6G

Search by name:

GET
SubstanceDefinition?name=Simvastatin

Search by code:

GET
SubstanceDefinition?code=AGG2FN16EV

Searching for a MedicinalProductDefinition

To search for a MedicinalProductDefinition representing an MPID we need to search that resource, specifying what AdministrableProductDefinition it is connected to via the formOf attribute according to the following example:

fhir/MedicinalProductDefinition?_has:AdministrableProductDefinition:form-of:identifier=[PhPId]

GET
MedicinalProductDefinition?_has:AdminstrableProductDefinition:form-of:identifier=91B3CA582581F57E4092F13AAF476215

When searching for a MedicinalProductDefinition using an Id or Identifier we simply use the format _id=[productId] or identifier=[MPID].

In the current implementation Id and Identifier is often (but not always) the same but Id should be the Id of the resource in the UMC system (WHODrug Product Id) while the Identifier should be the national IDMP MPID.

The following two examples actually retrieve the same resource.

Search by id:

GET
MedicinalProductDefinition?_id=711980A5521

Search by identifier:

GET
MedicinalProductDefinition?identifier=http://hl7.org/fhir/sid/ndc|51672-4005

Xml or json?

Any resource can be returned either as xml or json. This is defined using an accept header or by a query string parameter as follows:

GET
Omeprazole on json format (default)

GET
Omeprazole on xml format

Resource definitions (from HL7)

The PhPID resource (AdministrableProductDefinition).

GET
Administrable Product Definition

The Medicinal Product resource used to validate the request (MedicinalProductDefinition).

GET
Medicinal Product Definition

The Substance resource (SubstanceDefinition)

GET
Substance definition

The Organization resource

GET
Organization definition

The Task resource (used for PhPID and GSID requests)

GET
Task definition