ITI-18

The ITI-18 (Registry Stored Query) transaction allows a Document Consumer to query a Document Registry, using Registry Stored Queries.

This transaction has been implemented in order to respect the Swiss EPR regulation. However, it is very generic, and CH:PHARM-1 should be favored, as it offers emedication-specific query parameters.

Stored queries

Generic rules

The folders option is not supported as per the Swiss National Extensions to the IHE Technical Framework.
The only association supported is RPLC (replace).
Documents with deletionStatus=deletionRequested are ignored.
Objects belonging to a patient other than the patient of the provided XUA token are ignored, as per the Swiss National Extensions to the IHE Technical Framework.
All the queries support the XDS Metadata Update supplement.

Common query parameters

$MetadataLevel: If present, the attribute shall be equal to 1, as per the Swiss National Extensions to the IHE Technical Framework.

FindDocuments

This stored query allows to search for APPC and CH EMED EPR documents. CH EMED EPR documents could also be searched through the PHARM-1 transaction (it’s a specialized ITI-18 transaction). The parameters are matched against the corresponding XDSDocumentEntry metadata attributes of the documents in the registry.

All the parameters defined in the IHE profile are supported:

Parameter Name	Required	Remarks
`$XDSDocumentEntryPatientId`	yes	The patient’s PMP-PID
`$XDSDocumentEntryClassCode`	no	See the Annex 3 of the EPR Act, section 2.5, for possible values
`$XDSDocumentEntryTypeCode`	no	See the Annex 3 of the EPR Act, section 2.6, for possible values
`$XDSDocumentEntryPracticeSettingCode`	no	See the Annex 3 of the EPR Act, section 2.4, for possible values
`$XDSDocumentEntryCreationTimeFrom`	no	see dates processing
`$XDSDocumentEntryCreationTimeTo`	no	see dates processing
`$XDSDocumentEntryServiceStartTimeFrom`	no	Ignored for APPC documents. see dates processing
`$XDSDocumentEntryServiceStartTimeTo`	no	Ignored for APPC documents. see dates processing
`$XDSDocumentEntryServiceStopTimeFrom`	no	Ignored for APPC documents. see dates processing
`$XDSDocumentEntryServiceStopTimeTo`	no	Ignored for APPC documents. see dates processing
`$XDSDocumentEntryHealthcareFacilityTypeCode`	no	See the Annex 3 of the EPR Act, section 2.3, for possible values
`$XDSDocumentEntryEventCodeList`	no	See the Annex 3 of the EPR Act, section 2.8, for possible values
`$XDSDocumentEntryConfidentialityCode`	no	All documents in the eMedication service are set to `Normal`. See the Annex 3 of the EPR Act, section 2.8
`$XDSDocumentEntryAuthorPerson`	no	-
`$XDSDocumentEntryFormatCode`	no	See the ITI-41 section in this guide
`$XDSDocumentEntryStatus`	yes	-
`$XDSDocumentEntryType`	no	If empty, `Stable` will be assumed
`$XDSDocumentEntryDocumentAvailability`	no	All documents in the eMedication service are set to `Online`

FindSubmissionSets

This stored query allows to search for submission sets in the eMedication service registry. Query parameters are matched against the corresponding submission set metadata attributes in the registry. All the parameters defined in the IHE profile are supported.

Parameter Name	Required	Remarks
`$XDSSubmissionSetPatientId`	yes	The patient’s PMP-PID
`$XDSSubmissionSetSourceId`	no	-
`$XDSSubmissionSetSubmissionTimeFrom`	no	see dates processing
`$XDSSubmissionSetSubmissionTimeTo`	no	see dates processing
`$XDSSubmissionSetAuthorPerson`	no	-
`$XDSSubmissionSetContentType`	no	All submission sets in the eMedication service are of `Procedure` content type. See the Annex 3 of the EPR Act, section 2.15
`$XDSSubmissionSetStatus`	yes	All submission sets in the eMedication service are `Approved`

FindFolders

This query is not supported by the eMedication service.

GetAll

This stored query allows search for all registry content for a given patient and returns:

XDSSubmissionSet and XDSDocumentEntry objects matching the query parameters.
Association objects with sourceObject or targetObject attribute matching one of the above objects.

All the parameters defined in the IHE profile are supported.

Parameter Name	Required	Remarks
`$patientId`	yes	The patient’s PMP-PID
`$XDSDocumentEntryStatus`	yes	-
`$XDSSubmissionSetStatus`	yes	All submission sets in the eMedication service are `Approved`
`$XDSFolderStatus`	yes	Ignored by the eMedication service
`$XDSDocumentEntryFormatCode`	no	See the ITI-41 section in this guide
`$XDSDocumentEntryConfidentialityCode`	no	All documents in the eMedication service are set to `Normal`. See the Annex 3 of the EPR Act, section 2.8
`$XDSDocumentEntryType`	no	If empty, `Stable` will be assumed
`$XDSAssociationStatus`	no	Associations in the eMedication service can only be `Approved`. If empty, `Approved` will be assumed

GetDocuments

This stored query allows to fetch a collection of XDSDocumentEntry objects. All the IHE profile parameters are supported.

Parameter Name	Required	Remarks
`$XDSDocumentEntryEntryUUID`	no^*	-
`$XDSDocumentEntryUniqueId`	no^*	-
`$XDSDocumentEntryLogicalID`	no^*	-
`$homeCommunityId`	no	-

^* Either $XDSDocumentEntryEntryUUID, $XDSDocumentEntryUniqueId or $XDSDocumentEntryLogicalID shall be specified. This transaction shall return an XDSStoredQueryParamNumber error (see error codes) if more than one of these parameters are specified.

GetFolders

The response is empty, as folders are not implemented. A warning is added to the response.

GetAssociations

This stored query allows to fetch Association objects whose sourceObject or targetObject match the $uuid parameter. All the IHE profile parameters are supported.

Parameter Name	Required	Remarks
`$uuid`	yes	-
`$homeCommunityId`	no	-
`$XDSAssociationStatus`	no	Associations in the eMedication service can only be `Approved`. If empty, `Approved` will be assumed

GetDocumentsAndAssociations

This stored query allows to retrieve a collection of XDSDocumentEntry objects and the Association objects related to them (i.e. the Association sourceObject or targetObject must be one of the fetched XDSDocumentEntry objects), that is, a combination of the GetDocuments and GetAssociations queries. All the IHE profile parameters are supported.

Parameter Name	Required	Remarks
`$XDSDocumentEntryEntryUUID`	no^*	-
`$XDSDocumentEntryUniqueId`	no^*	-
`$homeCommunityId`	no	-
`$XDSAssociationStatus`	no	Associations in the eMedication service can only be `Approved`. If empty, `Approved` will be assumed

^* Either $XDSDocumentEntryEntryUUID or $XDSDocumentEntryUniqueId shall be specified. This transaction shall return an XDSStoredQueryParamNumber error (see error codes) if more than one of these parameters are specified.

GetSubmissionSets

This stored query allows to retrieve a collection of XDSSubmissionSet objects from the registry used to submit the specified document entries as parameters. All the IHE profile parameters are supported.

Parameter Name	Required	Remarks
`$uuid`	yes	matched against `XDSDocumentEntry.entryUUID`
`$homeCommunityId`	no	-

GetSubmissionSetAndContents

This stored query allows to fetch specific SubmissionSet objects and their associated objects, returning: - All SubmissionSet objects matching the query’s criteria. - DocumentEntry objects linked to the matching SubmissionSet objects by HasMember associations, as long as they also meet all other present criteria in the query. - Said HasMember Association objects.

All the IHE profile parameters are supported.

Parameter Name	Required	Remarks
`$XDSSubmissionSetEntryUUID`	no^*	-
`$XDSSubmissionSetUniqueId`	no^*	-
`$XDSDocumentEntryFormatCode`	no	See the ITI-41 section in this guide
`$XDSDocumentEntryConfidentialityCode`	no	All documents in the eMedication service are set to `Normal`. See the Annex 3 of the EPR Act, section 2.8
`$homeCommunityId`	no	-
`$XDSDocumentEntryType`	no	If empty, `Stable` will be assumed

Either $XDSSubmissionSetEntryUUID or $XDSSubmissionSetUniqueId shall be specified. This transaction shall return an XDSStoredQueryParamNumber error (see error codes) if both parameters are specified.

GetFolderAndContents

The response is empty, as folders are not supported. A warning is added to the response.

GetFoldersForDocument

The response is empty, as folders are not supported. A warning is added to the response.

GetRelatedDocuments

This stored query allows to fetch XDSDocumentEntry objects that are related to the specified document via Association objects satisfying all the following conditions:

The sourceObject attribute or the targetObject attribute references the specified document.
The sourceObject and the targetObject attributes reference documents.
The associationType attribute matches a value included in the $AssociationTypes parameter. See Association Types.

Matching associations are also included in the result set, along with the XDSDocumentEntry objects referenced by the sourceObject or targetObject attributes of the matching associations.

Note, therefore, that if a DocumentEntry is not part of an association between two documents, it will not be returned by the query.

All the IHE profile parameters are supported.

Parameter Name	Required	Remarks
`$XDSDocumentEntryEntryUUID`	no^*	-
`$XDSDocumentEntryUniqueId`	no^*	-
`$AssociationTypes`	yes	Only `RPLC` and `HasMember` are supported by the eMedication service
`$homeCommunityId`	no	-
`$XDSDocumentEntryType`	no	If empty, `Stable` will be assumed
`$XDSAssociationStatus`	no	Associations in the eMedication service can only be `Approved`. If empty, `Approved` will be assumed

^* Either $XDSDocumentEntryEntryUUID or $XDSDocumentEntryUniqueId shall be specified. This transaction shall return an XDSStoredQueryParamNumber error (see error codes) if more than one of these parameters are specified.

FindDocumentsByReferenceId

The response is empty, since the Reference ID option is not supported. A warning is added to the response.

Error codes

Specific codes not covered by generic codes.

XDS error code	Details
`XDSStoredQueryMissingParam`	If a required search parameter is missing
`XDSStoredQueryParamNumber`	If too many/too much search parameters are provided
`XDSUnknownStoredQuery`	If the search query is unknown
`XDSRegistryError`	If the search query is known but unsupported
`XDSRegistryMetadataError`	If `$MetadataLevel` is not “1”

This page was updated 2024-11-04