Skip to content

Commit bee0451

Browse files
committed
Improvements to endpoints.
1 parent f5ba558 commit bee0451

File tree

3 files changed

+17
-4
lines changed

3 files changed

+17
-4
lines changed

docs/endpoints.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ This page lists the different endpoints available to use the e-medication servic
2929

3030
| Transaction | Path | Comment |
3131
| --- | --- | --- |
32-
| [Provide Document Bundle (ITI-65)](transactions/iti65.md)|`/pmp/fhir`|MHD equivalent to [ITI-41](transactions/iti41.md).|
32+
| [Provide Document Bundle (ITI-65)](transactions/iti65.md)|`/pmp/fhir/Bundle`|MHD equivalent to [ITI-41](transactions/iti41.md).|
3333
| [Find Document References (ITI-67)](transactions/iti67.md)|`/pmp/fhir/DocumentReference`|MHD equivalent to [ITI-18](transactions/iti18.md).|
3434
| [Retrieve Document (ITI-68)](transactions/iti68.md)|`/pmp/mhd/iti68`|MHD equivalent to [ITI-43](transactions/iti43.md).|
3535
| [Update Document Metadata (CH:MHD-1)](transactions/chmhd1.md) | `/pmp/fhir/DocumentReference` |MHD equivalent to [ITI-57](transactions/iti57.md).|
36-
| [CH:PHARM-5](transactions/chpharm5.md)|`/pmp/fhir/DocumentReference/`|MHD equivalent to [CH:PHARM-1](transactions/chpharm1.md).|
36+
| [CH:PHARM-5](transactions/chpharm5.md)|`/pmp/fhir/DocumentReference/<operation>`|MHD equivalent to [CH:PHARM-1](transactions/chpharm1.md). The endpoint changes depending on the CH:PHARM-5 operation, see the [transaction page](transactions/chpharm5.md) for details.|
3737

3838
## PIXm EndPoints
3939
|Transaction|Path|Comment|
@@ -45,5 +45,5 @@ This page lists the different endpoints available to use the e-medication servic
4545
| Transaction | Path | Documentation |
4646
| --- | --- | --- |
4747
| Record Audit Event (syslog) | `:6514` | [ITI-20](transactions/iti20.md) |
48-
| Record Audit Event (RESTful) | `/alpage/fhir` | [ITI-20](transactions/iti20.md) |
48+
| Record Audit Event (RESTful) | `/alpage/fhir/AuditEvent` | [ITI-20](transactions/iti20.md) |
4949
| Audit Trail Consumption (CH:ATC) | `/alpage/fhir/AuditEvent` | [CH:ATC](transactions/chatc.md) |

docs/transactions/chpharm1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The eMedication service doesn't support CMA (Community Medication Administration
66

77
## Stored queries
88

9-
In relatio to IHE's PHARM-1, CH:PHARM-1 defines three additional queries: `FindMedicationCard`, `FindPrescriptionsForValidation` and `FindPrescriptionsForDispense`.
9+
In relation to IHE's PHARM-1, CH:PHARM-1 defines three additional queries: `FindMedicationCard`, `FindPrescriptionsForValidation` and `FindPrescriptionsForDispense`.
1010

1111
## Common query parameters
1212

docs/transactions/chpharm5.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,19 @@ This transaction is the RESTful alternative to the [CH:PHARM-1](chpharm1.html) t
44

55
As for the [ITI-67](iti67.html) request, the eMedication service backend is grouped with the XDS on FHIR option, and hence the `identifier` query parameter is not supported. All other parameters specified by PHARM-5 are supported.
66

7+
## Endpoints
8+
9+
Each CH:PHARM-1 stored query _becomes_ a FHIR operation in CH:PHARM-5. This means that, unlike its XDS-like counterpart, CH:PHARM-5 has a distinct endpoint per defined operation. These are the names of the operations:
10+
- $find-medication-treatment-plans
11+
- $find-prescritions
12+
- $find-dispenses
13+
- $find-prescriptions-for-validation
14+
- $find-prescriptions-for-dispense
15+
- $find-medication-list
16+
- $find-medication-card
17+
18+
In practice, this means that if the base URL for FHIR `DocumentReference` resources is `https://example.com/pmp/fhir/DocumentReference`, then the endpoint for a CH:PHARM-5 _FindMedicationCard_ request would be `https://example.com/pmp/fhir/DocumentReference/$find-medication-card`.
19+
720
## Security Considerations
821

922
Note that beside the security considerations expressed (directly or indirectly) by parent profiles, the eMedication service implementation supports only, for now, the [SAML Token option](https://profiles.ihe.net/ITI/IUA/#342-iua-actor-options), which means that the authorization token conveyed with the HTTP request must be an XUA token.

0 commit comments

Comments
 (0)