POST api/v1/{practiceid}/clinical/encountertemplates

Create encounter template

Request Information

URI Parameters

Name	Description	Type	Additional information
practiceid	Unique identifier of practice	globally unique identifier	Required

Body Parameters

encounter template object

Com.Healthbridge.Hhas.Clinical.Interface.Commands.UpdateEncounterTemplate

Name	Type	Additional information
EncounterTemplate	Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.EncounterTemplateVo	None.
CorrelationIds	Collection of string	None.
OriginatedSystem	string	None.

Request Formats

application/json, text/json

Sample:

{
  "EncounterTemplate": {
    "TemplateId": "7e0dd7e1-b9e2-4a40-913d-64148daadc0e",
    "TemplateXref": "sample string 2",
    "PracticeId": "19c82476-b082-48ca-8e00-569349788f30",
    "TemplateType": "sample string 4",
    "Caption": "sample string 5",
    "Description": "sample string 6",
    "SortOrder": 7,
    "EncounterLineItems": {
      "EncounterHeader": {
        "ClaimAuthorizationNumber": "sample string 1",
        "AdmissionDateTime": "2025-11-19T00:50:36Z",
        "DischargeDateTime": "2025-11-19T00:50:36Z",
        "HospitalIndicator": true,
        "ClaimType": "sample string 3",
        "TariffCode": "sample string 4",
        "Diagnosis": [
          {
            "Id": "cd938db4-f2be-48b4-8afd-59cdeab93773",
            "DiagnosisCode": "sample string 2",
            "DiagnosisDescription": "sample string 3",
            "SpecificCode": true,
            "PrimaryIndicator": true,
            "ValidPrimary": true,
            "ValidSequelae": true,
            "MaxSpecificity": true,
            "Gender": "sample string 9",
            "AgeRangeStart": 1,
            "AgeRangeEnd": 1,
            "DiagnosisToken": "sample string 10",
            "DiagnosisTokenDescription": "sample string 11",
            "IcdSource": "sample string 12",
            "OrderNo": 13
          },
          {
            "Id": "cd938db4-f2be-48b4-8afd-59cdeab93773",
            "DiagnosisCode": "sample string 2",
            "DiagnosisDescription": "sample string 3",
            "SpecificCode": true,
            "PrimaryIndicator": true,
            "ValidPrimary": true,
            "ValidSequelae": true,
            "MaxSpecificity": true,
            "Gender": "sample string 9",
            "AgeRangeStart": 1,
            "AgeRangeEnd": 1,
            "DiagnosisToken": "sample string 10",
            "DiagnosisTokenDescription": "sample string 11",
            "IcdSource": "sample string 12",
            "OrderNo": 13
          }
        ],
        "DateOfService": "2025-11-19T00:50:36Z",
        "PlaceOfService": 0,
        "Ward": "sample string 6"
      },
      "LineItems": [
        {
          "DateOfService": "2025-11-19T00:50:36Z",
          "LineNum": 2,
          "LineType": "sample string 3",
          "ChargeCode": "sample string 4",
          "ChargeDesc": "sample string 5",
          "NappiCode": "sample string 6",
          "ChargeUnits": "sample string 7",
          "DosageUnit": 8.1,
          "DosageType": "sample string 9",
          "FrequencyUnit": 10,
          "FrequencyType": "sample string 11",
          "PeriodUnit": 12,
          "PeriodType": "sample string 13",
          "DurationUnit": 14,
          "DurationType": "sample string 15",
          "Repeat": 16,
          "ChronicIndicator": true,
          "ChargeQuan": 18,
          "TotalExcVat": 19.0,
          "VatAmount": 20.0,
          "TotalIncVat": 21.0,
          "Amount": 22.0,
          "Parameters": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "Responses": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChargeStart": "2025-11-19T00:50:36Z",
          "ChargeEnd": "2025-11-19T00:50:36Z",
          "PriceOverride": true,
          "AccelerateLearning": true,
          "UnitPrice": 25.0,
          "SchemeRule": "sample string 26",
          "CreatedFrom": "sample string 27",
          "Diagnosis": [
            {
              "Id": "1a45814e-86c4-4673-b69d-c38f1f6d153a",
              "DiagnosisCode": "sample string 2",
              "DiagnosisDescription": "sample string 3",
              "SpecificCode": true,
              "PrimaryIndicator": true,
              "ValidPrimary": true,
              "ValidSequelae": true,
              "MaxSpecificity": true,
              "Gender": "sample string 9",
              "AgeRangeStart": 1,
              "AgeRangeEnd": 1
            },
            {
              "Id": "1a45814e-86c4-4673-b69d-c38f1f6d153a",
              "DiagnosisCode": "sample string 2",
              "DiagnosisDescription": "sample string 3",
              "SpecificCode": true,
              "PrimaryIndicator": true,
              "ValidPrimary": true,
              "ValidSequelae": true,
              "MaxSpecificity": true,
              "Gender": "sample string 9",
              "AgeRangeStart": 1,
              "AgeRangeEnd": 1
            }
          ]
        },
        {
          "DateOfService": "2025-11-19T00:50:36Z",
          "LineNum": 2,
          "LineType": "sample string 3",
          "ChargeCode": "sample string 4",
          "ChargeDesc": "sample string 5",
          "NappiCode": "sample string 6",
          "ChargeUnits": "sample string 7",
          "DosageUnit": 8.1,
          "DosageType": "sample string 9",
          "FrequencyUnit": 10,
          "FrequencyType": "sample string 11",
          "PeriodUnit": 12,
          "PeriodType": "sample string 13",
          "DurationUnit": 14,
          "DurationType": "sample string 15",
          "Repeat": 16,
          "ChronicIndicator": true,
          "ChargeQuan": 18,
          "TotalExcVat": 19.0,
          "VatAmount": 20.0,
          "TotalIncVat": 21.0,
          "Amount": 22.0,
          "Parameters": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "Responses": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChargeStart": "2025-11-19T00:50:36Z",
          "ChargeEnd": "2025-11-19T00:50:36Z",
          "PriceOverride": true,
          "AccelerateLearning": true,
          "UnitPrice": 25.0,
          "SchemeRule": "sample string 26",
          "CreatedFrom": "sample string 27",
          "Diagnosis": [
            {
              "Id": "1a45814e-86c4-4673-b69d-c38f1f6d153a",
              "DiagnosisCode": "sample string 2",
              "DiagnosisDescription": "sample string 3",
              "SpecificCode": true,
              "PrimaryIndicator": true,
              "ValidPrimary": true,
              "ValidSequelae": true,
              "MaxSpecificity": true,
              "Gender": "sample string 9",
              "AgeRangeStart": 1,
              "AgeRangeEnd": 1
            },
            {
              "Id": "1a45814e-86c4-4673-b69d-c38f1f6d153a",
              "DiagnosisCode": "sample string 2",
              "DiagnosisDescription": "sample string 3",
              "SpecificCode": true,
              "PrimaryIndicator": true,
              "ValidPrimary": true,
              "ValidSequelae": true,
              "MaxSpecificity": true,
              "Gender": "sample string 9",
              "AgeRangeStart": 1,
              "AgeRangeEnd": 1
            }
          ]
        }
      ]
    },
    "MedicationPrescriptionLines": [
      {
        "Quantity": 1,
        "LineNum": 2,
        "MedicationDescription": "sample string 3",
        "NappiCode": "sample string 4",
        "DosageUnits": 5.0,
        "DosageType": "sample string 6",
        "FrequencyUnits": 7,
        "FrequencyMax": 8,
        "PeriodUnit": 9,
        "PeriodType": "sample string 10",
        "DurationUnit": 11,
        "DurationType": "sample string 12",
        "Repeat": 13,
        "ChronicIndicator": true,
        "AllowGeneric": true,
        "Diagnosis": [
          {
            "Id": "cd938db4-f2be-48b4-8afd-59cdeab93773",
            "DiagnosisCode": "sample string 2",
            "DiagnosisDescription": "sample string 3",
            "SpecificCode": true,
            "PrimaryIndicator": true,
            "ValidPrimary": true,
            "ValidSequelae": true,
            "MaxSpecificity": true,
            "Gender": "sample string 9",
            "AgeRangeStart": 1,
            "AgeRangeEnd": 1,
            "DiagnosisToken": "sample string 10",
            "DiagnosisTokenDescription": "sample string 11",
            "IcdSource": "sample string 12",
            "OrderNo": 13
          },
          {
            "Id": "cd938db4-f2be-48b4-8afd-59cdeab93773",
            "DiagnosisCode": "sample string 2",
            "DiagnosisDescription": "sample string 3",
            "SpecificCode": true,
            "PrimaryIndicator": true,
            "ValidPrimary": true,
            "ValidSequelae": true,
            "MaxSpecificity": true,
            "Gender": "sample string 9",
            "AgeRangeStart": 1,
            "AgeRangeEnd": 1,
            "DiagnosisToken": "sample string 10",
            "DiagnosisTokenDescription": "sample string 11",
            "IcdSource": "sample string 12",
            "OrderNo": 13
          }
        ],
        "DispensingInstructions": "sample string 16",
        "AdministrationInstructions": "sample string 17",
        "Description": "sample string 18",
        "CreatedFrom": "sample string 19",
        "AccelerateLearning": true,
        "Parameters": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        }
      },
      {
        "Quantity": 1,
        "LineNum": 2,
        "MedicationDescription": "sample string 3",
        "NappiCode": "sample string 4",
        "DosageUnits": 5.0,
        "DosageType": "sample string 6",
        "FrequencyUnits": 7,
        "FrequencyMax": 8,
        "PeriodUnit": 9,
        "PeriodType": "sample string 10",
        "DurationUnit": 11,
        "DurationType": "sample string 12",
        "Repeat": 13,
        "ChronicIndicator": true,
        "AllowGeneric": true,
        "Diagnosis": [
          {
            "Id": "cd938db4-f2be-48b4-8afd-59cdeab93773",
            "DiagnosisCode": "sample string 2",
            "DiagnosisDescription": "sample string 3",
            "SpecificCode": true,
            "PrimaryIndicator": true,
            "ValidPrimary": true,
            "ValidSequelae": true,
            "MaxSpecificity": true,
            "Gender": "sample string 9",
            "AgeRangeStart": 1,
            "AgeRangeEnd": 1,
            "DiagnosisToken": "sample string 10",
            "DiagnosisTokenDescription": "sample string 11",
            "IcdSource": "sample string 12",
            "OrderNo": 13
          },
          {
            "Id": "cd938db4-f2be-48b4-8afd-59cdeab93773",
            "DiagnosisCode": "sample string 2",
            "DiagnosisDescription": "sample string 3",
            "SpecificCode": true,
            "PrimaryIndicator": true,
            "ValidPrimary": true,
            "ValidSequelae": true,
            "MaxSpecificity": true,
            "Gender": "sample string 9",
            "AgeRangeStart": 1,
            "AgeRangeEnd": 1,
            "DiagnosisToken": "sample string 10",
            "DiagnosisTokenDescription": "sample string 11",
            "IcdSource": "sample string 12",
            "OrderNo": 13
          }
        ],
        "DispensingInstructions": "sample string 16",
        "AdministrationInstructions": "sample string 17",
        "Description": "sample string 18",
        "CreatedFrom": "sample string 19",
        "AccelerateLearning": true,
        "Parameters": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        }
      }
    ],
    "Communications": [
      {
        "CommunicationId": "548c8322-a9e5-445b-9e95-686c8ee8d034",
        "PatientId": "227e0e80-9496-42d6-91dd-916582854101",
        "EncounterId": "a4486630-1d9f-487c-9091-abbff7ca5108",
        "CommunicationTemplateId": "4eb415be-fd11-4ca8-a3ea-e2a786fa4cea",
        "Type": "sample string 5",
        "Title": "sample string 6",
        "IncludeSignature": true
      },
      {
        "CommunicationId": "548c8322-a9e5-445b-9e95-686c8ee8d034",
        "PatientId": "227e0e80-9496-42d6-91dd-916582854101",
        "EncounterId": "a4486630-1d9f-487c-9091-abbff7ca5108",
        "CommunicationTemplateId": "4eb415be-fd11-4ca8-a3ea-e2a786fa4cea",
        "Type": "sample string 5",
        "Title": "sample string 6",
        "IncludeSignature": true
      }
    ]
  },
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 1"
}

application/xml, text/xml

Sample:

<UpdateEncounterTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.Commands">
  <CorrelationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CorrelationIds>
  <OriginatedSystem xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">sample string 1</OriginatedSystem>
  <EncounterTemplate xmlns:d2p1="http://mpsapi.healthbridge.com/clinical/clinical/v1/encounter/">
    <d2p1:Caption>sample string 5</d2p1:Caption>
    <d2p1:Communications>
      <d2p1:Communication>
        <d2p1:CommunicationId>548c8322-a9e5-445b-9e95-686c8ee8d034</d2p1:CommunicationId>
        <d2p1:CommunicationTemplateId>4eb415be-fd11-4ca8-a3ea-e2a786fa4cea</d2p1:CommunicationTemplateId>
        <d2p1:EncounterId>a4486630-1d9f-487c-9091-abbff7ca5108</d2p1:EncounterId>
        <d2p1:IncludeSignature>true</d2p1:IncludeSignature>
        <d2p1:PatientId>227e0e80-9496-42d6-91dd-916582854101</d2p1:PatientId>
        <d2p1:Title>sample string 6</d2p1:Title>
        <d2p1:Type>sample string 5</d2p1:Type>
      </d2p1:Communication>
      <d2p1:Communication>
        <d2p1:CommunicationId>548c8322-a9e5-445b-9e95-686c8ee8d034</d2p1:CommunicationId>
        <d2p1:CommunicationTemplateId>4eb415be-fd11-4ca8-a3ea-e2a786fa4cea</d2p1:CommunicationTemplateId>
        <d2p1:EncounterId>a4486630-1d9f-487c-9091-abbff7ca5108</d2p1:EncounterId>
        <d2p1:IncludeSignature>true</d2p1:IncludeSignature>
        <d2p1:PatientId>227e0e80-9496-42d6-91dd-916582854101</d2p1:PatientId>
        <d2p1:Title>sample string 6</d2p1:Title>
        <d2p1:Type>sample string 5</d2p1:Type>
      </d2p1:Communication>
    </d2p1:Communications>
    <d2p1:Description>sample string 6</d2p1:Description>
    <d2p1:EncounterLineItems>
      <d2p1:EncounterHeader>
        <d2p1:AdmissionDateTime>2025-11-19T00:50:36.8321111+02:00</d2p1:AdmissionDateTime>
        <d2p1:ClaimAuthorizationNumber>sample string 1</d2p1:ClaimAuthorizationNumber>
        <d2p1:ClaimType>sample string 3</d2p1:ClaimType>
        <d2p1:DateOfService>2025-11-19T00:50:36.8321111+02:00</d2p1:DateOfService>
        <d2p1:Diagnosis>
          <d2p1:Diagnosis>
            <d2p1:AgeRangeEnd>1</d2p1:AgeRangeEnd>
            <d2p1:AgeRangeStart>1</d2p1:AgeRangeStart>
            <d2p1:DiagnosisCode>sample string 2</d2p1:DiagnosisCode>
            <d2p1:DiagnosisDescription>sample string 3</d2p1:DiagnosisDescription>
            <d2p1:DiagnosisToken>sample string 10</d2p1:DiagnosisToken>
            <d2p1:DiagnosisTokenDescription>sample string 11</d2p1:DiagnosisTokenDescription>
            <d2p1:Gender>sample string 9</d2p1:Gender>
            <d2p1:IcdSource>sample string 12</d2p1:IcdSource>
            <d2p1:Id>cd938db4-f2be-48b4-8afd-59cdeab93773</d2p1:Id>
            <d2p1:MaxSpecificity>true</d2p1:MaxSpecificity>
            <d2p1:OrderNo>13</d2p1:OrderNo>
            <d2p1:PrimaryIndicator>true</d2p1:PrimaryIndicator>
            <d2p1:SpecificCode>true</d2p1:SpecificCode>
            <d2p1:ValidPrimary>true</d2p1:ValidPrimary>
            <d2p1:ValidSequelae>true</d2p1:ValidSequelae>
          </d2p1:Diagnosis>
          <d2p1:Diagnosis>
            <d2p1:AgeRangeEnd>1</d2p1:AgeRangeEnd>
            <d2p1:AgeRangeStart>1</d2p1:AgeRangeStart>
            <d2p1:DiagnosisCode>sample string 2</d2p1:DiagnosisCode>
            <d2p1:DiagnosisDescription>sample string 3</d2p1:DiagnosisDescription>
            <d2p1:DiagnosisToken>sample string 10</d2p1:DiagnosisToken>
            <d2p1:DiagnosisTokenDescription>sample string 11</d2p1:DiagnosisTokenDescription>
            <d2p1:Gender>sample string 9</d2p1:Gender>
            <d2p1:IcdSource>sample string 12</d2p1:IcdSource>
            <d2p1:Id>cd938db4-f2be-48b4-8afd-59cdeab93773</d2p1:Id>
            <d2p1:MaxSpecificity>true</d2p1:MaxSpecificity>
            <d2p1:OrderNo>13</d2p1:OrderNo>
            <d2p1:PrimaryIndicator>true</d2p1:PrimaryIndicator>
            <d2p1:SpecificCode>true</d2p1:SpecificCode>
            <d2p1:ValidPrimary>true</d2p1:ValidPrimary>
            <d2p1:ValidSequelae>true</d2p1:ValidSequelae>
          </d2p1:Diagnosis>
        </d2p1:Diagnosis>
        <d2p1:DischargeDateTime>2025-11-19T00:50:36.8321111+02:00</d2p1:DischargeDateTime>
        <d2p1:HospitalIndicator>true</d2p1:HospitalIndicator>
        <d2p1:PlaceOfService>Uknown</d2p1:PlaceOfService>
        <d2p1:TariffCode>sample string 4</d2p1:TariffCode>
        <d2p1:Ward>sample string 6</d2p1:Ward>
      </d2p1:EncounterHeader>
      <d2p1:LineItems>
        <d2p1:EncounterLineItem>
          <d2p1:AccelerateLearning>true</d2p1:AccelerateLearning>
          <d2p1:Amount>22</d2p1:Amount>
          <d2p1:ChargeCode>sample string 4</d2p1:ChargeCode>
          <d2p1:ChargeDesc>sample string 5</d2p1:ChargeDesc>
          <d2p1:ChargeEnd>2025-11-19T00:50:36.8321111+02:00</d2p1:ChargeEnd>
          <d2p1:ChargeQuan>18</d2p1:ChargeQuan>
          <d2p1:ChargeStart>2025-11-19T00:50:36.8321111+02:00</d2p1:ChargeStart>
          <d2p1:ChargeUnits>sample string 7</d2p1:ChargeUnits>
          <d2p1:ChronicIndicator>true</d2p1:ChronicIndicator>
          <d2p1:CreatedFrom>sample string 27</d2p1:CreatedFrom>
          <d2p1:DateOfService>2025-11-19T00:50:36.8321111+02:00</d2p1:DateOfService>
          <d2p1:Diagnosis xmlns:d6p1="http://mpsapi.healthbridge.com/rcm/billing/v1/invoice/">
            <d6p1:Diagnosis>
              <d6p1:AgeRangeEnd>1</d6p1:AgeRangeEnd>
              <d6p1:AgeRangeStart>1</d6p1:AgeRangeStart>
              <d6p1:DiagnosisCode>sample string 2</d6p1:DiagnosisCode>
              <d6p1:DiagnosisDescription>sample string 3</d6p1:DiagnosisDescription>
              <d6p1:Gender>sample string 9</d6p1:Gender>
              <d6p1:Id>1a45814e-86c4-4673-b69d-c38f1f6d153a</d6p1:Id>
              <d6p1:MaxSpecificity>true</d6p1:MaxSpecificity>
              <d6p1:PrimaryIndicator>true</d6p1:PrimaryIndicator>
              <d6p1:SpecificCode>true</d6p1:SpecificCode>
              <d6p1:ValidPrimary>true</d6p1:ValidPrimary>
              <d6p1:ValidSequelae>true</d6p1:ValidSequelae>
            </d6p1:Diagnosis>
            <d6p1:Diagnosis>
              <d6p1:AgeRangeEnd>1</d6p1:AgeRangeEnd>
              <d6p1:AgeRangeStart>1</d6p1:AgeRangeStart>
              <d6p1:DiagnosisCode>sample string 2</d6p1:DiagnosisCode>
              <d6p1:DiagnosisDescription>sample string 3</d6p1:DiagnosisDescription>
              <d6p1:Gender>sample string 9</d6p1:Gender>
              <d6p1:Id>1a45814e-86c4-4673-b69d-c38f1f6d153a</d6p1:Id>
              <d6p1:MaxSpecificity>true</d6p1:MaxSpecificity>
              <d6p1:PrimaryIndicator>true</d6p1:PrimaryIndicator>
              <d6p1:SpecificCode>true</d6p1:SpecificCode>
              <d6p1:ValidPrimary>true</d6p1:ValidPrimary>
              <d6p1:ValidSequelae>true</d6p1:ValidSequelae>
            </d6p1:Diagnosis>
          </d2p1:Diagnosis>
          <d2p1:DosageType>sample string 9</d2p1:DosageType>
          <d2p1:DosageUnit>8.1</d2p1:DosageUnit>
          <d2p1:DurationType>sample string 15</d2p1:DurationType>
          <d2p1:DurationUnit>14</d2p1:DurationUnit>
          <d2p1:FrequencyType>sample string 11</d2p1:FrequencyType>
          <d2p1:FrequencyUnit>10</d2p1:FrequencyUnit>
          <d2p1:LineNum>2</d2p1:LineNum>
          <d2p1:LineType>sample string 3</d2p1:LineType>
          <d2p1:NappiCode>sample string 6</d2p1:NappiCode>
          <d2p1:Parameters xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:Parameters>
          <d2p1:PeriodType>sample string 13</d2p1:PeriodType>
          <d2p1:PeriodUnit>12</d2p1:PeriodUnit>
          <d2p1:PriceOverride>true</d2p1:PriceOverride>
          <d2p1:Repeat>16</d2p1:Repeat>
          <d2p1:Responses xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:Responses>
          <d2p1:SchemeRule>sample string 26</d2p1:SchemeRule>
          <d2p1:TotalExcVat>19</d2p1:TotalExcVat>
          <d2p1:TotalIncVat>21</d2p1:TotalIncVat>
          <d2p1:UnitPrice>25</d2p1:UnitPrice>
          <d2p1:VatAmount>20</d2p1:VatAmount>
        </d2p1:EncounterLineItem>
        <d2p1:EncounterLineItem>
          <d2p1:AccelerateLearning>true</d2p1:AccelerateLearning>
          <d2p1:Amount>22</d2p1:Amount>
          <d2p1:ChargeCode>sample string 4</d2p1:ChargeCode>
          <d2p1:ChargeDesc>sample string 5</d2p1:ChargeDesc>
          <d2p1:ChargeEnd>2025-11-19T00:50:36.8321111+02:00</d2p1:ChargeEnd>
          <d2p1:ChargeQuan>18</d2p1:ChargeQuan>
          <d2p1:ChargeStart>2025-11-19T00:50:36.8321111+02:00</d2p1:ChargeStart>
          <d2p1:ChargeUnits>sample string 7</d2p1:ChargeUnits>
          <d2p1:ChronicIndicator>true</d2p1:ChronicIndicator>
          <d2p1:CreatedFrom>sample string 27</d2p1:CreatedFrom>
          <d2p1:DateOfService>2025-11-19T00:50:36.8321111+02:00</d2p1:DateOfService>
          <d2p1:Diagnosis xmlns:d6p1="http://mpsapi.healthbridge.com/rcm/billing/v1/invoice/">
            <d6p1:Diagnosis>
              <d6p1:AgeRangeEnd>1</d6p1:AgeRangeEnd>
              <d6p1:AgeRangeStart>1</d6p1:AgeRangeStart>
              <d6p1:DiagnosisCode>sample string 2</d6p1:DiagnosisCode>
              <d6p1:DiagnosisDescription>sample string 3</d6p1:DiagnosisDescription>
              <d6p1:Gender>sample string 9</d6p1:Gender>
              <d6p1:Id>1a45814e-86c4-4673-b69d-c38f1f6d153a</d6p1:Id>
              <d6p1:MaxSpecificity>true</d6p1:MaxSpecificity>
              <d6p1:PrimaryIndicator>true</d6p1:PrimaryIndicator>
              <d6p1:SpecificCode>true</d6p1:SpecificCode>
              <d6p1:ValidPrimary>true</d6p1:ValidPrimary>
              <d6p1:ValidSequelae>true</d6p1:ValidSequelae>
            </d6p1:Diagnosis>
            <d6p1:Diagnosis>
              <d6p1:AgeRangeEnd>1</d6p1:AgeRangeEnd>
              <d6p1:AgeRangeStart>1</d6p1:AgeRangeStart>
              <d6p1:DiagnosisCode>sample string 2</d6p1:DiagnosisCode>
              <d6p1:DiagnosisDescription>sample string 3</d6p1:DiagnosisDescription>
              <d6p1:Gender>sample string 9</d6p1:Gender>
              <d6p1:Id>1a45814e-86c4-4673-b69d-c38f1f6d153a</d6p1:Id>
              <d6p1:MaxSpecificity>true</d6p1:MaxSpecificity>
              <d6p1:PrimaryIndicator>true</d6p1:PrimaryIndicator>
              <d6p1:SpecificCode>true</d6p1:SpecificCode>
              <d6p1:ValidPrimary>true</d6p1:ValidPrimary>
              <d6p1:ValidSequelae>true</d6p1:ValidSequelae>
            </d6p1:Diagnosis>
          </d2p1:Diagnosis>
          <d2p1:DosageType>sample string 9</d2p1:DosageType>
          <d2p1:DosageUnit>8.1</d2p1:DosageUnit>
          <d2p1:DurationType>sample string 15</d2p1:DurationType>
          <d2p1:DurationUnit>14</d2p1:DurationUnit>
          <d2p1:FrequencyType>sample string 11</d2p1:FrequencyType>
          <d2p1:FrequencyUnit>10</d2p1:FrequencyUnit>
          <d2p1:LineNum>2</d2p1:LineNum>
          <d2p1:LineType>sample string 3</d2p1:LineType>
          <d2p1:NappiCode>sample string 6</d2p1:NappiCode>
          <d2p1:Parameters xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:Parameters>
          <d2p1:PeriodType>sample string 13</d2p1:PeriodType>
          <d2p1:PeriodUnit>12</d2p1:PeriodUnit>
          <d2p1:PriceOverride>true</d2p1:PriceOverride>
          <d2p1:Repeat>16</d2p1:Repeat>
          <d2p1:Responses xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:Responses>
          <d2p1:SchemeRule>sample string 26</d2p1:SchemeRule>
          <d2p1:TotalExcVat>19</d2p1:TotalExcVat>
          <d2p1:TotalIncVat>21</d2p1:TotalIncVat>
          <d2p1:UnitPrice>25</d2p1:UnitPrice>
          <d2p1:VatAmount>20</d2p1:VatAmount>
        </d2p1:EncounterLineItem>
      </d2p1:LineItems>
    </d2p1:EncounterLineItems>
    <d2p1:MedicationPrescriptionLines xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/clinical/v1/medicationprescription/">
      <d3p1:MedicationPrescriptionLine>
        <d3p1:AccelerateLearning>true</d3p1:AccelerateLearning>
        <d3p1:AdministrationInstructions>sample string 17</d3p1:AdministrationInstructions>
        <d3p1:AllowGeneric>true</d3p1:AllowGeneric>
        <d3p1:ChronicIndicator>true</d3p1:ChronicIndicator>
        <d3p1:CreatedFrom>sample string 19</d3p1:CreatedFrom>
        <d3p1:Description>sample string 18</d3p1:Description>
        <d3p1:Diagnosis>
          <d2p1:Diagnosis>
            <d2p1:AgeRangeEnd>1</d2p1:AgeRangeEnd>
            <d2p1:AgeRangeStart>1</d2p1:AgeRangeStart>
            <d2p1:DiagnosisCode>sample string 2</d2p1:DiagnosisCode>
            <d2p1:DiagnosisDescription>sample string 3</d2p1:DiagnosisDescription>
            <d2p1:DiagnosisToken>sample string 10</d2p1:DiagnosisToken>
            <d2p1:DiagnosisTokenDescription>sample string 11</d2p1:DiagnosisTokenDescription>
            <d2p1:Gender>sample string 9</d2p1:Gender>
            <d2p1:IcdSource>sample string 12</d2p1:IcdSource>
            <d2p1:Id>cd938db4-f2be-48b4-8afd-59cdeab93773</d2p1:Id>
            <d2p1:MaxSpecificity>true</d2p1:MaxSpecificity>
            <d2p1:OrderNo>13</d2p1:OrderNo>
            <d2p1:PrimaryIndicator>true</d2p1:PrimaryIndicator>
            <d2p1:SpecificCode>true</d2p1:SpecificCode>
            <d2p1:ValidPrimary>true</d2p1:ValidPrimary>
            <d2p1:ValidSequelae>true</d2p1:ValidSequelae>
          </d2p1:Diagnosis>
          <d2p1:Diagnosis>
            <d2p1:AgeRangeEnd>1</d2p1:AgeRangeEnd>
            <d2p1:AgeRangeStart>1</d2p1:AgeRangeStart>
            <d2p1:DiagnosisCode>sample string 2</d2p1:DiagnosisCode>
            <d2p1:DiagnosisDescription>sample string 3</d2p1:DiagnosisDescription>
            <d2p1:DiagnosisToken>sample string 10</d2p1:DiagnosisToken>
            <d2p1:DiagnosisTokenDescription>sample string 11</d2p1:DiagnosisTokenDescription>
            <d2p1:Gender>sample string 9</d2p1:Gender>
            <d2p1:IcdSource>sample string 12</d2p1:IcdSource>
            <d2p1:Id>cd938db4-f2be-48b4-8afd-59cdeab93773</d2p1:Id>
            <d2p1:MaxSpecificity>true</d2p1:MaxSpecificity>
            <d2p1:OrderNo>13</d2p1:OrderNo>
            <d2p1:PrimaryIndicator>true</d2p1:PrimaryIndicator>
            <d2p1:SpecificCode>true</d2p1:SpecificCode>
            <d2p1:ValidPrimary>true</d2p1:ValidPrimary>
            <d2p1:ValidSequelae>true</d2p1:ValidSequelae>
          </d2p1:Diagnosis>
        </d3p1:Diagnosis>
        <d3p1:DispensingInstructions>sample string 16</d3p1:DispensingInstructions>
        <d3p1:DosageType>sample string 6</d3p1:DosageType>
        <d3p1:DosageUnits>5</d3p1:DosageUnits>
        <d3p1:DurationType>sample string 12</d3p1:DurationType>
        <d3p1:DurationUnit>11</d3p1:DurationUnit>
        <d3p1:FrequencyMax>8</d3p1:FrequencyMax>
        <d3p1:FrequencyUnits>7</d3p1:FrequencyUnits>
        <d3p1:LineNum>2</d3p1:LineNum>
        <d3p1:MedicationDescription>sample string 3</d3p1:MedicationDescription>
        <d3p1:NappiCode>sample string 4</d3p1:NappiCode>
        <d3p1:Parameters xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d3p1:Parameters>
        <d3p1:PeriodType>sample string 10</d3p1:PeriodType>
        <d3p1:PeriodUnit>9</d3p1:PeriodUnit>
        <d3p1:Quantity>1</d3p1:Quantity>
        <d3p1:Repeat>13</d3p1:Repeat>
      </d3p1:MedicationPrescriptionLine>
      <d3p1:MedicationPrescriptionLine>
        <d3p1:AccelerateLearning>true</d3p1:AccelerateLearning>
        <d3p1:AdministrationInstructions>sample string 17</d3p1:AdministrationInstructions>
        <d3p1:AllowGeneric>true</d3p1:AllowGeneric>
        <d3p1:ChronicIndicator>true</d3p1:ChronicIndicator>
        <d3p1:CreatedFrom>sample string 19</d3p1:CreatedFrom>
        <d3p1:Description>sample string 18</d3p1:Description>
        <d3p1:Diagnosis>
          <d2p1:Diagnosis>
            <d2p1:AgeRangeEnd>1</d2p1:AgeRangeEnd>
            <d2p1:AgeRangeStart>1</d2p1:AgeRangeStart>
            <d2p1:DiagnosisCode>sample string 2</d2p1:DiagnosisCode>
            <d2p1:DiagnosisDescription>sample string 3</d2p1:DiagnosisDescription>
            <d2p1:DiagnosisToken>sample string 10</d2p1:DiagnosisToken>
            <d2p1:DiagnosisTokenDescription>sample string 11</d2p1:DiagnosisTokenDescription>
            <d2p1:Gender>sample string 9</d2p1:Gender>
            <d2p1:IcdSource>sample string 12</d2p1:IcdSource>
            <d2p1:Id>cd938db4-f2be-48b4-8afd-59cdeab93773</d2p1:Id>
            <d2p1:MaxSpecificity>true</d2p1:MaxSpecificity>
            <d2p1:OrderNo>13</d2p1:OrderNo>
            <d2p1:PrimaryIndicator>true</d2p1:PrimaryIndicator>
            <d2p1:SpecificCode>true</d2p1:SpecificCode>
            <d2p1:ValidPrimary>true</d2p1:ValidPrimary>
            <d2p1:ValidSequelae>true</d2p1:ValidSequelae>
          </d2p1:Diagnosis>
          <d2p1:Diagnosis>
            <d2p1:AgeRangeEnd>1</d2p1:AgeRangeEnd>
            <d2p1:AgeRangeStart>1</d2p1:AgeRangeStart>
            <d2p1:DiagnosisCode>sample string 2</d2p1:DiagnosisCode>
            <d2p1:DiagnosisDescription>sample string 3</d2p1:DiagnosisDescription>
            <d2p1:DiagnosisToken>sample string 10</d2p1:DiagnosisToken>
            <d2p1:DiagnosisTokenDescription>sample string 11</d2p1:DiagnosisTokenDescription>
            <d2p1:Gender>sample string 9</d2p1:Gender>
            <d2p1:IcdSource>sample string 12</d2p1:IcdSource>
            <d2p1:Id>cd938db4-f2be-48b4-8afd-59cdeab93773</d2p1:Id>
            <d2p1:MaxSpecificity>true</d2p1:MaxSpecificity>
            <d2p1:OrderNo>13</d2p1:OrderNo>
            <d2p1:PrimaryIndicator>true</d2p1:PrimaryIndicator>
            <d2p1:SpecificCode>true</d2p1:SpecificCode>
            <d2p1:ValidPrimary>true</d2p1:ValidPrimary>
            <d2p1:ValidSequelae>true</d2p1:ValidSequelae>
          </d2p1:Diagnosis>
        </d3p1:Diagnosis>
        <d3p1:DispensingInstructions>sample string 16</d3p1:DispensingInstructions>
        <d3p1:DosageType>sample string 6</d3p1:DosageType>
        <d3p1:DosageUnits>5</d3p1:DosageUnits>
        <d3p1:DurationType>sample string 12</d3p1:DurationType>
        <d3p1:DurationUnit>11</d3p1:DurationUnit>
        <d3p1:FrequencyMax>8</d3p1:FrequencyMax>
        <d3p1:FrequencyUnits>7</d3p1:FrequencyUnits>
        <d3p1:LineNum>2</d3p1:LineNum>
        <d3p1:MedicationDescription>sample string 3</d3p1:MedicationDescription>
        <d3p1:NappiCode>sample string 4</d3p1:NappiCode>
        <d3p1:Parameters xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d3p1:Parameters>
        <d3p1:PeriodType>sample string 10</d3p1:PeriodType>
        <d3p1:PeriodUnit>9</d3p1:PeriodUnit>
        <d3p1:Quantity>1</d3p1:Quantity>
        <d3p1:Repeat>13</d3p1:Repeat>
      </d3p1:MedicationPrescriptionLine>
    </d2p1:MedicationPrescriptionLines>
    <d2p1:PracticeId>19c82476-b082-48ca-8e00-569349788f30</d2p1:PracticeId>
    <d2p1:SortOrder>7</d2p1:SortOrder>
    <d2p1:TemplateId>7e0dd7e1-b9e2-4a40-913d-64148daadc0e</d2p1:TemplateId>
    <d2p1:TemplateType>sample string 4</d2p1:TemplateType>
    <d2p1:TemplateXref>sample string 2</d2p1:TemplateXref>
  </EncounterTemplate>
</UpdateEncounterTemplate>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'UpdateEncounterTemplate'.

Response Information

Resource Description

Id of created encounter template

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Guid

Name	Type	Additional information
Sucess	boolean	None.
ResponseCode	integer	None.
ResponseMessage	string	None.
Data	globally unique identifier	None.
Links	Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink	None.

Response Formats

application/json, text/json

Sample:

{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": "604045e7-6ad9-426c-906e-8e865bf24ff5",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>604045e7-6ad9-426c-906e-8e865bf24ff5</Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfguid>

URI parameters

Headers | Add header

Body

Status

Headers

Body

POST api/v1/{practiceid}/clinical/encountertemplates

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml