Class Iti67ResourceProvider

  • All Implemented Interfaces:
    Serializable

    public class Iti67ResourceProvider
    extends org.openehealth.ipf.commons.ihe.fhir.AbstractPlainProvider
    Resource Provider for MHD (ITI-67).

    Note (CP by Rick Riemer): When searching for XDS documents with specific referenceIdList values, MHD specifies to use the related-id query parameter. This parameter is of type token (https://www.hl7.org/fhir/search.html#token). The token type does not allow searching for the Identifier.type attribute, which would be a primary use case.

    IHE should provide a mechanism to search for referenceIdList values by type, in addition to system and value. Suggestion: don’t use token, but use composite, (https://www.hl7.org/fhir/search.html#composite) and define how to use it for searching against referenceIdList values. A composite parameter could look like: related id=urn:oid:1.2.3.4.5.6|2013001$urn:ihe:iti:xds:2013:accession.

    Since:
    3.6
    Author:
    Christian Ohr
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.hl7.fhir.r4.model.DocumentReference documentReferenceRetrieve​(org.hl7.fhir.r4.model.IdType id, ca.uhn.fhir.rest.api.server.RequestDetails requestDetails, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)
      Handles DocumentReference Retrieve.
      ca.uhn.fhir.rest.api.server.IBundleProvider documentReferenceSearch​(ca.uhn.fhir.rest.param.ReferenceParam patient, ca.uhn.fhir.rest.param.TokenOrListParam status, ca.uhn.fhir.rest.param.TokenParam identifier, ca.uhn.fhir.rest.param.DateRangeParam date, ca.uhn.fhir.rest.param.DateRangeParam indexed, ca.uhn.fhir.rest.param.ReferenceAndListParam author, ca.uhn.fhir.rest.param.TokenOrListParam category, ca.uhn.fhir.rest.param.TokenOrListParam class_, ca.uhn.fhir.rest.param.TokenOrListParam type, ca.uhn.fhir.rest.param.TokenOrListParam setting, ca.uhn.fhir.rest.param.DateRangeParam period, ca.uhn.fhir.rest.param.TokenOrListParam facility, ca.uhn.fhir.rest.param.TokenOrListParam event, ca.uhn.fhir.rest.param.TokenOrListParam securityLabel, ca.uhn.fhir.rest.param.TokenOrListParam label, ca.uhn.fhir.rest.param.TokenOrListParam format, ca.uhn.fhir.rest.param.ReferenceOrListParam related, ca.uhn.fhir.rest.param.TokenOrListParam relatedId, ca.uhn.fhir.rest.param.ReferenceOrListParam relatedRef, ca.uhn.fhir.rest.param.TokenParam resourceId, ca.uhn.fhir.rest.api.SortSpec sortSpec, Set<ca.uhn.fhir.model.api.Include> includeSpec, ca.uhn.fhir.rest.api.server.RequestDetails requestDetails, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)  
      • Methods inherited from class org.openehealth.ipf.commons.ihe.fhir.AbstractPlainProvider

        getFhirContext, getRequestConsumer, requestAction, requestBundle, requestBundleProvider, requestResource, setConsumer, unsetConsumer
      • Methods inherited from class org.openehealth.ipf.commons.ihe.fhir.FhirProvider

        enrichParameters, requiresDeregistration, requiresRegistration
    • Constructor Detail

      • Iti67ResourceProvider

        public Iti67ResourceProvider()
    • Method Detail

      • documentReferenceSearch

        public ca.uhn.fhir.rest.api.server.IBundleProvider documentReferenceSearch​(ca.uhn.fhir.rest.param.ReferenceParam patient,
                                                                                   ca.uhn.fhir.rest.param.TokenOrListParam status,
                                                                                   ca.uhn.fhir.rest.param.TokenParam identifier,
                                                                                   ca.uhn.fhir.rest.param.DateRangeParam date,
                                                                                   ca.uhn.fhir.rest.param.DateRangeParam indexed,
                                                                                   ca.uhn.fhir.rest.param.ReferenceAndListParam author,
                                                                                   ca.uhn.fhir.rest.param.TokenOrListParam category,
                                                                                   ca.uhn.fhir.rest.param.TokenOrListParam class_,
                                                                                   ca.uhn.fhir.rest.param.TokenOrListParam type,
                                                                                   ca.uhn.fhir.rest.param.TokenOrListParam setting,
                                                                                   ca.uhn.fhir.rest.param.DateRangeParam period,
                                                                                   ca.uhn.fhir.rest.param.TokenOrListParam facility,
                                                                                   ca.uhn.fhir.rest.param.TokenOrListParam event,
                                                                                   ca.uhn.fhir.rest.param.TokenOrListParam securityLabel,
                                                                                   ca.uhn.fhir.rest.param.TokenOrListParam label,
                                                                                   ca.uhn.fhir.rest.param.TokenOrListParam format,
                                                                                   ca.uhn.fhir.rest.param.ReferenceOrListParam related,
                                                                                   ca.uhn.fhir.rest.param.TokenOrListParam relatedId,
                                                                                   ca.uhn.fhir.rest.param.ReferenceOrListParam relatedRef,
                                                                                   ca.uhn.fhir.rest.param.TokenParam resourceId,
                                                                                   ca.uhn.fhir.rest.api.SortSpec sortSpec,
                                                                                   Set<ca.uhn.fhir.model.api.Include> includeSpec,
                                                                                   ca.uhn.fhir.rest.api.server.RequestDetails requestDetails,
                                                                                   javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                   javax.servlet.http.HttpServletResponse httpServletResponse)
      • documentReferenceRetrieve

        public org.hl7.fhir.r4.model.DocumentReference documentReferenceRetrieve​(org.hl7.fhir.r4.model.IdType id,
                                                                                 ca.uhn.fhir.rest.api.server.RequestDetails requestDetails,
                                                                                 javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                 javax.servlet.http.HttpServletResponse httpServletResponse)
        Handles DocumentReference Retrieve. This is not an actual part of the ITI-67 specification, but in the context of restful FHIR IHE transaction it makes sense to be able to retrieve a DocumentReference by its resource ID.
        Parameters:
        id - resource ID
        httpServletRequest - servlet request
        httpServletResponse - servlet response
        requestDetails - request details
        Returns:
        DocumentReference resource