GET api/v1/{practiceId}/clinical/encountertemplates/{encounterTemplateId}/referrals

Get referral templates list for provided encounter

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

globally unique identifier

Required
encounterTemplateId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.CommunicationTemplateVo
NameDescriptionTypeAdditional information
PracticeId

globally unique identifier

None.
TemplateId

globally unique identifier

None.
TemplateName

string

None.
TemplateType

string

None.
TemplateMediaType

string

None.
TemplateIdentifier

string

None.
TemplateBody

string

None.
Locale

string

None.
LastUpdated

date

None.
LastUpdatedBy

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "PracticeId": "ff591cab-f015-4338-9503-a4b07a34b147",
    "TemplateId": "871b0ef3-531f-4a7b-bec6-44d831075d90",
    "TemplateName": "sample string 3",
    "TemplateType": "sample string 4",
    "TemplateMediaType": "sample string 5",
    "TemplateIdentifier": "sample string 6",
    "TemplateBody": "sample string 7",
    "Locale": "sample string 8",
    "LastUpdated": "2025-10-11T19:17:21Z",
    "LastUpdatedBy": "sample string 10"
  },
  {
    "PracticeId": "ff591cab-f015-4338-9503-a4b07a34b147",
    "TemplateId": "871b0ef3-531f-4a7b-bec6-44d831075d90",
    "TemplateName": "sample string 3",
    "TemplateType": "sample string 4",
    "TemplateMediaType": "sample string 5",
    "TemplateIdentifier": "sample string 6",
    "TemplateBody": "sample string 7",
    "Locale": "sample string 8",
    "LastUpdated": "2025-10-11T19:17:21Z",
    "LastUpdatedBy": "sample string 10"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCommunicationTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/platform/commondomain/v1/communicationtemplate/">
  <CommunicationTemplate>
    <LastUpdated>2025-10-11T19:17:21.0291858+02:00</LastUpdated>
    <LastUpdatedBy>sample string 10</LastUpdatedBy>
    <Locale>sample string 8</Locale>
    <PracticeId>ff591cab-f015-4338-9503-a4b07a34b147</PracticeId>
    <TemplateBody>sample string 7</TemplateBody>
    <TemplateId>871b0ef3-531f-4a7b-bec6-44d831075d90</TemplateId>
    <TemplateIdentifier>sample string 6</TemplateIdentifier>
    <TemplateMediaType>sample string 5</TemplateMediaType>
    <TemplateName>sample string 3</TemplateName>
    <TemplateType>sample string 4</TemplateType>
  </CommunicationTemplate>
  <CommunicationTemplate>
    <LastUpdated>2025-10-11T19:17:21.0291858+02:00</LastUpdated>
    <LastUpdatedBy>sample string 10</LastUpdatedBy>
    <Locale>sample string 8</Locale>
    <PracticeId>ff591cab-f015-4338-9503-a4b07a34b147</PracticeId>
    <TemplateBody>sample string 7</TemplateBody>
    <TemplateId>871b0ef3-531f-4a7b-bec6-44d831075d90</TemplateId>
    <TemplateIdentifier>sample string 6</TemplateIdentifier>
    <TemplateMediaType>sample string 5</TemplateMediaType>
    <TemplateName>sample string 3</TemplateName>
    <TemplateType>sample string 4</TemplateType>
  </CommunicationTemplate>
</ArrayOfCommunicationTemplate>