Create a note for a referral | Referral Exchange docs

Authorizationstring

API key to authenticate for external integrations. Use the format: “ApiKey insert-token-here”

referralIdstringRequiredformat: "uuid"

Referral ID

This endpoint expects an object.

authorHciCodestringRequired

Author HCI code. Must be already tied to your system.

institutionIdTypeenumRequired

The type of institution ID

Allowed values:

institutionIdstringRequired

The institution ID

contentstringOptional<=8000 characters

Note content - plaintext.

idstring

contentstring

authorHciCodestring

authorNamestring

createdAtdouble

updatedAtdouble

401

Unauthorized Error

$	curl -X POST https://dummy-url-see-smartcms-spec/api/v1/referrals/referralId/notes \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"authorHciCode": "HCI12345",
>	"institutionIdType": "hci",
>	"institutionId": "SGH001"
>	}'

1	{
2	"id": "a3f1c9e2-7b4d-4f8a-9c2e-5d6b7e8f9a01",
3	"content": "Patient has been advised to follow up in 2 weeks for review of medication adherence.",
4	"authorHciCode": "HCI12345",
5	"authorName": "Dr. Jane Tan",
6	"createdAt": 1685606400,
7	"updatedAt": 1685606400
8	}

$	curl -X POST https://dummy-url-see-smartcms-spec/api/v1/referrals/referralId/notes \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"authorHciCode": "HCI12345",
>	"institutionIdType": "hci",
>	"institutionId": "SGH001"
>	}'

1	{
2	"id": "a3f1c9e2-7b4d-4f8a-9c2e-5d6b7e8f9a01",
3	"content": "Patient has been advised to follow up in 2 weeks for review of medication adherence.",
4	"authorHciCode": "HCI12345",
5	"authorName": "Dr. Jane Tan",
6	"createdAt": 1685606400,
7	"updatedAt": 1685606400
8	}