GET api/v1/patient/medschemes

Get all medical aids

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Array of medical aids

Collection of Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.MedicalAidVo
NameDescriptionTypeAdditional information
Name

string

None.
SchemeCode

string

None.
Plans

Collection of Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.PlanVo

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Name": "sample string 1",
    "SchemeCode": "sample string 2",
    "Plans": [
      {
        "Name": "sample string 1",
        "PlanCode": "sample string 2",
        "Options": [
          {
            "Name": "sample string 1",
            "PVEnabled": true,
            "RoutingCode": "sample string 3",
            "OptionCode": "sample string 4"
          },
          {
            "Name": "sample string 1",
            "PVEnabled": true,
            "RoutingCode": "sample string 3",
            "OptionCode": "sample string 4"
          }
        ]
      },
      {
        "Name": "sample string 1",
        "PlanCode": "sample string 2",
        "Options": [
          {
            "Name": "sample string 1",
            "PVEnabled": true,
            "RoutingCode": "sample string 3",
            "OptionCode": "sample string 4"
          },
          {
            "Name": "sample string 1",
            "PVEnabled": true,
            "RoutingCode": "sample string 3",
            "OptionCode": "sample string 4"
          }
        ]
      }
    ]
  },
  {
    "Name": "sample string 1",
    "SchemeCode": "sample string 2",
    "Plans": [
      {
        "Name": "sample string 1",
        "PlanCode": "sample string 2",
        "Options": [
          {
            "Name": "sample string 1",
            "PVEnabled": true,
            "RoutingCode": "sample string 3",
            "OptionCode": "sample string 4"
          },
          {
            "Name": "sample string 1",
            "PVEnabled": true,
            "RoutingCode": "sample string 3",
            "OptionCode": "sample string 4"
          }
        ]
      },
      {
        "Name": "sample string 1",
        "PlanCode": "sample string 2",
        "Options": [
          {
            "Name": "sample string 1",
            "PVEnabled": true,
            "RoutingCode": "sample string 3",
            "OptionCode": "sample string 4"
          },
          {
            "Name": "sample string 1",
            "PVEnabled": true,
            "RoutingCode": "sample string 3",
            "OptionCode": "sample string 4"
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfMedicalAid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
  <MedicalAid>
    <Name>sample string 1</Name>
    <Plans>
      <Plan>
        <Name>sample string 1</Name>
        <Options>
          <Option>
            <Name>sample string 1</Name>
            <OptionCode>sample string 4</OptionCode>
            <PVEnabled>true</PVEnabled>
            <RoutingCode>sample string 3</RoutingCode>
          </Option>
          <Option>
            <Name>sample string 1</Name>
            <OptionCode>sample string 4</OptionCode>
            <PVEnabled>true</PVEnabled>
            <RoutingCode>sample string 3</RoutingCode>
          </Option>
        </Options>
        <PlanCode>sample string 2</PlanCode>
      </Plan>
      <Plan>
        <Name>sample string 1</Name>
        <Options>
          <Option>
            <Name>sample string 1</Name>
            <OptionCode>sample string 4</OptionCode>
            <PVEnabled>true</PVEnabled>
            <RoutingCode>sample string 3</RoutingCode>
          </Option>
          <Option>
            <Name>sample string 1</Name>
            <OptionCode>sample string 4</OptionCode>
            <PVEnabled>true</PVEnabled>
            <RoutingCode>sample string 3</RoutingCode>
          </Option>
        </Options>
        <PlanCode>sample string 2</PlanCode>
      </Plan>
    </Plans>
    <SchemeCode>sample string 2</SchemeCode>
  </MedicalAid>
  <MedicalAid>
    <Name>sample string 1</Name>
    <Plans>
      <Plan>
        <Name>sample string 1</Name>
        <Options>
          <Option>
            <Name>sample string 1</Name>
            <OptionCode>sample string 4</OptionCode>
            <PVEnabled>true</PVEnabled>
            <RoutingCode>sample string 3</RoutingCode>
          </Option>
          <Option>
            <Name>sample string 1</Name>
            <OptionCode>sample string 4</OptionCode>
            <PVEnabled>true</PVEnabled>
            <RoutingCode>sample string 3</RoutingCode>
          </Option>
        </Options>
        <PlanCode>sample string 2</PlanCode>
      </Plan>
      <Plan>
        <Name>sample string 1</Name>
        <Options>
          <Option>
            <Name>sample string 1</Name>
            <OptionCode>sample string 4</OptionCode>
            <PVEnabled>true</PVEnabled>
            <RoutingCode>sample string 3</RoutingCode>
          </Option>
          <Option>
            <Name>sample string 1</Name>
            <OptionCode>sample string 4</OptionCode>
            <PVEnabled>true</PVEnabled>
            <RoutingCode>sample string 3</RoutingCode>
          </Option>
        </Options>
        <PlanCode>sample string 2</PlanCode>
      </Plan>
    </Plans>
    <SchemeCode>sample string 2</SchemeCode>
  </MedicalAid>
</ArrayOfMedicalAid>