Skip to content

Commit

Permalink
fixed PHARM-5 documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@unixoid
unixoid committed Jan 26, 2025
1 parent 925c77a commit 1a50ad1
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 29 deletions.
12 changes: 6 additions & 6 deletions _pages/boot/boot-fhir.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ into your project descriptor.
| `cors.exposed-headers` | | The list of response headers that an actual response might have and can be exposed to the client. The special value "*" allows all headers to be exposed. |
| `cors.allow-credentials` | | Whether user credentials are supported. Setting this property has an impact on how origins, originPatterns, allowedMethods and allowedHeaders are processed, |
| `cors.max-age` | | How long, as a duration, the response from a pre-flight request can be cached by clients. |

See [ipf-spring-boot-starter] and [ipf-atna-spring-boot-starter] for additional properties.


Expand All @@ -112,12 +113,11 @@ Camel provides a Spring boot starter module for this:

[camel-servlet-starter] provides the following application properties:

| Property (`camel.servlet.mapping.`)| Default | Description |
|------------------------------------|------------------------|------------------------------------------------------------------|
| `enabled` | true | Enables the automatic mapping of the servlet component into the Spring web context |
| `contextPath` | /camel/* | Context path used by the servlet component for automatic mapping |
| `servletName` | CamelServlet | The name of the Camel servlet |

| Property (`camel.servlet.mapping.`) | Default | Description |
|-------------------------------------|--------------|------------------------------------------------------------------------------------|
| `enabled` | true | Enables the automatic mapping of the servlet component into the Spring web context |
| `context-path` | /camel/* | Context path used by the servlet component for automatic mapping |
| `servlet-name` | CamelServlet | The name of the Camel servlet |

[Spring Boot]: https://projects.spring.io/spring-boot/
[ipf-spring-boot-starter]: {{ site.baseurl }}{% link _pages/boot/boot.md %}
Expand Down
47 changes: 25 additions & 22 deletions _pages/ihe/fhir/fhirMessageTypes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,17 @@ If unmarshalling fails, an FHIR response automatically generated and passed back
| Transaction | Request Message Type | Request Message Headers |
|-------------|-----------------------------------------------------------------------------------------------------------|-------------------------|
| ITI-65 | `Bundle` containing `DocumentManifest` (only MHD 3.2), `List`, `DocumentReference` and `Binary` resources | n/a |
| ITI-66 | n/a | Query Parameters |
| ITI-66 | n/a | Query Parameters |
| ITI-67 | n/a | Query Parameters |
| ITI-68 | n/a | n/a |
| ITI-68 | n/a | n/a |
| ITI-78 | n/a | Query Parameters |
| ITI-81 | n/a | Query Parameters |
| ITI-83 | n/a | Query Parameters |
| PCC-44 | n/a | Query Parameters |
| ITI-81 | n/a | Query Parameters |
| ITI-83 | n/a | Query Parameters |
| PCC-44 | n/a | Query Parameters |
| CH:PPQ-3 | - for POST and PUT -- `Consent` resource<br/>- for DELETE -- identifier of a `Consent` resource | |
| CH:PPQ-4 | Transaction `Bundle` containing `Consent` resources or identifiers of `Consent` resources | |
| CH:PPQ-5 | `ChPpq5SearchParameters` | |
| PHARM-5 | n/a | Query Parameters |

The following Camel headers are set by the consumer:

Expand Down Expand Up @@ -65,7 +66,7 @@ is transformed into a HAPI FHIR resource. When unmarshalling fails, an exception
| ITI-66 (get) | `DocumentManifest` (MHD 3.2) or `List` (MHD 4.2) resource |
| ITI-67 (search) | `Bundle` containing `DocumentReference` resources |
| ITI-67 (get) | `DocumentReference` resource |
| ITI-68 | binary content (usually via an `InputStream`) |
| ITI-68 | binary content (usually via an `InputStream`) |
| ITI-78 (search) | `Bundle` containing matching `Patient` resources |
| ITI-78 (get) | `Patient` resource |
| ITI-81 (get) | `AuditEvent` resource |
Expand All @@ -74,6 +75,7 @@ is transformed into a HAPI FHIR resource. When unmarshalling fails, an exception
| CH:PPQ-3 | `MethodOutcome` |
| CH:PPQ-4 | `Bundle` containing transaction results |
| CH:PPQ-5 | `Bundle` containing found `Consent` resources |
| PHARM-5 | `Bundle` containing `DocumentReference` resources |

### Consumer-side responses

Expand All @@ -88,22 +90,23 @@ for details.

Data types for the *request* message of the supported transactions on producer (i.e. client) side are listed in the table below:

| Transaction | Request Message Type |
|-----------------|-------------------------------------------------------------------------------------------------|
| ITI-65 | `Bundle` |
| ITI-66 (search) | `ca.uhn.fhir.rest.gclient.ICriterion` or URL string |
| ITI-66 (get) | String with the DocumentManifest (MHD 3.2) or List (MHD 4.2) resource identifier |
| ITI-67 (search) | `ca.uhn.fhir.rest.gclient.ICriterion` or URL string |
| ITI-67 (get) | String with the DocumentReference resource identifier |
| ITI-68 | URL string |
| ITI-78 (search) | `ca.uhn.fhir.rest.gclient.ICriterion` or URL string |
| ITI-78 (get) | String with the Patient resource identifier |
| ITI-81 (search) | `ca.uhn.fhir.rest.gclient.ICriterion` or URL string |
| ITI-83 | `org.hl7.fhir.instance.model.Parameters` |
| PCC-44 (search) | `ca.uhn.fhir.rest.gclient.ICriterion` or URL string |
| CH:PPQ-3 | - for POST and PUT -- `Consent` resource<br/>- for DELETE -- identifier of a `Consent` resource |
| CH:PPQ-4 | Transaction `Bundle` containing `Consent` resources or identifiers of `Consent` resources |
| CH:PPQ-5 | Array of ICriterion<?> |
| Transaction | Request Message Type |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ITI-65 | `Bundle` |
| ITI-66 (search) | `ca.uhn.fhir.rest.gclient.ICriterion` or URL string |
| ITI-66 (get) | String with the DocumentManifest (MHD 3.2) or List (MHD 4.2) resource identifier |
| ITI-67 (search) | `ca.uhn.fhir.rest.gclient.ICriterion` or URL string |
| ITI-67 (get) | String with the DocumentReference resource identifier |
| ITI-68 | URL string |
| ITI-78 (search) | `ca.uhn.fhir.rest.gclient.ICriterion` or URL string |
| ITI-78 (get) | String with the Patient resource identifier |
| ITI-81 (search) | `ca.uhn.fhir.rest.gclient.ICriterion` or URL string |
| ITI-83 | `org.hl7.fhir.instance.model.Parameters` |
| PCC-44 (search) | `ca.uhn.fhir.rest.gclient.ICriterion` or URL string |
| CH:PPQ-3 | - for POST and PUT -- `Consent` resource<br/>- for DELETE -- identifier of a `Consent` resource |
| CH:PPQ-4 | Transaction `Bundle` containing `Consent` resources or identifiers of `Consent` resources |
| CH:PPQ-5 | Array of ICriterion<?> |
| PHARM-5 | Pharm5SearchParameters in the FhirRequestParameters header; `org.hl7.fhir.r4.model.Parameters` in the body and `Pharm5Operations` in the OPERATION_HEADER header |

The URL string may be complete (e.g. `http://example.com/base/Patient?family=smith`) in which case the client's base URL will be ignored.
Or it can be relative (e.g. `Patient?family=smith`) in which case the client's base URL will be used.
Expand Down
2 changes: 1 addition & 1 deletion _pages/ihe/fhir/pharm5.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ which is described in the [{{ tx.section }}]({{ tx.section-link }}).

The transaction defines the following actors:

{% include figure image_path="/assets/images/iti65.svg" alt="ITI-65 actors" caption="ITI-65 transaction and actors " %}
{% include figure image_path="/assets/images/pharm5.svg" alt="PHARM-5 actors" caption="PHARM-5 transaction and actors " %}

Producer side corresponds to the *{{ tx.client-actor }}* actor.
Consumer side corresponds to the *{{ tx.server-actor }}* actor.
Expand Down

0 comments on commit 1a50ad1

Please sign in to comment.