Service Directory > v32.1 > Resource_Management > Put_Patient_Charge_Information
 

Operation: Put_Patient_Charge_Information

Adds Patient Charge Information to a Purchase Item. Data includes Revenue Center, CDM, HCPCS and Company or Company Hierarchy


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Put_Patient_Charge_Information_Request

Put Patient Charge Information Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Purchase_Item_Reference  Purchase_ItemObject  [1..1]  Reference to an existing Purchase Item   
Patient_Charge_Information_Data  Patient_Charge_Information_Data  [0..1]  Element Containing Purchase Item HCPCS value and Patient Charge Information Row subelement   
Validation Description
This web service is only available if "Enable Patient Charge Information" is enabled on the tenant.   
top
 

Response Element: Put_Patient_Charge_Information_Response

Put Patient Charge Information Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Purchase_Item_Reference  Purchase_ItemObject  [0..1]  Purchase Item Reference   
top
 

Purchase_ItemObject

part of: Put_Patient_Charge_Information_Response, Put_Patient_Charge_Information_Request
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Purchase_ItemObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Purchase_ItemObjectID

part of: Purchase_ItemObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Purchase_Item_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Patient_Charge_Information_Data

part of: Put_Patient_Charge_Information_Request
Element Containing Purchase Item HCPCS value and Patient Charge Information Row subelement
 
Parameter name Type/Value Cardinality Description Validations
HCPCS  string (5)   [0..1]  Purchase Item HCPCS Code 
Validation Description
Remove HCPCS from alternate item identifiers. HCPCS already exists for Item ([item]) on the Alternate Item Identifiers tab.   
 
Patient_Charge_Information_Row_Data  Patient_Charge_Information_Row_Data  [0..*]  Patient Charge Information Data 
Validation Description
The combination of CDM ([ccode]), Company ([company]), and Revenue Center ([revcenter]) for this item ([item]) is already in use.   
 
top
 

Patient_Charge_Information_Row_Data

part of: Patient_Charge_Information_Data
Patient Charge Information Row Data instance.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If True is entered, the Patient Charge Information for the supplied Purchase Item reference will be deleted.   
Patient_Charge_Information_Reference  Patient_Charge_InformationObject  [0..1]  Patient Charge Information Row Data instance.   
CDM  string  [1..1]  CDM Value   
Organization_Reference  OrganizationObject  [0..1]  Refers to existing Company associated with the Patient Charge Information   
Revenue_Center_Reference  Revenue_CenterObject  [0..1]  Refers to existing Revenue Center associated with the Patient Charge Information 
Validation Description
Revenue Center ([revenue center]) is inactive.   
Revenue Center ([revenue center]) is not valid for Company ([company])   
You can't submit a Revenue Center without an associated Company.   
 
Validation Description
The combination of CDM ([ccode]), Company ([company]), and Revenue Center ([revcenter]) for this item ([item]) is already in use.   
top
 

Patient_Charge_InformationObject

part of: Patient_Charge_Information_Row_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Patient_Charge_InformationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Patient_Charge_InformationObjectID

part of: Patient_Charge_InformationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Patient_Charge_Information_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

OrganizationObject

part of: Patient_Charge_Information_Row_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  OrganizationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

OrganizationObjectID

part of: OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Organization_Reference_ID, Region_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Revenue_CenterObject

part of: Patient_Charge_Information_Row_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Revenue_CenterObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Revenue_CenterObjectID

part of: Revenue_CenterObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Revenue_Center_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Purchase_ItemReferenceEnumeration

part of: Purchase_ItemObjectID
Base Type
string
top
 

Patient_Charge_InformationReferenceEnumeration

part of: Patient_Charge_InformationObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Revenue_CenterReferenceEnumeration

part of: Revenue_CenterObjectID
Base Type
string
top