POST api/HealthSummaryAmendmentRequest

Sends an health summary amendment request.

Request Information

URI Parameters

None.

Body Parameters

Mode used to send health summary amendment request.

HealthSummaryAmendmentRequestModel
NameDescriptionTypeAdditional information
AmendmentRequestId

Unique ID of amendment request.

globally unique identifier

None.

CdaId

Unique ID of health summary (CDA) for which amendment is required (Required).

globally unique identifier

None.

MissingInformation

Missing information in health summary (Required).

string

None.

IncorrectInformation

Incorrect information in health summary.

string

None.

NotifyOfAmendment

To whom notification for amendment will be sent.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "AmendmentRequestId": "a51bfd35-1787-4418-a68b-f6547acfcf40",
  "CdaId": "afc13801-2e03-43bb-82d4-320d28b0231d",
  "MissingInformation": "sample string 3",
  "IncorrectInformation": "sample string 4",
  "NotifyOfAmendment": "sample string 5"
}

application/xml, text/xml

Sample:
<HealthSummaryAmendmentRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.HealthSummaries">
  <AmendmentRequestId>a51bfd35-1787-4418-a68b-f6547acfcf40</AmendmentRequestId>
  <CdaId>afc13801-2e03-43bb-82d4-320d28b0231d</CdaId>
  <IncorrectInformation>sample string 4</IncorrectInformation>
  <MissingInformation>sample string 3</MissingInformation>
  <NotifyOfAmendment>sample string 5</NotifyOfAmendment>
</HealthSummaryAmendmentRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HealthSummaryAmendmentRequestModel
NameDescriptionTypeAdditional information
AmendmentRequestId

Unique ID of amendment request.

globally unique identifier

None.

CdaId

Unique ID of health summary (CDA) for which amendment is required (Required).

globally unique identifier

None.

MissingInformation

Missing information in health summary (Required).

string

None.

IncorrectInformation

Incorrect information in health summary.

string

None.

NotifyOfAmendment

To whom notification for amendment will be sent.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "AmendmentRequestId": "f4a87ab6-008e-48b3-812a-7e4744dbb089",
  "CdaId": "21640cbf-a9ff-4441-8fef-4bff4e32c6a1",
  "MissingInformation": "sample string 3",
  "IncorrectInformation": "sample string 4",
  "NotifyOfAmendment": "sample string 5"
}

application/xml, text/xml

Sample:
<HealthSummaryAmendmentRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.HealthSummaries">
  <AmendmentRequestId>f4a87ab6-008e-48b3-812a-7e4744dbb089</AmendmentRequestId>
  <CdaId>21640cbf-a9ff-4441-8fef-4bff4e32c6a1</CdaId>
  <IncorrectInformation>sample string 4</IncorrectInformation>
  <MissingInformation>sample string 3</MissingInformation>
  <NotifyOfAmendment>sample string 5</NotifyOfAmendment>
</HealthSummaryAmendmentRequestModel>