GET api/v1/{practiceId}/clinical/modifiers/{code}/info

Return modifier info (expected meta-data required to properly apply calculation logic for specific modifier), status (e.g. 0018 it would be 2 elements: Weight,Height)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

Unique identifier of practice

 globally unique identifier

Required
code

Unique identifier of modifier (e.g. 00005,0009, etc)

 string

Required

Body Parameters

None.

Response Information

Resource Description

encounter template

Com.Healthbridge.Hhas.Billing.Interface.ValueObjects.ModifierInformation
NameDescriptionTypeAdditional information
Name

string

None.
Code

string

None.
ImplementationStatus

string

None.
RequiredParameters

Collection of Com.Healthbridge.Hhas.Billing.Interface.ValueObjects.ModifierRequiredParameter

None.

Response Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "Code": "sample string 2",
  "ImplementationStatus": "sample string 3",
  "RequiredParameters": [
    {
      "FieldName": "sample string 1",
      "Type": "sample string 2",
      "Format": "sample string 3",
      "Description": "sample string 4",
      "Ordering": 5,
      "IsHeaderLevel": true,
      "Required": true
    },
    {
      "FieldName": "sample string 1",
      "Type": "sample string 2",
      "Format": "sample string 3",
      "Description": "sample string 4",
      "Ordering": 5,
      "IsHeaderLevel": true,
      "Required": true
    }
  ]
}

application/xml, text/xml

Sample: 
<ModifierInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Billing.Interface.ValueObjects">
  <Code>sample string 2</Code>
  <ImplementationStatus>sample string 3</ImplementationStatus>
  <Name>sample string 1</Name>
  <RequiredParameters>
    <ModifierRequiredParameter>
      <Description>sample string 4</Description>
      <FieldName>sample string 1</FieldName>
      <Format>sample string 3</Format>
      <IsHeaderLevel>true</IsHeaderLevel>
      <Ordering>5</Ordering>
      <Required>true</Required>
      <Type>sample string 2</Type>
    </ModifierRequiredParameter>
    <ModifierRequiredParameter>
      <Description>sample string 4</Description>
      <FieldName>sample string 1</FieldName>
      <Format>sample string 3</Format>
      <IsHeaderLevel>true</IsHeaderLevel>
      <Ordering>5</Ordering>
      <Required>true</Required>
      <Type>sample string 2</Type>
    </ModifierRequiredParameter>
  </RequiredParameters>
</ModifierInformation>