i2b2client

README

Package pkg/i2b2client

This package exposes a client for the i2b2 XML API. It implements a selection of requests for the ONT and CRC cells.

Documentation

Index

• type Client
  • func (c Client) CrcPdoReqFromInputList(reqMsgBody *models.CrcPdoReqFromInputListMessageBody) (*models.CrcPdoRespMessageBody, error)
  • func (c Client) CrcPsmReqFromQueryDef(reqMsgBody *models.CrcPsmReqFromQueryDefMessageBody) (*models.CrcPsmRespMessageBody, error)
  • func (c Client) OntGetCategories(reqMsgBody *models.OntReqGetCategoriesMessageBody) (*models.OntRespConceptsMessageBody, error)
  • func (c Client) OntGetChildren(reqMsgBody *models.OntReqGetChildrenMessageBody) (*models.OntRespConceptsMessageBody, error)
  • func (c Client) OntGetModifierChildren(reqMsgBody *models.OntReqGetModifierChildrenMessageBody) (*models.OntRespModifiersMessageBody, error)
  • func (c Client) OntGetModifierInfo(reqMsgBody *models.OntReqGetModifierInfoMessageBody) (*models.OntRespModifiersMessageBody, error)
  • func (c Client) OntGetModifiers(reqMsgBody *models.OntReqGetModifiersMessageBody) (*models.OntRespModifiersMessageBody, error)
  • func (c Client) OntGetTermInfo(reqMsgBody *models.OntReqGetTermInfoMessageBody) (*models.OntRespConceptsMessageBody, error)

Types

type Client

type Client struct {

	// Logger is the Logger from GeCo
	Logger logrus.FieldLogger

	// Ci contains the connection information to the i2b2 instance
	Ci models.ConnectionInfo
}

Client is an i2b2 client for its XML API.

func (Client) CrcPdoReqFromInputList

func (c Client) CrcPdoReqFromInputList(reqMsgBody *models.CrcPdoReqFromInputListMessageBody) (*models.CrcPdoRespMessageBody, error)

CrcPdoReqFromInputList makes an i2b2 API request to /QueryToolService/pdorequest for CRC PDO from input list.

func (Client) CrcPsmReqFromQueryDef

func (c Client) CrcPsmReqFromQueryDef(reqMsgBody *models.CrcPsmReqFromQueryDefMessageBody) (*models.CrcPsmRespMessageBody, error)

CrcPsmReqFromQueryDef makes an i2b2 API request to /QueryToolService/request for CRC PSM from query definition.

func (Client) OntGetCategories

func (c Client) OntGetCategories(reqMsgBody *models.OntReqGetCategoriesMessageBody) (*models.OntRespConceptsMessageBody, error)

OntGetCategories makes an i2b2 API request to /OntologyService/getCategories.

func (Client) OntGetChildren

func (c Client) OntGetChildren(reqMsgBody *models.OntReqGetChildrenMessageBody) (*models.OntRespConceptsMessageBody, error)

OntGetChildren makes an i2b2 API request to /OntologyService/getChildren.

func (Client) OntGetModifierChildren

func (c Client) OntGetModifierChildren(reqMsgBody *models.OntReqGetModifierChildrenMessageBody) (*models.OntRespModifiersMessageBody, error)

OntGetModifierChildren makes an i2b2 API request to /OntologyService/getModifierChildren.

func (Client) OntGetModifierInfo

func (c Client) OntGetModifierInfo(reqMsgBody *models.OntReqGetModifierInfoMessageBody) (*models.OntRespModifiersMessageBody, error)

OntGetModifierInfo makes an i2b2 API request to /OntologyService/getModifierInfo.

func (Client) OntGetModifiers

func (c Client) OntGetModifiers(reqMsgBody *models.OntReqGetModifiersMessageBody) (*models.OntRespModifiersMessageBody, error)

OntGetModifiers makes an i2b2 API request to /OntologyService/getModifiers.

func (Client) OntGetTermInfo

func (c Client) OntGetTermInfo(reqMsgBody *models.OntReqGetTermInfoMessageBody) (*models.OntRespConceptsMessageBody, error)

OntGetTermInfo makes an i2b2 API request to /OntologyService/getTermInfo.