GET api/v1/patiented/sheetstatements?drugId={drugId}&drugIdType={drugIdType}&languageId={languageId}&formatted={formatted}

Get the Patient Education sheet statments for a drug identifier

Request Information

URI Parameters

Name	Description	Type	Additional information
drugId	Drug Identifier. Accepts formatted and unformatted identifiers.	string	Required
drugIdType	Drug Identifier Type	DrugIdentifierEnum	Required
languageId	Language Identifier	integer	Default value is 1
formatted	Return statements with HTML formatting.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

A list of PatientEd sheet statements for the input drug identifier in the given language if it exists.

PatientEdSheetStatements

Name	Type	Additional information
languages	Collection of Language	None.
sheetLanguage	Language	None.
sheetId	integer	None.
sheetStatements	Collection of PatientEdSheetStatementItem	None.
gpcId	integer	None.
cpNum	integer	None.
_links	Collection of Link	None.
_languages	Collection of LanguagesLink	None.

Response Codes

Code	Description	Additional information
200	OK	The request returned without error
204	No Content	The request was successful but no results were returned
400	Bad Request	A parameter was missing or invalid
404	Not Found	The requested resource was not found

Response Formats

application/json, text/json

Sample:

{
  "languages": [
    {
      "id": 1,
      "name": "sample string 2",
      "locale": "sample string 3",
      "rtl": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "locale": "sample string 3",
      "rtl": true
    }
  ],
  "sheetLanguage": {
    "id": 1,
    "name": "sample string 2",
    "locale": "sample string 3",
    "rtl": true
  },
  "sheetId": 1,
  "sheetStatements": [
    {
      "sectionId": 1,
      "nodeId": 2,
      "displayOrder": 3,
      "statement": "sample string 4"
    },
    {
      "sectionId": 1,
      "nodeId": 2,
      "displayOrder": 3,
      "statement": "sample string 4"
    }
  ],
  "gpcId": 1,
  "cpNum": 1,
  "_links": [
    {
      "rel": "sample string 1",
      "locale": "sample string 4",
      "href": "sample string 2",
      "templated": true
    },
    {
      "rel": "sample string 1",
      "locale": "sample string 4",
      "href": "sample string 2",
      "templated": true
    }
  ],
  "_languages": [
    {
      "rel": "sample string 1",
      "locale": "sample string 3",
      "name": "sample string 4",
      "href": "sample string 2"
    },
    {
      "rel": "sample string 1",
      "locale": "sample string 3",
      "name": "sample string 4",
      "href": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<patientEdSheetStatements xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.PatientEd">
  <_languages xmlns="">
    <languageslink>
      <rel>sample string 1</rel>
      <locale>sample string 3</locale>
      <name>sample string 4</name>
      <href>sample string 2</href>
    </languageslink>
    <languageslink>
      <rel>sample string 1</rel>
      <locale>sample string 3</locale>
      <name>sample string 4</name>
      <href>sample string 2</href>
    </languageslink>
  </_languages>
  <_links xmlns="">
    <link>
      <rel>sample string 1</rel>
      <locale>sample string 4</locale>
      <href>sample string 2</href>
      <templated>true</templated>
    </link>
    <link>
      <rel>sample string 1</rel>
      <locale>sample string 4</locale>
      <href>sample string 2</href>
      <templated>true</templated>
    </link>
  </_links>
  <cpNum>1</cpNum>
  <gpcId>1</gpcId>
  <languages>
    <language xmlns="">
      <id>1</id>
      <locale>sample string 3</locale>
      <name>sample string 2</name>
      <rtl>true</rtl>
    </language>
    <language xmlns="">
      <id>1</id>
      <locale>sample string 3</locale>
      <name>sample string 2</name>
      <rtl>true</rtl>
    </language>
  </languages>
  <sheetId>1</sheetId>
  <sheetLanguage>
    <id xmlns="">1</id>
    <locale xmlns="">sample string 3</locale>
    <name xmlns="">sample string 2</name>
    <rtl xmlns="">true</rtl>
  </sheetLanguage>
  <sheetStatements>
    <PatientEdSheetStatementItem>
      <displayOrder>3</displayOrder>
      <nodeId>2</nodeId>
      <sectionId>1</sectionId>
      <statement>sample string 4</statement>
    </PatientEdSheetStatementItem>
    <PatientEdSheetStatementItem>
      <displayOrder>3</displayOrder>
      <nodeId>2</nodeId>
      <sectionId>1</sectionId>
      <statement>sample string 4</statement>
    </PatientEdSheetStatementItem>
  </sheetStatements>
</patientEdSheetStatements>