Request

Documentation

Index

• type Camera
• type Image
• type ImageDictionary
• type Order
• type OrderRequest
  • func NewOrderRequest(clientGuid string, evaluationType string, orderControlCode string) OrderRequest
• type PCP
• type Patient
• type RequestAzureBlobStorage

Types

type Camera

type Camera struct {
	/// Collection of images assocated with the camera for this order
	Images []Image
}

type Image

type Image struct {
	// Id of image as specified by the submitting organization.
	LocalId string

	// Timestamp when Image was taken
	DateTimeOffset string

	// Laterality of image
	Laterality string

	// Context of Image
	ImageContext string

	// Optional Grouping context
	GroupId int

	// Optional Ordinal of image in group context by results receiving organization
	GroupOrdinal int

	// If specified this is the Id of the parent image for this image
	ParentLocalId string

	// Details of image location uploaded in Azure blob storage
	AzureBlobStorage RequestAzureBlobStorage
}

type ImageDictionary

type ImageDictionary struct {
	Images []Image
}

type Order

type Order struct {

	// Date/Time offset when order was created
	CreatedTime string

	// Date/Time offset when order is scheduled for image capture
	ScheduledTime string

	// Id for the order as specified by the submission source
	LocalId string

	// US State where the images are being taken.  Can be full name or 2 character abbreviation
	State string

	// If true images will be taken for a single eye only
	// Setting this value to true will prevent an order from delaying in wait of images for both eyes
	SingleEyeOnly bool

	// If the order is to have only one eye, this specifies the reason
	MissingEyeReason string

	// Unspecified additional information to include in the order
	AdditionalInfo string

	// If desired include the Encounter number
	EncounterNumber string

	// Specifies one or more evaluation types of the following Options
	// DR=Diabetic Retinopathy exam, Glaucoma=Glaucoma exam, HIV=HIV Retinopathy exam, AMD=Age-Related Macular Degeneration exam,
	// DR_AMD=Combined Diabetic Retinopathy & Age-Related Macular Degeneration exam
	EvaluationTypes []string

	// Typically a value from DICOM
	StudyInstanceUniqueId string

	// Department Id associated with order
	DepartmentId string

	// Open field for specific identifier of order. This is for support of EMR/EHR systems that use this concept
	OrderableIdentifier string

	CPTCode string
}

Contains Details for the order

type OrderRequest

type OrderRequest struct {

	// IRIS Request version
	Version string

	// Identifies the submission source organization
	ClientGuid string

	// Site the exam is being taken from
	Site Shared.Site

	// Username of the user submitting this order
	UserNameSubmitting string

	// Type of order request
	// NW = New Order, XO = Change order, CA = Cancel Order, ResendResult = Requesting resend of results
	OrderControlCode string

	// Camera associated with the request
	Camera Camera

	// Order specific data
	Order Order

	// Patient specific data
	Patient Patient

	// Medical provider ordering the exam
	OrderingProvider Shared.Provider

	// Medical provider referring patient for exam
	ReferringProvider Shared.Provider

	// Camera Operator performing the exam
	CameraOperator Shared.Provider

	// Username (login) for camera operator
	CameraOperatorUserName string

	// HealthPlan information associated with the request
	HealthPlan Shared.HealthPlan
}

Structure used to send an order to IRIS

func NewOrderRequest

func NewOrderRequest(clientGuid string, evaluationType string, orderControlCode string) OrderRequest

Return a new OrderRequest object with required fields

type PCP

type PCP struct {

	// Providers Name
	Name Shared.PersonName

	// Providers National ID number
	NPI string

	// Email Address for results
	EmailAddress string

	// Fax number for results
	FaxNumber string
}

type Patient

type Patient struct {

	// Id as specified by the client.  Typically MRN
	LocalId string

	// Patient Name details
	Name Shared.PersonName

	// Patient Date of birth
	Dob string

	// Patient Gender -- Obsolete("Use Genders")
	Gender string

	// Patient phone number
	Phone string

	// List of person genders
	Genders []Shared.PersonGender

	// Gender Race code
	// 1002-5: American Indian or Alaska Native
	// 2028-9: Asian
	// 2054-5: Black or African American
	// 2076-8: Native Hawaiian or Other Pacific Islander
	// 2131-1: Other Race
	// 2106-3: White
	Race string

	// Ethnicity code
	Ethnicity string

	// Language Code es=Spanish, fr=French, en-US=English(United States), etc...
	PrimaryLanguage string

	// Marital Status single letter code
	MaritalStatus string

	// Email address for patient
	Email string

	// Free form additonal information specific to the patient
	AdditionalInfo string

	// Patient Address Details
	Address Shared.Address

	// ICD-10 Code diagnosed that supports the exam
	DxCode string
}

Patient details for order

type RequestAzureBlobStorage

type RequestAzureBlobStorage struct {

	// Blob Storage Container
	Container string

	// Azure File Name
	FileName string
}

Details for loaction of file in Azure Blob Storage