afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/HealthCareProcedure.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "associated_objects",
    "field_reference"
  ],
  "title": "HealthCareProcedure - Data API",
  "description": "Represents information related to industry-standard healthcare procedure codes. Before the Spring ’21 release, the Healthcare Procedure and Healthcare Diagnosis objects stored codes specifically related to procedures and diagnoses. These codes were used for prior-authorization requests and approval processes. Since the Spring’21 release, Health Cloud uses the Code Set and Code Set Bundle objects for this purpose instead.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "Category": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort, Update",
      "description": "Category of the procedure code such as anesthesia, surgery, radiology, and so on."
    },
    "Code": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Industry standard procedure code such as CPT or HCPCS."
    },
    "CodeDescription": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Description of the procedure code."
    },
    "CodeShortDescription": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Short description of the procedure code."
    },
    "CodeType": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort, Update",
      "description": "Type of procedure code represented in the record such as CPT or HCPCS."
    },
    "EffectiveDate": {
      "type": "date",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Start date for the code."
    },
    "EndDate": {
      "type": "date",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "End date for the code."
    },
    "IsActive": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether the diagnosis code is available for use."
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp for when the current user last viewed a record related to this record."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed."
    },
    "Name": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort, Update",
      "description": "The name of the code that displays in search and lookup fields. Salesforce recommends using the code along with the description to populate this field. For example, use <Code>: <Description> or <Code>-<Description> such as 95115: Allergy injection."
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "The ID of the user who owns this record. This is a polymorphic relationship field.",
      "relationship_name": "Owner",
      "relationship_type": "Lookup",
      "refers_to": "Group, User"
    }
  },
  "associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **HealthCareProcedureChangeEvent (API version 60.0)**: Change events are available for the object.\n- **HealthCareProcedureHistory**: History is available for tracked fields of the object.\n- **HealthCareProcedureOwnerSharingRule**: Sharing rules are available for the object.\n- **HealthCareProcedureShare**: Sharing is available for the object.",
  "field_reference": {
    "Category": {
      "field_label": "Category",
      "type": "picklist",
      "length": "40"
    },
    "Code": {
      "field_label": "Code",
      "type": "string",
      "length": "32"
    },
    "CodeDescription": {
      "field_label": "Description",
      "type": "string",
      "length": "255"
    },
    "CodeShortDescription": {
      "field_label": "Short Description",
      "type": "string",
      "length": "255"
    },
    "CodeType": {
      "field_label": "Code Type",
      "type": "picklist",
      "length": "40"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "EffectiveDate": {
      "field_label": "Effective Date",
      "type": "date"
    },
    "EndDate": {
      "field_label": "End Date",
      "type": "date"
    },
    "Id": {
      "field_label": "Health Care Procedure ID",
      "type": "id",
      "length": "18"
    },
    "IsActive": {
      "field_label": "Active",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}