POST api/ContentPatientEducationStatements

The ContentPatientEducationStatements method returns the Patient Education Sheet statements. All formatting and special characters have been removed from the sheet to allow for customization and to enable use in mainframe terminal systems without web browser technology.

Patient Education sheets statements are available in various languages (refer to documentation for complete list of languages).


Request Information

URI Parameters

None.

Body Parameters

ContentPatientEducationStatementsRequest
NameDescriptionTypeAdditional information
DrugIdentifier The drug identifer to retrieve the patient education sheet for. PedcDrugIdentifier

Required

LanguageCode Enter the language code. Defaults to en-US (English US) if input language code is not input. string

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:
{
  "DrugIdentifier": {
    "IdType": "SpecificProductId",
    "Id": "1"
  },
  "LanguageCode": "es-ES",
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ContentPatientEducationStatementsResponse
NameDescriptionTypeAdditional information
Languages A collection of language codes the sheet is available in. Collection of string

None.

SheetLanguageCode The sheet language code. string

None.

SheetId The sheet identifier. integer

None.

SheetStatements Search results Collection of PatientEdSheetStatementItem

None.

GenericProductClinicalId The sheet Generic Product Clinical concept identifier mapping. integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Languages": [
    "Sample Languages text.",
    "Sample Languages text."
  ],
  "SheetLanguageCode": "Sample SheetLanguageCode text.",
  "SheetId": 1,
  "SheetStatements": [
    {
      "SectionId": 2,
      "NodeId": 3,
      "DisplayOrder": 2,
      "Statement": "Sample Statement text."
    },
    {
      "SectionId": 4,
      "NodeId": 5,
      "DisplayOrder": 2,
      "Statement": "Sample Statement text."
    }
  ],
  "GenericProductClinicalId": 6
}