Functions

The following table lists the functions provided by MyPractice.� In some cases there is additional information available at the end of the table and is accessed by clicking on the Hyperlink.

MyPractice Javascript Integration Interface (Version 1.0) Document History�

Function Call	Category Name	Input parameters	Output Type
Concept	Concepts	1. Element Name, String	String
		2. M Value, String, Optional, Default = " "
GetConcept	Concepts	1. Concept Name, String	String
		2. Order, String, Optional, Default = ""
		3. Start Position, Optional, Default = ""
		4. Number of Rows, Optional, Default = ""
		5. Minimum Value, Optional, Default = ""
		6. Maximum Value, Optional, Default = ""
		7. Minimum Date Time, Optional, Default = ""
		8. Maximum Date Time, Optional, Default = ""
		9. Search String, Optional, Default = ""
		10. Search Concept, Optional, Default = ""
		11. Concept Qualifier, Optional, Default = ""
		12. Reference Id, Optional, Default = ""
getdsLabResults	Concepts	None	dsFFLab
HasMangementPlan		1.Plan name, string	Boolean
AddMangementPlan		1. Plan name, string	Json string

GetConceptDate	Concepts	1. Element Name, String	String
GetConceptOutput	Concepts	1. Concept Name, String	DataTable
		2. Concept Filter, ConceptFilter(type)
GetConceptValue	Concepts	1. Concept Id, String	String
		2. Return As XML, String, Optional, Default = "False"
AddMeasurement	Concepts	1. Code, String	Boolean
		2. Value, String
		3. Entered Date, Date
		4. Units, String
patient_prescribedmedication	Returns all medicines matching the drug group in the qualifier	1. Concept Name, String	Json string. See below for example
		2. Order, String, Optional, Default = ""
		3. Start Position, Optional, Default = ""
		4. Number of Rows, Optional, Default = ""
		5. Minimum Value, Optional, Default = ""
		6. Maximum Value, Optional, Default = ""
		7. Minimum Date Time, Optional, Default = ""
		8. Maximum Date Time, Optional, Default = ""
		9. Search String, Optional, Default = ""
		10. Search Concept, Optional, Default = ""
		11. Concept Qualifier, Optional, Default = ""
		12. Reference Id, Optional, Default = ""
openDocument	Documents	1. Document Name	Boolean
openPrescription	Documents	1. Drug Code, String	Boolean
		2. Frequency, String
		3. Dosage, String
		4. Period, String
AddInvoiceByServiceDescription	Patient Info(Accounts)	1. Service Description, String	Boolean
		2. Invoice Line Data, String
AddInvoice	Patient Info(Accounts)	1. Service Code, String,	String
		2. Invoice No. , String
		3. Amount, Decimal
		4. Invoice Line data, String, Optional
		Default = “"
		5. GST Exclusive, String, Optional
		Default = "false"
GetAddressList	Patient Info(Demographics)	1. Return Format Type, String, Optional, Default = “XML", Options: JSON, XML	String
		2. Address Type, String, Optional, Default = "" e.g home
GetRelationshipList	Patient Info(Demographics)	1. Return Format Type, String, Optional, Default = “XML" Options: JSON, XML	String
		2. Relationship Type, String, Optional, Default = ""
PatientGUID	Patient Info(Demographics)	None	String
GetContactList	Patient Info(Demographics)	1. Return Format Type, String, Optional, Default = “XML" Options: JSON, XML	String
		2. Contact Type, String, Optional, Default = "" e.g HomePhone
GetFamilyMembersList	Patient Info(Demographics)	1. Return Format Type, String, Optional, Default = "XML" Options: JSON, XML	String
GetSchemesList	Patient Info(Demographics)	1. Return Format Type, String, Optional, Default = “XML" Options: JSON, XML	String
		2. Scheme Name, String, Optional, Default = "" e.g CSC, High User, Capitation, Careplus

PMSName	Practice/PMS Details	None	String
GetProfilesList	Profiles	1. Return Format Type, String, Optional, Default = “XML" Options: JSON, XML	String
		2. Profile Section, String, Optional, Default = "Current Problem"
		3. Description, String, Optional, Default = "" e.g
		4. Code, String, Optional, Default = "" e.g
AddOrResetRecall	Recalls	1. Type, String	Boolean
		2. Code, String
		3. Days, Integer
		4. Note, String
addRecall	Recalls	1. Type, String	Boolean
		2. Code, String
		3. Days, Integer
		4. Note, String
CompleteRecall	Recalls	1. Type, String	Boolean
		2. Task Code, String
OpenWebForm		1. Form name	URL as a string

SendToHealthLink	Save/Close WebForm	1. File Name, String	String
		2. Sub Directory, String
		3. Text, String
TranslateURL	Save/Close WebForm	1. URL, String	String
AuthorisingPrac_RegistrationNo	Staff Details	None	String
AuthorisingPrac_LastName	Staff Details	None	String
ProvRegNo	Staff Details	None	String
PreferredPrac_FirstName	Staff Details	None	String
UserOccupation	Staff Details	None	String
PreferredPrac_RegistrationNo	Staff Details	None	String
PreferredPrac_LastName	Staff Details	None	String
AuthorisingPrac_FirstName	Staff Details	None	String
SaveCurrentDocumentAsHtml	Web Form Save Options	1. Title, String	Boolean
		2. Html, String, Optional, Default = ""
		3. Misc, String, Optional, Default = ""
		4. h, String, Optional, Default = ""
SaveAsTextDocument	Web Form Save Options	1. Title, String	Boolean
		2. Text Content, String
SaveAsHtmlDocument	Web Form Save Options	1. Title, String	Boolean
		2. HTML Content, String
SaveCurrentDocumentAsHtml	Web Form Save Options	1. Title, String	Boolean
SaveAsTextDocument			Boolean
CancelWebForm
CloseWebForm
HideCloseButton
SaveAsAttachmentWithCertificate	Web Form Save Options	1. URL, String	String
		2. File Name, String
		3. Client Certificate Hash, String
SaveAsAttachment	Web Form Save Options	1. URL, String	String
		2. File Name, String
SaveCurrentDocumentAsMht	Web Form Save Options	1. Title, String	Boolean
		2. Html, String, Optional, Default = ""
		3. Misc, String, Optional, Default = ""
		4. h, String, Optional, Default = ""
GetConceptTest		1. conceptName, String	String
		2. myOrder, Strin, Optional, Default = ""
		3. myStartPosition Optional, Default = ""
		4. myNumRows Optional, Default = ""
		5. myMinValue Optional, Default = ""
		6. myMaxValue Optional, Default = ""
		7. myMinDateTime Optional, Default = ""
		8. myMaxDateTime Optional, Default = ""
		9. mySearchString Optional, Default = ""
		10. mySearchConcept As String = "",
		11. myConceptQualifier Optional, Default = ""
		12. myReferenceId Optional, Default = ""

GetConcept

function GetConcept(conceptName,[order],[startPosition],[numRows],[minValue],[maxValue],[minDateTime],[maxDateTime],[searchString],[searchConcept],[conceptQualifier],[referenceId])

conceptName�refers to a concept within the Online Forms Architecturedata concepts list and may reference a list concept or a value property.

The full list of concept names can be found�here:
https://staging-1.mypractice.co.nz/developer/implementedconceptlist

order�?�specifies the order that the items are returned in. The options datedescend, dateascend, valuedescend and valueascend.�?� The default value is datedescend:

startPosition�specifies the starting row to return items from

numRows specifies�?�specifies the maximum number of items to be returned.

minValue�the value of the concept must equal or exceed this value to be returned.

maxValue�?�the value of the concept must equal or be less than this value to be returned.

minDateTime�the timestamp of the concept must equal or exceed this value.

maxDateTime�the timestamp of the concept must equal or be less than this value to be returned.

searchString�the item must contain this sub string to be included in the information returned.

searchConcept�not implemented yet..

Qualifier�is an optional parameter to request a subset of data from the concept using fully qualified SNOMED concept names or in specific cases a code from another code set. Where the code system is not SNOMED then the code system is identified in the concept list. This is used for requesting specific patient measurements such as the patient�?s blood pressure, height, weight etc.?� a forms provider uses the following SNOMED concepts to extract measurements from the PMS

�blood pressure (observable entity) 75367002
�body height measure (observable entity) 50373000�
�body weight (observable entity) 27113001

ReferenceId�is an optional parameter to request a specific item in a concept list matching the PMS reference id.?� This avoids iteration through the list to get a specific list item.?� The reference id could be a GUID or primary key that is generated by the PMS

Data is returned in the JSON format as in the following example.

{�Patient_MedicationRegular_Exists�:[
{
“Patient_MedicationRegular_Exists”:”True”,
“Date”:”2014-05-14T10:05:17.000″,
“ReferenceID”:”00000000-0000-0000-0000-000000000000″
}

]}

patient_prescribedmedication

This function uses the same modifiers as GetConcept.� The example below is looking for prescriptions within a date range that have a medicine that belongs to the drug group (ATC) code C09A.� This differs from the normal use of the qualifier as it is not a Snomed-CT code.

“window.external.concept(‘patient_prescribedmedication”,”,”,”,”,”,’2012-06-01′,’2012-06-30′,”,”,’C09A’,”)

The Json result is shown below:

{
“patient_prescribedmedication”:[
{
“Patient_PrescribedMedication_Administrationinstructions”:”OD”,
“Date”:”2012-07-04T15:14:00.000″,
“ReferenceID”:”ab59bb52-ebc0-4cf0-90a4-b0247c771e47″,
“Patient_PrescribedMedication_BrandName”:”Inhibace�-�cilazapril�5�mg�tablet”,
“Patient_PrescribedMedication_Code”:”C09AA08″,
“Patient_PrescribedMedication_CodingSystem”:”ATC�Code”,
“Patient_PrescribedMedication_DispensedQuantity”:”90″,
“Patient_PrescribedMedication_DispensedUnit”:”Tablets”,
“Patient_PrescribedMedication_GenericName”:”cilazapril�5�mg�tablet”,
“Patient_PrescribedMedication_Name”:”Inhibace�Tab�5�mg”,
“Patient_PrescribedMedication_PrescribedDate”:”2012-07-04″
},
{
“Patient_PrescribedMedication_Administrationinstructions”:”OD”,
“Date”:”2012-06-13T11:47:00.000″,
“ReferenceID”:”ac39622d-f45b-4f45-abdd-d180bb365c56″,
“Patient_PrescribedMedication_BrandName”:”Zapril�-�cilazapril�5�mg�tablet”,
“Patient_PrescribedMedication_Code”:”C09AA08″,
“Patient_PrescribedMedication_CodingSystem”:”ATC�Code”,
“Patient_PrescribedMedication_DispensedQuantity”:”90″,
“Patient_PrescribedMedication_DispensedUnit”:”Tablets”,
“Patient_PrescribedMedication_GenericName”:”cilazapril�5�mg�tablet”,
“Patient_PrescribedMedication_Name”:”Zapril�Tab�5�mg”,
“Patient_PrescribedMedication_PrescribedDate”:”2012-06-13″
},

}

Top

Find you way back…

Functions

GetConcept

patient_prescribedmedication