Skip to content

CH:PHARM-1: Query Pharmacy Documents

CH:PHARM-1 (Query Pharmacy Documents) is an extension of PHARM-1, a transaction defined by IHE Pharmacy in the CMPD profile, Β§3.1.

The eMedication service doesn’t support CMA documents and these won’t be present in any response.

Stored queries

CH:PHARM-1 defines three new stored queries, FindMedicationCard, FindConsolidatedPrescriptionsForValidation and FindConsolidatedPrescriptionsForDispense.

Common query parameters

  • $MetadataLevel: if present, the attribute shall equal to 1, as per Nationale Anpassungen der Integrationsprofile nach Artikel 5 Absatz 1 Buchstabe b EPDV-EDI.
  • $XDSDocumentEntryPatientId: the patient XAD-PID (MPI-PID), meaning CARA’s assigned identifier.
  • $XDSDocumentEntryPracticeSettingCode: only codes from the Swiss value set.
  • $XDSDocumentEntryService(Start|Stop)Time(From|To): see the definition of XDSDocumentEntry.service(Start|Stop)Time
  • $XDSDocumentEntryHealthcareFacilityTypeCode: only codes from the Swiss value set.
  • $XDSDocumentEntryEventCodeList: only codes from the Swiss value set.
  • $XDSDocumentEntryConfidentialityCode: only Normal supported by the service.

FindMedicationTreatmentPlans

Implemented, as per IHE specs.

FindPrescriptions

Implemented, as per IHE specs.

FindDispenses

Implemented, as per IHE specs.

FindMedicationAdministrations

🚫 Not implemented, CMA documents are not supported.

FindPrescriptionsForValidation

It returns prescriptions that are temporary or … See the prescription statuses in the CH-EMED-EPR profile.

FindPrescriptionsForDispense

Return only prescriptions that are actually provisional or active (i.e. dispensable).

FindMedicationList

Only documents that are linked to an MTP are considered in this query.

Entry selection (via the search query execution) is done at document retrieval time, not search time.

FindMedicationCard (πŸ‡¨πŸ‡­)

This transaction is a Swiss extension and is copied from the FindMedicationList stored query.

Stored query ID: urn:uuid:a8fc04c1-5fb0-45a9-bc59-7a59958beb38

Treatment selection (via the search query execution) is done at document retrieval time, not search time.

Query parameters

Parameter Name Attribute Opt Mult
$XDSDocumentEntryPatientId XDSDocumentEntry.patientId R
$XDSDocumentEntryStatus XDSDocumentEntry.objectType R M
$XDSDocumentEntryFormatCode XDSDocumentEntry.formatCode O
$XDSDocumentEntryLanguageCode XDSDocumentEntry.languageCode O
$XDSDocumentEntryServiceStartFrom N/A O
$XDSDocumentEntryServiceStartTo N/A O
$XDSDocumentEntryServiceEndFrom N/A O
$XDSDocumentEntryServiceEndTo N/A O
$XDSDocumentEntryType N/A O M
  • $XDSDocumentEntryStatus: This parameter is not used.
  • $XDSDocumentEntryFormatCode: this parameter is used to determine what will be the type of the generated medication card:

    Supported format code Processing
    urn:che:epr:ch-emed:medication-card:2022 By default. The medication card is a CH-EMED-EPR document.
    urn:che:epr:EPR_Unstructured_Document The medication card is a PDF document.
  • $XDSDocumentEntryLanguageCode: the language that will be used to generate the medication card. If not specified, the eMedication service uses the default language (french).

    Supported language code
    Français (default) fr-CH
    Deutsch de-CH
    Italiano it-CH
    English en

    Warning

    The service currently only supports french.

  • $XDSDocumentEntryServiceStartFrom, $XDSDocumentEntryServiceStartTo: This parameter is not used.

  • $XDSDocumentEntryServiceEndFrom, $XDSDocumentEntryServiceEndTo: This parameter is not used.
  • $XDSDocumentEntryType: stable and/or on-demand. Stable documents are PML documents that have been generated and saved, on-demand are documents that can be generated. There’s no stable PML in the eMedication service (the response is empty for requests that only specify stable types). If absent, all types are returned. A single on-demand document is returned.

Draft: FindConsolidatedPrescriptionsForValidation (πŸ‡¨πŸ‡­)

This transaction is a Swiss extension and is copied from the FindPrescriptionsForValidation stored query.

Stored query ID: urn:uuid:b4f7e093-d2f1-4278-918e-ada92b55d39e

Query parameters

Parameter Name Attribute Opt Mult
$XDSDocumentEntryPatientId XDSDocumentEntry.patientId R
$XDSDocumentEntryEntryUUID XDSDocumentEntry.entryUUID O M
$XDSDocumentEntryUniqueId XDSDocumentEntry.uniqueId O M
$XDSDocumentEntryPracticeSettingCode XDSDocumentEntry. practiceSettingCode O M
$XDSDocumentEntryCreationTimeFrom XDSDocumentEntry.creationTime O
$XDSDocumentEntryCreationTimeTo XDSDocumentEntry.creationTime O
$XDSDocumentEntryServiceStartTimeFrom N/A O
$XDSDocumentEntryServiceStartTimeTo N/A O
$XDSDocumentEntryServiceStopTimeFrom N/A O
$XDSDocumentEntryServiceStopTimeTo N/A O
$XDSDocumentEntryHealthcareFacilityTypeCode O M
$XDSDocumentEntryEventCodeList O M
$XDSDocumentEntryConfidentialityCode Keep? O M
$XDSDocumentEntryAuthorPerson Keep? O M
$XDSDocumentEntryStatus No reason to keep it O M

Draft: FindConsolidatedPrescriptionsForDispense (πŸ‡¨πŸ‡­)

This transaction is a Swiss extension and is copied from the FindPrescriptionsForDispense stored query.

Stored query ID: urn:uuid:c9d8c2d3-69b9-4b5c-9bf8-d40fa7d8bf11

Query parameters


This page was updated 2023-10-04