Get a referral action link by type | Referral Exchange docs

referralIdstringRequired

The ID of the referral

typeenumRequired

The type of action link to retrieve

Allowed values:

This endpoint expects an object.

requesterIdentifierstringRequired

Identifier for the individual requesting the referral. Preferred to be an email.

institutionIdTypeenumRequired

The type of institution ID

institutionIdstringRequired

The institution ID

attachmentIdstringOptional

ID of the attachment. Required when the action link type is attachment.

typeenum

type of referral action

labelstring

Human-readable label that can be displayed directly to users

urlstring

The URL of the link

attachmentobject

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

$	curl -X POST https://dummy-url-see-smartcms-spec/api/v1/referrals/referralId/action-links/amend \
>	-H "Content-Type: application/json" \
>	-d '{
>	"requesterIdentifier": "jane.doe@singhealth.com.sg",
>	"institutionIdType": "hci",
>	"institutionId": "SGH12345"
>	}'

1	{
2	"type": "amend",
3	"label": "Amend Referral Details",
4	"url": "https://refer.health.gov.sg/referrals/123456/action-links/amend",
5	"attachment": {
6	"id": "att-987654321",
7	"uploadedAt": "2024-05-01T14:22:00Z"
8	}
9	}