Get the recommended offering for a category based on postal code

curl -G https://dummy-url-see-smartcms-spec/api/v1/offerings/recommended \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d category=aac \
     -d postalCode=postalCode

{
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "name": "Gastroenterology Specialist Consultation",
  "institutionHciCode": "S1234",
  "institution": {
    "hciCode": "S1234",
    "name": "Singapore General Hospital",
    "block": "Outram Road",
    "streetName": "Outram Road",
    "buildingName": "Main Building",
    "floorNumber": "5",
    "unitNumber": "05-12",
    "postalCode": "169608"
  },
  "system": "HAS",
  "description": "Before proceeding with your referral, please refer to the guidelines of referrals to this SOC. https://go.gov.sg/refx-nuhs-gastro-guidelines",
  "isActive": true,
  "isSubsidisable": true,
  "timeslotPolicy": "timeslot-required",
  "category": "aac",
  "specialty": "Gastroenterology",
  "nehrCode": "GASTRO123"
}

Authentication

Authorizationstring

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

Query parameters

categoryenumRequired

Offering category to retrieve recommendation for

Allowed values:

postalCodestringRequired

Postal code of the patient to retrieve recommendation for

Response

idstring

namestring

Name of the offering - use these as labels

institutionHciCodestring

institutionobject

systemenum

descriptionstring

Clinical guidelines and other information which clinicians should read before proceeding with creating the referral. May contain URLs - should be rendered in a Linkify component

isActiveboolean

Whether the offering is able to receive new referrals currently

isSubsidisableboolean

Whether this offering supports subsidized referrals.

timeslotPolicyenum

How timeslots are handled for this offering. Is enforced at validation. timeslot-required: Timeslots must be selected when creating a referral. optional-timeslots-and-urgentable: Timeslots are selectable but optional. If no timeslot is selected, the referral will be routed to a manual call-centre for scheduling. If you indicate isUrgent: true, the timeslot will be disregarded and referral will be sent to the call-centre for triage. no-timeslots: Timeslots are not selectable for this offering. Calling the timeslot API will return an error.

categoryenumOptional

Category of the offering. Used to group offerings together.

specialtystringOptional

Specialty of the offering

nehrCodestringOptional

NEHR code for the offering

Errors

401

Unauthorized Error

404

Not Found Error