Package org.openehealth.ipf.commons.ihe.hl7v3.core.responses

Class PixV3QueryResponse

java.lang.Object
org.openehealth.ipf.commons.ihe.hl7v3.core.requests.PixV3QueryRequest
org.openehealth.ipf.commons.ihe.hl7v3.core.responses.PixV3QueryResponse
public class PixV3QueryResponse extends PixV3QueryRequest
Simplified model of a PIXV3 Query response (ITI-45).

It extends PixV3QueryRequest for convenience, as most properties are duplicated between both models.

Since:
4.1
Author:
Quentin Ligier

  • Constructor Details

    • PixV3QueryResponse

      public PixV3QueryResponse()
      Empty constructor. By default, it sets the response code to "Application Error".

  • Method Details

    • fromQuery

      public static PixV3QueryResponse fromQuery(PixV3QueryRequest query)
      Creates and prepopulate a PixV3QueryResponse from a PixV3QueryRequest. The receiver and sender are inverted.
      Parameters:
      query - The query data.
      Returns:
      the created response.

    • setDataFound

      public void setDataFound()
      Sets the response code to "Data Found". The patient data will be included in the response.

    • setNoDataFound

      public void setNoDataFound()
      Sets the response code to "No Data Found". No patient data will be included in the response.

    • setApplicationError

      public void setApplicationError()
      Sets the response code to "Application Error". No patient data will be included in the response.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class PixV3QueryRequest

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class PixV3QueryRequest

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class PixV3QueryRequest

    • getAcknowledgementTypeCode

      public String getAcknowledgementTypeCode()
      The acknowledgement type code, either "AA" (Application Accept) or "AE" (Application Error). It shall be provided. Please use the methods setDataFound(), setNoDataFound() and setApplicationError() instead of the setter.

    • getQueryResponseCode

      public String getQueryResponseCode()
      The query response code, either "OK" (Data Found), "NF" (No Data Found) or "AE" (Application Error). It shall be provided. Please use the methods setDataFound(), setNoDataFound() and setApplicationError() instead of the setter.

    • getTargetMessageId

      public net.ihe.gazelle.hl7v3.datatypes.II getTargetMessageId()
      The targeted message ID. It shall be provided.

    • getPatientIds

      public List<net.ihe.gazelle.hl7v3.datatypes.II> getPatientIds()
      The list of patient ID values (OID). At least one ID shall be provided if data is found, the list is never null.

    • getPersonName

      public net.ihe.gazelle.hl7v3.datatypes.PN getPersonName()
      The list of person names. Exactly one name shall be provided if data is found.

    • getPersonIds

      public List<net.ihe.gazelle.hl7v3.datatypes.II> getPersonIds()
      The list of IDs associated with the person, not the patient. It may be empty but is never null.

    • getAsOtherIDs

      public List<net.ihe.gazelle.hl7v3.prpamt201304UV02.PRPAMT201304UV02OtherIDs> getAsOtherIDs()
      The list of other patient IDs. It may be empty but is never null.

    • getProviderOrganization

      public net.ihe.gazelle.hl7v3.coctmt150003UV03.COCTMT150003UV03Organization getProviderOrganization()
      The details of the provider organization. It shall be provided.

    • getCustodianOid

      public String getCustodianOid()
      The custodian OID. It shall be provided.

    • getAcknowledgementDetails

      public List<net.ihe.gazelle.hl7v3.mccimt000300UV01.MCCIMT000300UV01AcknowledgementDetail> getAcknowledgementDetails()
      The list of acknowledgement details in the message. It shall be provided if the status is "AE", the list may be empty but is never null.

    • setAcknowledgementTypeCode

      public void setAcknowledgementTypeCode(String acknowledgementTypeCode)
      The acknowledgement type code, either "AA" (Application Accept) or "AE" (Application Error). It shall be provided. Please use the methods setDataFound(), setNoDataFound() and setApplicationError() instead of the setter.

    • setQueryResponseCode

      public void setQueryResponseCode(String queryResponseCode)
      The query response code, either "OK" (Data Found), "NF" (No Data Found) or "AE" (Application Error). It shall be provided. Please use the methods setDataFound(), setNoDataFound() and setApplicationError() instead of the setter.

    • setTargetMessageId

      public void setTargetMessageId(net.ihe.gazelle.hl7v3.datatypes.II targetMessageId)
      The targeted message ID. It shall be provided.

    • setPersonName

      public void setPersonName(net.ihe.gazelle.hl7v3.datatypes.PN personName)
      The list of person names. Exactly one name shall be provided if data is found.

    • setProviderOrganization

      public void setProviderOrganization(net.ihe.gazelle.hl7v3.coctmt150003UV03.COCTMT150003UV03Organization providerOrganization)
      The details of the provider organization. It shall be provided.

    • setCustodianOid

      public void setCustodianOid(String custodianOid)
      The custodian OID. It shall be provided.

    • toString

      public String toString()
      Overrides:
      toString in class PixV3QueryRequest