IPrimeSuiteAPI REST API Documentation


ClinicalDocumentSave


Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/ClinicalTemplate/ClinicalDocumentSave

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<ClinicalDocumentSaveRequest>
  <Credentials>
    <PrimeSuiteCredential>
      <PrimeSuiteSiteId>String Content</PrimeSuiteSiteId>
      <PrimeSuiteUserName>String Content</PrimeSuiteUserName>
      <PrimeSuiteUserPassword>String Content</PrimeSuiteUserPassword>
      <PrimeSuiteUserAlias>String Content</PrimeSuiteUserAlias>
    </PrimeSuiteCredential>
    <VendorCredential>
      <VendorLogin>String Content</VendorLogin>
      <VendorPassword>String Content</VendorPassword>
    </VendorCredential>
  </Credentials>
  <Header>
    <SourceSiteID>String Content</SourceSiteID>
    <DestinationSiteID>String Content</DestinationSiteID>
    <PrimeSuiteUserID>0</PrimeSuiteUserID>
  </Header>
  <DocumentID>0</DocumentID>
  <SequenceNumber>0</SequenceNumber>
  <PatientID>0</PatientID>
  <VisitID>0</VisitID>
  <DocumentSaveOption>0</DocumentSaveOption>
  <DocumentType>0</DocumentType>
  <XmlString>String Content</XmlString>
  <SaveComment>String Content</SaveComment>
  <DocumentSource>String Content</DocumentSource>
</ClinicalDocumentSaveRequest>

Request Json Example (schema): 

{
  "Credentials": {
    "PrimeSuiteCredential": {
      "PrimeSuiteSiteId": "String Content",
      "PrimeSuiteUserName": "String Content",
      "PrimeSuiteUserPassword": "String Content",
      "PrimeSuiteUserAlias": "String Content"
    },
    "VendorCredential": {
      "VendorLogin": "String Content",
      "VendorPassword": "String Content"
    }
  },
  "Header": {
    "SourceSiteID": "String Content",
    "DestinationSiteID": "String Content",
    "PrimeSuiteUserID": 0
  },
  "DocumentID": 0,
  "SequenceNumber": 0,
  "PatientID": 0,
  "VisitID": 0,
  "DocumentSaveOption": 0,
  "DocumentType": 0,
  "XmlString": "String Content",
  "SaveComment": "String Content",
  "DocumentSource": "String Content"
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<ClinicalDocumentSaveResponse>
  <DocumentID>0</DocumentID>
  <SequenceNumber>0</SequenceNumber>
  <XmlString>String Content</XmlString>
  <CDAXmlString>String Content</CDAXmlString>
</ClinicalDocumentSaveResponse>

Response Format: Json

Response Example (schema):

{
  "DocumentID": 0,
  "SequenceNumber": 0,
  "XmlString": "String Content",
  "CDAXmlString": "String Content"
}