POST api/formularies/{formularyid}/formularycompanydiagnosiscodelimits

Posts a new Formulary Company Diagnosis Code Limit

Request Information

URI Parameters

NameDescriptionTypeAdditional information
formularyid

The id of the formulary for which diagnosis code limit

integer

Required

Body Parameters

FormularyCompanyDiagnosisCodeLimitModel
NameDescriptionTypeAdditional information
CompanyDiagnosisCodeLimitSeqNo

Gets or sets the value indicating whether this formulary diagnosis code limit is inheriting from a global/company-level diagnosis code limit.

integer

None.

CompanyDiagnosisCodeLimitUrl

Gets the url where the global/company-level diagnosis code limit resource can be found

string

None.

ProductID

Gets or sets the product ID for this resource. The value should be a valid NDC, DDID or GPI.

string

None.

ProductIDType

Gets or sets the product ID Type for the ProductID value set on this resource. The value will indicate whether the product ID for this resource is an NDC or DDID . String values other than 'NDC' or 'DDID' will not be valid.

string

None.

Name

Gets or sets the description of the diagnosis code limit company level resource

string

None.

Active

Gets or sets the value indicating whether this diagnosis code limit is currently active.

boolean

None.

EffectiveStartDate

Gets or sets the Effective Start Date of this resource

date

None.

EffectiveEndDate

Gets or sets the Effective End Date of this resource

date

None.

DxCodesUrl

Gets or sets the URL that can be accessed to find which dx codes should be tried as part of this Diagnosis Code Limit resource.

string

None.

DxCodes

Collection of CompanyDiagnosisCodeLimitDxCodeModel

None.

Url

Gets or sets the link representing a link back to the resource

string

None.

ID

Gets or sets the identifier for the resource

integer

None.

Request Formats

application/json, text/json, application/json-patch+json

Sample:
{
  "url": "sample string 7",
  "id": 8,
  "companyDiagnosisCodeLimitSeqNo": 1,
  "companyDiagnosisCodeLimitUrl": "sample string 1",
  "productID": "sample string 3",
  "productIDType": "sample string 4",
  "name": "sample string 5",
  "active": true,
  "effectiveStartDate": "2025-05-30T03:39:38.4148013-05:00",
  "effectiveEndDate": "2025-05-30T03:39:38.4148013-05:00",
  "dxCodesUrl": "sample string 6",
  "dxCodes": [
    {
      "url": "sample string 5",
      "id": 0,
      "seqNo": 1,
      "companyDiagnosisCodeLimitSeqNo": 2,
      "diagnosisCode": "sample string 3",
      "diagnosisCodeType": "sample string 4",
      "isActive": true,
      "createdOn": "2025-05-30T03:39:38.4148013-05:00",
      "changedOn": "2025-05-30T03:39:38.4148013-05:00"
    },
    {
      "url": "sample string 5",
      "id": 0,
      "seqNo": 1,
      "companyDiagnosisCodeLimitSeqNo": 2,
      "diagnosisCode": "sample string 3",
      "diagnosisCodeType": "sample string 4",
      "isActive": true,
      "createdOn": "2025-05-30T03:39:38.4148013-05:00",
      "changedOn": "2025-05-30T03:39:38.4148013-05:00"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The newly created Formulary Company Diagnosis Code Limit object

FormularyCompanyDiagnosisCodeLimitModel
NameDescriptionTypeAdditional information
CompanyDiagnosisCodeLimitSeqNo

Gets or sets the value indicating whether this formulary diagnosis code limit is inheriting from a global/company-level diagnosis code limit.

integer

None.

CompanyDiagnosisCodeLimitUrl

Gets the url where the global/company-level diagnosis code limit resource can be found

string

None.

ProductID

Gets or sets the product ID for this resource. The value should be a valid NDC, DDID or GPI.

string

None.

ProductIDType

Gets or sets the product ID Type for the ProductID value set on this resource. The value will indicate whether the product ID for this resource is an NDC or DDID . String values other than 'NDC' or 'DDID' will not be valid.

string

None.

Name

Gets or sets the description of the diagnosis code limit company level resource

string

None.

Active

Gets or sets the value indicating whether this diagnosis code limit is currently active.

boolean

None.

EffectiveStartDate

Gets or sets the Effective Start Date of this resource

date

None.

EffectiveEndDate

Gets or sets the Effective End Date of this resource

date

None.

DxCodesUrl

Gets or sets the URL that can be accessed to find which dx codes should be tried as part of this Diagnosis Code Limit resource.

string

None.

DxCodes

Collection of CompanyDiagnosisCodeLimitDxCodeModel

None.

Url

Gets or sets the link representing a link back to the resource

string

None.

ID

Gets or sets the identifier for the resource

integer

None.

Response Formats

application/json, text/json, application/json-patch+json

Sample:
{
  "url": "sample string 7",
  "id": 8,
  "companyDiagnosisCodeLimitSeqNo": 1,
  "companyDiagnosisCodeLimitUrl": "sample string 1",
  "productID": "sample string 3",
  "productIDType": "sample string 4",
  "name": "sample string 5",
  "active": true,
  "effectiveStartDate": "2025-05-30T03:39:38.4148013-05:00",
  "effectiveEndDate": "2025-05-30T03:39:38.4148013-05:00",
  "dxCodesUrl": "sample string 6",
  "dxCodes": [
    {
      "url": "sample string 5",
      "id": 0,
      "seqNo": 1,
      "companyDiagnosisCodeLimitSeqNo": 2,
      "diagnosisCode": "sample string 3",
      "diagnosisCodeType": "sample string 4",
      "isActive": true,
      "createdOn": "2025-05-30T03:39:38.4148013-05:00",
      "changedOn": "2025-05-30T03:39:38.4148013-05:00"
    },
    {
      "url": "sample string 5",
      "id": 0,
      "seqNo": 1,
      "companyDiagnosisCodeLimitSeqNo": 2,
      "diagnosisCode": "sample string 3",
      "diagnosisCodeType": "sample string 4",
      "isActive": true,
      "createdOn": "2025-05-30T03:39:38.4148013-05:00",
      "changedOn": "2025-05-30T03:39:38.4148013-05:00"
    }
  ]
}