GET api/HealthInformationUpdatePreview?pghdUpdateRequestId={pghdUpdateRequestId}

Get the preview of patient health information update request.

Request Information

URI Parameters

Name	Description	Type	Additional information
pghdUpdateRequestId	Unique ID of health information update request.	integer	None.

Body Parameters

None.

Response Information

Resource Description

HealthInformationUpdatePreviewModel

Name	Description	Type	Additional information
PghdUpdateRequestId	Unique ID of health information update request.	integer	None.
Created	Date of update request.	string	None.
AlreadySent	Indicates if request is sent ot not.	boolean	None.
Demographics	List of fields requested for demographics data update.	Collection of Pair of string [key] and string [value]	None.
PhoneNumbers	List of phone numbers requested for changes.	Collection of PatientPhoneNumberModel	None.
Medications	List of medications requested for changes.	Collection of PatientMedicationUpdateRequestModel	None.
Allergies	List of allergies requested for changes.	Collection of PatientAllergyRequestModel	None.
Insurances	List of insurances requested for changes.	Dictionary of string [key] and Collection of Pair of string [key] and string [value] [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "PghdUpdateRequestId": 1,
  "Created": "sample string 1",
  "AlreadySent": true,
  "Demographics": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "PhoneNumbers": [
    {
      "Alias": "sample string 1",
      "OriginalNumber": "sample string 2",
      "OriginalDefaultPhoneNumber": true,
      "OriginalSortOrder": 4,
      "OriginalUseForSms": true,
      "UpdatedNumber": "sample string 6",
      "UpdatedDefaultPhoneNumber": true,
      "UpdatedSortOrder": 8,
      "UpdatedUseForSms": true
    },
    {
      "Alias": "sample string 1",
      "OriginalNumber": "sample string 2",
      "OriginalDefaultPhoneNumber": true,
      "OriginalSortOrder": 4,
      "OriginalUseForSms": true,
      "UpdatedNumber": "sample string 6",
      "UpdatedDefaultPhoneNumber": true,
      "UpdatedSortOrder": 8,
      "UpdatedUseForSms": true
    }
  ],
  "Medications": [
    {
      "PatientMedicationUpdateRequestId": 1,
      "PatientMedicationRecordId": 1,
      "MedicationId": 1,
      "MedicationExternalId": "sample string 1",
      "MedicationName": "sample string 2",
      "MedicationDosageId": 1,
      "MedicationDosageExternalId": "sample string 3",
      "MedicationDosageName": "sample string 4",
      "MedicationFormTypeId": 1,
      "MedicationFormTypeExternalId": "sample string 5",
      "MedicationFormTypeName": "sample string 6",
      "MedicationFrequencyId": 1,
      "MedicationFrequencyExternalId": "sample string 7",
      "MedicationFrequencyName": "sample string 8",
      "MedicationRouteId": 1,
      "MedicationRouteExternalId": "sample string 9",
      "MedicationRouteName": "sample string 10",
      "StartDate": "sample string 11",
      "EndDate": "sample string 12",
      "Notes": "sample string 13",
      "EyeMedication": true,
      "Operation": "sample string 15"
    },
    {
      "PatientMedicationUpdateRequestId": 1,
      "PatientMedicationRecordId": 1,
      "MedicationId": 1,
      "MedicationExternalId": "sample string 1",
      "MedicationName": "sample string 2",
      "MedicationDosageId": 1,
      "MedicationDosageExternalId": "sample string 3",
      "MedicationDosageName": "sample string 4",
      "MedicationFormTypeId": 1,
      "MedicationFormTypeExternalId": "sample string 5",
      "MedicationFormTypeName": "sample string 6",
      "MedicationFrequencyId": 1,
      "MedicationFrequencyExternalId": "sample string 7",
      "MedicationFrequencyName": "sample string 8",
      "MedicationRouteId": 1,
      "MedicationRouteExternalId": "sample string 9",
      "MedicationRouteName": "sample string 10",
      "StartDate": "sample string 11",
      "EndDate": "sample string 12",
      "Notes": "sample string 13",
      "EyeMedication": true,
      "Operation": "sample string 15"
    }
  ],
  "Allergies": [
    {
      "PatientAllergyUpdateRequestId": 1,
      "PatientAllergyId": 1,
      "AllergyId": 1,
      "AllergyExternalId": "sample string 1",
      "AllergyName": "sample string 2",
      "AllergySeverityId": 1,
      "AllergySeverityExternalId": "sample string 3",
      "AllergySeverityName": "sample string 4",
      "AllergyReactionId": 1,
      "AllergyReactionExternalId": "sample string 5",
      "AllergyReactionName": "sample string 6",
      "StartDate": "2025-04-03T18:34:25.9327627-04:00",
      "Notes": "sample string 7",
      "Operation": "sample string 8"
    },
    {
      "PatientAllergyUpdateRequestId": 1,
      "PatientAllergyId": 1,
      "AllergyId": 1,
      "AllergyExternalId": "sample string 1",
      "AllergyName": "sample string 2",
      "AllergySeverityId": 1,
      "AllergySeverityExternalId": "sample string 3",
      "AllergySeverityName": "sample string 4",
      "AllergyReactionId": 1,
      "AllergyReactionExternalId": "sample string 5",
      "AllergyReactionName": "sample string 6",
      "StartDate": "2025-04-03T18:34:25.9327627-04:00",
      "Notes": "sample string 7",
      "Operation": "sample string 8"
    }
  ],
  "Insurances": {
    "sample string 1": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "sample string 2": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<HealthInformationUpdatePreviewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.RequestHistories">
  <Allergies xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.PatientAllergies">
    <d2p1:PatientAllergyRequestModel>
      <d2p1:AllergyExternalId>sample string 1</d2p1:AllergyExternalId>
      <d2p1:AllergyId>1</d2p1:AllergyId>
      <d2p1:AllergyName>sample string 2</d2p1:AllergyName>
      <d2p1:AllergyReactionExternalId>sample string 5</d2p1:AllergyReactionExternalId>
      <d2p1:AllergyReactionId>1</d2p1:AllergyReactionId>
      <d2p1:AllergyReactionName>sample string 6</d2p1:AllergyReactionName>
      <d2p1:AllergySeverityExternalId>sample string 3</d2p1:AllergySeverityExternalId>
      <d2p1:AllergySeverityId>1</d2p1:AllergySeverityId>
      <d2p1:AllergySeverityName>sample string 4</d2p1:AllergySeverityName>
      <d2p1:Notes>sample string 7</d2p1:Notes>
      <d2p1:Operation>sample string 8</d2p1:Operation>
      <d2p1:PatientAllergyId>1</d2p1:PatientAllergyId>
      <d2p1:PatientAllergyUpdateRequestId>1</d2p1:PatientAllergyUpdateRequestId>
      <d2p1:StartDate>2025-04-03T18:34:25.9327627-04:00</d2p1:StartDate>
    </d2p1:PatientAllergyRequestModel>
    <d2p1:PatientAllergyRequestModel>
      <d2p1:AllergyExternalId>sample string 1</d2p1:AllergyExternalId>
      <d2p1:AllergyId>1</d2p1:AllergyId>
      <d2p1:AllergyName>sample string 2</d2p1:AllergyName>
      <d2p1:AllergyReactionExternalId>sample string 5</d2p1:AllergyReactionExternalId>
      <d2p1:AllergyReactionId>1</d2p1:AllergyReactionId>
      <d2p1:AllergyReactionName>sample string 6</d2p1:AllergyReactionName>
      <d2p1:AllergySeverityExternalId>sample string 3</d2p1:AllergySeverityExternalId>
      <d2p1:AllergySeverityId>1</d2p1:AllergySeverityId>
      <d2p1:AllergySeverityName>sample string 4</d2p1:AllergySeverityName>
      <d2p1:Notes>sample string 7</d2p1:Notes>
      <d2p1:Operation>sample string 8</d2p1:Operation>
      <d2p1:PatientAllergyId>1</d2p1:PatientAllergyId>
      <d2p1:PatientAllergyUpdateRequestId>1</d2p1:PatientAllergyUpdateRequestId>
      <d2p1:StartDate>2025-04-03T18:34:25.9327627-04:00</d2p1:StartDate>
    </d2p1:PatientAllergyRequestModel>
  </Allergies>
  <AlreadySent>true</AlreadySent>
  <Created>sample string 1</Created>
  <Demographics xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </Demographics>
  <Insurances xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfKeyValuePairOfstringstringtwCi8m_S7>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:KeyValuePairOfstringstring>
          <d4p1:key>sample string 1</d4p1:key>
          <d4p1:value>sample string 2</d4p1:value>
        </d4p1:KeyValuePairOfstringstring>
        <d4p1:KeyValuePairOfstringstring>
          <d4p1:key>sample string 1</d4p1:key>
          <d4p1:value>sample string 2</d4p1:value>
        </d4p1:KeyValuePairOfstringstring>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfKeyValuePairOfstringstringtwCi8m_S7>
    <d2p1:KeyValueOfstringArrayOfKeyValuePairOfstringstringtwCi8m_S7>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:KeyValuePairOfstringstring>
          <d4p1:key>sample string 1</d4p1:key>
          <d4p1:value>sample string 2</d4p1:value>
        </d4p1:KeyValuePairOfstringstring>
        <d4p1:KeyValuePairOfstringstring>
          <d4p1:key>sample string 1</d4p1:key>
          <d4p1:value>sample string 2</d4p1:value>
        </d4p1:KeyValuePairOfstringstring>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfKeyValuePairOfstringstringtwCi8m_S7>
  </Insurances>
  <Medications xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.PatientMedications">
    <d2p1:PatientMedicationUpdateRequestModel>
      <d2p1:EndDate>sample string 12</d2p1:EndDate>
      <d2p1:EyeMedication>true</d2p1:EyeMedication>
      <d2p1:MedicationDosageExternalId>sample string 3</d2p1:MedicationDosageExternalId>
      <d2p1:MedicationDosageId>1</d2p1:MedicationDosageId>
      <d2p1:MedicationDosageName>sample string 4</d2p1:MedicationDosageName>
      <d2p1:MedicationExternalId>sample string 1</d2p1:MedicationExternalId>
      <d2p1:MedicationFormTypeExternalId>sample string 5</d2p1:MedicationFormTypeExternalId>
      <d2p1:MedicationFormTypeId>1</d2p1:MedicationFormTypeId>
      <d2p1:MedicationFormTypeName>sample string 6</d2p1:MedicationFormTypeName>
      <d2p1:MedicationFrequencyExternalId>sample string 7</d2p1:MedicationFrequencyExternalId>
      <d2p1:MedicationFrequencyId>1</d2p1:MedicationFrequencyId>
      <d2p1:MedicationFrequencyName>sample string 8</d2p1:MedicationFrequencyName>
      <d2p1:MedicationId>1</d2p1:MedicationId>
      <d2p1:MedicationName>sample string 2</d2p1:MedicationName>
      <d2p1:MedicationRouteExternalId>sample string 9</d2p1:MedicationRouteExternalId>
      <d2p1:MedicationRouteId>1</d2p1:MedicationRouteId>
      <d2p1:MedicationRouteName>sample string 10</d2p1:MedicationRouteName>
      <d2p1:Notes>sample string 13</d2p1:Notes>
      <d2p1:Operation>sample string 15</d2p1:Operation>
      <d2p1:PatientMedicationRecordId>1</d2p1:PatientMedicationRecordId>
      <d2p1:PatientMedicationUpdateRequestId>1</d2p1:PatientMedicationUpdateRequestId>
      <d2p1:StartDate>sample string 11</d2p1:StartDate>
    </d2p1:PatientMedicationUpdateRequestModel>
    <d2p1:PatientMedicationUpdateRequestModel>
      <d2p1:EndDate>sample string 12</d2p1:EndDate>
      <d2p1:EyeMedication>true</d2p1:EyeMedication>
      <d2p1:MedicationDosageExternalId>sample string 3</d2p1:MedicationDosageExternalId>
      <d2p1:MedicationDosageId>1</d2p1:MedicationDosageId>
      <d2p1:MedicationDosageName>sample string 4</d2p1:MedicationDosageName>
      <d2p1:MedicationExternalId>sample string 1</d2p1:MedicationExternalId>
      <d2p1:MedicationFormTypeExternalId>sample string 5</d2p1:MedicationFormTypeExternalId>
      <d2p1:MedicationFormTypeId>1</d2p1:MedicationFormTypeId>
      <d2p1:MedicationFormTypeName>sample string 6</d2p1:MedicationFormTypeName>
      <d2p1:MedicationFrequencyExternalId>sample string 7</d2p1:MedicationFrequencyExternalId>
      <d2p1:MedicationFrequencyId>1</d2p1:MedicationFrequencyId>
      <d2p1:MedicationFrequencyName>sample string 8</d2p1:MedicationFrequencyName>
      <d2p1:MedicationId>1</d2p1:MedicationId>
      <d2p1:MedicationName>sample string 2</d2p1:MedicationName>
      <d2p1:MedicationRouteExternalId>sample string 9</d2p1:MedicationRouteExternalId>
      <d2p1:MedicationRouteId>1</d2p1:MedicationRouteId>
      <d2p1:MedicationRouteName>sample string 10</d2p1:MedicationRouteName>
      <d2p1:Notes>sample string 13</d2p1:Notes>
      <d2p1:Operation>sample string 15</d2p1:Operation>
      <d2p1:PatientMedicationRecordId>1</d2p1:PatientMedicationRecordId>
      <d2p1:PatientMedicationUpdateRequestId>1</d2p1:PatientMedicationUpdateRequestId>
      <d2p1:StartDate>sample string 11</d2p1:StartDate>
    </d2p1:PatientMedicationUpdateRequestModel>
  </Medications>
  <PghdUpdateRequestId>1</PghdUpdateRequestId>
  <PhoneNumbers xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.PatientDemographics">
    <d2p1:PatientPhoneNumberModel>
      <d2p1:Alias>sample string 1</d2p1:Alias>
      <d2p1:OriginalDefaultPhoneNumber>true</d2p1:OriginalDefaultPhoneNumber>
      <d2p1:OriginalNumber>sample string 2</d2p1:OriginalNumber>
      <d2p1:OriginalSortOrder>4</d2p1:OriginalSortOrder>
      <d2p1:OriginalUseForSms>true</d2p1:OriginalUseForSms>
      <d2p1:UpdatedDefaultPhoneNumber>true</d2p1:UpdatedDefaultPhoneNumber>
      <d2p1:UpdatedNumber>sample string 6</d2p1:UpdatedNumber>
      <d2p1:UpdatedSortOrder>8</d2p1:UpdatedSortOrder>
      <d2p1:UpdatedUseForSms>true</d2p1:UpdatedUseForSms>
    </d2p1:PatientPhoneNumberModel>
    <d2p1:PatientPhoneNumberModel>
      <d2p1:Alias>sample string 1</d2p1:Alias>
      <d2p1:OriginalDefaultPhoneNumber>true</d2p1:OriginalDefaultPhoneNumber>
      <d2p1:OriginalNumber>sample string 2</d2p1:OriginalNumber>
      <d2p1:OriginalSortOrder>4</d2p1:OriginalSortOrder>
      <d2p1:OriginalUseForSms>true</d2p1:OriginalUseForSms>
      <d2p1:UpdatedDefaultPhoneNumber>true</d2p1:UpdatedDefaultPhoneNumber>
      <d2p1:UpdatedNumber>sample string 6</d2p1:UpdatedNumber>
      <d2p1:UpdatedSortOrder>8</d2p1:UpdatedSortOrder>
      <d2p1:UpdatedUseForSms>true</d2p1:UpdatedUseForSms>
    </d2p1:PatientPhoneNumberModel>
  </PhoneNumbers>
</HealthInformationUpdatePreviewModel>