Skip to content

Commit

Permalink
Work
Browse files Browse the repository at this point in the history
  • Loading branch information
@qligier
qligier committed Nov 2, 2022
1 parent 737784e commit 781ac83
Show file tree
Hide file tree
Showing 6 changed files with 117 additions and 105 deletions.
92 changes: 0 additions & 92 deletions docs/cdachemed/mtp.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,52 +6,13 @@

## Item entry

It's an `#!xml <hl7:substanceAdministration>`.

### Dosage instructions

See the [dedicated page](dosage.md).

### Product and package

See the [dedicated page](product.md).

### Authors

They're forbidden in a MTP document and SHALL be provided in PML and PMLC documents.
The first author contains the first document author of the original MTP document that contained this MTP entry.
The second author contains the section author of the original MTP section that contained this MTP entry, but only if the later is different than the former.
Their use is described in [PML](pml.md) and [PMLC](pmlc.md) pages.

### Reference to the Treatment Reason Entry Content Module

Not used, see below for the treatment reason as free text.

### Treatment reason

Swiss extension.
The treatment reason as a free text.
Authors SHOULD keep it as simple and short as possible (e.g. "blood clog", "hypertension").

```xml title="Example usage of the treatment reason"
<entryRelationship typeCode="RSON">
<observation classCode="OBS" moodCode="EVN">
<templateId root="2.16.756.5.30.1.1.10.4.41"/>
<code code="75326-9" codeSystem="2.16.840.1.113883.6.1" displayName="Problem" codeSystemName="LOINC"/>
<text>
Pain <!--(1)-->
<reference value="#ref"/>
</text>
<statusCode code="completed"/>
</observation>
</entryRelationship>
```

1. Change this text as needed.

### Reference to the original Medication Treatment Plan Item

Forbidden in a MTP or PML document, mandatory in a PMLC document.

### Patient medication instructions

Expand Down Expand Up @@ -80,63 +41,10 @@ It SHALL not contain human readable dosage instructions (see the [dosage page](d
The instructions are comments from the author to the prescriber and/or dispenser.
It SHALL not be provided by a patient or representative.

```xml title="Example usage of the fulfillment instructions"
<entryRelationship typeCode="SUBJ" inversionInd="true">
<act classCode="ACT" moodCode="INT">
<templateId root="1.3.6.1.4.1.19376.1.5.3.1.4.3.1" />
<templateId root="2.16.840.1.113883.10.20.1.43" />
<code code="FINSTRUCT" codeSystem="1.3.6.1.4.1.19376.1.5.3.2" codeSystemName="IHEActCode" />
<text>
Please cut some tablets in half for the patient. Patient weights 67 kg. <!--(1)-->
<reference value="#ref" />
</text>
<statusCode code="completed"/>
</act>
</entryRelationship>
```

1. Change this text as needed.

### Amount of units of the consumable to dispense

Not supported currently.

### Substitution permission

<span class="should-support">Should support</span>.
Whether the dispenser can substitute the prescribed medicine/package by another that is deemed equivalent, for medical or logistical reasons.
By default, substitution is authorized.
It SHALL not appear more than once.

!!! warning "CARA: additional requirement"

The eMedication services restricts the substitution permissions to the following two values:

| Permission | Description |
| ---------- | ----------- |
| `E` | Equivalent, subsitution is authorized |
| `NONE` | None, substitution is disallowed |

```xml title="Example usage of the substitution permission"
<entryRelationship typeCode="COMP">
<act classCode="ACT" moodCode="DEF">
<templateId root="1.3.6.1.4.1.19376.1.9.1.3.9.1" />
<code code="E" codeSystem="2.16.840.1.113883.5.1070" codeSystemName="Substance Admin Substitution" displayName="equivalent" /> <!--(1)-->
<statusCode code="completed" />
</act>
</entryRelationship>
```

1. Change this code as needed.

### ID of parent container

Forbidden in a MTP or PMLC document, mandatory in a PML document. It contains the ID of the document that originally introduced this MTP entry.

### Precondition Criterion

Not used.

### Annotation comment

Use case not clear yet.
Expand Down
45 changes: 40 additions & 5 deletions docs/transactions/chpharm1.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# CH:PHARM-1
# CH:PHARM-1: Query Pharmacy Documents

The PMP doesn't support CMA documents and these should not be expected in any response.
CH:PHARM-1 (Query Pharmacy Documents) is an extension of PHARM-1, a transaction defined by IHE Pharmacy in [the CMPD profile](https://www.ihe.net/uploadedFiles/Documents/Pharmacy/IHE_Pharmacy_Suppl_CMPD.pdf), §3.1.
It only adds a new stored query, _FindMedicationCard_.

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

### FindMedicationTreatmentPlans

Expand Down Expand Up @@ -30,6 +33,38 @@ Return only prescriptions that are actually "open|valid" (i.e. dispensable).

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

### FindMedicationCard

- *$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. On-demand is required, as there's no stable PML in the PMP. By default, all types are returned. At max one on-demand document is returned.
### 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`

**Query parameters**

| Parameter Name | Attribute | Opt | Mult |
| --------------------------------- | ----------------------------- | --- | ---- |
| $XDSDocumentEntryPatientId | XDSDocumentEntry.patientId | R | -- |
| $XDSDocumentEntryStatus | XDSDocumentEntry.objectType | R | M |
| $XDSDocumentEntryFormatCode | XDSDocumentEntry.formatCode | O | M |
| $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 |

1. *$XDSDocumentEntryPatientId*: TODO
2. *$XDSDocumentEntryStatus*: TODO
3. *$XDSDocumentEntryFormatCode*: TODO
4. *$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` |

5. *$XDSDocumentEntryServiceStartFrom*, *$XDSDocumentEntryServiceStartTo*: TODO
6. *$XDSDocumentEntryServiceEndFrom*, *$XDSDocumentEntryServiceEndTo*: TODO
7. *$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.
59 changes: 59 additions & 0 deletions docs/transactions/documents.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Documents

## Metadata

When two cardinalities are given, the first one is for Content Sender actors and the second one for the Document Repository actor.

| DocumentEntry | Cardinality | APPC | CH-EMED | Comment |
| ------------------------------ | :---------: | ------------ | ------------------------------------------------------------ | ------------------------------------------------- |
| author | M | | | |
| author.authorInstitution | M | | Mapping | |
| author.authorPerson | 1 | | Mapping | |
| author.authorRole | 1 | | | |
| author.authorSpecialty | 0..? | | | |
| author.authorTelecommunication | M | | Mapping | |
| availabilityStatus | 0..1 / 1 | | | Only "Approved" for Content Senders | <!-- Reviewed -->
| classCode | 1 | Single value | Mapping | |
| comments | 0..1 | | | |
| confidentialityCode | 1 | | | Only "Normal" | <!-- Reviewed -->
| creationTime | 1 | | | |
| deletionStatus | 0..1 / 1 | | | Only "deletion not requested" for Content Senders |
| documentAvailability | 0..1 / 1 | | | Only "Online" | <!-- Reviewed -->
| entryUUID | 1 | | `Bundle.identifier.value` and `Composition.identifier.value` | |
| eventCodeList | 0..* | | Mapping | |
| formatCode | 1 | Single value | Mapping | |
| hash | 0..1 / 1 | | | | <!-- Reviewed -->
| healthcareFacilityTypeCode | 1 | | | |
| homeCommunityId | 0..1 / 1 | | | |
| languageCode | 1 | | `Composition.language` | |
| legalAuthenticator | 0..1 | | | |
| limitedMetadata | 0 | | | |
| logicalID | 0..1 / 1 | | `Bundle.identifier.value` and `Composition.identifier.value` | Same value as the `entryUUID` |
| mimeType | 1 | `text/xml` | `application/fhir+xml` or `application/fhir+json` | Single value |
| objectType | 1 | | | Only "stable" for Content Senders | <!-- Reviewed -->
| originalProviderRole | TODO | | | |
| patientId | 1 | | | MPI-PID or EPR-SPID? |
| practiceSettingCode | 1 | | | |
| referenceIdList | 0..* / 0 | | | Ignored by the eMedication service | <!-- Reviewed -->
| repositoryUniqueId | 0..1 / 1 | | | |
| serviceStartTime | 0..1 | None | Mapping | |
| serviceStopTime | 0..1 | None | Mapping | |
| size | 0..1 / 1 | | | | <!-- Reviewed -->
| sourcePatientId | 1 | | Mapping | |
| sourcePatientInfo | 0..1 / 0 | | | Ignored by the eMedication service | <!-- Reviewed -->
| title | 1 | | | |
| typeCode | 1 | Single value | Mapping | |
| uniqueId | 1 | | Mapping. UUID. | |
| URI | 0 / 1 | | | | <!-- TODO MHD download link? -->
| version | 0..1 / 1 | | | Only "1" | <!-- Reviewed -->

**Value sets**:

1. [healthcareFacilityTypeCode](http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.healthcareFacilityTypeCode.html)
2. [languageCode](http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.languageCode.html)
4. deletionStatus <!-- TODO https://github.com/hl7ch/ch-epr-term/issues/11 -->
5. [eventCodeList](http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.eventCodeList.html)
6. [practiceSettingCode](http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.practiceSettingCode.html)
7. [originalProviderRole](http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.originalProviderRole.html)
8. [author.authorRole](http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.authorRole.html)
9. [author.authorSpecialty](http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.authorSpeciality.html)
10 changes: 5 additions & 5 deletions docs/transactions/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ The eMedication service exposes its own IHE endpoints.

Implemented transactions are ITI-18, ITI-41, ITI-43, ITI-57 and CH:PHARM-1.

* [ITI-18](transaction_iti18.md)
* [ITI-41](transaction_iti41.md)
* [ITI-43](transaction_iti43.md)
* [ITI-57](transaction_iti57.md)
* [CH:PHARM-1](transaction_chpharm1.md)
* [ITI-18](iti18.md)
* [ITI-41](iti41.md)
* [ITI-43](iti43.md)
* [ITI-57](iti57.md)
* [CH:PHARM-1](chpharm1.md)

!!! tip

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ nav:
- Usage: chappc/usage.md
- CH-EMED: chemed/index.md
markdown_extensions:
# - smarty
- smarty
- admonition
- attr_list
- md_in_html
Expand Down
14 changes: 12 additions & 2 deletions overrides/partials/source-file.html
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,25 @@
<hr>
<div class="md-source-file last-edited">
{% if page.meta.git_revision_date_localized %}
This page was updated
<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-clock-edit" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">
<path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
<path d="M21 12a9.001 9.001 0 1 0 -9.972 8.948c.32 .034 .644 .052 .972 .052"></path>
<path d="M12 7v5l2 2"></path>
<path d="M18.42 15.61a2.1 2.1 0 0 1 2.97 2.97l-3.39 3.42h-3v-3l3.42 -3.39z"></path>
</svg> This page was updated
{{ page.meta.git_revision_date_localized }}
{% if page.meta.git_creation_date_localized %}
<br>
{{ lang.t("source.file.date.created") }}:
{{ page.meta.git_creation_date_localized }}
{% endif %}
{% elif page.meta.revision_date %}
This page was updated on
<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-clock-edit" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">
<path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
<path d="M21 12a9.001 9.001 0 1 0 -9.972 8.948c.32 .034 .644 .052 .972 .052"></path>
<path d="M12 7v5l2 2"></path>
<path d="M18.42 15.61a2.1 2.1 0 0 1 2.97 2.97l-3.39 3.42h-3v-3l3.42 -3.39z"></path>
</svg> This page was updated on
{{ page.meta.revision_date }}
{% endif %}
</div>

0 comments on commit 781ac83

Please sign in to comment.