Internal Medication API Subsystem - Revision history

Eumhoefer: Eumhoefer moved page Medication API Subsystem to Internal Medication API Subsystem

2017-07-10T18:23:50Z

← Older revision	Revision as of 18:23, 10 July 2017
(No difference)

2017-07-10T16:44:11Z

Added Internal to GCAPI

← Older revision		Revision as of 16:44, 10 July 2017
Line 1:		Line 1:

	The Medication subsystem allows you to manage medications and medication schedules from a system via [[GCAPI]].		The Medication subsystem allows you to manage medications and medication schedules from a system via [[Internal GCAPI]].
	= Operations =		= Operations =
	== createPrescription ==		== createPrescription ==

2017-07-10T15:20:40Z

Fixed spelling of 'Ndc' so that it links correctly

← Older revision		Revision as of 15:20, 10 July 2017
Line 11:		Line 11:
	* ''brandName'' - [optional] - Proprietary Name		* ''brandName'' - [optional] - Proprietary Name
	* ''simpleName'' - [optional] - Display name, default ''brandName''		* ''simpleName'' - [optional] - Display name, default ''brandName''
	* ''[[Internal ~~ndc~~]]'' - [optional] - FDA's NDC code		* ''[[Internal Ndc]]'' - [optional] - FDA's NDC code
	* ''manufacturer'' - [optional] - Medication labeler		* ''manufacturer'' - [optional] - Medication labeler
	* ''description'' - [optional] - Medication description		* ''description'' - [optional] - Medication description
Line 87:		Line 87:
	Looks up medication via FDA NDC Directory		Looks up medication via FDA NDC Directory
	=== Parameters ===		=== Parameters ===
	* ''rxsearch'' - [required] - Free form search string or [[Internal ~~ndc~~\|NDC]] code		* ''rxsearch'' - [required] - Free form search string or [[Internal Ndc\|NDC]] code

	=== Results ===		=== Results ===

2017-07-10T15:16:33Z

Changed NDC page name to Internal NDC

← Older revision		Revision as of 15:16, 10 July 2017
Line 11:		Line 11:
	* ''brandName'' - [optional] - Proprietary Name		* ''brandName'' - [optional] - Proprietary Name
	* ''simpleName'' - [optional] - Display name, default ''brandName''		* ''simpleName'' - [optional] - Display name, default ''brandName''
	* ''[[ndc]]'' - [optional] - FDA's NDC code		* ''[[Internal ndc]]'' - [optional] - FDA's NDC code
	* ''manufacturer'' - [optional] - Medication labeler		* ''manufacturer'' - [optional] - Medication labeler
	* ''description'' - [optional] - Medication description		* ''description'' - [optional] - Medication description
Line 87:		Line 87:
	Looks up medication via FDA NDC Directory		Looks up medication via FDA NDC Directory
	=== Parameters ===		=== Parameters ===
	* ''rxsearch'' - [required] - Free form search string or [[ndc\|NDC]] code		* ''rxsearch'' - [required] - Free form search string or [[Internal ndc\|NDC]] code

	=== Results ===		=== Results ===

2012-08-27T17:40:09Z

Parameters

← Older revision		Revision as of 17:40, 27 August 2012
Line 87:		Line 87:
	Looks up medication via FDA NDC Directory		Looks up medication via FDA NDC Directory
	=== Parameters ===		=== Parameters ===
	* ''rxsearch'' - [required] - Free form search string or NDC code		* ''rxsearch'' - [required] - Free form search string or [[ndc\|NDC]] code

	=== Results ===		=== Results ===
	==== json ====		==== json ====

2012-08-27T17:37:01Z

Parameters

← Older revision		Revision as of 17:37, 27 August 2012
Line 11:		Line 11:
	* ''brandName'' - [optional] - Proprietary Name		* ''brandName'' - [optional] - Proprietary Name
	* ''simpleName'' - [optional] - Display name, default ''brandName''		* ''simpleName'' - [optional] - Display name, default ''brandName''
	* ''ndc'' - [optional] - FDA's NDC code		* ''[[ndc]]'' - [optional] - FDA's NDC code
	* ''manufacturer'' - [optional] - Medication labeler		* ''manufacturer'' - [optional] - Medication labeler
	* ''description'' - [optional] - Medication description		* ''description'' - [optional] - Medication description

2012-08-27T17:35:14Z

RxLookup

← Older revision		Revision as of 17:35, 27 August 2012
Line 86:		Line 86:
	== RxLookup ==		== RxLookup ==
	Looks up medication via FDA NDC Directory		Looks up medication via FDA NDC Directory
			=== Parameters ===
			* ''rxsearch'' - [required] - Free form search string or NDC code
	=== Results ===		=== Results ===
	==== json ====		==== json ====

2012-08-27T17:31:55Z

readPrescription

← Older revision		Revision as of 17:31, 27 August 2012
Line 72:		Line 72:
	=== Results ===		=== Results ===
	Returns SUCCESS and a single medication or all medications in the following format:		Returns SUCCESS and a single medication or all medications in the following format:
	~~==== xml ====~~
	~~<gcapi>~~
	~~<result>SUCCESS</result>~~
	~~<medication>~~
	~~<id>5f3e081d-e6af-4dd6-a6b8-dd4d8890e611</id>~~
	~~<firstname>Shirley</firstname>~~
	~~<lastname>Doe</lastname>~~
	~~<address>2412 West Washington Ave</address>~~
	~~<city>West Bend</city>~~
	~~<state>WI</state>~~
	~~<zipcode>53095</zipcode>~~
	~~<homephone>2623349394</homephone>~~
	~~<workphone>2623386147</workphone>~~
	~~<cellphone>2626896732</cellphone>~~
	~~<pager></pager>~~
	~~<email>shirley@grandcare.com</email>~~
	~~</medication>~~
	~~</gcapi>~~

	~~==== json ====~~
	{
	~~"gcapi": {~~
	~~"result": "SUCCESS",~~
	~~"medication": [~~
	{
	~~"id": "5f3e081d-e6af-4dd6-a6b8-dd4d8890e611",~~
	~~"firstname": "Shirley",~~
	~~"lastname": "Doe",~~
	~~"address": "2412 West Washington Ave",~~
	~~"city": "West Bend",~~
	~~"state": "WI",~~
	~~"zipcode": "53095",~~
	~~"homephone": "2623349394",~~
	~~"workphone": "2623386147",~~
	~~"cellphone": "2626896732",~~
	~~"pager": "",~~
	~~"email": "shirley@grandcare.com"~~
	}
	]
	}
	}

	== updatePrescription ==		== updatePrescription ==

2012-08-27T17:31:36Z

delete

← Older revision		Revision as of 17:31, 27 August 2012
Line 117:		Line 117:
	Updates an existing medication		Updates an existing medication

	== ~~delete~~ ==		== deletePrescription ==
	Deletes an existing medication		Deletes an existing medication
	=== Parameters ===		=== Parameters ===

2012-08-27T17:31:21Z

update

← Older revision		Revision as of 17:31, 27 August 2012
Line 114:		Line 114:
	}		}

	== ~~update~~ ==		== updatePrescription ==
	Updates an existing medication		Updates an existing medication
	~~=== Parameters ===~~
	* ''id'' - [required] - ID of medication to update
	* ''firstname'' - [optional] - First name
	* ''lastname'' - [optional] - Last name
	* ''email'' - [optional] - Email address
	* ''address'' - [optional] - Street address
	* ''city'' - [optional] - City
	* ''state'' - [optional] - State
	* ''zip'' - [optional] - Zip code
	* ''homephone'' - [optional] - Home phone number
	* ''workphone'' - [optional] - Work phone number
	* ''cellphone'' - [optional] - Cell phone number
	* ''pager'' - [optional] - Pager phone number

	~~=== Results ===~~
	~~Returns SUCCESS and a copy of the newly updated medication if successful, otherwise FAILURE. See the [[#read]] method for more information on the returned medication object.~~

	== delete ==		== delete ==