GET Appointment/GetServiceRequestAsync?serviceRequisition={serviceRequisition}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
serviceRequisition | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ServiceRequestInfoName | Description | Type | Additional information |
---|---|---|---|
Endpoint_reference | string |
None. |
|
ServiceRequest_reference | string |
None. |
|
ServiceRequest_requisition | string |
None. |
|
ServiceRequest_status | string |
None. |
|
ServiceRequest_ocurrence_Timing_DayOfWeek | Collection of string |
None. |
|
Region_reference | string |
None. |
|
Region_display | string |
None. |
|
Organization_reference | string |
None. |
|
Organization_display | string |
None. |
|
Healthcareservice_reference | string |
None. |
|
Healthcareservice_display | string |
None. |
|
Patient_reference | string |
None. |
|
Patient_name_given | string |
None. |
|
Patient_name_family | string |
None. |
|
Patient_birthdate | date |
None. |
|
Patient_identifier_NN | string |
None. |
|
Patient_identifier_MR | string |
None. |
|
Patient_gender | string |
None. |
|
Patient_telephone | string |
None. |
|
Patient_email | string |
None. |
|
Patient_address | string |
None. |
|
Patient_city | string |
None. |
|
InsurancePlan_ownedBy_reference | string |
None. |
|
InsurancePlan_ownedBy_display | string |
None. |
|
InsurancePlan_reference | string |
None. |
|
InsurancePlan_display | string |
None. |
|
Coverage_identifier_SN | string |
None. |
|
Coverage_class | string |
None. |
|
EncounterServiceProvider_display | string |
None. |
|
EncounterParticipant_display | string |
None. |
|
EncounterPeriodStart | date |
None. |
|
EncounterLocation_display | string |
None. |
|
EncounterHealthcareservice_display | string |
None. |
|
SupportingInfos | Collection of ServiceRequestSupportingInfo |
None. |
|
Contact_relationship | string |
None. |
|
Contact_name | string |
None. |
|
Contact_value | string |
None. |
|
Requester_display | string |
None. |
|
Requester_identifier_DOC | string |
None. |
|
ReasonCode | string |
None. |
|
ReasonCode_display | string |
None. |
|
ReasonCode_note | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Endpoint_reference": "sample string 1", "ServiceRequest_reference": "sample string 2", "ServiceRequest_requisition": "sample string 3", "ServiceRequest_status": "sample string 4", "ServiceRequest_ocurrence_Timing_DayOfWeek": [ "sample string 1", "sample string 2" ], "Region_reference": "sample string 5", "Region_display": "sample string 6", "Organization_reference": "sample string 7", "Organization_display": "sample string 8", "Healthcareservice_reference": "sample string 9", "Healthcareservice_display": "sample string 10", "Patient_reference": "sample string 11", "Patient_name_given": "sample string 12", "Patient_name_family": "sample string 13", "Patient_birthdate": "2025-09-04T13:37:27.2037534+00:00", "Patient_identifier_NN": "sample string 15", "Patient_identifier_MR": "sample string 16", "Patient_gender": "sample string 17", "Patient_telephone": "sample string 18", "Patient_email": "sample string 19", "Patient_address": "sample string 20", "Patient_city": "sample string 21", "InsurancePlan_ownedBy_reference": "sample string 22", "InsurancePlan_ownedBy_display": "sample string 23", "InsurancePlan_reference": "sample string 24", "InsurancePlan_display": "sample string 25", "Coverage_identifier_SN": "sample string 26", "Coverage_class": "sample string 27", "EncounterServiceProvider_display": "sample string 28", "EncounterParticipant_display": "sample string 29", "EncounterPeriodStart": "2025-09-04T13:37:27.216954+00:00", "EncounterLocation_display": "sample string 30", "EncounterHealthcareservice_display": "sample string 31", "SupportingInfos": [ { "Display": "sample string 1", "Content": "QEA=" }, { "Display": "sample string 1", "Content": "QEA=" } ], "Contact_relationship": "sample string 32", "Contact_name": "sample string 33", "Contact_value": "sample string 34", "Requester_display": "sample string 35", "Requester_identifier_DOC": "sample string 36", "ReasonCode": "sample string 37", "ReasonCode_display": "sample string 38", "ReasonCode_note": "sample string 39" }
application/xml, text/xml
Sample:
<ServiceRequestInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hosix.Business.Shared.Entidades.ReferenciaData"> <_x003C_Contact_name_x003E_k__BackingField>sample string 33</_x003C_Contact_name_x003E_k__BackingField> <_x003C_Contact_relationship_x003E_k__BackingField>sample string 32</_x003C_Contact_relationship_x003E_k__BackingField> <_x003C_Contact_value_x003E_k__BackingField>sample string 34</_x003C_Contact_value_x003E_k__BackingField> <_x003C_Coverage_class_x003E_k__BackingField>sample string 27</_x003C_Coverage_class_x003E_k__BackingField> <_x003C_Coverage_identifier_SN_x003E_k__BackingField>sample string 26</_x003C_Coverage_identifier_SN_x003E_k__BackingField> <_x003C_EncounterHealthcareservice_display_x003E_k__BackingField>sample string 31</_x003C_EncounterHealthcareservice_display_x003E_k__BackingField> <_x003C_EncounterLocation_display_x003E_k__BackingField>sample string 30</_x003C_EncounterLocation_display_x003E_k__BackingField> <_x003C_EncounterParticipant_display_x003E_k__BackingField>sample string 29</_x003C_EncounterParticipant_display_x003E_k__BackingField> <_x003C_EncounterPeriodStart_x003E_k__BackingField>2025-09-04T13:37:27.216954+00:00</_x003C_EncounterPeriodStart_x003E_k__BackingField> <_x003C_EncounterServiceProvider_display_x003E_k__BackingField>sample string 28</_x003C_EncounterServiceProvider_display_x003E_k__BackingField> <_x003C_Endpoint_reference_x003E_k__BackingField>sample string 1</_x003C_Endpoint_reference_x003E_k__BackingField> <_x003C_Healthcareservice_display_x003E_k__BackingField>sample string 10</_x003C_Healthcareservice_display_x003E_k__BackingField> <_x003C_Healthcareservice_reference_x003E_k__BackingField>sample string 9</_x003C_Healthcareservice_reference_x003E_k__BackingField> <_x003C_InsurancePlan_display_x003E_k__BackingField>sample string 25</_x003C_InsurancePlan_display_x003E_k__BackingField> <_x003C_InsurancePlan_ownedBy_display_x003E_k__BackingField>sample string 23</_x003C_InsurancePlan_ownedBy_display_x003E_k__BackingField> <_x003C_InsurancePlan_ownedBy_reference_x003E_k__BackingField>sample string 22</_x003C_InsurancePlan_ownedBy_reference_x003E_k__BackingField> <_x003C_InsurancePlan_reference_x003E_k__BackingField>sample string 24</_x003C_InsurancePlan_reference_x003E_k__BackingField> <_x003C_Organization_display_x003E_k__BackingField>sample string 8</_x003C_Organization_display_x003E_k__BackingField> <_x003C_Organization_reference_x003E_k__BackingField>sample string 7</_x003C_Organization_reference_x003E_k__BackingField> <_x003C_Patient_address_x003E_k__BackingField>sample string 20</_x003C_Patient_address_x003E_k__BackingField> <_x003C_Patient_birthdate_x003E_k__BackingField>2025-09-04T13:37:27.2037534+00:00</_x003C_Patient_birthdate_x003E_k__BackingField> <_x003C_Patient_city_x003E_k__BackingField>sample string 21</_x003C_Patient_city_x003E_k__BackingField> <_x003C_Patient_email_x003E_k__BackingField>sample string 19</_x003C_Patient_email_x003E_k__BackingField> <_x003C_Patient_gender_x003E_k__BackingField>sample string 17</_x003C_Patient_gender_x003E_k__BackingField> <_x003C_Patient_identifier_MR_x003E_k__BackingField>sample string 16</_x003C_Patient_identifier_MR_x003E_k__BackingField> <_x003C_Patient_identifier_NN_x003E_k__BackingField>sample string 15</_x003C_Patient_identifier_NN_x003E_k__BackingField> <_x003C_Patient_name_family_x003E_k__BackingField>sample string 13</_x003C_Patient_name_family_x003E_k__BackingField> <_x003C_Patient_name_given_x003E_k__BackingField>sample string 12</_x003C_Patient_name_given_x003E_k__BackingField> <_x003C_Patient_reference_x003E_k__BackingField>sample string 11</_x003C_Patient_reference_x003E_k__BackingField> <_x003C_Patient_telephone_x003E_k__BackingField>sample string 18</_x003C_Patient_telephone_x003E_k__BackingField> <_x003C_ReasonCode_display_x003E_k__BackingField>sample string 38</_x003C_ReasonCode_display_x003E_k__BackingField> <_x003C_ReasonCode_note_x003E_k__BackingField>sample string 39</_x003C_ReasonCode_note_x003E_k__BackingField> <_x003C_ReasonCode_x003E_k__BackingField>sample string 37</_x003C_ReasonCode_x003E_k__BackingField> <_x003C_Region_display_x003E_k__BackingField>sample string 6</_x003C_Region_display_x003E_k__BackingField> <_x003C_Region_reference_x003E_k__BackingField>sample string 5</_x003C_Region_reference_x003E_k__BackingField> <_x003C_Requester_display_x003E_k__BackingField>sample string 35</_x003C_Requester_display_x003E_k__BackingField> <_x003C_Requester_identifier_DOC_x003E_k__BackingField>sample string 36</_x003C_Requester_identifier_DOC_x003E_k__BackingField> <_x003C_ServiceRequest_ocurrence_Timing_DayOfWeek_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </_x003C_ServiceRequest_ocurrence_Timing_DayOfWeek_x003E_k__BackingField> <_x003C_ServiceRequest_reference_x003E_k__BackingField>sample string 2</_x003C_ServiceRequest_reference_x003E_k__BackingField> <_x003C_ServiceRequest_requisition_x003E_k__BackingField>sample string 3</_x003C_ServiceRequest_requisition_x003E_k__BackingField> <_x003C_ServiceRequest_status_x003E_k__BackingField>sample string 4</_x003C_ServiceRequest_status_x003E_k__BackingField> <_x003C_SupportingInfos_x003E_k__BackingField> <ServiceRequestSupportingInfo> <_x003C_Content_x003E_k__BackingField>QEA=</_x003C_Content_x003E_k__BackingField> <_x003C_Display_x003E_k__BackingField>sample string 1</_x003C_Display_x003E_k__BackingField> </ServiceRequestSupportingInfo> <ServiceRequestSupportingInfo> <_x003C_Content_x003E_k__BackingField>QEA=</_x003C_Content_x003E_k__BackingField> <_x003C_Display_x003E_k__BackingField>sample string 1</_x003C_Display_x003E_k__BackingField> </ServiceRequestSupportingInfo> </_x003C_SupportingInfos_x003E_k__BackingField> </ServiceRequestInfo>