Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## be.ehealth.business.kmehrcommons
Class HcPartyUtil

    java.lang.Object
      be.ehealth.business.kmehrcommons.HcPartyUtil

    public final class HcPartyUtil

extends Object

utility class to create HcParty kmehr objects. for more info about HcPartyCodes : https://www.ehealth.fgov.be/standards/kmehr/content/page/tables/198/healthcare-party-type for more info about HcParty : https://www.ehealth.fgov.be/standards/kmehr/content/page/37/hcparty

Method Summary
`static void` | `addSecurityTags(AuthorType author)`
`static CDHCPARTY` | `buildCd(String sv, String value, CDHCPARTYschemes scheme, String sl)`
`static CDHCPARTY` | `buildCd(String sv, String value, CDHCPARTYschemes scheme, String sl, String dn, String l)`
`static IDHCPARTY` | `buildId(String value, IDHCPARTYschemes scheme)`
`static IDHCPARTY` | `buildId(String version, String value, IDHCPARTYschemes scheme)`
`static IDHCPARTY` | `buildId(String version, String value, IDHCPARTYschemes scheme, String sl)`
`static IDHCPARTY` | `createApplicationId(String applicationId)`
`static AuthorType` | `createAuthor(String projectName)` create the author
`static List<HcpartyType>` | `createAuthorHcParties(String projectName)` Get the list of all Hc Parties that must be created
`static IDHCPARTY` | `createCbeId(String cbe)`
`static IDHCPARTY` | `createEhpId(String ehpId)`
`static List<HcpartyType>` | `createHcpartiesFromConfig(String configName)` Create the list of hcparty
`static IDHCPARTY` | `createInssId(String insz)`
`static IDKMEHR` | `createKmehrId(String projectName, String kmehrIdSuffix)` generates an IDKMEHR object with a semi generated kmehr id
`static String` | `createKmehrIdPrefix()` Deprecated.
`static String` | `createKmehrIdString(String projectName)` creates the kmehrId for the given project, with a generated suffix.
`static String` | `createKmehrIdString(String projectName, String kmehrIdSuffix)` Generate the kmehr id
`static String` | `createKmehrIdSuffix()`
`static IDHCPARTY` | `createNihiiId(String nihii)`
`static HcpartyType` | `createProfessionalParty(String inss, String nihii, String professionType)` Create a professional hcparty
`static HcpartyType` | `createSingleHcpartyFromConfig(String configName)` Create only one hc party
`static HcpartyType` | `createSoftwareIdentifier(String softwareName, String appId)` create a Software identifier
`static String` | `getAuthorKmehrQuality()`
`static String` | `retrieveMainAuthorId(String projectName)` retrieves the main author id from configuration.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### getAuthorKmehrQuality

    public static String getAuthorKmehrQuality()

### createHcpartiesFromConfig

    public static List<HcpartyType> createHcpartiesFromConfig(String configName)
                                                       throws TechnicalConnectorException

  Create the list of hcparty

  Parameters:
    `configName` -
  Returns:
  Throws:
    `TechnicalConnectorException`

### createSingleHcpartyFromConfig

    public static HcpartyType createSingleHcpartyFromConfig(String configName)
                                                     throws TechnicalConnectorException

  Create only one hc party

  Parameters:
    `configName` -
  Returns:
  Throws:
    `TechnicalConnectorException`

### createSoftwareIdentifier

    public static HcpartyType createSoftwareIdentifier(String softwareName,
                                                       String appId)
                                                throws TechnicalConnectorException

  create a Software identifier

  Parameters:
    `softwareName` -
    `appId` - the value to used in the application_ID identifier tag
  Returns:
  Throws:
    `TechnicalConnectorException`

### createProfessionalParty

    public static HcpartyType createProfessionalParty(String inss,
                                                      String nihii,
                                                      String professionType)
                                               throws TechnicalConnectorException

  Create a professional hcparty

  Parameters:
    `inss` -
    `nihii` -
    `professionType` -
  Returns:
  Throws:
    `TechnicalConnectorException` - if the builder validation fails

### createKmehrIdString

    public static String createKmehrIdString(String projectName,
                                             String kmehrIdSuffix)
                                      throws TechnicalConnectorException

  Generate the kmehr id

  Parameters:
    `projectName` - used to retrieve the main author id from config file
    `kmehrIdSuffix` - if null an autogenerated suffix will be used
  Returns:
  Throws:
    `TechnicalConnectorException`

### createKmehrIdString

    public static String createKmehrIdString(String projectName)
                                      throws TechnicalConnectorException

  creates the kmehrId for the given project, with a generated suffix.

  Parameters:
    `projectName` - use to retrieve the main author type.
  Returns:
    String the generated Kmehr id string
  Throws:
    `TechnicalConnectorException`

### retrieveMainAuthorId

    public static String retrieveMainAuthorId(String projectName)
                                       throws TechnicalConnectorException

  retrieves the main author id from configuration. this requires the property "kmehr." + {projectName/default} + ".identifier.id.idhcparty.value" to be filled out

  Parameters:
    `projectName` -
  Returns:
  Throws:
    `TechnicalConnectorException`

### createKmehrIdPrefix

    @Deprecated
    public static String createKmehrIdPrefix()
                                      throws TechnicalConnectorException

  Deprecated.

  Returns:
  Throws:
    `TechnicalConnectorException`

### createKmehrIdSuffix

    public static String createKmehrIdSuffix()
                                      throws TechnicalConnectorException

  Throws:
    `TechnicalConnectorException`

### createKmehrId

    public static IDKMEHR createKmehrId(String projectName,
                                        String kmehrIdSuffix)
                                 throws TechnicalConnectorException

  generates an IDKMEHR object with a semi generated kmehr id

  Parameters:
    `projectName` - the projectName, use to retrieve configuration parameters
    `kmehrIdSuffix` - the suffix for the kmehrId : often this needs to be identical to another identifier, if null an id will be build
  Returns:
    IDKMEHR
  Throws:
    `TechnicalConnectorException`

### createInssId

    public static IDHCPARTY createInssId(String insz)

  Parameters:
    `insz` - the national security number used as id value
  Returns:
    `IDHCPARTY`

### createNihiiId

    public static IDHCPARTY createNihiiId(String nihii)

### createCbeId

    public static IDHCPARTY createCbeId(String cbe)

### createApplicationId

    public static IDHCPARTY createApplicationId(String applicationId)

### createEhpId

    public static IDHCPARTY createEhpId(String ehpId)

### buildId

    public static IDHCPARTY buildId(String version,
                                    String value,
                                    IDHCPARTYschemes scheme,
                                    String sl)

  Parameters:
    `version` -
    `value` -
    `local` -
    `sl` -
  Returns:

### buildId

    public static IDHCPARTY buildId(String version,
                                    String value,
                                    IDHCPARTYschemes scheme)

### buildId

    public static IDHCPARTY buildId(String value,
                                    IDHCPARTYschemes scheme)

### buildCd

    public static CDHCPARTY buildCd(String sv,
                                    String value,
                                    CDHCPARTYschemes scheme,
                                    String sl)

  Parameters:
    `hcp` -
  Returns:

### buildCd

    public static CDHCPARTY buildCd(String sv,
                                    String value,
                                    CDHCPARTYschemes scheme,
                                    String sl,
                                    String dn,
                                    String l)

### createAuthorHcParties

    public static List<HcpartyType> createAuthorHcParties(String projectName)
                                                   throws TechnicalConnectorException

  Get the list of all Hc Parties that must be created

  Parameters:
    `projectName` -
  Returns:
  Throws:
    `TechnicalConnectorException`

### createAuthor

    public static AuthorType createAuthor(String projectName)
                                   throws TechnicalConnectorException

  create the author

  Parameters:
    `projectName` -
  Returns:
  Throws:
    `TechnicalConnectorException`

### addSecurityTags

    public static void addSecurityTags(AuthorType author)
                                throws TechnicalConnectorException

  Parameters:
    `author` -
  Throws:
    `TechnicalConnectorException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Connector Packaging PERSPRACTICALNURSE 3.15.1 API
Copyright © {inceptionYear}-2018 eHealth. All Rights Reserved.