GET api/v1/billing/specialityrules

Returns list of all speciality rules

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Array of invoices

Collection of Com.Healthbridge.Hhas.Billing.Interface.ValueObjects.SpecialityRuleVo
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
SpecialityCode

Speciality code (086)

 string

None.
Speciality

Speciality name (Psychologist, Physiotherapist, etc)

 string

None.
DefaultProcedureCode

Default consultation code to be added to encounter

 string

None.
ConsumableProcedureCode

Default consumable procedure code to be used for consumable lines

 string

None.
PrefixChargeCodesOnClaim

Prefix charge codes during lookup

 boolean

None.
AvailableWards

Collection of string

None.
MutuallyExclusiveCodes

List of codes which shouldn't be used together with each other in one encounter

 Collection of Collection of string

None.
Options

Define the list of features allowed for speciality

 Dictionary of string [key] and string [value]

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "9b8b4c39-4d9e-4075-bab5-8f52b3a3e77e",
    "SpecialityCode": "sample string 2",
    "Speciality": "sample string 3",
    "DefaultProcedureCode": "sample string 4",
    "ConsumableProcedureCode": "sample string 5",
    "PrefixChargeCodesOnClaim": true,
    "AvailableWards": [
      "sample string 1",
      "sample string 2"
    ],
    "MutuallyExclusiveCodes": [
      [
        "sample string 1",
        "sample string 2"
      ],
      [
        "sample string 1",
        "sample string 2"
      ]
    ],
    "Options": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  },
  {
    "Id": "9b8b4c39-4d9e-4075-bab5-8f52b3a3e77e",
    "SpecialityCode": "sample string 2",
    "Speciality": "sample string 3",
    "DefaultProcedureCode": "sample string 4",
    "ConsumableProcedureCode": "sample string 5",
    "PrefixChargeCodesOnClaim": true,
    "AvailableWards": [
      "sample string 1",
      "sample string 2"
    ],
    "MutuallyExclusiveCodes": [
      [
        "sample string 1",
        "sample string 2"
      ],
      [
        "sample string 1",
        "sample string 2"
      ]
    ],
    "Options": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  }
]

application/xml, text/xml

Sample: 
<ArrayOfSpecialityRuleVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Billing.Interface.ValueObjects">
  <SpecialityRuleVo>
    <AvailableWards xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AvailableWards>
    <ConsumableProcedureCode>sample string 5</ConsumableProcedureCode>
    <DefaultProcedureCode>sample string 4</DefaultProcedureCode>
    <Id>9b8b4c39-4d9e-4075-bab5-8f52b3a3e77e</Id>
    <MutuallyExclusiveCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfstring>
        <d3p1:string>sample string 1</d3p1:string>
        <d3p1:string>sample string 2</d3p1:string>
      </d3p1:ArrayOfstring>
      <d3p1:ArrayOfstring>
        <d3p1:string>sample string 1</d3p1:string>
        <d3p1:string>sample string 2</d3p1:string>
      </d3p1:ArrayOfstring>
    </MutuallyExclusiveCodes>
    <Options xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Options>
    <PrefixChargeCodesOnClaim>true</PrefixChargeCodesOnClaim>
    <Speciality>sample string 3</Speciality>
    <SpecialityCode>sample string 2</SpecialityCode>
  </SpecialityRuleVo>
  <SpecialityRuleVo>
    <AvailableWards xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AvailableWards>
    <ConsumableProcedureCode>sample string 5</ConsumableProcedureCode>
    <DefaultProcedureCode>sample string 4</DefaultProcedureCode>
    <Id>9b8b4c39-4d9e-4075-bab5-8f52b3a3e77e</Id>
    <MutuallyExclusiveCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfstring>
        <d3p1:string>sample string 1</d3p1:string>
        <d3p1:string>sample string 2</d3p1:string>
      </d3p1:ArrayOfstring>
      <d3p1:ArrayOfstring>
        <d3p1:string>sample string 1</d3p1:string>
        <d3p1:string>sample string 2</d3p1:string>
      </d3p1:ArrayOfstring>
    </MutuallyExclusiveCodes>
    <Options xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Options>
    <PrefixChargeCodesOnClaim>true</PrefixChargeCodesOnClaim>
    <Speciality>sample string 3</Speciality>
    <SpecialityCode>sample string 2</SpecialityCode>
  </SpecialityRuleVo>
</ArrayOfSpecialityRuleVo>