POST api/ListSigFrequencies

Returns specific SIG frequency details and the associated SNOMED codes, based on the supplied filters. If available, returns label and alternate SIGs. Includes a ‘MaxResults’ option that allows you to limit the number of results returned.


Request Information

URI Parameters

None.

Body Parameters

ListSigFrequenciesRequest
NameDescriptionTypeAdditional information
FilterType The type of filter to search. This is ignored if the Filter is not set. SigFrequencyFilterEnum

None.
Filter The identifier or concept name to search. This is ignored if the FilterType is not set. 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": "SigFrequencyText",
  "Filter": "%name%",
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListSigFrequenciesResponse
NameDescriptionTypeAdditional information
SigFrequencies A collection of SIG frequency information. Collection of SigFrequency

None.

Response Formats

application/json, text/json

Sample: 
{
  "SigFrequencies": [
    {
      "SigFrequencyId": 1,
      "SNOMEDCT": "Sample SNOMEDCT text.",
      "QualifierFrequencyText": "Sample QualifierFrequencyText text.",
      "LabelSig": "Sample LabelSig text.",
      "AlternateSig": "Sample AlternateSig text.",
      "DosesPerDay": 1.234
    },
    {
      "SigFrequencyId": 2,
      "SNOMEDCT": "Sample SNOMEDCT text.",
      "QualifierFrequencyText": "Sample QualifierFrequencyText text.",
      "LabelSig": "Sample LabelSig text.",
      "AlternateSig": "Sample AlternateSig text.",
      "DosesPerDay": 1.234
    }
  ]
}