Skip to content

Commit 025a63d

Browse files
unixoidunixoid
committed
revised HL7v3 message types descriptions
1 parent 7a5e9b0 commit 025a63d

1 file changed

Lines changed: 44 additions & 20 deletions

File tree

‎_pages/ihe/hl7v3/hl7v3MessageTypes.md‎

Lines changed: 44 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,54 @@ permalink: /docs/ihe/hl7v3MessageTypes/
55
classes: wide
66
---
77

8-
HL7v3-based components do not mandate any special data model. Web Service metadata (WSDL documens) reflects
9-
this by declaring all message parts to be `xsd:anyType`.
8+
### XML strings
9+
10+
HL7v3-based IPF components do not mandate any special data model. Web Service metadata (WSDL documents) reflects
11+
this by defining all message parts as `xsd:anyType`.
1012

1113
What the components deliver to a Camel route, is always an HL7 v3 message as String. Groovy
12-
[DSL extensions for XML processing](https://camel.apache.org/groovy-dsl.html) can be efficiently used to
13-
handle and prepare request and response messages.
14+
[XML processing mechanisms](https://groovy-lang.org/processing-xml.html) can be efficiently used to
15+
parse and create request and response messages.
16+
17+
What the components expect to obtain from a Camel route (e.g. outgoing requests on producer side and outgoing responses
18+
on consumer side) is an XML String containing an HL7 v3 message, or something that can be transformed into such String
19+
by the means of [Camel type converters](https://camel.apache.org/type-converter.html) — e.g. byte array,
20+
input stream, stream reader, DOM document, XSLT source, model class instance, etc.
21+
22+
### Java model classes
23+
24+
Starting with the version 4.1.0, IPF contains model classes for requests and responses of selected HL7v3 transactions,
25+
divided into two categories:
26+
* stub classes, whose structures resemble generic HL7v3 definitions and whose names correspond
27+
to root XML elements of HL7v3 messages, e.g. `PRPAIN201309UV02` for ITI-45 request.
28+
* simplified model classes tailored to a particular IHE transaction, e.g. `PixV3QueryRequest` for ITI-45 request.
29+
30+
For the conversion between these two categories of model classes, as well as between them and XML strings,
31+
IPF provides corresponding [Camel type converters](https://camel.apache.org/type-converter.html).
32+
33+
Currently, the following stub model classes are available:
1434

15-
In addition, starting with the version 4.1.0, IPF introduces model classes for request and response messages of
16-
selected HL7v3 transactions (ongoing work), as well as [Camel type converters](https://camel.apache.org/type-converter.html)
17-
for transforming instances of these classes into Strings and back again.
35+
| Message | Model class |
36+
|---------------------------------------------------------------------------|-------------------------------------------------------------------|
37+
| ITI-44 request (create) | net.ihe.gazelle.hl7v3.prpain201301UV02.PRPAIN201301UV02Type |
38+
| ITI-44 request (update)<br>ITI-46 request | net.ihe.gazelle.hl7v3.prpain201302UV02.PRPAIN201302UV02Type |
39+
| ITI-44 request (merge) | net.ihe.gazelle.hl7v3.prpain201304UV02.PRPAIN201304UV02Type |
40+
| ITI-44 response<br>ITI-46 response<br>ITI-47 continuation cancel response | net.ihe.gazelle.hl7v3.mcciin000002UV01.MCCIIN000002UV01Type |
41+
| ITI-45 request | net.ihe.gazelle.hl7v3.prpain201309UV02.PRPAIN201309UV02Type |
42+
| ITI-45 response | net.ihe.gazelle.hl7v3.prpain201310UV02.PRPAIN201310UV02Type |
43+
| ITI-47 request<br>ITI-55 request | net.ihe.gazelle.hl7v3.prpain201305UV02.PRPAIN201305UV02Type |
44+
| ITI-47 continuation request | net.ihe.gazelle.hl7v3.quqiin000003UV01.QUQIIN000003UV01Type |
45+
| ITI-47 continuation cancel request | net.ihe.gazelle.hl7v3.quqiin000003UV01.QUQIIN000003UV01CancelType |
46+
| ITI-47 response<br>ITI-47 continuation response<br>ITI-55 response | net.ihe.gazelle.hl7v3.prpain201306UV02.PRPAIN201306UV02Type |
1847

19-
In a Maven-based environment, the following dependency must be registered in `pom.xml`:
48+
Simplified model classes:
49+
50+
| Message | Model class |
51+
|-----------------|-------------------------------------------------------------------------|
52+
| ITI-45 request | org.openehealth.ipf.commons.ihe.hl7v3.core.requests.PixV3QueryRequest |
53+
| ITI-45 response | org.openehealth.ipf.commons.ihe.hl7v3.core.responses.PixV3QueryResponse |
54+
55+
Both the model classes and the converters are contained in the following Maven artifact:
2056

2157
```xml
2258
<dependency>
@@ -26,15 +62,3 @@ In a Maven-based environment, the following dependency must be registered in `po
2662
</dependency>
2763
```
2864

29-
30-
Currently, the following model classes are available:
31-
32-
| Message | Model class
33-
|------------------|--------------------------------------------------------------------------------------------------
34-
| ITI-45 request | org.openehealth.ipf.commons.ihe.hl7v3.core.requests.PixV3QueryRequest
35-
| ITI-45 response | org.openehealth.ipf.commons.ihe.hl7v3.core.responses.PixV3QueryResponse
36-
37-
What the components expect to obtain from a Camel route (e.g. outgoing requests on producer side and outgoing responses
38-
on consumer side) is an XML String containing an HL7 v3 message, or something that can be transformed into such String
39-
by the means of [Camel type converters](https://camel.apache.org/type-converter.html) — e.g. byte array,
40-
input stream, stream reader, DOM document, XSLT source, model class instance, etc.

0 commit comments

Comments
 (0)