Class PixmQueryParametersIn

All Implemented Interfaces:
IElement, Serializable, IAnyResource, IBase, IBaseParameters, IBaseResource

public class PixmQueryParametersIn extends Parameters
Parameters resource for ITI-83 Mobile Patient Identifier Cross-reference Query input as defined by the PIXm specification.

This Parameters resource contains the input parameters for the $ihe-pix operation, including the source identifier (in "system|value" format) and optional target system(s) for cross-referencing.

Since:
5.2
Author:
Christian Ohr
See Also:
  • Field Details

  • Constructor Details

    • PixmQueryParametersIn

      public PixmQueryParametersIn()
  • Method Details

    • copy

      public PixmQueryParametersIn copy()
      Overrides:
      copy in class Parameters
    • getSourceIdentifier

      public String getSourceIdentifier()
      Gets the source identifier parameter value as a string in "system|value" format.
      Returns:
      the source identifier string, or null if not present
    • getSourceIdentifierAsIdentifier

      public Identifier getSourceIdentifierAsIdentifier()
      Gets the source identifier as an Identifier object by parsing the "system|value" format.
      Returns:
      the parsed Identifier, or null if not present or invalid format
    • setSourceIdentifier

      public PixmQueryParametersIn setSourceIdentifier(String sourceIdentifier)
      Sets the source identifier parameter from a string in "system|value" format.
      Parameters:
      sourceIdentifier - the source identifier string
      Returns:
      this Parameters instance
    • setSourceIdentifier

      public PixmQueryParametersIn setSourceIdentifier(Identifier sourceIdentifier)
      Sets the source identifier parameter from an Identifier object, converting it to "system|value" format.
      Parameters:
      sourceIdentifier - the source identifier
      Returns:
      this Parameters instance
    • getTargetSystems

      public List<String> getTargetSystems()
      Gets the target system parameter values.
      Returns:
      list of target system URIs
    • addTargetSystem

      public PixmQueryParametersIn addTargetSystem(String targetSystem)
      Adds a target system parameter.
      Parameters:
      targetSystem - the target system URI
      Returns:
      this Parameters instance
    • setTargetSystems

      public PixmQueryParametersIn setTargetSystems(List<String> targetSystems)
      Sets the target system parameters, replacing any existing ones.
      Parameters:
      targetSystems - list of target system URIs
      Returns:
      this Parameters instance
    • getFormat

      public String getFormat()
      Gets the _format parameter value.
      Returns:
      the format string, or null if not present
    • setFormat

      public PixmQueryParametersIn setFormat(String format)
      Sets the _format parameter.
      Parameters:
      format - the format string
      Returns:
      this Parameters instance