GET api/v1/{practiceid}/claiming/claims/{claimid}

Get claim by their id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceid

practice NodeId

globally unique identifier

Required

claimid

claim id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Com.Healthbridge.Hhas.Claiming.Interface.ValueObjects.Claim
NameDescriptionTypeAdditional information
Transaction

Com.Healthbridge.Hhas.Claiming.Interface.ValueObjects.ClaimTransaction

None.

Providers

Collection of Com.Healthbridge.Hhas.Claiming.Interface.ValueObjects.Provider

None.

Member

Com.Healthbridge.Hhas.Claiming.Interface.ValueObjects.Member

None.

Patient

Com.Healthbridge.Hhas.Claiming.Interface.ValueObjects.Patient

None.

Details

Com.Healthbridge.Hhas.Claiming.Interface.ValueObjects.ClaimDetails

None.

Response Formats

application/json, text/json

Sample:
{
  "Transaction": null,
  "Providers": [
    {
      "Type": "Billing",
      "SpecialtyCode": "sample string 1",
      "SubSpecialtyCode": "sample string 2",
      "DispensingDoctor": "Yes",
      "DispensingLicNum": "sample string 3",
      "PracticeName": "sample string 4",
      "PracticeNum": "sample string 5",
      "HPCSA": "sample string 6",
      "Demographics": {
        "PostalAddress": {
          "Suburb": "sample string 2",
          "Town": "sample string 3",
          "Code": "sample string 4",
          "Address": "sample string 1"
        },
        "PhysicalAddress": {
          "Suburb": "sample string 2",
          "Town": "sample string 3",
          "Code": "sample string 4",
          "Address": "sample string 1"
        },
        "WkTelephone": "sample string 1",
        "HMTelephone": "sample string 2",
        "Fax": "sample string 3",
        "Cellphone": "sample string 4",
        "Email": "sample string 5"
      }
    },
    {
      "Type": "Billing",
      "SpecialtyCode": "sample string 1",
      "SubSpecialtyCode": "sample string 2",
      "DispensingDoctor": "Yes",
      "DispensingLicNum": "sample string 3",
      "PracticeName": "sample string 4",
      "PracticeNum": "sample string 5",
      "HPCSA": "sample string 6",
      "Demographics": {
        "PostalAddress": {
          "Suburb": "sample string 2",
          "Town": "sample string 3",
          "Code": "sample string 4",
          "Address": "sample string 1"
        },
        "PhysicalAddress": {
          "Suburb": "sample string 2",
          "Town": "sample string 3",
          "Code": "sample string 4",
          "Address": "sample string 1"
        },
        "WkTelephone": "sample string 1",
        "HMTelephone": "sample string 2",
        "Fax": "sample string 3",
        "Cellphone": "sample string 4",
        "Email": "sample string 5"
      }
    }
  ],
  "Member": {
    "Name": "sample string 1",
    "Initials": "sample string 2",
    "Surname": "sample string 3",
    "DOB": "2025-04-10T16:53:15Z",
    "ID": "sample string 5",
    "MANum": "sample string 6",
    "SchemeName": "sample string 7",
    "SchemeReg": "sample string 8",
    "Demographics": {
      "PostalAddress": {
        "Suburb": "sample string 2",
        "Town": "sample string 3",
        "Code": "sample string 4",
        "Address": "sample string 1"
      },
      "PhysicalAddress": {
        "Suburb": "sample string 2",
        "Town": "sample string 3",
        "Code": "sample string 4",
        "Address": "sample string 1"
      },
      "WkTelephone": "sample string 1",
      "HMTelephone": "sample string 2",
      "Fax": "sample string 3",
      "Cellphone": "sample string 4",
      "Email": "sample string 5"
    },
    "Gender": "Male"
  },
  "Patient": {
    "Name": "sample string 1",
    "Initials": "sample string 2",
    "Surname": "sample string 3",
    "DOB": "2025-04-10T16:53:15Z",
    "ID": "sample string 5",
    "DepCode": "sample string 6",
    "Identifier": "sample string 7",
    "AccNum": "sample string 8",
    "Demographics": {
      "PostalAddress": {
        "Suburb": "sample string 2",
        "Town": "sample string 3",
        "Code": "sample string 4",
        "Address": "sample string 1"
      },
      "PhysicalAddress": {
        "Suburb": "sample string 2",
        "Town": "sample string 3",
        "Code": "sample string 4",
        "Address": "sample string 1"
      },
      "WkTelephone": "sample string 1",
      "HMTelephone": "sample string 2",
      "Fax": "sample string 3",
      "Cellphone": "sample string 4",
      "Email": "sample string 5"
    },
    "Gender": "Male",
    "NewBornInd": "Yes"
  },
  "Details": {
    "AuthNum": "sample string 1",
    "ReferralNum": "sample string 2",
    "DiagnosisCodes": [
      {
        "Version": "sample string 1",
        "Value": "sample string 2",
        "Description": "sample string 3",
        "Set": "ICD"
      },
      {
        "Version": "sample string 1",
        "Value": "sample string 2",
        "Description": "sample string 3",
        "Set": "ICD"
      }
    ],
    "AdmDateTime": "sample string 3",
    "DisDateTime": "sample string 4",
    "OptomScripts": [
      {
        "Ref": "sample string 1",
        "Type": 0,
        "PowerSpher": "sample string 2",
        "PowerCylin": "sample string 3",
        "Axis": 4,
        "Add": "sample string 5",
        "Prism": "sample string 6",
        "VisualAcuity": "sample string 7",
        "InocularPressure": "sample string 8",
        "VisualFieldInfo": "sample string 9",
        "NVSTagNum": "sample string 10",
        "Labref": "sample string 11",
        "LabOrderNum": "sample string 12",
        "Eye": "Left",
        "Status": "Current"
      },
      {
        "Ref": "sample string 1",
        "Type": 0,
        "PowerSpher": "sample string 2",
        "PowerCylin": "sample string 3",
        "Axis": 4,
        "Add": "sample string 5",
        "Prism": "sample string 6",
        "VisualAcuity": "sample string 7",
        "InocularPressure": "sample string 8",
        "VisualFieldInfo": "sample string 9",
        "NVSTagNum": "sample string 10",
        "Labref": "sample string 11",
        "LabOrderNum": "sample string 12",
        "Eye": "Left",
        "Status": "Current"
      }
    ],
    "ClaimFinancials": {
      "TotalBilledAmt": 1,
      "TotalDiscount": 2,
      "NettBilledAmt": 3
    },
    "LineItems": [
      null,
      {
        "UniqueID": null,
        "OptomScriptRefs": null,
        "DOS": "0001-01-01T00:00:00Z",
        "Labs": null,
        "AuthNum": null,
        "ScriptNum": null,
        "ChargeCode": null,
        "StockCode": null,
        "DiagnosisCodes": null,
        "ChargeStart": "0001-01-01T00:00:00Z",
        "ChargeEnd": "0001-01-01T00:00:00Z",
        "ChargeQuantity": 0,
        "Dentals": null,
        "PlaceServiceCode": "11",
        "Medicine": null,
        "LineItemFinancials": null,
        "Type": "Procedure",
        "PricingInd": "Private",
        "ChargeUnit": "Days",
        "ContactLensChargeFreq": "Days",
        "HospInd": "Yes"
      }
    ],
    "PayWho": "Provider",
    "HospInd": "Yes",
    "RecInd": "MVA"
  }
}

application/xml, text/xml

Sample:
<Claim xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Claiming.Interface.ValueObjects">
  <Transaction i:nil="true" />
  <Providers>
    <Provider>
      <Type>Billing</Type>
      <SpecialtyCode>sample string 1</SpecialtyCode>
      <SubSpecialtyCode>sample string 2</SubSpecialtyCode>
      <DispensingDoctor>Yes</DispensingDoctor>
      <DispensingLicNum>sample string 3</DispensingLicNum>
      <PracticeName>sample string 4</PracticeName>
      <PracticeNum>sample string 5</PracticeNum>
      <HPCSA>sample string 6</HPCSA>
      <Demographics>
        <Cellphone>sample string 4</Cellphone>
        <Email>sample string 5</Email>
        <Fax>sample string 3</Fax>
        <HMTelephone>sample string 2</HMTelephone>
        <PhysicalAddress>
          <Code>sample string 4</Code>
          <Suburb>sample string 2</Suburb>
          <Town>sample string 3</Town>
          <Address>sample string 1</Address>
        </PhysicalAddress>
        <PostalAddress>
          <Code>sample string 4</Code>
          <Suburb>sample string 2</Suburb>
          <Town>sample string 3</Town>
          <Address>sample string 1</Address>
        </PostalAddress>
        <WkTelephone>sample string 1</WkTelephone>
      </Demographics>
    </Provider>
    <Provider>
      <Type>Billing</Type>
      <SpecialtyCode>sample string 1</SpecialtyCode>
      <SubSpecialtyCode>sample string 2</SubSpecialtyCode>
      <DispensingDoctor>Yes</DispensingDoctor>
      <DispensingLicNum>sample string 3</DispensingLicNum>
      <PracticeName>sample string 4</PracticeName>
      <PracticeNum>sample string 5</PracticeNum>
      <HPCSA>sample string 6</HPCSA>
      <Demographics>
        <Cellphone>sample string 4</Cellphone>
        <Email>sample string 5</Email>
        <Fax>sample string 3</Fax>
        <HMTelephone>sample string 2</HMTelephone>
        <PhysicalAddress>
          <Code>sample string 4</Code>
          <Suburb>sample string 2</Suburb>
          <Town>sample string 3</Town>
          <Address>sample string 1</Address>
        </PhysicalAddress>
        <PostalAddress>
          <Code>sample string 4</Code>
          <Suburb>sample string 2</Suburb>
          <Town>sample string 3</Town>
          <Address>sample string 1</Address>
        </PostalAddress>
        <WkTelephone>sample string 1</WkTelephone>
      </Demographics>
    </Provider>
  </Providers>
  <Member>
    <DOB>2025-04-10T16:53:15.598588+02:00</DOB>
    <Demographics>
      <Cellphone>sample string 4</Cellphone>
      <Email>sample string 5</Email>
      <Fax>sample string 3</Fax>
      <HMTelephone>sample string 2</HMTelephone>
      <PhysicalAddress>
        <Code>sample string 4</Code>
        <Suburb>sample string 2</Suburb>
        <Town>sample string 3</Town>
        <Address>sample string 1</Address>
      </PhysicalAddress>
      <PostalAddress>
        <Code>sample string 4</Code>
        <Suburb>sample string 2</Suburb>
        <Town>sample string 3</Town>
        <Address>sample string 1</Address>
      </PostalAddress>
      <WkTelephone>sample string 1</WkTelephone>
    </Demographics>
    <Gender>Male</Gender>
    <ID>sample string 5</ID>
    <Initials>sample string 2</Initials>
    <MANum>sample string 6</MANum>
    <Name>sample string 1</Name>
    <SchemeName>sample string 7</SchemeName>
    <SchemeReg>sample string 8</SchemeReg>
    <Surname>sample string 3</Surname>
  </Member>
  <Patient>
    <AccNum>sample string 8</AccNum>
    <DOB>2025-04-10T16:53:15.598588+02:00</DOB>
    <Demographics>
      <Cellphone>sample string 4</Cellphone>
      <Email>sample string 5</Email>
      <Fax>sample string 3</Fax>
      <HMTelephone>sample string 2</HMTelephone>
      <PhysicalAddress>
        <Code>sample string 4</Code>
        <Suburb>sample string 2</Suburb>
        <Town>sample string 3</Town>
        <Address>sample string 1</Address>
      </PhysicalAddress>
      <PostalAddress>
        <Code>sample string 4</Code>
        <Suburb>sample string 2</Suburb>
        <Town>sample string 3</Town>
        <Address>sample string 1</Address>
      </PostalAddress>
      <WkTelephone>sample string 1</WkTelephone>
    </Demographics>
    <DepCode>sample string 6</DepCode>
    <Gender>Male</Gender>
    <ID>sample string 5</ID>
    <Identifier>sample string 7</Identifier>
    <Initials>sample string 2</Initials>
    <Name>sample string 1</Name>
    <NewBornInd>Yes</NewBornInd>
    <Surname>sample string 3</Surname>
  </Patient>
  <Details>
    <AdmDateTime>sample string 3</AdmDateTime>
    <AuthNum>sample string 1</AuthNum>
    <ClaimFinancials>
      <NettBilledAmt>3</NettBilledAmt>
      <TotalBilledAmt>1</TotalBilledAmt>
      <TotalDiscount>2</TotalDiscount>
    </ClaimFinancials>
    <DiagnosisCodes>
      <ClaimDiagnosisCodes>
        <Description>sample string 3</Description>
        <Set>ICD</Set>
        <Value>sample string 2</Value>
        <Version>sample string 1</Version>
      </ClaimDiagnosisCodes>
      <ClaimDiagnosisCodes>
        <Description>sample string 3</Description>
        <Set>ICD</Set>
        <Value>sample string 2</Value>
        <Version>sample string 1</Version>
      </ClaimDiagnosisCodes>
    </DiagnosisCodes>
    <DisDateTime>sample string 4</DisDateTime>
    <HospInd>Yes</HospInd>
    <LineItems>
      <ClaimLineItem i:nil="true" />
      <ClaimLineItem>
        <AuthNum i:nil="true" />
        <ChargeCode i:nil="true" />
        <ChargeEnd>0001-01-01T00:00:00</ChargeEnd>
        <ChargeQuantity>0</ChargeQuantity>
        <ChargeStart>0001-01-01T00:00:00</ChargeStart>
        <ChargeUnit>Days</ChargeUnit>
        <ContactLensChargeFreq>Days</ContactLensChargeFreq>
        <DOS>0001-01-01T00:00:00</DOS>
        <Dentals i:nil="true" />
        <DiagnosisCodes i:nil="true" />
        <HospInd>Yes</HospInd>
        <Labs i:nil="true" />
        <LineItemFinancials i:nil="true" />
        <Medicine i:nil="true" />
        <OptomScriptRefs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <PlaceServiceCode>11</PlaceServiceCode>
        <PricingInd>Private</PricingInd>
        <ScriptNum i:nil="true" />
        <StockCode i:nil="true" />
        <Type>Procedure</Type>
        <UniqueID i:nil="true" />
      </ClaimLineItem>
    </LineItems>
    <OptomScripts>
      <ClaimOptomScripts>
        <Add>sample string 5</Add>
        <Axis>4</Axis>
        <Eye>Left</Eye>
        <InocularPressure>sample string 8</InocularPressure>
        <LabOrderNum>sample string 12</LabOrderNum>
        <Labref>sample string 11</Labref>
        <NVSTagNum>sample string 10</NVSTagNum>
        <PowerCylin>sample string 3</PowerCylin>
        <PowerSpher>sample string 2</PowerSpher>
        <Prism>sample string 6</Prism>
        <Ref>sample string 1</Ref>
        <Status>Current</Status>
        <Type>Spectacle</Type>
        <VisualAcuity>sample string 7</VisualAcuity>
        <VisualFieldInfo>sample string 9</VisualFieldInfo>
      </ClaimOptomScripts>
      <ClaimOptomScripts>
        <Add>sample string 5</Add>
        <Axis>4</Axis>
        <Eye>Left</Eye>
        <InocularPressure>sample string 8</InocularPressure>
        <LabOrderNum>sample string 12</LabOrderNum>
        <Labref>sample string 11</Labref>
        <NVSTagNum>sample string 10</NVSTagNum>
        <PowerCylin>sample string 3</PowerCylin>
        <PowerSpher>sample string 2</PowerSpher>
        <Prism>sample string 6</Prism>
        <Ref>sample string 1</Ref>
        <Status>Current</Status>
        <Type>Spectacle</Type>
        <VisualAcuity>sample string 7</VisualAcuity>
        <VisualFieldInfo>sample string 9</VisualFieldInfo>
      </ClaimOptomScripts>
    </OptomScripts>
    <PayWho>Provider</PayWho>
    <RecInd>MVA</RecInd>
    <ReferralNum>sample string 2</ReferralNum>
  </Details>
</Claim>