POST api/ListSigAdminMethods

Returns a list of SIG administration methods and the associated SNOMED codes, based on supplied identifiers and filters. Includes a ‘MaxResults’ option that allows you to limit the number of results returned.

‘SIG’ is Latin for ‘instruction’ and refers to ‘a method of communication between the physician and the pharmacists on how the medication is to be taken; ‘doctor shorthand’. The various pieces of a SIG are put together to form a complete thought.

API Method Test Client

Request Information

URI Parameters

None.

Body Parameters

ListSigAdminMethodsRequest

Name	Description	Type	Additional information
FilterType	The type of filter to search.	SigAdminMethodFilterEnum	None.
Filter	The identifier or concept name to search.	string	None.
MaxResults	Limits the number of results returned. A null value means no limit, and everthing will be returned.	integer	None.
AccessToken	Temporary access token from the GSDD Auth API. Used to validate your license. Note: Access tokens are temporary and may be invalidated early for various reasons, including—but not limited to—site maintenance and security updates. If a token is invalidated prematurely, simply request new tokens via the AccessToken method in the GSDD Auth API. This is a rather rare occurrence, but should be planned for and handled by the consuming application.	string	Required

Request Formats

application/json, text/json

Sample:

{
  "FilterType": "SigAdminMethodText",
  "Filter": "%name%",
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListSigAdminMethodsResponse

Name	Description	Type	Additional information
SigAdminMethods	Returns the. output parameters for the SIG Administration Method details, based on supplied filters	Collection of SigAdminMethod	None.

Response Formats

application/json, text/json

Sample:

{
  "SigAdminMethods": [
    {
      "SigAdminMethodId": 1,
      "AdminMethod": "Sample AdminMethod text.",
      "SNOMEDCT": "Sample SNOMEDCT text."
    },
    {
      "SigAdminMethodId": 2,
      "AdminMethod": "Sample AdminMethod text.",
      "SNOMEDCT": "Sample SNOMEDCT text."
    }
  ]
}