Changelog

Additions

• Added a new referral.singhealth-patient-create-reminder-sent value to the timeline event type field (timelineEvents[].type) returned by GET /api/v1/referrals/:referralId.

Additions

• Added new submittedAt field to referral responses (GET /api/v1/institutions/:institutionIdType/:institutionId/referrals, GET /api/v1/referrals/:referralId, DELETE /api/v1/referrals/:referralId, POST /api/v1/referrals/:referralId/cancel, POST /api/v1/referrals/:referralId/back-to-draft).

Recommendations

Documentation Changes

• Removed unimplemented patient.isHsgEnrolled field from referral responses (GET /api/v1/institutions/:institutionIdType/:institutionId/referrals, GET /api/v1/referrals/:referralId, DELETE /api/v1/referrals/:referralId, POST /api/v1/referrals/:referralId/cancel, POST /api/v1/referrals/:referralId/back-to-draft).
• Updated description of the offering.description field in referral responses (GET /api/v1/institutions/:institutionIdType/:institutionId/referrals, GET /api/v1/referrals/:referralId, DELETE /api/v1/referrals/:referralId, POST /api/v1/referrals/:referralId/cancel, POST /api/v1/referrals/:referralId/back-to-draft).

Additions

• Added new Manual enum value to the senderSystem field in referral responses (GET /api/v1/institutions/:institutionIdType/:institutionId/referrals, GET /api/v1/referrals/:referralId, DELETE /api/v1/referrals/:referralId, POST /api/v1/referrals/:referralId/cancel, POST /api/v1/referrals/:referralId/back-to-draft).
• Added new Manual enum value to the timelineEvents[].system field in GET /api/v1/referrals/:referralId response.
• Added new gpfirst and ae enum values to the offering.category field in referral responses (GET /api/v1/institutions/:institutionIdType/:institutionId/referrals, GET /api/v1/referrals/:referralId, DELETE /api/v1/referrals/:referralId, POST /api/v1/referrals/:referralId/cancel, POST /api/v1/referrals/:referralId/back-to-draft).

Additions

• Added new nehrForm enum value to the additionalField query parameter on GET /api/v1/referrals/:referralId. When requested, the response includes:
  • nehrForm — the referral form rendered as a self-contained HTML document, suitable for forwarding to NEHR.
  • nehrFormType — a human-readable description of the NEHR form type(s), with multiple templates joined by |.

The changes documented here consolidate the main changes made from v0.0.58 to v0.0.66.