Skip to main content
GET
Get Procedure

Authorizations

Authorization
string
header
required

The API requires a Bearer token (JWT) for authentication.

Headers

X-Pt-Id
string

Eka User ID (OID)

X-Partner-Pt-Id
string

Partner User ID

X-Hip-Id
string

Partner HIP ID

Path Parameters

policyId
integer
required

policy_id from Search Policies or Policy Discovery Status

Required range: x >= 0
procedureCode
string
required

Procedure code from List Procedures

Response

OK

claim_amount
number

ClaimAmount / MandatoryDocs / STGForms are populated by GetProcedure's join step (not stored directly on the Dynamo item) so existing consumers keep working unchanged: ClaimAmount mirrors the "Procedure" cost line (or the first cost line if none is typed "Procedure"); MandatoryDocs/STGForms are the joined documents' MAND codes / STG display strings. MandatoryDocDetails is the same join's full document records (category/code/display) keyed off MandCode, added so callers that need the richer metadata (e.g. enrichPreAuthItems filling CategoryDisplay/DocDisplay) don't need a second CatalogStore call — it is additive and safe to ignore.

code
string
costs
object[]
discharge_stages
string
document_ids
string[]
flags
string[]
is_unspecified
boolean

Marks an "Unspecified Surgical Package" (code "U100"). Derived from the code at read time (not stored), so the FE knows to render the free-text name + amount fields: these packages have no catalog price (ClaimAmount is the 9999999 sentinel) and the provider must supply both. Such an item also cannot be clubbed with other procedures — see unspecified_procedure.go.

mandatory_doc_details
object[]
mandatory_docs
string[]
maximum_cycles_allowed
integer
maximum_implants_allowed
integer
maximum_stratification_allowed
integer
name
string
parent_procedure
string

The procedure an IMPLANT line attaches to (implant caps/flags live on that parent, not on the implant); DischargeStages is the LAMA/DAMA stage list. Both mirror NormProcedure — see the notes there.

parent_procedures
string[]
quantity_allowed
integer

The four numeric Claim-Condition caps, mirroring NormProcedure's — see the note there for why they are not omitempty (0 is a real value) and why callers must gate on the matching Flags entry before reading a cap.

questionnaire_ids
string[]
speciality_codes
string[]
standalone
boolean

Standalone / ParentProcedures are read-time conveniences for the FE's payer-enforced standalone/parent-procedure validations: Standalone surfaces the Flags entry as a bool; ParentProcedures splits ParentProcedure's comma list ("NA" normalised away). Derived in joinProcedureDocuments, not stored.

stg_forms
string[]
type
string