ITI-41
The ITI-41 (Provide and Register Document Set-b) transaction allows a content sender to send documents to the eMedication service (content receiver).
Generic DocumentEntry metadata are described in the documents section. This page references additional constraints specific to ITI-41.
See also IHE’s documentation for metadata in Document Sharing profiles as well as EPD by example’s Provide and Register Document Set page.
Publishing documents
Document types
Two types of documents might be published to the service:
- CH-EMED-EPR documents (MTP, PRE, DIS and PADV only, PML and PMLC can only be retrieved from the service and not published to it). These documents contain the eMedication data. See also the corresponding page in this guide.
- APPC (Advanced Patient Privacy Consent) documents. These documents are used to let patients define access rights to their data (who can publish and retrieve their data). See also the corresponding page in this guide.
SubmissionSet and relations
The eMedication service does not support folders and can only receive ONE document at a time. Hence, the metadata must always contain a SubmissionSet with a single DocumentEntry.
Only the following associations are supported:
Association Type | Usage |
---|---|
urn:oasis:names:tc:ebxml-regrep:AssociationType:HasMember | To link a DocumentEntry to the SubmissionSet. |
urn:ihe:iti:2007:AssociationType:RPLC | To replace a previously published document. Replaced document becomes deprecated. |
Uniqueness
Documents can be sent to the eMedication service only once. Uniqueness is checked against DocumentEntry’s unique Id, that must be an UUID and DocumentEntry’s entryUUID.
Metadata
This section describes the rules applicable for any document’s type metadata.
SubmissionSet metadata
See also the IHE SubmissionSet Metadata Attributes diagram or the IHE SubmissionSet Attributes section.
Metadata | Opt | Rules |
---|---|---|
uniqueId | R | Must be an OID. Can be used only once and must be globally unique. |
author | R | Multiple values accepted. |
author.authorRole | R | Possible values are defined in ch-epr-term IG. For APPC, only PAT (patient) and REP (Representative) are allowed. |
author.authorSpecialty | O | Possible values are defined in ch-epr-term IG. |
availabilityStatus | O | The value set in the metadata is always ignored, and replaced by approved . |
comments | O | - |
contentTypeCode | R | Possible values are defined in ch-epr-term IG. Use application/fhir+json or application/fhir+xml for CH-EMED-EPR documents, and text/xml for APPC. |
entryUUID | R | Must be globally unique. |
homeCommunityId | O | Not used. Can be left blank or omitted. |
intendedRecipient | O | Not used. Can be left blank or omitted. |
limitedMetadata | O | Must be left bank or omitted. |
patientId | R | Must be a XAD-PID. |
sourceId | R | Globally unique and immutable OID identifier of the source. |
submissionTime | R | HL7 DTM value in UTC. |
title | O | - |
DocumentEntry metadata
See also the DocumentEntry Metadata Attributes diagram.
Metadata | Opt | Rules |
---|---|---|
author.authorRole | R | Possible values are defined in ch-epr-term IG. For APPC, only PAT (patient) and REP (Representative) are allowed. Must be aligned with document content author (see below). |
author.authorSpecialty | O | Possible values are defined in ch-epr-term IG. Must be aligned with document content author (see below). |
availabilityStatus | O | The value set in the metadata is always ignored, and replaced by approved . |
classCode | R | See CH-EMED-EPR and APPC sections below. |
comments | O | - |
confidentialityCode | R | Confidentiality level in the DocumentEntry metadata is forced to Normal . |
creationTime | R | HL7 DTM value in UTC. Must match document content creation time (see below). |
deletionStatus | O | If present, deletionStatus must be urn:e-health-suisse:2019:deletionStatus:deletionNotRequested . |
documentAvailability | O | If present should be Online . |
entryUUID | R | Must be globally unique. |
eventCodeList | O | See the list of available codes. |
formatCode | R | See CH-EMED-EPR and APPC sections below. |
hash | O | Hash of the document content. |
healthcareFacilityTypeCode | R | See the list of available codes. |
homeCommunityId | O | - |
languageCode | R | See the list of available codes. |
legalAuthenticator | O | - |
limitedMetadata | O | Must be left bank or omitted. |
logicalId | O | Shall be present when replacing a document. |
mimeType | O | Possible values are defined ch-epr-term IG. Use application/fhir+json or application/fhir+xml for CH-EMED-EPR documents, and text/xml for APPC. |
objectType | R | Value is ignored and set to Stable . |
patientId | R | Must match SubmissionSet.patientId and be a XAD-PID (see above). |
practiceSettingCode | R | See the list of available codes. |
referenceIdList | O | Must be omitted or empty as referencing external documents is not permitted (see Referencing external documents section). |
repositoryUniqueId | O | If the attribute repositoryUniqueId is present and does not correspond to the repositoryUniqueId the relevant document repository OID, the request is rejected. |
serviceStartTime | O | Given as an HL7 DTM in UTC. Shall be empty for APPC |
serviceStopTime | O | Given as an HL7 DTM in UTC. Shall be empty for APPC |
size | O | - |
sourcePatientId | R | Any id known or unknown to the local MPI. EPR-SPID and SSN are forbidden. |
sourcePatientInfo | O | Ignored by the service. |
title | R | - |
typeCode | R | See section below. |
uniqueId | R | Must be globally unique and be a UUID. Must match the document id in the case of CH-EMED-EPR documents. |
URI | O | - |
version | O | If present shall be empty, the value is ignored and set by the document registry. |
Publishing a CH-EMED-EPR document
This section details the specific rules to follow when publishing CH-EMED-EPR documents.
Only MTP, PRE, DIS and PADV docs can be published. PML and PMLC can only be retrieved from the service.
Referencing external documents
When publishing CH-EMED-EPR documents, all references (from the key elements) shall be known to the eMedication service. All non-key elements are ignored by the eMedication service.
This implies that the metadata cannot contain Reference ids. This option is not supported, and submission of a reference to an existing document is forbidden.
Creation times
Creation time of a document must be equal or greater than the creation time of the last document of the treatment chain, ie. the last published document targeting the treatment (either the original MTP if no other document, or the last document published referencing this treatment).
- Creation time of the document has to be in the past.
- All references to other documents or items have to refer to existing approved non deleted documents.
Rules for each type of document
MTP
- The medication referenced in the MTP (
CHEMEDEPRMedicationStatement
) should follow some rules. These are detailed in the implementation guide’s treatment guidance page.
PRE
- Each PRE item should refer to an MTP item (
CHEMEDEPRMedicationRequest.treatmentplan
) that must:- Exist (has already been published, and never deleted)
- Be approved, ie.
DocumentEntry.availabilityStatus = approved
, - Preferably be valid, i.e. the submission date should be within the MTP
dosage
’sboundsPeriod
(CHEMEDEPRDosage.repeat.bounds
).- If the
boundsPeriod
is not defined, the entry is considered to be always active. - If only a
startDate
is specified, the MTP is considered to be active if the current date is after that date.
- If the
- Active, ie.
CHEMEDEPRDocumentMedicationTreatmentPlan.CHEMEDEPRMedicationStatement.status = active
- For the same patient.
- Code of medication should match the code of medication of the MTP referenced by the PRE (
CHEMEDEPRMedicationRequest.treatmentplan
). This rule is not enforced and might be extended in the future. - If lot number (
CHEMEDEPRMedication.batch
) is specified in referenced MTP, the one in the PRE (CHEMEDEPRMedicationRequest.medication[x]:medicationReference.batch
) should match it. This rule is not enforced and might be extended in the future.
PADV
PADV against a provisional PRE
A “provisional PRE” is a prescription for which the CHEMEDEPRMedicationRequest.status
is SUBMITTED
or PROVISIONAL
and for which a PADV
OK
has not been completed yet.
- Medication cannot be changed. This rule is not enforced and might be extended in the future.
- Dosage instructions cannot be changed. This rule is not enforced and might be extended in the future.
- Substitution cannot be disallowed if the existing dispense includes one. This rule is not enforced and might be extended in the future.
- Observation code
REFUSE
cannot be issued.
PADV CANCEL
- Sets status to
CANCELED
. - Not allowed against
DIS
or otherPADV
documents.
Against MTP
- Also set related prescriptions’ status to
CANCELED
if their status was not alreadyREFUSED
orCANCELED
. - Treatment plan status must be
ACTIVE
orSUSPENDED
.
Against PRE
- Not allowed for prescriptions whose status is already
CANCELED
orREFUSED
. - Not allowed to target anything else than
MTP
orPRE
PADV OK
- Sets targeted
MTP
orPRE
status toACTIVE
. - Against
MTP
: only allowed for treatment plans with statusACTIVE
orSUSPENDED
. - Against
PRE
: only allowed for prescriptions with statusSUBMITTED
orPROVISIONAL
. PADV OK
cannot target anything else thanMTP
orPRE
.
PADV CHANGE
- Changes the treatment plan or prescription.
- Can only target
MTP
orPRE
.
Against MTP
- The treatment status must be
ACTIVE
orSUSPENDED
. - The treatment must not have been prescribed.
- Additionally, the treatment’s status is set to
ACTIVE
as a result of the aggregation.
Against PRE
- The prescription’s status must not be
CANCELED
orREFUSED
. - If the prescription’s status is
SUBMITTED
, the aggregation sets it toACTIVE
as a result.
PADV REFUSE
- Sets status to
REFUSED
.
Against MTP
- Sets also related prescriptions’ status to
REFUSED
if the status was not alreadyREFUSED
orCANCELED
. - Treatment’s status must be
ACTIVE
orSUSPENDED
.
Against PRE
- The prescription’s status must not be
REFUSED
,CANCELED
orPROVISIONAL
. - Cannot target anything else than
MTP
orPRE
.
PADV SUSPEND
- Sets status to
SUSPENDED
- Only allowed to target
MTP
entries - The treatment status must be
ACTIVE
PADV COMMENT:
- Can target
MTP
,PRE
andDIS
entries only.
DIS
- If lot number (
batch
) is specified in referenced MTP(treatmentPlan
) or PRE (prescription
), then it should match the one in the DIS if substitution is not allowed. This rule is not enforced and might be extended in the future.
DIS against MTP or PRE + MTP:
- Medication should not be different if substitution is not allowed by PRE. This rule might be extended in the future.
- Dispense should not occur after the end of validity of the PRE document. This rule might be extended in the future.
- Dispense should not occur after the end of the treatment if specified in the prescription item. This rule might be extended in the future.
- If referenced PRE is not provisional, it should be
dispensable
(that is have status eitherPROVISIONAL
orACTIVE
). This rule is not enforced and might be extended in the future. - List of active ingredients should be the same than the one in the referenced PRE (
prescription
). This rule is not enforced and might be extended in the future. - If the treatment has been prescribed (at least one PRE document has been successfully submitted for it), then any DIS document targeting this treatment must reference one of its prescriptions as well.
Roles
- Patients and their representatives are allowed to publish only the following type of docs:
- MTP
- PADV with a
COMMENT
observation code with no restriction. - PADV with any other observation code only when referencing a document published by the same patient or a representative of the same patient.
- Healthcare professionals are allowed to publish only the following types of docs:
- MTP
- PRE
- DIS
- PADV
Metadata values check
Some values from the DocumentEntry are checked against the document (values in metadata and document must be equal):
DocumentEntry | CH-EMED-EPR |
---|---|
author | Composition.author |
classCode | Composition.type . Must be consistent with the document type (see below) |
creationTime | Composition.date |
formatCode | Must be consistent with the document type (see below) |
languageCode | Composition.language |
mimeType | application/fhir+xml or application/fhir+json |
typeCode | Must be consistent with the document type (see below) |
uniqueId | Bundle.identifier.value and Composition.identifier.value |
Metadata codes per document type
Document type | DocumentEntry.classCode | DocumentEntry.formatCode | DocumentEntry.typeCode |
---|---|---|---|
MTP | 440545006 Prescription record | urn:che:epr:ch-emed:mtp:2022 | 761931002 Medication treatment plan report (record artifact) |
PRE | 440545006 Prescription record | urn:che:epr:ch-emed:pre:2022 | 761938008 Medicinal Prescription record (record artifact) |
DIS | 440545006 Prescription record | urn:che:epr:ch-emed:dis:2022 | 294121000195110 Medication dispense document (record artifact) |
PADV | 440545006 Prescription record | urn:che:epr:ch-emed:padv:2022 | 419891008 Record artifact |
PML | 422735006 Summary clinical document | urn:che:epr:ch-emed:pml:2022 | 721912009 Medication summary document |
PMLC | 422735006 Summary clinical document | urn:che:epr:ch-emed:medication-card:2022 | 736378000 Medication management plan (record artifact) |
The class and type codes are from the SNOMED CT system: 2.16.840.1.113883.6.96
. The system for the formatCode
is 2.16.756.5.30.1.127.3.10.10
Replacing a CH-EMED-EPR document
The following rules must be observed when replacing a document:
- Patients and their representatives can only replace a document published by the same patient.
- representatives are not supported by the service yet.
- Healthcare professionals (HCP) can only replace a document published by himself or by another HCP of same community of affiliation.
- Current implementation: an HCP can replace a document published by any other HCP. Further rules and possible implementations are under discussion.
- Document administrator may only replace a document published by an HCP of the same community of affiliation.
- Not implemented in PMP, to be discussed, for now a document admin can replace any document.
- Replacing and replaced documents have to be of the same type (e.g. both MTP documents).
- Replacing and replaced documents have to refer to the same patient.
- Only documents at the end of a treatment chain can be replaced.
- Replaced document must exist in the repository.
- A replacement document must can be linked only to elements of the same medication chain. In case a PRE document is replaced, it may be linked only to elements of the medication chain of the referenced MTP.
- Document administrator can replace any document regardless of who published it.
- Replaced document must be approved (although this is always the case after an initial ITI-41 transaction, documents might become
deprecated
after another ITI-41 transaction with a replacement association). - Replaced document must not have
deletionStatus = deletionRequested
(this is relevant since although it is not the case at the moment with the current implementation, there might be files in the repository flagged for deletion but not deleted yet).
Publishing a PMP-APPC document
This section details the rules applicable to metadata when publishing APPC documents.
Rules for APPC
- Only Patients and their representatives or policy administrators can publish a new APPC document.
- representatives are not supported by the service yet.
- Only Patients and their representatives can replace their own APPC documents (if it exists).
- representatives are not supported by the service yet.
- Policy administrators of the reference community of the patient can replace any existing APPC document.
- No APPC for the specified patient exists in the system (unless the published document is a replacement), otherwise the document is refused.
- As for CH-EMED-EPR, APPC documents to be replaced must:
- Be approved (as before, this is always the case for documents in the PMP repository when they are published, but their status might change to deprecated after a replacement).
- Not have
deletionStatus = deletionRequested
.
- APPC document structure is described in Implementation Guide for eMedication architecture in the context of the EPR, section ยง7.5
1 Description
section for free text description of the policy set1 Target
section containing:1 Resources
section containing1 Resource
object pointing to the patient by indicating theEPR-SPID
.* Subjects
sections each one containing themselvesSubject
entries each defining 1 “who”. Subject cannot be the patient.* Environments
sections each one containing oneEnvironment
object limiting the validity period of the policy.- Required if at least one
Subject
refers to an organization or group.- Specs state “This section will not be used within this context.”
- Required if at least one
- A list of
PolicyIdReference
orPolicySetIdReference
defining the level of access granted to the users identified by the Subjects section.- See 7.5 for the list of policies that can be used.
*
embeddedPolicySet
sections containing:1..* Subjects
sections containing themselvesSubject entries
and each defines one “who”.* Environments
(same as above)
APPC metadata
DocumentEntry | APPC |
---|---|
classCode | 371537001 Consent report (record artifact) |
formatCode | urn:ihe:iti:appc:2016:consent |
mimeType | text/xml |
serviceStartTime | None |
serviceStopTime | None |
typeCode | 419891008 Record artifact |