CH ELM (R4)
1.6.0 - release
CH ELM (R4)
1.6.0 - release
This page is part of the Observations of notifiable communicable infectious diseases (v1.6.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
CH ELM defines a RESTful web API based on FHIR to enable a laboratory to send and verify the processing of its reports.
The Send Report transaction provides a report from the laboratory to the FOPH.
After providing the report the laboratory shall verify through the API that the report has been successfully processed.
Actor: Laboratory
Role: Sends a report in the CH ELM document format and metadata to the FOPH and verifies that the report has been successfully processed.
Actor: FOPH
Role: Accepts the report from the Document Source and processes the report in a later stage.
Figure: Report Interactions
Release 4 of the HL7® FHIR® standard.
The Send report transaction passes a DocumentReference message from the laboratory to the FOPH, providing the report directly as a FHIR Bundle.
This message uses the HTTP POST method on the DocumentReference endpoint to convey the metadata and the document as a FHIR DocumentReference. See also the CapabilityStatement of the server.
This method is invoked when the laboratory needs to submit one document to the FOPH.
The laboratory shall initiate a FHIR “create” action by sending an HTTP POST request method composed of a FHIR Publish DocumentReference, with the document referenced in the DocumentReference.content.attachment.url element and provided as contained bundle.
The media type of the HTTP body shall be either application/fhir+json or application/fhir+xml.
The message is sent to the DocumentReference at the base URL as defined in FHIR. See http://hl7.org/fhir/R4/http.html for the definition of “HTTP” access methods and “base”.
POST http://[base]/DocumentReference HTTP/1.1
Content-Type: application/fhir+json
Accept: application/fhir+json
{
"resourceType" : "DocumentReference",
"contained" : [
{
"resourceType" : "Bundle",
"id" : "1Doc-NeisseriaGonorrhoeae",
"meta" : {
"profile" : [
"http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-document",
"http://hl7.eu/fhir/laboratory/StructureDefinition/Bundle-eu-lab"
]
},
"identifier" : {
"system" : "urn:ietf:rfc:3986",
"value" : "urn:uuid:1901332d-6012-443f-9690-9291adb2e19d"
},
"type" : "document"
// snip the rest of the bundle
}
],
"identifier" : [
{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:uuid:1901332d-6012-443f-9690-9291adb2e19d"
}
],
"status" : "current",
"content" : [
{
"attachment" : {
"language" : "de-CH",
"url" : "#1Doc-NeisseriaGonorrhoeae"
}
}
]
}
DocumentReference needs to follow the Publish DocumentReference Profile Resource metadata requirements. See example.
When resources are contained they shall be contained using the FHIR contained method (see http://hl7.org/fhir/R4/references.html#contained ).
The FOPH shall accept both media types application/fhir+json and application/fhir+xml.
On receipt of the Publish Request Message, the FOPH shall extract the document from the DocumentReference.content.attachment.url and respond with one of the HTTP codes defined in the response http://hl7.org/fhir/R4/http.html#ops.
If the FOPH encounters any errors or if any validation fails, the FOPH shall return an error using a FHIR OperationOutcome.
The FOPH returns a HTTP Status code appropriate to the processing outcome, conforming to the create transaction specification requirements as specified in http://hl7.org/fhir/R4/http.html#create.
If the FOPH has accepted the information it will return an id for the created DocumentReference. The DocumentReference will have an additional element returning the processing state of the document, which can have the following values: in-progress, failed, completed. If failed a reference to an OperationOutcome is added.
This message shall be sent when a success or error condition needs to be communicated. Success is only indicated once the document is received and validated to the FOPH Actor configuration.
To enable the laboratory to know the outcome of processing the transaction, and the identities assigned to the resources by the FOPH, the FOPH shall return the DocumentReference as created conforming to Publish DocumentReference Response.
The FOPH processes the results according to application-defined rules.
Important: The laboratory shall afterwards check the status of the processing, see next message.
The laboratory shall verify through the API that the reports have been successfully processed. The laboratory can either query the DocumentReference by id or query it with different search parameters.
This message uses the search method parameterized query to obtain DocumentReference Resources from the FOPH.
When the laboratory needs to discover DocumentReference Resources matching various metadata parameters, it issues a request message.
The laboratory executes an HTTP search against the FOPHs DocumentReference URL. The search tar follows the FHIR HTTP specification, addressing the DocumentReference Resource http://hl7.org/fhir/R4/http.html:
[base]/DocumentReference?<query>
If the id of the DocumentReference resource is known, it can be directly accessed by id instead of a query.
[base]/DocumentReference/id
This URL [base] is configurable by the FOPH and is subject to the following constraints:
The <query> represents a series of encoded name-value pairs representing the filter for the query as well as control parameters to modify the behavior of the FOPH such as response format, or pagination.
The laboratory can use GET searches.
The laboratory may supply, and the FOPH shall be capable of processing, all query parameters listed below. All query parameter values shall be appropriately encoded per RFC3986 “percent” encoding rules. Note that percent encoding does restrict the character set to a subset of ASCII characters which is used for encoding all other characters used in the URL.
The parameters described below are optional. The FOPH must implement the parameters described below. The FOPH may choose to support additional query parameters beyond the subset listed below. Any additional query parameters supported shall be supported according to the core FHIR specification. Such additional parameters are considered out of scope for this transaction. Any additional parameters not supported should be ignored. See http://hl7.org/fhir/R4/search.html#errors.
date: This parameter, of type date, specifies the time when the DocumentReference was created. See http://hl7.org/fhir/R4/search.html#date for use of the date search type.
_lastUpdate: The search parameter _lastUpdated can be used to select resources based on the last time they were changed. See http://hl7.org/fhir/R4/search.html#lastUpdated for use of the _lastUpdate search type.
for date and _lastUpdate the following prefixes for parameter are supported: eq,ne,gt,ge,lt, le
identifier: This parameter, of type token, specifies an identifier for this DocumentReference and/or the contained document. The search results represent the results of a search on DocumentReference.identifier.
elm-status: This parameter, of type token, specifies the status of the processing of the report at the FOPH. It can be either in-progress, failed or completed, see ValueSet. Only one status per query is supported, you cannot query for multiple (e.g. failed, complete).
Sorting
The client can indicate which order to return the results by using the parameter _sort, which can contain a comma-separated list of sort rules in priority order. The following support parameters can be specified: identifier, date, elm-status, _lastUpdated. A prefix of '-' indicates decreasing order; in its absence, the parameter is applied in increasing order.
Paging
The parameter _count is defined as an instruction to the server regarding how many resources should be returned in a single page.
If _count has the value 0, this shall be treated the same as _summary=count: the server returns a bundle that reports the total number of resources that match in Bundle.total, but with no entries, and no prev/next/last links.
FOPH allows with the parameter page to directly query a specific page in the search result. The client can also follow the first, next, prev, last link in the Bundle search response.
The FHIR standard provides encodings for responses as either XML or JSON.
GET http://[base]/DocumentReference?_lastUpdate=gt2023-10-02T08:00:00+02:00&elm-status=failed
The FOPH shall process the query to discover the DocumentReference entries that match the search parameters given.
The FOPH returns a HTTP Status code appropriate to the processing as well as a Bundle of the matching DocumentReference Resources for the query, DocumentReference resource if the DocumentReference was accessed by id.
The FOPH completed processing of the request message.
Based on the query results, the FOPH will either return an error or success. Guidance on handling Access Denied related to use of 200, 403 and 404 can be found in ITI TF-2x: Appendix Z.7.
When the FOPH needs to report an error, it shall use HTTP error response codes and should include a FHIR OperationOutcome with more details on the failure. See FHIR http://hl7.org/fhir/R4/http.html and http://hl7.org/fhir/R4/operationoutcome.html.
If the query is processed successfully, whether or not any DocumentReference Resources are found, the HTTP status code shall be 200. The response message shall be a Bundle Resource containing zero or more DocumentReference Resources.
The response shall adhere to the FHIR Bundle constraints specified.
Example of responses from query by id: in-progress, failed, completed.
The laboratory shall process the results. It is in the responsibility of the laboratory to resubmit the failed responses.
mTLS shall be used.
The following endpoints are defined:
Integration System: https://ws.infreport-a.bag.admin.ch/ch-elm/v1/fhir
Production System: https://ws.infreport.bag.admin.ch/ch-elm/v1/fhir